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 if (PP->getLangOpts().Modules)
333 PP->getHeaderSearchInfo().setModuleCachePath(getSpecificModuleCachePath());
335 // Handle generating dependencies, if requested.
336 const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
337 if (!DepOpts.OutputFile.empty())
338 TheDependencyFileGenerator.reset(
339 DependencyFileGenerator::CreateAndAttachToPreprocessor(*PP, DepOpts));
340 if (!DepOpts.DOTOutputFile.empty())
341 AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
342 getHeaderSearchOpts().Sysroot);
344 for (auto &Listener : DependencyCollectors)
345 Listener->attachToPreprocessor(*PP);
347 // If we don't have a collector, but we are collecting module dependencies,
348 // then we're the top level compiler instance and need to create one.
349 if (!ModuleDepCollector && !DepOpts.ModuleDependencyOutputDir.empty())
350 ModuleDepCollector = std::make_shared<ModuleDependencyCollector>(
351 DepOpts.ModuleDependencyOutputDir);
353 // Handle generating header include information, if requested.
354 if (DepOpts.ShowHeaderIncludes)
355 AttachHeaderIncludeGen(*PP);
356 if (!DepOpts.HeaderIncludeOutputFile.empty()) {
357 StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
358 if (OutputPath == "-")
360 AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/true, OutputPath,
361 /*ShowDepth=*/false);
364 if (DepOpts.PrintShowIncludes) {
365 AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/false, /*OutputPath=*/"",
366 /*ShowDepth=*/true, /*MSStyle=*/true);
370 std::string CompilerInstance::getSpecificModuleCachePath() {
371 // Set up the module path, including the hash for the
372 // module-creation options.
373 SmallString<256> SpecificModuleCache(
374 getHeaderSearchOpts().ModuleCachePath);
375 if (!getHeaderSearchOpts().DisableModuleHash)
376 llvm::sys::path::append(SpecificModuleCache,
377 getInvocation().getModuleHash());
378 return SpecificModuleCache.str();
383 void CompilerInstance::createASTContext() {
384 Preprocessor &PP = getPreprocessor();
385 Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
386 PP.getIdentifierTable(), PP.getSelectorTable(),
387 PP.getBuiltinInfo());
388 Context->InitBuiltinTypes(getTarget());
393 void CompilerInstance::createPCHExternalASTSource(
394 StringRef Path, bool DisablePCHValidation, bool AllowPCHWithCompilerErrors,
395 void *DeserializationListener, bool OwnDeserializationListener) {
396 bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
397 ModuleManager = createPCHExternalASTSource(
398 Path, getHeaderSearchOpts().Sysroot, DisablePCHValidation,
399 AllowPCHWithCompilerErrors, getPreprocessor(), getASTContext(),
400 DeserializationListener, OwnDeserializationListener, Preamble,
401 getFrontendOpts().UseGlobalModuleIndex);
404 IntrusiveRefCntPtr<ASTReader> CompilerInstance::createPCHExternalASTSource(
405 StringRef Path, const std::string &Sysroot, bool DisablePCHValidation,
406 bool AllowPCHWithCompilerErrors, Preprocessor &PP, ASTContext &Context,
407 void *DeserializationListener, bool OwnDeserializationListener,
408 bool Preamble, bool UseGlobalModuleIndex) {
409 HeaderSearchOptions &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
411 IntrusiveRefCntPtr<ASTReader> Reader(
412 new ASTReader(PP, Context, Sysroot.empty() ? "" : Sysroot.c_str(),
413 DisablePCHValidation, AllowPCHWithCompilerErrors,
414 /*AllowConfigurationMismatch*/ false,
415 HSOpts.ModulesValidateSystemHeaders, UseGlobalModuleIndex));
417 // We need the external source to be set up before we read the AST, because
418 // eagerly-deserialized declarations may use it.
419 Context.setExternalSource(Reader.get());
421 Reader->setDeserializationListener(
422 static_cast<ASTDeserializationListener *>(DeserializationListener),
423 /*TakeOwnership=*/OwnDeserializationListener);
424 switch (Reader->ReadAST(Path,
425 Preamble ? serialization::MK_Preamble
426 : serialization::MK_PCH,
428 ASTReader::ARR_None)) {
429 case ASTReader::Success:
430 // Set the predefines buffer as suggested by the PCH reader. Typically, the
431 // predefines buffer will be empty.
432 PP.setPredefines(Reader->getSuggestedPredefines());
435 case ASTReader::Failure:
436 // Unrecoverable failure: don't even try to process the input file.
439 case ASTReader::Missing:
440 case ASTReader::OutOfDate:
441 case ASTReader::VersionMismatch:
442 case ASTReader::ConfigurationMismatch:
443 case ASTReader::HadErrors:
444 // No suitable PCH file could be found. Return an error.
448 Context.setExternalSource(nullptr);
454 static bool EnableCodeCompletion(Preprocessor &PP,
455 const std::string &Filename,
458 // Tell the source manager to chop off the given file at a specific
460 const FileEntry *Entry = PP.getFileManager().getFile(Filename);
462 PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
467 // Truncate the named file at the given line/column.
468 PP.SetCodeCompletionPoint(Entry, Line, Column);
472 void CompilerInstance::createCodeCompletionConsumer() {
473 const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
474 if (!CompletionConsumer) {
475 setCodeCompletionConsumer(
476 createCodeCompletionConsumer(getPreprocessor(),
477 Loc.FileName, Loc.Line, Loc.Column,
478 getFrontendOpts().CodeCompleteOpts,
480 if (!CompletionConsumer)
482 } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
483 Loc.Line, Loc.Column)) {
484 setCodeCompletionConsumer(nullptr);
488 if (CompletionConsumer->isOutputBinary() &&
489 llvm::sys::ChangeStdoutToBinary()) {
490 getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
491 setCodeCompletionConsumer(nullptr);
495 void CompilerInstance::createFrontendTimer() {
496 FrontendTimer.reset(new llvm::Timer("Clang front-end timer"));
499 CodeCompleteConsumer *
500 CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
501 const std::string &Filename,
504 const CodeCompleteOptions &Opts,
506 if (EnableCodeCompletion(PP, Filename, Line, Column))
509 // Set up the creation routine for code-completion.
510 return new PrintingCodeCompleteConsumer(Opts, OS);
513 void CompilerInstance::createSema(TranslationUnitKind TUKind,
514 CodeCompleteConsumer *CompletionConsumer) {
515 TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
516 TUKind, CompletionConsumer));
521 void CompilerInstance::addOutputFile(OutputFile &&OutFile) {
522 assert(OutFile.OS && "Attempt to add empty stream to output list!");
523 OutputFiles.push_back(std::move(OutFile));
526 void CompilerInstance::clearOutputFiles(bool EraseFiles) {
527 for (OutputFile &OF : OutputFiles) {
528 // Manually close the stream before we rename it.
531 if (!OF.TempFilename.empty()) {
533 llvm::sys::fs::remove(OF.TempFilename);
535 SmallString<128> NewOutFile(OF.Filename);
537 // If '-working-directory' was passed, the output filename should be
539 FileMgr->FixupRelativePath(NewOutFile);
540 if (std::error_code ec =
541 llvm::sys::fs::rename(OF.TempFilename, NewOutFile)) {
542 getDiagnostics().Report(diag::err_unable_to_rename_temp)
543 << OF.TempFilename << OF.Filename << ec.message();
545 llvm::sys::fs::remove(OF.TempFilename);
548 } else if (!OF.Filename.empty() && EraseFiles)
549 llvm::sys::fs::remove(OF.Filename);
553 NonSeekStream.reset();
557 CompilerInstance::createDefaultOutputFile(bool Binary, StringRef InFile,
558 StringRef Extension) {
559 return createOutputFile(getFrontendOpts().OutputFile, Binary,
560 /*RemoveFileOnSignal=*/true, InFile, Extension,
561 /*UseTemporary=*/true);
564 llvm::raw_null_ostream *CompilerInstance::createNullOutputFile() {
565 auto OS = llvm::make_unique<llvm::raw_null_ostream>();
566 llvm::raw_null_ostream *Ret = OS.get();
567 addOutputFile(OutputFile("", "", std::move(OS)));
572 CompilerInstance::createOutputFile(StringRef OutputPath, bool Binary,
573 bool RemoveFileOnSignal, StringRef InFile,
574 StringRef Extension, bool UseTemporary,
575 bool CreateMissingDirectories) {
576 std::string OutputPathName, TempPathName;
578 std::unique_ptr<raw_pwrite_stream> OS = createOutputFile(
579 OutputPath, EC, Binary, RemoveFileOnSignal, InFile, Extension,
580 UseTemporary, CreateMissingDirectories, &OutputPathName, &TempPathName);
582 getDiagnostics().Report(diag::err_fe_unable_to_open_output) << OutputPath
587 raw_pwrite_stream *Ret = OS.get();
588 // Add the output file -- but don't try to remove "-", since this means we are
590 addOutputFile(OutputFile((OutputPathName != "-") ? OutputPathName : "",
591 TempPathName, std::move(OS)));
596 std::unique_ptr<llvm::raw_pwrite_stream> CompilerInstance::createOutputFile(
597 StringRef OutputPath, std::error_code &Error, bool Binary,
598 bool RemoveFileOnSignal, StringRef InFile, StringRef Extension,
599 bool UseTemporary, bool CreateMissingDirectories,
600 std::string *ResultPathName, std::string *TempPathName) {
601 assert((!CreateMissingDirectories || UseTemporary) &&
602 "CreateMissingDirectories is only allowed when using temporary files");
604 std::string OutFile, TempFile;
605 if (!OutputPath.empty()) {
606 OutFile = OutputPath;
607 } else if (InFile == "-") {
609 } else if (!Extension.empty()) {
610 SmallString<128> Path(InFile);
611 llvm::sys::path::replace_extension(Path, Extension);
612 OutFile = Path.str();
617 std::unique_ptr<llvm::raw_fd_ostream> OS;
622 UseTemporary = false;
624 llvm::sys::fs::file_status Status;
625 llvm::sys::fs::status(OutputPath, Status);
626 if (llvm::sys::fs::exists(Status)) {
627 // Fail early if we can't write to the final destination.
628 if (!llvm::sys::fs::can_write(OutputPath))
631 // Don't use a temporary if the output is a special file. This handles
632 // things like '-o /dev/null'
633 if (!llvm::sys::fs::is_regular_file(Status))
634 UseTemporary = false;
640 // Create a temporary file.
641 SmallString<128> TempPath;
643 TempPath += "-%%%%%%%%";
646 llvm::sys::fs::createUniqueFile(TempPath, fd, TempPath);
648 if (CreateMissingDirectories &&
649 EC == llvm::errc::no_such_file_or_directory) {
650 StringRef Parent = llvm::sys::path::parent_path(OutputPath);
651 EC = llvm::sys::fs::create_directories(Parent);
653 EC = llvm::sys::fs::createUniqueFile(TempPath, fd, TempPath);
658 OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
659 OSFile = TempFile = TempPath.str();
661 // If we failed to create the temporary, fallback to writing to the file
662 // directly. This handles the corner case where we cannot write to the
663 // directory, but can write to the file.
668 OS.reset(new llvm::raw_fd_ostream(
670 (Binary ? llvm::sys::fs::F_None : llvm::sys::fs::F_Text)));
675 // Make sure the out stream file gets removed if we crash.
676 if (RemoveFileOnSignal)
677 llvm::sys::RemoveFileOnSignal(OSFile);
680 *ResultPathName = OutFile;
682 *TempPathName = TempFile;
684 if (!Binary || OS->supportsSeeking())
685 return std::move(OS);
687 auto B = llvm::make_unique<llvm::buffer_ostream>(*OS);
688 assert(!NonSeekStream);
689 NonSeekStream = std::move(OS);
693 // Initialization Utilities
695 bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
696 return InitializeSourceManager(Input, getDiagnostics(),
697 getFileManager(), getSourceManager(),
701 bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input,
702 DiagnosticsEngine &Diags,
703 FileManager &FileMgr,
704 SourceManager &SourceMgr,
705 const FrontendOptions &Opts) {
706 SrcMgr::CharacteristicKind
707 Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
709 if (Input.isBuffer()) {
710 SourceMgr.setMainFileID(SourceMgr.createFileID(
711 std::unique_ptr<llvm::MemoryBuffer>(Input.getBuffer()), Kind));
712 assert(!SourceMgr.getMainFileID().isInvalid() &&
713 "Couldn't establish MainFileID!");
717 StringRef InputFile = Input.getFile();
719 // Figure out where to get and map in the main file.
720 if (InputFile != "-") {
721 const FileEntry *File = FileMgr.getFile(InputFile, /*OpenFile=*/true);
723 Diags.Report(diag::err_fe_error_reading) << InputFile;
727 // The natural SourceManager infrastructure can't currently handle named
728 // pipes, but we would at least like to accept them for the main
729 // file. Detect them here, read them with the volatile flag so FileMgr will
730 // pick up the correct size, and simply override their contents as we do for
732 if (File->isNamedPipe()) {
733 auto MB = FileMgr.getBufferForFile(File, /*isVolatile=*/true);
735 // Create a new virtual file that will have the correct size.
736 File = FileMgr.getVirtualFile(InputFile, (*MB)->getBufferSize(), 0);
737 SourceMgr.overrideFileContents(File, std::move(*MB));
739 Diags.Report(diag::err_cannot_open_file) << InputFile
740 << MB.getError().message();
745 SourceMgr.setMainFileID(
746 SourceMgr.createFileID(File, SourceLocation(), Kind));
748 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> SBOrErr =
749 llvm::MemoryBuffer::getSTDIN();
750 if (std::error_code EC = SBOrErr.getError()) {
751 Diags.Report(diag::err_fe_error_reading_stdin) << EC.message();
754 std::unique_ptr<llvm::MemoryBuffer> SB = std::move(SBOrErr.get());
756 const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
757 SB->getBufferSize(), 0);
758 SourceMgr.setMainFileID(
759 SourceMgr.createFileID(File, SourceLocation(), Kind));
760 SourceMgr.overrideFileContents(File, std::move(SB));
763 assert(!SourceMgr.getMainFileID().isInvalid() &&
764 "Couldn't establish MainFileID!");
768 // High-Level Operations
770 bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
771 assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
772 assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
773 assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
775 // FIXME: Take this as an argument, once all the APIs we used have moved to
776 // taking it as an input instead of hard-coding llvm::errs.
777 raw_ostream &OS = llvm::errs();
779 // Create the target instance.
780 setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(),
781 getInvocation().TargetOpts));
785 // Inform the target of the language options.
787 // FIXME: We shouldn't need to do this, the target should be immutable once
788 // created. This complexity should be lifted elsewhere.
789 getTarget().adjust(getLangOpts());
791 // rewriter project will change target built-in bool type from its default.
792 if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
793 getTarget().noSignedCharForObjCBool();
795 // Validate/process some options.
796 if (getHeaderSearchOpts().Verbose)
797 OS << "clang -cc1 version " CLANG_VERSION_STRING
798 << " based upon " << BACKEND_PACKAGE_STRING
799 << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
801 if (getFrontendOpts().ShowTimers)
802 createFrontendTimer();
804 if (getFrontendOpts().ShowStats)
805 llvm::EnableStatistics();
807 for (unsigned i = 0, e = getFrontendOpts().Inputs.size(); i != e; ++i) {
808 // Reset the ID tables if we are reusing the SourceManager and parsing
810 if (hasSourceManager() && !Act.isModelParsingAction())
811 getSourceManager().clearIDTables();
813 if (Act.BeginSourceFile(*this, getFrontendOpts().Inputs[i])) {
819 // Notify the diagnostic client that all files were processed.
820 getDiagnostics().getClient()->finish();
822 if (getDiagnosticOpts().ShowCarets) {
823 // We can have multiple diagnostics sharing one diagnostic client.
824 // Get the total number of warnings/errors from the client.
825 unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
826 unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
829 OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
830 if (NumWarnings && NumErrors)
833 OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
834 if (NumWarnings || NumErrors)
835 OS << " generated.\n";
838 if (getFrontendOpts().ShowStats && hasFileManager()) {
839 getFileManager().PrintStats();
843 return !getDiagnostics().getClient()->getNumErrors();
846 /// \brief Determine the appropriate source input kind based on language
848 static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
854 return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
855 return LangOpts.CPlusPlus? IK_CXX : IK_C;
858 /// \brief Compile a module file for the given module, using the options
859 /// provided by the importing compiler instance. Returns true if the module
860 /// was built without errors.
861 static bool compileModuleImpl(CompilerInstance &ImportingInstance,
862 SourceLocation ImportLoc,
864 StringRef ModuleFileName) {
866 = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
868 // Construct a compiler invocation for creating this module.
869 IntrusiveRefCntPtr<CompilerInvocation> Invocation
870 (new CompilerInvocation(ImportingInstance.getInvocation()));
872 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
874 // For any options that aren't intended to affect how a module is built,
875 // reset them to their default values.
876 Invocation->getLangOpts()->resetNonModularOptions();
877 PPOpts.resetNonModularOptions();
879 // Remove any macro definitions that are explicitly ignored by the module.
880 // They aren't supposed to affect how the module is built anyway.
881 const HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
883 std::remove_if(PPOpts.Macros.begin(), PPOpts.Macros.end(),
884 [&HSOpts](const std::pair<std::string, bool> &def) {
885 StringRef MacroDef = def.first;
886 return HSOpts.ModulesIgnoreMacros.count(MacroDef.split('=').first) > 0;
888 PPOpts.Macros.end());
890 // Note the name of the module we're building.
891 Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
893 // Make sure that the failed-module structure has been allocated in
894 // the importing instance, and propagate the pointer to the newly-created
896 PreprocessorOptions &ImportingPPOpts
897 = ImportingInstance.getInvocation().getPreprocessorOpts();
898 if (!ImportingPPOpts.FailedModules)
899 ImportingPPOpts.FailedModules = new PreprocessorOptions::FailedModulesSet;
900 PPOpts.FailedModules = ImportingPPOpts.FailedModules;
902 // If there is a module map file, build the module using the module map.
903 // Set up the inputs/outputs so that we build the module from its umbrella
905 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
906 FrontendOpts.OutputFile = ModuleFileName.str();
907 FrontendOpts.DisableFree = false;
908 FrontendOpts.GenerateGlobalModuleIndex = false;
909 FrontendOpts.Inputs.clear();
910 InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
912 // Don't free the remapped file buffers; they are owned by our caller.
913 PPOpts.RetainRemappedFileBuffers = true;
915 Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
916 assert(ImportingInstance.getInvocation().getModuleHash() ==
917 Invocation->getModuleHash() && "Module hash mismatch!");
919 // Construct a compiler instance that will be used to actually create the
921 CompilerInstance Instance(/*BuildingModule=*/true);
922 Instance.setInvocation(&*Invocation);
924 Instance.createDiagnostics(new ForwardingDiagnosticConsumer(
925 ImportingInstance.getDiagnosticClient()),
926 /*ShouldOwnClient=*/true);
928 Instance.setVirtualFileSystem(&ImportingInstance.getVirtualFileSystem());
930 // Note that this module is part of the module build stack, so that we
931 // can detect cycles in the module graph.
932 Instance.setFileManager(&ImportingInstance.getFileManager());
933 Instance.createSourceManager(Instance.getFileManager());
934 SourceManager &SourceMgr = Instance.getSourceManager();
935 SourceMgr.setModuleBuildStack(
936 ImportingInstance.getSourceManager().getModuleBuildStack());
937 SourceMgr.pushModuleBuildStack(Module->getTopLevelModuleName(),
938 FullSourceLoc(ImportLoc, ImportingInstance.getSourceManager()));
940 // If we're collecting module dependencies, we need to share a collector
941 // between all of the module CompilerInstances.
942 Instance.setModuleDepCollector(ImportingInstance.getModuleDepCollector());
944 // Get or create the module map that we'll use to build this module.
945 std::string InferredModuleMapContent;
946 if (const FileEntry *ModuleMapFile =
947 ModMap.getContainingModuleMapFile(Module)) {
948 // Use the module map where this module resides.
949 FrontendOpts.Inputs.push_back(
950 FrontendInputFile(ModuleMapFile->getName(), IK));
952 SmallString<128> FakeModuleMapFile(Module->Directory->getName());
953 llvm::sys::path::append(FakeModuleMapFile, "__inferred_module.map");
954 FrontendOpts.Inputs.push_back(FrontendInputFile(FakeModuleMapFile, IK));
956 llvm::raw_string_ostream OS(InferredModuleMapContent);
960 std::unique_ptr<llvm::MemoryBuffer> ModuleMapBuffer =
961 llvm::MemoryBuffer::getMemBuffer(InferredModuleMapContent);
962 ModuleMapFile = Instance.getFileManager().getVirtualFile(
963 FakeModuleMapFile, InferredModuleMapContent.size(), 0);
964 SourceMgr.overrideFileContents(ModuleMapFile, std::move(ModuleMapBuffer));
967 // Construct a module-generating action. Passing through the module map is
968 // safe because the FileManager is shared between the compiler instances.
969 GenerateModuleAction CreateModuleAction(
970 ModMap.getModuleMapFileForUniquing(Module), Module->IsSystem);
972 ImportingInstance.getDiagnostics().Report(ImportLoc,
973 diag::remark_module_build)
974 << Module->Name << ModuleFileName;
976 // Execute the action to actually build the module in-place. Use a separate
977 // thread so that we get a stack large enough.
978 const unsigned ThreadStackSize = 8 << 20;
979 llvm::CrashRecoveryContext CRC;
980 CRC.RunSafelyOnThread([&]() { Instance.ExecuteAction(CreateModuleAction); },
983 ImportingInstance.getDiagnostics().Report(ImportLoc,
984 diag::remark_module_build_done)
987 // Delete the temporary module map file.
988 // FIXME: Even though we're executing under crash protection, it would still
989 // be nice to do this with RemoveFileOnSignal when we can. However, that
990 // doesn't make sense for all clients, so clean this up manually.
991 Instance.clearOutputFiles(/*EraseFiles=*/true);
993 // We've rebuilt a module. If we're allowed to generate or update the global
994 // module index, record that fact in the importing compiler instance.
995 if (ImportingInstance.getFrontendOpts().GenerateGlobalModuleIndex) {
996 ImportingInstance.setBuildGlobalModuleIndex(true);
999 return !Instance.getDiagnostics().hasErrorOccurred();
1002 static bool compileAndLoadModule(CompilerInstance &ImportingInstance,
1003 SourceLocation ImportLoc,
1004 SourceLocation ModuleNameLoc, Module *Module,
1005 StringRef ModuleFileName) {
1006 DiagnosticsEngine &Diags = ImportingInstance.getDiagnostics();
1008 auto diagnoseBuildFailure = [&] {
1009 Diags.Report(ModuleNameLoc, diag::err_module_not_built)
1010 << Module->Name << SourceRange(ImportLoc, ModuleNameLoc);
1013 // FIXME: have LockFileManager return an error_code so that we can
1014 // avoid the mkdir when the directory already exists.
1015 StringRef Dir = llvm::sys::path::parent_path(ModuleFileName);
1016 llvm::sys::fs::create_directories(Dir);
1019 unsigned ModuleLoadCapabilities = ASTReader::ARR_Missing;
1020 llvm::LockFileManager Locked(ModuleFileName);
1022 case llvm::LockFileManager::LFS_Error:
1023 Diags.Report(ModuleNameLoc, diag::err_module_lock_failure)
1027 case llvm::LockFileManager::LFS_Owned:
1028 // We're responsible for building the module ourselves.
1029 if (!compileModuleImpl(ImportingInstance, ModuleNameLoc, Module,
1031 diagnoseBuildFailure();
1036 case llvm::LockFileManager::LFS_Shared:
1037 // Someone else is responsible for building the module. Wait for them to
1039 switch (Locked.waitForUnlock()) {
1040 case llvm::LockFileManager::Res_Success:
1041 ModuleLoadCapabilities |= ASTReader::ARR_OutOfDate;
1043 case llvm::LockFileManager::Res_OwnerDied:
1044 continue; // try again to get the lock.
1045 case llvm::LockFileManager::Res_Timeout:
1046 Diags.Report(ModuleNameLoc, diag::err_module_lock_timeout)
1048 // Clear the lock file so that future invokations can make progress.
1049 Locked.unsafeRemoveLockFile();
1055 // Try to read the module file, now that we've compiled it.
1056 ASTReader::ASTReadResult ReadResult =
1057 ImportingInstance.getModuleManager()->ReadAST(
1058 ModuleFileName, serialization::MK_ImplicitModule, ImportLoc,
1059 ModuleLoadCapabilities);
1061 if (ReadResult == ASTReader::OutOfDate &&
1062 Locked == llvm::LockFileManager::LFS_Shared) {
1063 // The module may be out of date in the presence of file system races,
1064 // or if one of its imports depends on header search paths that are not
1065 // consistent with this ImportingInstance. Try again...
1067 } else if (ReadResult == ASTReader::Missing) {
1068 diagnoseBuildFailure();
1069 } else if (ReadResult != ASTReader::Success &&
1070 !Diags.hasErrorOccurred()) {
1071 // The ASTReader didn't diagnose the error, so conservatively report it.
1072 diagnoseBuildFailure();
1074 return ReadResult == ASTReader::Success;
1078 /// \brief Diagnose differences between the current definition of the given
1079 /// configuration macro and the definition provided on the command line.
1080 static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
1081 Module *Mod, SourceLocation ImportLoc) {
1082 IdentifierInfo *Id = PP.getIdentifierInfo(ConfigMacro);
1083 SourceManager &SourceMgr = PP.getSourceManager();
1085 // If this identifier has never had a macro definition, then it could
1086 // not have changed.
1087 if (!Id->hadMacroDefinition())
1089 auto *LatestLocalMD = PP.getLocalMacroDirectiveHistory(Id);
1091 // Find the macro definition from the command line.
1092 MacroInfo *CmdLineDefinition = nullptr;
1093 for (auto *MD = LatestLocalMD; MD; MD = MD->getPrevious()) {
1094 // We only care about the predefines buffer.
1095 FileID FID = SourceMgr.getFileID(MD->getLocation());
1096 if (FID.isInvalid() || FID != PP.getPredefinesFileID())
1098 if (auto *DMD = dyn_cast<DefMacroDirective>(MD))
1099 CmdLineDefinition = DMD->getMacroInfo();
1103 auto *CurrentDefinition = PP.getMacroInfo(Id);
1104 if (CurrentDefinition == CmdLineDefinition) {
1105 // Macro matches. Nothing to do.
1106 } else if (!CurrentDefinition) {
1107 // This macro was defined on the command line, then #undef'd later.
1109 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1110 << true << ConfigMacro << Mod->getFullModuleName();
1111 auto LatestDef = LatestLocalMD->getDefinition();
1112 assert(LatestDef.isUndefined() &&
1113 "predefined macro went away with no #undef?");
1114 PP.Diag(LatestDef.getUndefLocation(), diag::note_module_def_undef_here)
1117 } else if (!CmdLineDefinition) {
1118 // There was no definition for this macro in the predefines buffer,
1119 // but there was a local definition. Complain.
1120 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1121 << false << ConfigMacro << Mod->getFullModuleName();
1122 PP.Diag(CurrentDefinition->getDefinitionLoc(),
1123 diag::note_module_def_undef_here)
1125 } else if (!CurrentDefinition->isIdenticalTo(*CmdLineDefinition, PP,
1126 /*Syntactically=*/true)) {
1127 // The macro definitions differ.
1128 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1129 << false << ConfigMacro << Mod->getFullModuleName();
1130 PP.Diag(CurrentDefinition->getDefinitionLoc(),
1131 diag::note_module_def_undef_here)
1136 /// \brief Write a new timestamp file with the given path.
1137 static void writeTimestampFile(StringRef TimestampFile) {
1139 llvm::raw_fd_ostream Out(TimestampFile.str(), EC, llvm::sys::fs::F_None);
1142 /// \brief Prune the module cache of modules that haven't been accessed in
1144 static void pruneModuleCache(const HeaderSearchOptions &HSOpts) {
1145 struct stat StatBuf;
1146 llvm::SmallString<128> TimestampFile;
1147 TimestampFile = HSOpts.ModuleCachePath;
1148 llvm::sys::path::append(TimestampFile, "modules.timestamp");
1150 // Try to stat() the timestamp file.
1151 if (::stat(TimestampFile.c_str(), &StatBuf)) {
1152 // If the timestamp file wasn't there, create one now.
1153 if (errno == ENOENT) {
1154 writeTimestampFile(TimestampFile);
1159 // Check whether the time stamp is older than our pruning interval.
1160 // If not, do nothing.
1161 time_t TimeStampModTime = StatBuf.st_mtime;
1162 time_t CurrentTime = time(nullptr);
1163 if (CurrentTime - TimeStampModTime <= time_t(HSOpts.ModuleCachePruneInterval))
1166 // Write a new timestamp file so that nobody else attempts to prune.
1167 // There is a benign race condition here, if two Clang instances happen to
1168 // notice at the same time that the timestamp is out-of-date.
1169 writeTimestampFile(TimestampFile);
1171 // Walk the entire module cache, looking for unused module files and module
1174 SmallString<128> ModuleCachePathNative;
1175 llvm::sys::path::native(HSOpts.ModuleCachePath, ModuleCachePathNative);
1176 for (llvm::sys::fs::directory_iterator Dir(ModuleCachePathNative, EC), DirEnd;
1177 Dir != DirEnd && !EC; Dir.increment(EC)) {
1178 // If we don't have a directory, there's nothing to look into.
1179 if (!llvm::sys::fs::is_directory(Dir->path()))
1182 // Walk all of the files within this directory.
1183 for (llvm::sys::fs::directory_iterator File(Dir->path(), EC), FileEnd;
1184 File != FileEnd && !EC; File.increment(EC)) {
1185 // We only care about module and global module index files.
1186 StringRef Extension = llvm::sys::path::extension(File->path());
1187 if (Extension != ".pcm" && Extension != ".timestamp" &&
1188 llvm::sys::path::filename(File->path()) != "modules.idx")
1191 // Look at this file. If we can't stat it, there's nothing interesting
1193 if (::stat(File->path().c_str(), &StatBuf))
1196 // If the file has been used recently enough, leave it there.
1197 time_t FileAccessTime = StatBuf.st_atime;
1198 if (CurrentTime - FileAccessTime <=
1199 time_t(HSOpts.ModuleCachePruneAfter)) {
1204 llvm::sys::fs::remove(File->path());
1206 // Remove the timestamp file.
1207 std::string TimpestampFilename = File->path() + ".timestamp";
1208 llvm::sys::fs::remove(TimpestampFilename);
1211 // If we removed all of the files in the directory, remove the directory
1213 if (llvm::sys::fs::directory_iterator(Dir->path(), EC) ==
1214 llvm::sys::fs::directory_iterator() && !EC)
1215 llvm::sys::fs::remove(Dir->path());
1219 void CompilerInstance::createModuleManager() {
1220 if (!ModuleManager) {
1221 if (!hasASTContext())
1224 // If we're implicitly building modules but not currently recursively
1225 // building a module, check whether we need to prune the module cache.
1226 if (getLangOpts().ImplicitModules &&
1227 getSourceManager().getModuleBuildStack().empty() &&
1228 getHeaderSearchOpts().ModuleCachePruneInterval > 0 &&
1229 getHeaderSearchOpts().ModuleCachePruneAfter > 0) {
1230 pruneModuleCache(getHeaderSearchOpts());
1233 HeaderSearchOptions &HSOpts = getHeaderSearchOpts();
1234 std::string Sysroot = HSOpts.Sysroot;
1235 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
1236 ModuleManager = new ASTReader(getPreprocessor(), *Context,
1237 Sysroot.empty() ? "" : Sysroot.c_str(),
1238 PPOpts.DisablePCHValidation,
1239 /*AllowASTWithCompilerErrors=*/false,
1240 /*AllowConfigurationMismatch=*/false,
1241 HSOpts.ModulesValidateSystemHeaders,
1242 getFrontendOpts().UseGlobalModuleIndex);
1243 if (hasASTConsumer()) {
1244 ModuleManager->setDeserializationListener(
1245 getASTConsumer().GetASTDeserializationListener());
1246 getASTContext().setASTMutationListener(
1247 getASTConsumer().GetASTMutationListener());
1249 getASTContext().setExternalSource(ModuleManager);
1251 ModuleManager->InitializeSema(getSema());
1252 if (hasASTConsumer())
1253 ModuleManager->StartTranslationUnit(&getASTConsumer());
1257 bool CompilerInstance::loadModuleFile(StringRef FileName) {
1258 // Helper to recursively read the module names for all modules we're adding.
1259 // We mark these as known and redirect any attempt to load that module to
1260 // the files we were handed.
1261 struct ReadModuleNames : ASTReaderListener {
1262 CompilerInstance &CI;
1263 std::vector<StringRef> ModuleFileStack;
1264 std::vector<StringRef> ModuleNameStack;
1266 bool TopFileIsModule;
1268 ReadModuleNames(CompilerInstance &CI)
1269 : CI(CI), Failed(false), TopFileIsModule(false) {}
1271 bool needsImportVisitation() const override { return true; }
1273 void visitImport(StringRef FileName) override {
1274 if (!CI.ExplicitlyLoadedModuleFiles.insert(FileName).second) {
1275 if (ModuleFileStack.size() == 0)
1276 TopFileIsModule = true;
1280 ModuleFileStack.push_back(FileName);
1281 ModuleNameStack.push_back(StringRef());
1282 if (ASTReader::readASTFileControlBlock(FileName, CI.getFileManager(),
1284 CI.getDiagnostics().Report(
1285 SourceLocation(), CI.getFileManager().getBufferForFile(FileName)
1286 ? diag::err_module_file_invalid
1287 : diag::err_module_file_not_found)
1289 for (int I = ModuleFileStack.size() - 2; I >= 0; --I)
1290 CI.getDiagnostics().Report(SourceLocation(),
1291 diag::note_module_file_imported_by)
1292 << ModuleFileStack[I]
1293 << !ModuleNameStack[I].empty() << ModuleNameStack[I];
1296 ModuleNameStack.pop_back();
1297 ModuleFileStack.pop_back();
1300 void ReadModuleName(StringRef ModuleName) override {
1301 if (ModuleFileStack.size() == 1)
1302 TopFileIsModule = true;
1303 ModuleNameStack.back() = ModuleName;
1305 auto &ModuleFile = CI.ModuleFileOverrides[ModuleName];
1306 if (!ModuleFile.empty() &&
1307 CI.getFileManager().getFile(ModuleFile) !=
1308 CI.getFileManager().getFile(ModuleFileStack.back()))
1309 CI.getDiagnostics().Report(SourceLocation(),
1310 diag::err_conflicting_module_files)
1311 << ModuleName << ModuleFile << ModuleFileStack.back();
1312 ModuleFile = ModuleFileStack.back();
1316 // If we don't already have an ASTReader, create one now.
1318 createModuleManager();
1320 // Tell the module manager about this module file.
1321 if (getModuleManager()->getModuleManager().addKnownModuleFile(FileName)) {
1322 getDiagnostics().Report(SourceLocation(), diag::err_module_file_not_found)
1327 // Build our mapping of module names to module files from this file
1329 RMN.visitImport(FileName);
1334 // If we never found a module name for the top file, then it's not a module,
1335 // it's a PCH or preamble or something.
1336 if (!RMN.TopFileIsModule) {
1337 getDiagnostics().Report(SourceLocation(), diag::err_module_file_not_module)
1346 CompilerInstance::loadModule(SourceLocation ImportLoc,
1348 Module::NameVisibilityKind Visibility,
1349 bool IsInclusionDirective) {
1350 // Determine what file we're searching from.
1351 StringRef ModuleName = Path[0].first->getName();
1352 SourceLocation ModuleNameLoc = Path[0].second;
1354 // If we've already handled this import, just return the cached result.
1355 // This one-element cache is important to eliminate redundant diagnostics
1356 // when both the preprocessor and parser see the same import declaration.
1357 if (!ImportLoc.isInvalid() && LastModuleImportLoc == ImportLoc) {
1358 // Make the named module visible.
1359 if (LastModuleImportResult && ModuleName != getLangOpts().CurrentModule &&
1360 ModuleName != getLangOpts().ImplementationOfModule)
1361 ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility,
1363 return LastModuleImportResult;
1366 clang::Module *Module = nullptr;
1368 // If we don't already have information on this module, load the module now.
1369 llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
1370 = KnownModules.find(Path[0].first);
1371 if (Known != KnownModules.end()) {
1372 // Retrieve the cached top-level module.
1373 Module = Known->second;
1374 } else if (ModuleName == getLangOpts().CurrentModule ||
1375 ModuleName == getLangOpts().ImplementationOfModule) {
1376 // This is the module we're building.
1377 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1378 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1380 // Search for a module with the given name.
1381 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1383 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1385 << SourceRange(ImportLoc, ModuleNameLoc);
1386 ModuleBuildFailed = true;
1387 return ModuleLoadResult();
1390 auto Override = ModuleFileOverrides.find(ModuleName);
1391 bool Explicit = Override != ModuleFileOverrides.end();
1392 if (!Explicit && !getLangOpts().ImplicitModules) {
1393 getDiagnostics().Report(ModuleNameLoc, diag::err_module_build_disabled)
1395 ModuleBuildFailed = true;
1396 return ModuleLoadResult();
1399 std::string ModuleFileName =
1400 Explicit ? Override->second
1401 : PP->getHeaderSearchInfo().getModuleFileName(Module);
1403 // If we don't already have an ASTReader, create one now.
1405 createModuleManager();
1407 if (TheDependencyFileGenerator)
1408 TheDependencyFileGenerator->AttachToASTReader(*ModuleManager);
1410 if (ModuleDepCollector)
1411 ModuleDepCollector->attachToASTReader(*ModuleManager);
1413 for (auto &Listener : DependencyCollectors)
1414 Listener->attachToASTReader(*ModuleManager);
1416 // Try to load the module file.
1418 Explicit ? 0 : ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing;
1419 switch (ModuleManager->ReadAST(ModuleFileName,
1420 Explicit ? serialization::MK_ExplicitModule
1421 : serialization::MK_ImplicitModule,
1422 ImportLoc, ARRFlags)) {
1423 case ASTReader::Success:
1426 case ASTReader::OutOfDate:
1427 case ASTReader::Missing: {
1429 // ReadAST has already complained for us.
1430 ModuleLoader::HadFatalFailure = true;
1431 KnownModules[Path[0].first] = nullptr;
1432 return ModuleLoadResult();
1435 // The module file is missing or out-of-date. Build it.
1436 assert(Module && "missing module file");
1437 // Check whether there is a cycle in the module graph.
1438 ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
1439 ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1440 for (; Pos != PosEnd; ++Pos) {
1441 if (Pos->first == ModuleName)
1445 if (Pos != PosEnd) {
1446 SmallString<256> CyclePath;
1447 for (; Pos != PosEnd; ++Pos) {
1448 CyclePath += Pos->first;
1449 CyclePath += " -> ";
1451 CyclePath += ModuleName;
1453 getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
1454 << ModuleName << CyclePath;
1455 return ModuleLoadResult();
1458 // Check whether we have already attempted to build this module (but
1460 if (getPreprocessorOpts().FailedModules &&
1461 getPreprocessorOpts().FailedModules->hasAlreadyFailed(ModuleName)) {
1462 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_built)
1464 << SourceRange(ImportLoc, ModuleNameLoc);
1465 ModuleBuildFailed = true;
1466 return ModuleLoadResult();
1469 // Try to compile and then load the module.
1470 if (!compileAndLoadModule(*this, ImportLoc, ModuleNameLoc, Module,
1472 assert(getDiagnostics().hasErrorOccurred() &&
1473 "undiagnosed error in compileAndLoadModule");
1474 if (getPreprocessorOpts().FailedModules)
1475 getPreprocessorOpts().FailedModules->addFailed(ModuleName);
1476 KnownModules[Path[0].first] = nullptr;
1477 ModuleBuildFailed = true;
1478 return ModuleLoadResult();
1481 // Okay, we've rebuilt and now loaded the module.
1485 case ASTReader::VersionMismatch:
1486 case ASTReader::ConfigurationMismatch:
1487 case ASTReader::HadErrors:
1488 ModuleLoader::HadFatalFailure = true;
1489 // FIXME: The ASTReader will already have complained, but can we showhorn
1490 // that diagnostic information into a more useful form?
1491 KnownModules[Path[0].first] = nullptr;
1492 return ModuleLoadResult();
1494 case ASTReader::Failure:
1495 ModuleLoader::HadFatalFailure = true;
1496 // Already complained, but note now that we failed.
1497 KnownModules[Path[0].first] = nullptr;
1498 ModuleBuildFailed = true;
1499 return ModuleLoadResult();
1502 // Cache the result of this top-level module lookup for later.
1503 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1506 // If we never found the module, fail.
1508 return ModuleLoadResult();
1510 // Verify that the rest of the module path actually corresponds to
1512 if (Path.size() > 1) {
1513 for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1514 StringRef Name = Path[I].first->getName();
1515 clang::Module *Sub = Module->findSubmodule(Name);
1518 // Attempt to perform typo correction to find a module name that works.
1519 SmallVector<StringRef, 2> Best;
1520 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1522 for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1523 JEnd = Module->submodule_end();
1525 unsigned ED = Name.edit_distance((*J)->Name,
1526 /*AllowReplacements=*/true,
1528 if (ED <= BestEditDistance) {
1529 if (ED < BestEditDistance) {
1531 BestEditDistance = ED;
1534 Best.push_back((*J)->Name);
1538 // If there was a clear winner, user it.
1539 if (Best.size() == 1) {
1540 getDiagnostics().Report(Path[I].second,
1541 diag::err_no_submodule_suggest)
1542 << Path[I].first << Module->getFullModuleName() << Best[0]
1543 << SourceRange(Path[0].second, Path[I-1].second)
1544 << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1547 Sub = Module->findSubmodule(Best[0]);
1552 // No submodule by this name. Complain, and don't look for further
1554 getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
1555 << Path[I].first << Module->getFullModuleName()
1556 << SourceRange(Path[0].second, Path[I-1].second);
1564 // Don't make the module visible if we are in the implementation.
1565 if (ModuleName == getLangOpts().ImplementationOfModule)
1566 return ModuleLoadResult(Module, false);
1568 // Make the named module visible, if it's not already part of the module
1570 if (ModuleName != getLangOpts().CurrentModule) {
1571 if (!Module->IsFromModuleFile) {
1572 // We have an umbrella header or directory that doesn't actually include
1573 // all of the headers within the directory it covers. Complain about
1574 // this missing submodule and recover by forgetting that we ever saw
1576 // FIXME: Should we detect this at module load time? It seems fairly
1577 // expensive (and rare).
1578 getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1579 << Module->getFullModuleName()
1580 << SourceRange(Path.front().second, Path.back().second);
1582 return ModuleLoadResult(nullptr, true);
1585 // Check whether this module is available.
1586 clang::Module::Requirement Requirement;
1587 clang::Module::UnresolvedHeaderDirective MissingHeader;
1588 if (!Module->isAvailable(getLangOpts(), getTarget(), Requirement,
1590 if (MissingHeader.FileNameLoc.isValid()) {
1591 getDiagnostics().Report(MissingHeader.FileNameLoc,
1592 diag::err_module_header_missing)
1593 << MissingHeader.IsUmbrella << MissingHeader.FileName;
1595 getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1596 << Module->getFullModuleName()
1597 << Requirement.second << Requirement.first
1598 << SourceRange(Path.front().second, Path.back().second);
1600 LastModuleImportLoc = ImportLoc;
1601 LastModuleImportResult = ModuleLoadResult();
1602 return ModuleLoadResult();
1605 ModuleManager->makeModuleVisible(Module, Visibility, ImportLoc);
1608 // Check for any configuration macros that have changed.
1609 clang::Module *TopModule = Module->getTopLevelModule();
1610 for (unsigned I = 0, N = TopModule->ConfigMacros.size(); I != N; ++I) {
1611 checkConfigMacro(getPreprocessor(), TopModule->ConfigMacros[I],
1615 LastModuleImportLoc = ImportLoc;
1616 LastModuleImportResult = ModuleLoadResult(Module, false);
1617 return LastModuleImportResult;
1620 void CompilerInstance::makeModuleVisible(Module *Mod,
1621 Module::NameVisibilityKind Visibility,
1622 SourceLocation ImportLoc) {
1624 createModuleManager();
1628 ModuleManager->makeModuleVisible(Mod, Visibility, ImportLoc);
1631 GlobalModuleIndex *CompilerInstance::loadGlobalModuleIndex(
1632 SourceLocation TriggerLoc) {
1634 createModuleManager();
1635 // Can't do anything if we don't have the module manager.
1638 // Get an existing global index. This loads it if not already
1640 ModuleManager->loadGlobalIndex();
1641 GlobalModuleIndex *GlobalIndex = ModuleManager->getGlobalIndex();
1642 // If the global index doesn't exist, create it.
1643 if (!GlobalIndex && shouldBuildGlobalModuleIndex() && hasFileManager() &&
1644 hasPreprocessor()) {
1645 llvm::sys::fs::create_directories(
1646 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1647 GlobalModuleIndex::writeIndex(
1649 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1650 ModuleManager->resetForReload();
1651 ModuleManager->loadGlobalIndex();
1652 GlobalIndex = ModuleManager->getGlobalIndex();
1654 // For finding modules needing to be imported for fixit messages,
1655 // we need to make the global index cover all modules, so we do that here.
1656 if (!HaveFullGlobalModuleIndex && GlobalIndex && !buildingModule()) {
1657 ModuleMap &MMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
1658 bool RecreateIndex = false;
1659 for (ModuleMap::module_iterator I = MMap.module_begin(),
1660 E = MMap.module_end(); I != E; ++I) {
1661 Module *TheModule = I->second;
1662 const FileEntry *Entry = TheModule->getASTFile();
1664 SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
1665 Path.push_back(std::make_pair(
1666 getPreprocessor().getIdentifierInfo(TheModule->Name), TriggerLoc));
1667 std::reverse(Path.begin(), Path.end());
1668 // Load a module as hidden. This also adds it to the global index.
1669 loadModule(TheModule->DefinitionLoc, Path,
1670 Module::Hidden, false);
1671 RecreateIndex = true;
1674 if (RecreateIndex) {
1675 GlobalModuleIndex::writeIndex(
1677 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1678 ModuleManager->resetForReload();
1679 ModuleManager->loadGlobalIndex();
1680 GlobalIndex = ModuleManager->getGlobalIndex();
1682 HaveFullGlobalModuleIndex = true;
1687 // Check global module index for missing imports.
1689 CompilerInstance::lookupMissingImports(StringRef Name,
1690 SourceLocation TriggerLoc) {
1691 // Look for the symbol in non-imported modules, but only if an error
1692 // actually occurred.
1693 if (!buildingModule()) {
1694 // Load global module index, or retrieve a previously loaded one.
1695 GlobalModuleIndex *GlobalIndex = loadGlobalModuleIndex(
1698 // Only if we have a global index.
1700 GlobalModuleIndex::HitSet FoundModules;
1702 // Find the modules that reference the identifier.
1703 // Note that this only finds top-level modules.
1704 // We'll let diagnoseTypo find the actual declaration module.
1705 if (GlobalIndex->lookupIdentifier(Name, FoundModules))
1712 void CompilerInstance::resetAndLeakSema() { BuryPointer(takeSema()); }