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(bool BuildingModule)
55 : ModuleLoader(BuildingModule),
56 Invocation(new CompilerInvocation()), ModuleManager(nullptr),
57 BuildGlobalModuleIndex(false), HaveFullGlobalModuleIndex(false),
58 ModuleBuildFailed(false) {
61 CompilerInstance::~CompilerInstance() {
62 assert(OutputFiles.empty() && "Still output files in flight?");
65 void CompilerInstance::setInvocation(CompilerInvocation *Value) {
69 bool CompilerInstance::shouldBuildGlobalModuleIndex() const {
70 return (BuildGlobalModuleIndex ||
71 (ModuleManager && ModuleManager->isGlobalIndexUnavailable() &&
72 getFrontendOpts().GenerateGlobalModuleIndex)) &&
76 void CompilerInstance::setDiagnostics(DiagnosticsEngine *Value) {
80 void CompilerInstance::setTarget(TargetInfo *Value) {
84 void CompilerInstance::setFileManager(FileManager *Value) {
87 VirtualFileSystem = Value->getVirtualFileSystem();
89 VirtualFileSystem.reset();
92 void CompilerInstance::setSourceManager(SourceManager *Value) {
96 void CompilerInstance::setPreprocessor(Preprocessor *Value) { PP = Value; }
98 void CompilerInstance::setASTContext(ASTContext *Value) { Context = Value; }
100 void CompilerInstance::setSema(Sema *S) {
104 void CompilerInstance::setASTConsumer(std::unique_ptr<ASTConsumer> Value) {
105 Consumer = std::move(Value);
108 void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
109 CompletionConsumer.reset(Value);
112 std::unique_ptr<Sema> CompilerInstance::takeSema() {
113 return std::move(TheSema);
116 IntrusiveRefCntPtr<ASTReader> CompilerInstance::getModuleManager() const {
117 return ModuleManager;
119 void CompilerInstance::setModuleManager(IntrusiveRefCntPtr<ASTReader> Reader) {
120 ModuleManager = Reader;
123 std::shared_ptr<ModuleDependencyCollector>
124 CompilerInstance::getModuleDepCollector() const {
125 return ModuleDepCollector;
128 void CompilerInstance::setModuleDepCollector(
129 std::shared_ptr<ModuleDependencyCollector> Collector) {
130 ModuleDepCollector = Collector;
134 static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts,
135 const CodeGenOptions *CodeGenOpts,
136 DiagnosticsEngine &Diags) {
138 std::unique_ptr<raw_ostream> StreamOwner;
139 raw_ostream *OS = &llvm::errs();
140 if (DiagOpts->DiagnosticLogFile != "-") {
141 // Create the output stream.
142 auto FileOS = llvm::make_unique<llvm::raw_fd_ostream>(
143 DiagOpts->DiagnosticLogFile, EC,
144 llvm::sys::fs::F_Append | llvm::sys::fs::F_Text);
146 Diags.Report(diag::warn_fe_cc_log_diagnostics_failure)
147 << DiagOpts->DiagnosticLogFile << EC.message();
149 FileOS->SetUnbuffered();
150 FileOS->SetUseAtomicWrites(true);
152 StreamOwner = std::move(FileOS);
156 // Chain in the diagnostic client which will log the diagnostics.
157 auto Logger = llvm::make_unique<LogDiagnosticPrinter>(*OS, DiagOpts,
158 std::move(StreamOwner));
160 Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
161 assert(Diags.ownsClient());
163 new ChainedDiagnosticConsumer(Diags.takeClient(), std::move(Logger)));
166 static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts,
167 DiagnosticsEngine &Diags,
168 StringRef OutputFile) {
169 auto SerializedConsumer =
170 clang::serialized_diags::create(OutputFile, DiagOpts);
172 if (Diags.ownsClient()) {
173 Diags.setClient(new ChainedDiagnosticConsumer(
174 Diags.takeClient(), std::move(SerializedConsumer)));
176 Diags.setClient(new ChainedDiagnosticConsumer(
177 Diags.getClient(), std::move(SerializedConsumer)));
181 void CompilerInstance::createDiagnostics(DiagnosticConsumer *Client,
182 bool ShouldOwnClient) {
183 Diagnostics = createDiagnostics(&getDiagnosticOpts(), Client,
184 ShouldOwnClient, &getCodeGenOpts());
187 IntrusiveRefCntPtr<DiagnosticsEngine>
188 CompilerInstance::createDiagnostics(DiagnosticOptions *Opts,
189 DiagnosticConsumer *Client,
190 bool ShouldOwnClient,
191 const CodeGenOptions *CodeGenOpts) {
192 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
193 IntrusiveRefCntPtr<DiagnosticsEngine>
194 Diags(new DiagnosticsEngine(DiagID, Opts));
196 // Create the diagnostic client for reporting errors or for
197 // implementing -verify.
199 Diags->setClient(Client, ShouldOwnClient);
201 Diags->setClient(new TextDiagnosticPrinter(llvm::errs(), Opts));
203 // Chain in -verify checker, if requested.
204 if (Opts->VerifyDiagnostics)
205 Diags->setClient(new VerifyDiagnosticConsumer(*Diags));
207 // Chain in -diagnostic-log-file dumper, if requested.
208 if (!Opts->DiagnosticLogFile.empty())
209 SetUpDiagnosticLog(Opts, CodeGenOpts, *Diags);
211 if (!Opts->DiagnosticSerializationFile.empty())
212 SetupSerializedDiagnostics(Opts, *Diags,
213 Opts->DiagnosticSerializationFile);
215 // Configure our handling of diagnostics.
216 ProcessWarningOptions(*Diags, *Opts);
223 void CompilerInstance::createFileManager() {
224 if (!hasVirtualFileSystem()) {
225 // TODO: choose the virtual file system based on the CompilerInvocation.
226 setVirtualFileSystem(vfs::getRealFileSystem());
228 FileMgr = new FileManager(getFileSystemOpts(), VirtualFileSystem);
233 void CompilerInstance::createSourceManager(FileManager &FileMgr) {
234 SourceMgr = new SourceManager(getDiagnostics(), FileMgr);
237 // Initialize the remapping of files to alternative contents, e.g.,
238 // those specified through other files.
239 static void InitializeFileRemapping(DiagnosticsEngine &Diags,
240 SourceManager &SourceMgr,
241 FileManager &FileMgr,
242 const PreprocessorOptions &InitOpts) {
243 // Remap files in the source manager (with buffers).
244 for (const auto &RB : InitOpts.RemappedFileBuffers) {
245 // Create the file entry for the file that we're mapping from.
246 const FileEntry *FromFile =
247 FileMgr.getVirtualFile(RB.first, RB.second->getBufferSize(), 0);
249 Diags.Report(diag::err_fe_remap_missing_from_file) << RB.first;
250 if (!InitOpts.RetainRemappedFileBuffers)
255 // Override the contents of the "from" file with the contents of
257 SourceMgr.overrideFileContents(FromFile, RB.second,
258 InitOpts.RetainRemappedFileBuffers);
261 // Remap files in the source manager (with other files).
262 for (const auto &RF : InitOpts.RemappedFiles) {
263 // Find the file that we're mapping to.
264 const FileEntry *ToFile = FileMgr.getFile(RF.second);
266 Diags.Report(diag::err_fe_remap_missing_to_file) << RF.first << RF.second;
270 // Create the file entry for the file that we're mapping from.
271 const FileEntry *FromFile =
272 FileMgr.getVirtualFile(RF.first, ToFile->getSize(), 0);
274 Diags.Report(diag::err_fe_remap_missing_from_file) << RF.first;
278 // Override the contents of the "from" file with the contents of
280 SourceMgr.overrideFileContents(FromFile, ToFile);
283 SourceMgr.setOverridenFilesKeepOriginalName(
284 InitOpts.RemappedFilesKeepOriginalName);
289 void CompilerInstance::createPreprocessor(TranslationUnitKind TUKind) {
290 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
292 // Create a PTH manager if we are using some form of a token cache.
293 PTHManager *PTHMgr = nullptr;
294 if (!PPOpts.TokenCache.empty())
295 PTHMgr = PTHManager::Create(PPOpts.TokenCache, getDiagnostics());
297 // Create the Preprocessor.
298 HeaderSearch *HeaderInfo = new HeaderSearch(&getHeaderSearchOpts(),
303 PP = new Preprocessor(&getPreprocessorOpts(), getDiagnostics(), getLangOpts(),
304 getSourceManager(), *HeaderInfo, *this, PTHMgr,
305 /*OwnsHeaderSearch=*/true, TUKind);
306 PP->Initialize(getTarget());
308 // Note that this is different then passing PTHMgr to Preprocessor's ctor.
309 // That argument is used as the IdentifierInfoLookup argument to
310 // IdentifierTable's ctor.
312 PTHMgr->setPreprocessor(&*PP);
313 PP->setPTHManager(PTHMgr);
316 if (PPOpts.DetailedRecord)
317 PP->createPreprocessingRecord();
319 // Apply remappings to the source manager.
320 InitializeFileRemapping(PP->getDiagnostics(), PP->getSourceManager(),
321 PP->getFileManager(), PPOpts);
323 // Predefine macros and configure the preprocessor.
324 InitializePreprocessor(*PP, PPOpts, getFrontendOpts());
326 // Initialize the header search object.
327 ApplyHeaderSearchOptions(PP->getHeaderSearchInfo(), getHeaderSearchOpts(),
328 PP->getLangOpts(), PP->getTargetInfo().getTriple());
330 PP->setPreprocessedOutput(getPreprocessorOutputOpts().ShowCPP);
332 // Set up the module path, including the hash for the
333 // module-creation options.
334 SmallString<256> SpecificModuleCache(
335 getHeaderSearchOpts().ModuleCachePath);
336 if (!getHeaderSearchOpts().DisableModuleHash)
337 llvm::sys::path::append(SpecificModuleCache,
338 getInvocation().getModuleHash());
339 PP->getHeaderSearchInfo().setModuleCachePath(SpecificModuleCache);
341 // Handle generating dependencies, if requested.
342 const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
343 if (!DepOpts.OutputFile.empty())
344 TheDependencyFileGenerator.reset(
345 DependencyFileGenerator::CreateAndAttachToPreprocessor(*PP, DepOpts));
346 if (!DepOpts.DOTOutputFile.empty())
347 AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
348 getHeaderSearchOpts().Sysroot);
350 for (auto &Listener : DependencyCollectors)
351 Listener->attachToPreprocessor(*PP);
353 // If we don't have a collector, but we are collecting module dependencies,
354 // then we're the top level compiler instance and need to create one.
355 if (!ModuleDepCollector && !DepOpts.ModuleDependencyOutputDir.empty())
356 ModuleDepCollector = std::make_shared<ModuleDependencyCollector>(
357 DepOpts.ModuleDependencyOutputDir);
359 // Handle generating header include information, if requested.
360 if (DepOpts.ShowHeaderIncludes)
361 AttachHeaderIncludeGen(*PP);
362 if (!DepOpts.HeaderIncludeOutputFile.empty()) {
363 StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
364 if (OutputPath == "-")
366 AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/true, OutputPath,
367 /*ShowDepth=*/false);
370 if (DepOpts.PrintShowIncludes) {
371 AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/false, /*OutputPath=*/"",
372 /*ShowDepth=*/true, /*MSStyle=*/true);
375 // Load all explictly-specified module map files.
376 for (const auto &Filename : getFrontendOpts().ModuleMapFiles) {
377 if (auto *File = getFileManager().getFile(Filename))
378 PP->getHeaderSearchInfo().loadModuleMapFile(File, /*IsSystem*/false);
380 getDiagnostics().Report(diag::err_module_map_not_found) << Filename;
386 void CompilerInstance::createASTContext() {
387 Preprocessor &PP = getPreprocessor();
388 Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
389 PP.getIdentifierTable(), PP.getSelectorTable(),
390 PP.getBuiltinInfo());
391 Context->InitBuiltinTypes(getTarget());
396 void CompilerInstance::createPCHExternalASTSource(
397 StringRef Path, bool DisablePCHValidation, bool AllowPCHWithCompilerErrors,
398 void *DeserializationListener, bool OwnDeserializationListener) {
399 IntrusiveRefCntPtr<ExternalASTSource> Source;
400 bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
401 Source = createPCHExternalASTSource(
402 Path, getHeaderSearchOpts().Sysroot, DisablePCHValidation,
403 AllowPCHWithCompilerErrors, getPreprocessor(), getASTContext(),
404 DeserializationListener, OwnDeserializationListener, Preamble,
405 getFrontendOpts().UseGlobalModuleIndex);
406 ModuleManager = static_cast<ASTReader*>(Source.get());
407 getASTContext().setExternalSource(Source);
410 ExternalASTSource *CompilerInstance::createPCHExternalASTSource(
411 StringRef Path, const std::string &Sysroot, bool DisablePCHValidation,
412 bool AllowPCHWithCompilerErrors, Preprocessor &PP, ASTContext &Context,
413 void *DeserializationListener, bool OwnDeserializationListener,
414 bool Preamble, bool UseGlobalModuleIndex) {
415 HeaderSearchOptions &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
417 std::unique_ptr<ASTReader> Reader;
418 Reader.reset(new ASTReader(PP, Context,
419 Sysroot.empty() ? "" : Sysroot.c_str(),
420 DisablePCHValidation,
421 AllowPCHWithCompilerErrors,
422 /*AllowConfigurationMismatch*/false,
423 HSOpts.ModulesValidateSystemHeaders,
424 UseGlobalModuleIndex));
426 Reader->setDeserializationListener(
427 static_cast<ASTDeserializationListener *>(DeserializationListener),
428 /*TakeOwnership=*/OwnDeserializationListener);
429 switch (Reader->ReadAST(Path,
430 Preamble ? serialization::MK_Preamble
431 : serialization::MK_PCH,
433 ASTReader::ARR_None)) {
434 case ASTReader::Success:
435 // Set the predefines buffer as suggested by the PCH reader. Typically, the
436 // predefines buffer will be empty.
437 PP.setPredefines(Reader->getSuggestedPredefines());
438 return Reader.release();
440 case ASTReader::Failure:
441 // Unrecoverable failure: don't even try to process the input file.
444 case ASTReader::Missing:
445 case ASTReader::OutOfDate:
446 case ASTReader::VersionMismatch:
447 case ASTReader::ConfigurationMismatch:
448 case ASTReader::HadErrors:
449 // No suitable PCH file could be found. Return an error.
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(const OutputFile &OutFile) {
526 assert(OutFile.OS && "Attempt to add empty stream to output list!");
527 OutputFiles.push_back(OutFile);
530 void CompilerInstance::clearOutputFiles(bool EraseFiles) {
531 for (std::list<OutputFile>::iterator
532 it = OutputFiles.begin(), ie = OutputFiles.end(); it != ie; ++it) {
534 if (!it->TempFilename.empty()) {
536 llvm::sys::fs::remove(it->TempFilename);
538 SmallString<128> NewOutFile(it->Filename);
540 // If '-working-directory' was passed, the output filename should be
542 FileMgr->FixupRelativePath(NewOutFile);
543 if (std::error_code ec =
544 llvm::sys::fs::rename(it->TempFilename, NewOutFile.str())) {
545 getDiagnostics().Report(diag::err_unable_to_rename_temp)
546 << it->TempFilename << it->Filename << ec.message();
548 llvm::sys::fs::remove(it->TempFilename);
551 } else if (!it->Filename.empty() && EraseFiles)
552 llvm::sys::fs::remove(it->Filename);
558 llvm::raw_fd_ostream *
559 CompilerInstance::createDefaultOutputFile(bool Binary,
561 StringRef Extension) {
562 return createOutputFile(getFrontendOpts().OutputFile, Binary,
563 /*RemoveFileOnSignal=*/true, InFile, Extension,
564 /*UseTemporary=*/true);
567 llvm::raw_null_ostream *CompilerInstance::createNullOutputFile() {
568 llvm::raw_null_ostream *OS = new llvm::raw_null_ostream();
569 addOutputFile(OutputFile("", "", OS));
573 llvm::raw_fd_ostream *
574 CompilerInstance::createOutputFile(StringRef OutputPath,
575 bool Binary, bool RemoveFileOnSignal,
579 bool CreateMissingDirectories) {
580 std::string OutputPathName, TempPathName;
582 llvm::raw_fd_ostream *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 // Add the output file -- but don't try to remove "-", since this means we are
593 addOutputFile(OutputFile((OutputPathName != "-") ? OutputPathName : "",
599 llvm::raw_fd_ostream *CompilerInstance::createOutputFile(
600 StringRef OutputPath, std::error_code &Error, bool Binary,
601 bool RemoveFileOnSignal, StringRef InFile, StringRef Extension,
602 bool UseTemporary, bool CreateMissingDirectories,
603 std::string *ResultPathName, std::string *TempPathName) {
604 assert((!CreateMissingDirectories || UseTemporary) &&
605 "CreateMissingDirectories is only allowed when using temporary files");
607 std::string OutFile, TempFile;
608 if (!OutputPath.empty()) {
609 OutFile = OutputPath;
610 } else if (InFile == "-") {
612 } else if (!Extension.empty()) {
613 SmallString<128> Path(InFile);
614 llvm::sys::path::replace_extension(Path, Extension);
615 OutFile = Path.str();
620 std::unique_ptr<llvm::raw_fd_ostream> OS;
625 UseTemporary = false;
627 llvm::sys::fs::file_status Status;
628 llvm::sys::fs::status(OutputPath, Status);
629 if (llvm::sys::fs::exists(Status)) {
630 // Fail early if we can't write to the final destination.
631 if (!llvm::sys::fs::can_write(OutputPath))
634 // Don't use a temporary if the output is a special file. This handles
635 // things like '-o /dev/null'
636 if (!llvm::sys::fs::is_regular_file(Status))
637 UseTemporary = false;
643 // Create a temporary file.
644 SmallString<128> TempPath;
646 TempPath += "-%%%%%%%%";
649 llvm::sys::fs::createUniqueFile(TempPath.str(), fd, TempPath);
651 if (CreateMissingDirectories &&
652 EC == llvm::errc::no_such_file_or_directory) {
653 StringRef Parent = llvm::sys::path::parent_path(OutputPath);
654 EC = llvm::sys::fs::create_directories(Parent);
656 EC = llvm::sys::fs::createUniqueFile(TempPath.str(), fd, TempPath);
661 OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
662 OSFile = TempFile = TempPath.str();
664 // If we failed to create the temporary, fallback to writing to the file
665 // directly. This handles the corner case where we cannot write to the
666 // directory, but can write to the file.
671 OS.reset(new llvm::raw_fd_ostream(
673 (Binary ? llvm::sys::fs::F_None : llvm::sys::fs::F_Text)));
678 // Make sure the out stream file gets removed if we crash.
679 if (RemoveFileOnSignal)
680 llvm::sys::RemoveFileOnSignal(OSFile);
683 *ResultPathName = OutFile;
685 *TempPathName = TempFile;
690 // Initialization Utilities
692 bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
693 return InitializeSourceManager(Input, getDiagnostics(),
694 getFileManager(), getSourceManager(),
698 bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input,
699 DiagnosticsEngine &Diags,
700 FileManager &FileMgr,
701 SourceManager &SourceMgr,
702 const FrontendOptions &Opts) {
703 SrcMgr::CharacteristicKind
704 Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
706 if (Input.isBuffer()) {
707 SourceMgr.setMainFileID(SourceMgr.createFileID(
708 std::unique_ptr<llvm::MemoryBuffer>(Input.getBuffer()), Kind));
709 assert(!SourceMgr.getMainFileID().isInvalid() &&
710 "Couldn't establish MainFileID!");
714 StringRef InputFile = Input.getFile();
716 // Figure out where to get and map in the main file.
717 if (InputFile != "-") {
718 const FileEntry *File = FileMgr.getFile(InputFile, /*OpenFile=*/true);
720 Diags.Report(diag::err_fe_error_reading) << InputFile;
724 // The natural SourceManager infrastructure can't currently handle named
725 // pipes, but we would at least like to accept them for the main
726 // file. Detect them here, read them with the volatile flag so FileMgr will
727 // pick up the correct size, and simply override their contents as we do for
729 if (File->isNamedPipe()) {
730 auto MB = FileMgr.getBufferForFile(File, /*isVolatile=*/true);
732 // Create a new virtual file that will have the correct size.
733 File = FileMgr.getVirtualFile(InputFile, (*MB)->getBufferSize(), 0);
734 SourceMgr.overrideFileContents(File, std::move(*MB));
736 Diags.Report(diag::err_cannot_open_file) << InputFile
737 << MB.getError().message();
742 SourceMgr.setMainFileID(
743 SourceMgr.createFileID(File, SourceLocation(), Kind));
745 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> SBOrErr =
746 llvm::MemoryBuffer::getSTDIN();
747 if (std::error_code EC = SBOrErr.getError()) {
748 Diags.Report(diag::err_fe_error_reading_stdin) << EC.message();
751 std::unique_ptr<llvm::MemoryBuffer> SB = std::move(SBOrErr.get());
753 const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
754 SB->getBufferSize(), 0);
755 SourceMgr.setMainFileID(
756 SourceMgr.createFileID(File, SourceLocation(), Kind));
757 SourceMgr.overrideFileContents(File, std::move(SB));
760 assert(!SourceMgr.getMainFileID().isInvalid() &&
761 "Couldn't establish MainFileID!");
765 // High-Level Operations
767 bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
768 assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
769 assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
770 assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
772 // FIXME: Take this as an argument, once all the APIs we used have moved to
773 // taking it as an input instead of hard-coding llvm::errs.
774 raw_ostream &OS = llvm::errs();
776 // Create the target instance.
777 setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(),
778 getInvocation().TargetOpts));
782 // Inform the target of the language options.
784 // FIXME: We shouldn't need to do this, the target should be immutable once
785 // created. This complexity should be lifted elsewhere.
786 getTarget().adjust(getLangOpts());
788 // rewriter project will change target built-in bool type from its default.
789 if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
790 getTarget().noSignedCharForObjCBool();
792 // Validate/process some options.
793 if (getHeaderSearchOpts().Verbose)
794 OS << "clang -cc1 version " CLANG_VERSION_STRING
795 << " based upon " << BACKEND_PACKAGE_STRING
796 << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
798 if (getFrontendOpts().ShowTimers)
799 createFrontendTimer();
801 if (getFrontendOpts().ShowStats)
802 llvm::EnableStatistics();
804 for (unsigned i = 0, e = getFrontendOpts().Inputs.size(); i != e; ++i) {
805 // Reset the ID tables if we are reusing the SourceManager and parsing
807 if (hasSourceManager() && !Act.isModelParsingAction())
808 getSourceManager().clearIDTables();
810 if (Act.BeginSourceFile(*this, getFrontendOpts().Inputs[i])) {
816 // Notify the diagnostic client that all files were processed.
817 getDiagnostics().getClient()->finish();
819 if (getDiagnosticOpts().ShowCarets) {
820 // We can have multiple diagnostics sharing one diagnostic client.
821 // Get the total number of warnings/errors from the client.
822 unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
823 unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
826 OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
827 if (NumWarnings && NumErrors)
830 OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
831 if (NumWarnings || NumErrors)
832 OS << " generated.\n";
835 if (getFrontendOpts().ShowStats && hasFileManager()) {
836 getFileManager().PrintStats();
840 return !getDiagnostics().getClient()->getNumErrors();
843 /// \brief Determine the appropriate source input kind based on language
845 static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
851 return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
852 return LangOpts.CPlusPlus? IK_CXX : IK_C;
855 /// \brief Compile a module file for the given module, using the options
856 /// provided by the importing compiler instance. Returns true if the module
857 /// was built without errors.
858 static bool compileModuleImpl(CompilerInstance &ImportingInstance,
859 SourceLocation ImportLoc,
861 StringRef ModuleFileName) {
863 = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
865 // Construct a compiler invocation for creating this module.
866 IntrusiveRefCntPtr<CompilerInvocation> Invocation
867 (new CompilerInvocation(ImportingInstance.getInvocation()));
869 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
871 // For any options that aren't intended to affect how a module is built,
872 // reset them to their default values.
873 Invocation->getLangOpts()->resetNonModularOptions();
874 PPOpts.resetNonModularOptions();
876 // Remove any macro definitions that are explicitly ignored by the module.
877 // They aren't supposed to affect how the module is built anyway.
878 const HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
880 std::remove_if(PPOpts.Macros.begin(), PPOpts.Macros.end(),
881 [&HSOpts](const std::pair<std::string, bool> &def) {
882 StringRef MacroDef = def.first;
883 return HSOpts.ModulesIgnoreMacros.count(MacroDef.split('=').first) > 0;
885 PPOpts.Macros.end());
887 // Note the name of the module we're building.
888 Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
890 // Make sure that the failed-module structure has been allocated in
891 // the importing instance, and propagate the pointer to the newly-created
893 PreprocessorOptions &ImportingPPOpts
894 = ImportingInstance.getInvocation().getPreprocessorOpts();
895 if (!ImportingPPOpts.FailedModules)
896 ImportingPPOpts.FailedModules = new PreprocessorOptions::FailedModulesSet;
897 PPOpts.FailedModules = ImportingPPOpts.FailedModules;
899 // If there is a module map file, build the module using the module map.
900 // Set up the inputs/outputs so that we build the module from its umbrella
902 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
903 FrontendOpts.OutputFile = ModuleFileName.str();
904 FrontendOpts.DisableFree = false;
905 FrontendOpts.GenerateGlobalModuleIndex = false;
906 FrontendOpts.Inputs.clear();
907 InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
909 // Don't free the remapped file buffers; they are owned by our caller.
910 PPOpts.RetainRemappedFileBuffers = true;
912 Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
913 assert(ImportingInstance.getInvocation().getModuleHash() ==
914 Invocation->getModuleHash() && "Module hash mismatch!");
916 // Construct a compiler instance that will be used to actually create the
918 CompilerInstance Instance(/*BuildingModule=*/true);
919 Instance.setInvocation(&*Invocation);
921 Instance.createDiagnostics(new ForwardingDiagnosticConsumer(
922 ImportingInstance.getDiagnosticClient()),
923 /*ShouldOwnClient=*/true);
925 Instance.setVirtualFileSystem(&ImportingInstance.getVirtualFileSystem());
927 // Note that this module is part of the module build stack, so that we
928 // can detect cycles in the module graph.
929 Instance.setFileManager(&ImportingInstance.getFileManager());
930 Instance.createSourceManager(Instance.getFileManager());
931 SourceManager &SourceMgr = Instance.getSourceManager();
932 SourceMgr.setModuleBuildStack(
933 ImportingInstance.getSourceManager().getModuleBuildStack());
934 SourceMgr.pushModuleBuildStack(Module->getTopLevelModuleName(),
935 FullSourceLoc(ImportLoc, ImportingInstance.getSourceManager()));
937 // If we're collecting module dependencies, we need to share a collector
938 // between all of the module CompilerInstances.
939 Instance.setModuleDepCollector(ImportingInstance.getModuleDepCollector());
941 // Get or create the module map that we'll use to build this module.
942 std::string InferredModuleMapContent;
943 if (const FileEntry *ModuleMapFile =
944 ModMap.getContainingModuleMapFile(Module)) {
945 // Use the module map where this module resides.
946 FrontendOpts.Inputs.push_back(
947 FrontendInputFile(ModuleMapFile->getName(), IK));
949 llvm::raw_string_ostream OS(InferredModuleMapContent);
952 FrontendOpts.Inputs.push_back(
953 FrontendInputFile("__inferred_module.map", IK));
955 std::unique_ptr<llvm::MemoryBuffer> ModuleMapBuffer =
956 llvm::MemoryBuffer::getMemBuffer(InferredModuleMapContent);
957 ModuleMapFile = Instance.getFileManager().getVirtualFile(
958 "__inferred_module.map", InferredModuleMapContent.size(), 0);
959 SourceMgr.overrideFileContents(ModuleMapFile, std::move(ModuleMapBuffer));
962 // Construct a module-generating action. Passing through the module map is
963 // safe because the FileManager is shared between the compiler instances.
964 GenerateModuleAction CreateModuleAction(
965 ModMap.getModuleMapFileForUniquing(Module), Module->IsSystem);
967 ImportingInstance.getDiagnostics().Report(ImportLoc,
968 diag::remark_module_build)
969 << Module->Name << ModuleFileName;
971 // Execute the action to actually build the module in-place. Use a separate
972 // thread so that we get a stack large enough.
973 const unsigned ThreadStackSize = 8 << 20;
974 llvm::CrashRecoveryContext CRC;
975 CRC.RunSafelyOnThread([&]() { Instance.ExecuteAction(CreateModuleAction); },
978 ImportingInstance.getDiagnostics().Report(ImportLoc,
979 diag::remark_module_build_done)
982 // Delete the temporary module map file.
983 // FIXME: Even though we're executing under crash protection, it would still
984 // be nice to do this with RemoveFileOnSignal when we can. However, that
985 // doesn't make sense for all clients, so clean this up manually.
986 Instance.clearOutputFiles(/*EraseFiles=*/true);
988 // We've rebuilt a module. If we're allowed to generate or update the global
989 // module index, record that fact in the importing compiler instance.
990 if (ImportingInstance.getFrontendOpts().GenerateGlobalModuleIndex) {
991 ImportingInstance.setBuildGlobalModuleIndex(true);
994 return !Instance.getDiagnostics().hasErrorOccurred();
997 static bool compileAndLoadModule(CompilerInstance &ImportingInstance,
998 SourceLocation ImportLoc,
999 SourceLocation ModuleNameLoc, Module *Module,
1000 StringRef ModuleFileName) {
1001 DiagnosticsEngine &Diags = ImportingInstance.getDiagnostics();
1003 auto diagnoseBuildFailure = [&] {
1004 Diags.Report(ModuleNameLoc, diag::err_module_not_built)
1005 << Module->Name << SourceRange(ImportLoc, ModuleNameLoc);
1008 // FIXME: have LockFileManager return an error_code so that we can
1009 // avoid the mkdir when the directory already exists.
1010 StringRef Dir = llvm::sys::path::parent_path(ModuleFileName);
1011 llvm::sys::fs::create_directories(Dir);
1014 unsigned ModuleLoadCapabilities = ASTReader::ARR_Missing;
1015 llvm::LockFileManager Locked(ModuleFileName);
1017 case llvm::LockFileManager::LFS_Error:
1018 Diags.Report(ModuleNameLoc, diag::err_module_lock_failure)
1022 case llvm::LockFileManager::LFS_Owned:
1023 // We're responsible for building the module ourselves.
1024 if (!compileModuleImpl(ImportingInstance, ModuleNameLoc, Module,
1026 diagnoseBuildFailure();
1031 case llvm::LockFileManager::LFS_Shared:
1032 // Someone else is responsible for building the module. Wait for them to
1034 if (Locked.waitForUnlock() == llvm::LockFileManager::Res_OwnerDied)
1035 continue; // try again to get the lock.
1036 ModuleLoadCapabilities |= ASTReader::ARR_OutOfDate;
1040 // Try to read the module file, now that we've compiled it.
1041 ASTReader::ASTReadResult ReadResult =
1042 ImportingInstance.getModuleManager()->ReadAST(
1043 ModuleFileName, serialization::MK_ImplicitModule, ImportLoc,
1044 ModuleLoadCapabilities);
1046 if (ReadResult == ASTReader::OutOfDate &&
1047 Locked == llvm::LockFileManager::LFS_Shared) {
1048 // The module may be out of date in the presence of file system races,
1049 // or if one of its imports depends on header search paths that are not
1050 // consistent with this ImportingInstance. Try again...
1052 } else if (ReadResult == ASTReader::Missing) {
1053 diagnoseBuildFailure();
1054 } else if (ReadResult != ASTReader::Success &&
1055 !Diags.hasErrorOccurred()) {
1056 // The ASTReader didn't diagnose the error, so conservatively report it.
1057 diagnoseBuildFailure();
1059 return ReadResult == ASTReader::Success;
1063 /// \brief Diagnose differences between the current definition of the given
1064 /// configuration macro and the definition provided on the command line.
1065 static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
1066 Module *Mod, SourceLocation ImportLoc) {
1067 IdentifierInfo *Id = PP.getIdentifierInfo(ConfigMacro);
1068 SourceManager &SourceMgr = PP.getSourceManager();
1070 // If this identifier has never had a macro definition, then it could
1071 // not have changed.
1072 if (!Id->hadMacroDefinition())
1075 // If this identifier does not currently have a macro definition,
1076 // check whether it had one on the command line.
1077 if (!Id->hasMacroDefinition()) {
1078 MacroDirective::DefInfo LatestDef =
1079 PP.getMacroDirectiveHistory(Id)->getDefinition();
1080 for (MacroDirective::DefInfo Def = LatestDef; Def;
1081 Def = Def.getPreviousDefinition()) {
1082 FileID FID = SourceMgr.getFileID(Def.getLocation());
1083 if (FID.isInvalid())
1086 // We only care about the predefines buffer.
1087 if (FID != PP.getPredefinesFileID())
1090 // This macro was defined on the command line, then #undef'd later.
1092 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1093 << true << ConfigMacro << Mod->getFullModuleName();
1094 if (LatestDef.isUndefined())
1095 PP.Diag(LatestDef.getUndefLocation(), diag::note_module_def_undef_here)
1100 // Okay: no definition in the predefines buffer.
1104 // This identifier has a macro definition. Check whether we had a definition
1105 // on the command line.
1106 MacroDirective::DefInfo LatestDef =
1107 PP.getMacroDirectiveHistory(Id)->getDefinition();
1108 MacroDirective::DefInfo PredefinedDef;
1109 for (MacroDirective::DefInfo Def = LatestDef; Def;
1110 Def = Def.getPreviousDefinition()) {
1111 FileID FID = SourceMgr.getFileID(Def.getLocation());
1112 if (FID.isInvalid())
1115 // We only care about the predefines buffer.
1116 if (FID != PP.getPredefinesFileID())
1119 PredefinedDef = Def;
1123 // If there was no definition for this macro in the predefines buffer,
1125 if (!PredefinedDef ||
1126 (!PredefinedDef.getLocation().isValid() &&
1127 PredefinedDef.getUndefLocation().isValid())) {
1128 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1129 << false << ConfigMacro << Mod->getFullModuleName();
1130 PP.Diag(LatestDef.getLocation(), diag::note_module_def_undef_here)
1135 // If the current macro definition is the same as the predefined macro
1136 // definition, it's okay.
1137 if (LatestDef.getMacroInfo() == PredefinedDef.getMacroInfo() ||
1138 LatestDef.getMacroInfo()->isIdenticalTo(*PredefinedDef.getMacroInfo(),PP,
1139 /*Syntactically=*/true))
1142 // The macro definitions differ.
1143 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1144 << false << ConfigMacro << Mod->getFullModuleName();
1145 PP.Diag(LatestDef.getLocation(), diag::note_module_def_undef_here)
1149 /// \brief Write a new timestamp file with the given path.
1150 static void writeTimestampFile(StringRef TimestampFile) {
1152 llvm::raw_fd_ostream Out(TimestampFile.str(), EC, llvm::sys::fs::F_None);
1155 /// \brief Prune the module cache of modules that haven't been accessed in
1157 static void pruneModuleCache(const HeaderSearchOptions &HSOpts) {
1158 struct stat StatBuf;
1159 llvm::SmallString<128> TimestampFile;
1160 TimestampFile = HSOpts.ModuleCachePath;
1161 llvm::sys::path::append(TimestampFile, "modules.timestamp");
1163 // Try to stat() the timestamp file.
1164 if (::stat(TimestampFile.c_str(), &StatBuf)) {
1165 // If the timestamp file wasn't there, create one now.
1166 if (errno == ENOENT) {
1167 writeTimestampFile(TimestampFile);
1172 // Check whether the time stamp is older than our pruning interval.
1173 // If not, do nothing.
1174 time_t TimeStampModTime = StatBuf.st_mtime;
1175 time_t CurrentTime = time(nullptr);
1176 if (CurrentTime - TimeStampModTime <= time_t(HSOpts.ModuleCachePruneInterval))
1179 // Write a new timestamp file so that nobody else attempts to prune.
1180 // There is a benign race condition here, if two Clang instances happen to
1181 // notice at the same time that the timestamp is out-of-date.
1182 writeTimestampFile(TimestampFile);
1184 // Walk the entire module cache, looking for unused module files and module
1187 SmallString<128> ModuleCachePathNative;
1188 llvm::sys::path::native(HSOpts.ModuleCachePath, ModuleCachePathNative);
1189 for (llvm::sys::fs::directory_iterator
1190 Dir(ModuleCachePathNative.str(), EC), DirEnd;
1191 Dir != DirEnd && !EC; Dir.increment(EC)) {
1192 // If we don't have a directory, there's nothing to look into.
1193 if (!llvm::sys::fs::is_directory(Dir->path()))
1196 // Walk all of the files within this directory.
1197 for (llvm::sys::fs::directory_iterator File(Dir->path(), EC), FileEnd;
1198 File != FileEnd && !EC; File.increment(EC)) {
1199 // We only care about module and global module index files.
1200 StringRef Extension = llvm::sys::path::extension(File->path());
1201 if (Extension != ".pcm" && Extension != ".timestamp" &&
1202 llvm::sys::path::filename(File->path()) != "modules.idx")
1205 // Look at this file. If we can't stat it, there's nothing interesting
1207 if (::stat(File->path().c_str(), &StatBuf))
1210 // If the file has been used recently enough, leave it there.
1211 time_t FileAccessTime = StatBuf.st_atime;
1212 if (CurrentTime - FileAccessTime <=
1213 time_t(HSOpts.ModuleCachePruneAfter)) {
1218 llvm::sys::fs::remove(File->path());
1220 // Remove the timestamp file.
1221 std::string TimpestampFilename = File->path() + ".timestamp";
1222 llvm::sys::fs::remove(TimpestampFilename);
1225 // If we removed all of the files in the directory, remove the directory
1227 if (llvm::sys::fs::directory_iterator(Dir->path(), EC) ==
1228 llvm::sys::fs::directory_iterator() && !EC)
1229 llvm::sys::fs::remove(Dir->path());
1233 void CompilerInstance::createModuleManager() {
1234 if (!ModuleManager) {
1235 if (!hasASTContext())
1238 // If we're not recursively building a module, check whether we
1239 // need to prune the module cache.
1240 if (getSourceManager().getModuleBuildStack().empty() &&
1241 getHeaderSearchOpts().ModuleCachePruneInterval > 0 &&
1242 getHeaderSearchOpts().ModuleCachePruneAfter > 0) {
1243 pruneModuleCache(getHeaderSearchOpts());
1246 HeaderSearchOptions &HSOpts = getHeaderSearchOpts();
1247 std::string Sysroot = HSOpts.Sysroot;
1248 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
1249 ModuleManager = new ASTReader(getPreprocessor(), *Context,
1250 Sysroot.empty() ? "" : Sysroot.c_str(),
1251 PPOpts.DisablePCHValidation,
1252 /*AllowASTWithCompilerErrors=*/false,
1253 /*AllowConfigurationMismatch=*/false,
1254 HSOpts.ModulesValidateSystemHeaders,
1255 getFrontendOpts().UseGlobalModuleIndex);
1256 if (hasASTConsumer()) {
1257 ModuleManager->setDeserializationListener(
1258 getASTConsumer().GetASTDeserializationListener());
1259 getASTContext().setASTMutationListener(
1260 getASTConsumer().GetASTMutationListener());
1262 getASTContext().setExternalSource(ModuleManager);
1264 ModuleManager->InitializeSema(getSema());
1265 if (hasASTConsumer())
1266 ModuleManager->StartTranslationUnit(&getASTConsumer());
1270 bool CompilerInstance::loadModuleFile(StringRef FileName) {
1271 // Helper to recursively read the module names for all modules we're adding.
1272 // We mark these as known and redirect any attempt to load that module to
1273 // the files we were handed.
1274 struct ReadModuleNames : ASTReaderListener {
1275 CompilerInstance &CI;
1276 std::vector<StringRef> ModuleFileStack;
1278 bool TopFileIsModule;
1280 ReadModuleNames(CompilerInstance &CI)
1281 : CI(CI), Failed(false), TopFileIsModule(false) {}
1283 bool needsImportVisitation() const override { return true; }
1285 void visitImport(StringRef FileName) override {
1286 ModuleFileStack.push_back(FileName);
1287 if (ASTReader::readASTFileControlBlock(FileName, CI.getFileManager(),
1289 CI.getDiagnostics().Report(SourceLocation(),
1290 diag::err_module_file_not_found)
1292 // FIXME: Produce a note stack explaining how we got here.
1295 ModuleFileStack.pop_back();
1298 void ReadModuleName(StringRef ModuleName) override {
1299 if (ModuleFileStack.size() == 1)
1300 TopFileIsModule = true;
1302 auto &ModuleFile = CI.ModuleFileOverrides[ModuleName];
1303 if (!ModuleFile.empty() &&
1304 CI.getFileManager().getFile(ModuleFile) !=
1305 CI.getFileManager().getFile(ModuleFileStack.back()))
1306 CI.getDiagnostics().Report(SourceLocation(),
1307 diag::err_conflicting_module_files)
1308 << ModuleName << ModuleFile << ModuleFileStack.back();
1309 ModuleFile = ModuleFileStack.back();
1313 RMN.visitImport(FileName);
1318 // If we never found a module name for the top file, then it's not a module,
1319 // it's a PCH or preamble or something.
1320 if (!RMN.TopFileIsModule) {
1321 getDiagnostics().Report(SourceLocation(), diag::err_module_file_not_module)
1330 CompilerInstance::loadModule(SourceLocation ImportLoc,
1332 Module::NameVisibilityKind Visibility,
1333 bool IsInclusionDirective) {
1334 // Determine what file we're searching from.
1335 StringRef ModuleName = Path[0].first->getName();
1336 SourceLocation ModuleNameLoc = Path[0].second;
1338 // If we've already handled this import, just return the cached result.
1339 // This one-element cache is important to eliminate redundant diagnostics
1340 // when both the preprocessor and parser see the same import declaration.
1341 if (!ImportLoc.isInvalid() && LastModuleImportLoc == ImportLoc) {
1342 // Make the named module visible.
1343 if (LastModuleImportResult && ModuleName != getLangOpts().CurrentModule &&
1344 ModuleName != getLangOpts().ImplementationOfModule)
1345 ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility,
1346 ImportLoc, /*Complain=*/false);
1347 return LastModuleImportResult;
1350 clang::Module *Module = nullptr;
1352 // If we don't already have information on this module, load the module now.
1353 llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
1354 = KnownModules.find(Path[0].first);
1355 if (Known != KnownModules.end()) {
1356 // Retrieve the cached top-level module.
1357 Module = Known->second;
1358 } else if (ModuleName == getLangOpts().CurrentModule ||
1359 ModuleName == getLangOpts().ImplementationOfModule) {
1360 // This is the module we're building.
1361 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1362 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1364 // Search for a module with the given name.
1365 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1367 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1369 << SourceRange(ImportLoc, ModuleNameLoc);
1370 ModuleBuildFailed = true;
1371 return ModuleLoadResult();
1374 auto Override = ModuleFileOverrides.find(ModuleName);
1375 bool Explicit = Override != ModuleFileOverrides.end();
1377 std::string ModuleFileName =
1378 Explicit ? Override->second
1379 : PP->getHeaderSearchInfo().getModuleFileName(Module);
1381 // If we don't already have an ASTReader, create one now.
1383 createModuleManager();
1385 if (TheDependencyFileGenerator)
1386 TheDependencyFileGenerator->AttachToASTReader(*ModuleManager);
1388 if (ModuleDepCollector)
1389 ModuleDepCollector->attachToASTReader(*ModuleManager);
1391 for (auto &Listener : DependencyCollectors)
1392 Listener->attachToASTReader(*ModuleManager);
1394 // Try to load the module file.
1396 Explicit ? 0 : ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing;
1397 switch (ModuleManager->ReadAST(ModuleFileName,
1398 Explicit ? serialization::MK_ExplicitModule
1399 : serialization::MK_ImplicitModule,
1400 ImportLoc, ARRFlags)) {
1401 case ASTReader::Success:
1404 case ASTReader::OutOfDate:
1405 case ASTReader::Missing: {
1407 // ReadAST has already complained for us.
1408 ModuleLoader::HadFatalFailure = true;
1409 KnownModules[Path[0].first] = nullptr;
1410 return ModuleLoadResult();
1413 // The module file is missing or out-of-date. Build it.
1414 assert(Module && "missing module file");
1415 // Check whether there is a cycle in the module graph.
1416 ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
1417 ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1418 for (; Pos != PosEnd; ++Pos) {
1419 if (Pos->first == ModuleName)
1423 if (Pos != PosEnd) {
1424 SmallString<256> CyclePath;
1425 for (; Pos != PosEnd; ++Pos) {
1426 CyclePath += Pos->first;
1427 CyclePath += " -> ";
1429 CyclePath += ModuleName;
1431 getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
1432 << ModuleName << CyclePath;
1433 return ModuleLoadResult();
1436 // Check whether we have already attempted to build this module (but
1438 if (getPreprocessorOpts().FailedModules &&
1439 getPreprocessorOpts().FailedModules->hasAlreadyFailed(ModuleName)) {
1440 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_built)
1442 << SourceRange(ImportLoc, ModuleNameLoc);
1443 ModuleBuildFailed = true;
1444 return ModuleLoadResult();
1447 // Try to compile and then load the module.
1448 if (!compileAndLoadModule(*this, ImportLoc, ModuleNameLoc, Module,
1450 assert(getDiagnostics().hasErrorOccurred() &&
1451 "undiagnosed error in compileAndLoadModule");
1452 if (getPreprocessorOpts().FailedModules)
1453 getPreprocessorOpts().FailedModules->addFailed(ModuleName);
1454 KnownModules[Path[0].first] = nullptr;
1455 ModuleBuildFailed = true;
1456 return ModuleLoadResult();
1459 // Okay, we've rebuilt and now loaded the module.
1463 case ASTReader::VersionMismatch:
1464 case ASTReader::ConfigurationMismatch:
1465 case ASTReader::HadErrors:
1466 ModuleLoader::HadFatalFailure = true;
1467 // FIXME: The ASTReader will already have complained, but can we showhorn
1468 // that diagnostic information into a more useful form?
1469 KnownModules[Path[0].first] = nullptr;
1470 return ModuleLoadResult();
1472 case ASTReader::Failure:
1473 ModuleLoader::HadFatalFailure = true;
1474 // Already complained, but note now that we failed.
1475 KnownModules[Path[0].first] = nullptr;
1476 ModuleBuildFailed = true;
1477 return ModuleLoadResult();
1480 // Cache the result of this top-level module lookup for later.
1481 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1484 // If we never found the module, fail.
1486 return ModuleLoadResult();
1488 // Verify that the rest of the module path actually corresponds to
1490 if (Path.size() > 1) {
1491 for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1492 StringRef Name = Path[I].first->getName();
1493 clang::Module *Sub = Module->findSubmodule(Name);
1496 // Attempt to perform typo correction to find a module name that works.
1497 SmallVector<StringRef, 2> Best;
1498 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1500 for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1501 JEnd = Module->submodule_end();
1503 unsigned ED = Name.edit_distance((*J)->Name,
1504 /*AllowReplacements=*/true,
1506 if (ED <= BestEditDistance) {
1507 if (ED < BestEditDistance) {
1509 BestEditDistance = ED;
1512 Best.push_back((*J)->Name);
1516 // If there was a clear winner, user it.
1517 if (Best.size() == 1) {
1518 getDiagnostics().Report(Path[I].second,
1519 diag::err_no_submodule_suggest)
1520 << Path[I].first << Module->getFullModuleName() << Best[0]
1521 << SourceRange(Path[0].second, Path[I-1].second)
1522 << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1525 Sub = Module->findSubmodule(Best[0]);
1530 // No submodule by this name. Complain, and don't look for further
1532 getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
1533 << Path[I].first << Module->getFullModuleName()
1534 << SourceRange(Path[0].second, Path[I-1].second);
1542 // Don't make the module visible if we are in the implementation.
1543 if (ModuleName == getLangOpts().ImplementationOfModule)
1544 return ModuleLoadResult(Module, false);
1546 // Make the named module visible, if it's not already part of the module
1548 if (ModuleName != getLangOpts().CurrentModule) {
1549 if (!Module->IsFromModuleFile) {
1550 // We have an umbrella header or directory that doesn't actually include
1551 // all of the headers within the directory it covers. Complain about
1552 // this missing submodule and recover by forgetting that we ever saw
1554 // FIXME: Should we detect this at module load time? It seems fairly
1555 // expensive (and rare).
1556 getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1557 << Module->getFullModuleName()
1558 << SourceRange(Path.front().second, Path.back().second);
1560 return ModuleLoadResult(nullptr, true);
1563 // Check whether this module is available.
1564 clang::Module::Requirement Requirement;
1565 clang::Module::UnresolvedHeaderDirective MissingHeader;
1566 if (!Module->isAvailable(getLangOpts(), getTarget(), Requirement,
1568 if (MissingHeader.FileNameLoc.isValid()) {
1569 getDiagnostics().Report(MissingHeader.FileNameLoc,
1570 diag::err_module_header_missing)
1571 << MissingHeader.IsUmbrella << MissingHeader.FileName;
1573 getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1574 << Module->getFullModuleName()
1575 << Requirement.second << Requirement.first
1576 << SourceRange(Path.front().second, Path.back().second);
1578 LastModuleImportLoc = ImportLoc;
1579 LastModuleImportResult = ModuleLoadResult();
1580 return ModuleLoadResult();
1583 ModuleManager->makeModuleVisible(Module, Visibility, ImportLoc,
1587 // Check for any configuration macros that have changed.
1588 clang::Module *TopModule = Module->getTopLevelModule();
1589 for (unsigned I = 0, N = TopModule->ConfigMacros.size(); I != N; ++I) {
1590 checkConfigMacro(getPreprocessor(), TopModule->ConfigMacros[I],
1594 // Determine whether we're in the #include buffer for a module. The #includes
1595 // in that buffer do not qualify as module imports; they're just an
1596 // implementation detail of us building the module.
1597 bool IsInModuleIncludes = !getLangOpts().CurrentModule.empty() &&
1598 getSourceManager().getFileID(ImportLoc) ==
1599 getSourceManager().getMainFileID();
1601 // If this module import was due to an inclusion directive, create an
1602 // implicit import declaration to capture it in the AST.
1603 if (IsInclusionDirective && hasASTContext() && !IsInModuleIncludes) {
1604 TranslationUnitDecl *TU = getASTContext().getTranslationUnitDecl();
1605 ImportDecl *ImportD = ImportDecl::CreateImplicit(getASTContext(), TU,
1607 Path.back().second);
1608 TU->addDecl(ImportD);
1610 Consumer->HandleImplicitImportDecl(ImportD);
1613 LastModuleImportLoc = ImportLoc;
1614 LastModuleImportResult = ModuleLoadResult(Module, false);
1615 return LastModuleImportResult;
1618 void CompilerInstance::makeModuleVisible(Module *Mod,
1619 Module::NameVisibilityKind Visibility,
1620 SourceLocation ImportLoc,
1622 ModuleManager->makeModuleVisible(Mod, Visibility, ImportLoc, Complain);
1625 GlobalModuleIndex *CompilerInstance::loadGlobalModuleIndex(
1626 SourceLocation TriggerLoc) {
1628 createModuleManager();
1629 // Can't do anything if we don't have the module manager.
1632 // Get an existing global index. This loads it if not already
1634 ModuleManager->loadGlobalIndex();
1635 GlobalModuleIndex *GlobalIndex = ModuleManager->getGlobalIndex();
1636 // If the global index doesn't exist, create it.
1637 if (!GlobalIndex && shouldBuildGlobalModuleIndex() && hasFileManager() &&
1638 hasPreprocessor()) {
1639 llvm::sys::fs::create_directories(
1640 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1641 GlobalModuleIndex::writeIndex(
1643 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1644 ModuleManager->resetForReload();
1645 ModuleManager->loadGlobalIndex();
1646 GlobalIndex = ModuleManager->getGlobalIndex();
1648 // For finding modules needing to be imported for fixit messages,
1649 // we need to make the global index cover all modules, so we do that here.
1650 if (!HaveFullGlobalModuleIndex && GlobalIndex && !buildingModule()) {
1651 ModuleMap &MMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
1652 bool RecreateIndex = false;
1653 for (ModuleMap::module_iterator I = MMap.module_begin(),
1654 E = MMap.module_end(); I != E; ++I) {
1655 Module *TheModule = I->second;
1656 const FileEntry *Entry = TheModule->getASTFile();
1658 SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
1659 Path.push_back(std::make_pair(
1660 getPreprocessor().getIdentifierInfo(TheModule->Name), TriggerLoc));
1661 std::reverse(Path.begin(), Path.end());
1662 // Load a module as hidden. This also adds it to the global index.
1663 loadModule(TheModule->DefinitionLoc, Path,
1664 Module::Hidden, false);
1665 RecreateIndex = true;
1668 if (RecreateIndex) {
1669 GlobalModuleIndex::writeIndex(
1671 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1672 ModuleManager->resetForReload();
1673 ModuleManager->loadGlobalIndex();
1674 GlobalIndex = ModuleManager->getGlobalIndex();
1676 HaveFullGlobalModuleIndex = true;
1681 // Check global module index for missing imports.
1683 CompilerInstance::lookupMissingImports(StringRef Name,
1684 SourceLocation TriggerLoc) {
1685 // Look for the symbol in non-imported modules, but only if an error
1686 // actually occurred.
1687 if (!buildingModule()) {
1688 // Load global module index, or retrieve a previously loaded one.
1689 GlobalModuleIndex *GlobalIndex = loadGlobalModuleIndex(
1692 // Only if we have a global index.
1694 GlobalModuleIndex::HitSet FoundModules;
1696 // Find the modules that reference the identifier.
1697 // Note that this only finds top-level modules.
1698 // We'll let diagnoseTypo find the actual declaration module.
1699 if (GlobalIndex->lookupIdentifier(Name, FoundModules))
1706 void CompilerInstance::resetAndLeakSema() { BuryPointer(takeSema()); }