23#include "clang/Config/config.h"
45#include "llvm/ADT/IntrusiveRefCntPtr.h"
46#include "llvm/ADT/STLExtras.h"
47#include "llvm/ADT/ScopeExit.h"
48#include "llvm/ADT/Statistic.h"
49#include "llvm/Config/llvm-config.h"
50#include "llvm/Plugins/PassPlugin.h"
51#include "llvm/Support/AdvisoryLock.h"
52#include "llvm/Support/BuryPointer.h"
53#include "llvm/Support/CrashRecoveryContext.h"
54#include "llvm/Support/Errc.h"
55#include "llvm/Support/FileSystem.h"
56#include "llvm/Support/MemoryBuffer.h"
57#include "llvm/Support/Path.h"
58#include "llvm/Support/Signals.h"
59#include "llvm/Support/SmallVectorMemoryBuffer.h"
60#include "llvm/Support/TimeProfiler.h"
61#include "llvm/Support/Timer.h"
62#include "llvm/Support/VirtualFileSystem.h"
63#include "llvm/Support/VirtualOutputBackends.h"
64#include "llvm/Support/VirtualOutputError.h"
65#include "llvm/Support/raw_ostream.h"
66#include "llvm/TargetParser/Host.h"
73CompilerInstance::CompilerInstance(
74 std::shared_ptr<CompilerInvocation> Invocation,
75 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
76 std::shared_ptr<ModuleCache> ModCache)
78 Invocation(
std::move(Invocation)),
79 ModCache(ModCache ?
std::move(ModCache)
81 ThePCHContainerOperations(
std::move(PCHContainerOps)) {
82 assert(this->Invocation &&
"Invocation must not be null");
86 assert(OutputFiles.empty() &&
"Still output files in flight?");
90 return (BuildGlobalModuleIndex ||
91 (TheASTReader && TheASTReader->isGlobalIndexUnavailable() &&
93 !DisableGeneratingGlobalModuleIndex;
98 Diagnostics = std::move(
Value);
102 OwnedVerboseOutputStream.reset();
103 VerboseOutputStream = &
Value;
107 OwnedVerboseOutputStream.swap(
Value);
108 VerboseOutputStream = OwnedVerboseOutputStream.get();
126 auto &TO = AuxTargetOpts = std::make_unique<TargetOptions>();
167 assert(
Value ==
nullptr ||
169 FileMgr = std::move(
Value);
174 SourceMgr = std::move(
Value);
178 PP = std::move(
Value);
183 Context = std::move(
Value);
185 if (Context && Consumer)
194 Consumer = std::move(
Value);
196 if (Context && Consumer)
201 CompletionConsumer.reset(
Value);
205 return std::move(TheSema);
212 assert(ModCache.get() == &Reader->getModuleManager().getModuleCache() &&
213 "Expected ASTReader to use the same PCM cache");
214 TheASTReader = std::move(Reader);
217std::shared_ptr<ModuleDependencyCollector>
219 return ModuleDepCollector;
223 std::shared_ptr<ModuleDependencyCollector> Collector) {
224 ModuleDepCollector = std::move(Collector);
228 std::shared_ptr<ModuleDependencyCollector> MDC) {
231 for (
auto &Name : HeaderMapFileNames)
236 std::shared_ptr<ModuleDependencyCollector> MDC) {
243 auto PCHDir =
FileMgr.getOptionalDirectoryRef(PCHInclude);
245 MDC->addFile(PCHInclude);
251 llvm::sys::path::native(PCHDir->getName(), DirNative);
252 llvm::vfs::FileSystem &FS =
FileMgr.getVirtualFileSystem();
254 for (llvm::vfs::directory_iterator Dir = FS.dir_begin(DirNative, EC), DirEnd;
255 Dir != DirEnd && !EC; Dir.increment(EC)) {
264 MDC->addFile(Dir->path());
269 std::shared_ptr<ModuleDependencyCollector> MDC) {
273 if (
auto *RedirectingVFS = dyn_cast<llvm::vfs::RedirectingFileSystem>(&VFS))
274 llvm::vfs::collectVFSEntries(*RedirectingVFS, VFSEntries);
277 for (
auto &E : VFSEntries)
278 MDC->addFile(E.VPath, E.RPath);
292 llvm::makeIntrusiveRefCnt<llvm::vfs::TracingFileSystem>(std::move(VFS));
300 std::unique_ptr<raw_ostream> StreamOwner;
301 raw_ostream *OS = &llvm::errs();
304 auto FileOS = std::make_unique<llvm::raw_fd_ostream>(
306 llvm::sys::fs::OF_Append | llvm::sys::fs::OF_TextWithCRLF);
308 Diags.
Report(diag::warn_fe_cc_log_diagnostics_failure)
311 FileOS->SetUnbuffered();
313 StreamOwner = std::move(FileOS);
318 auto Logger = std::make_unique<LogDiagnosticPrinter>(*OS, DiagOpts,
319 std::move(StreamOwner));
333 StringRef OutputFile) {
334 auto SerializedConsumer =
339 Diags.
takeClient(), std::move(SerializedConsumer)));
342 Diags.
getClient(), std::move(SerializedConsumer)));
347 bool ShouldOwnClient) {
356 auto Diags = llvm::makeIntrusiveRefCnt<DiagnosticsEngine>(
362 Diags->setClient(Client, ShouldOwnClient);
369 if (Opts.VerifyDiagnostics)
388 assert(VFS &&
"CompilerInstance needs a VFS for creating FileManager");
395 assert(Diagnostics &&
"DiagnosticsEngine needed for creating SourceManager");
396 assert(FileMgr &&
"FileManager needed for creating SourceManager");
397 SourceMgr = llvm::makeIntrusiveRefCnt<SourceManager>(
getDiagnostics(),
411 FileMgr.getVirtualFileRef(RB.first, RB.second->getBufferSize(), 0);
418 SourceMgr.overrideFileContents(FromFile, RB.second->getMemBufferRef());
420 SourceMgr.overrideFileContents(
421 FromFile, std::unique_ptr<llvm::MemoryBuffer>(RB.second));
429 Diags.
Report(diag::err_fe_remap_missing_to_file) << RF.first << RF.second;
439 SourceMgr.overrideFileContents(FromFile, *ToFile);
442 SourceMgr.setOverridenFilesKeepOriginalName(
452 TheASTReader.reset();
458 PP = std::make_shared<Preprocessor>(Invocation->getPreprocessorOpts(),
467 PP->createPreprocessingRecord();
471 PP->getFileManager(), PPOpts);
480 const llvm::Triple *HeaderSearchTriple = &PP->getTargetInfo().getTriple();
481 if (PP->getTargetInfo().getTriple().getOS() == llvm::Triple::CUDA &&
482 PP->getAuxTargetInfo())
483 HeaderSearchTriple = &PP->getAuxTargetInfo()->getTriple();
486 PP->getLangOpts(), *HeaderSearchTriple);
490 if (PP->getLangOpts().Modules && PP->getLangOpts().ImplicitModules) {
494 PP->getHeaderSearchInfo().initializeModuleCachePath(
509 ModuleDepCollector = std::make_shared<ModuleDependencyCollector>(
515 if (ModuleDepCollector) {
526 for (
auto &Listener : DependencyCollectors)
527 Listener->attachToPreprocessor(*PP);
534 if (OutputPath ==
"-")
547 if (GetDependencyDirectives)
548 PP->setDependencyDirectivesGetter(*GetDependencyDirectives);
555 auto Context = llvm::makeIntrusiveRefCnt<ASTContext>(
556 getLangOpts(), PP.getSourceManager(), PP.getIdentifierTable(),
557 PP.getSelectorTable(), PP.getBuiltinInfo(), PP.TUKind);
574 void ReadModuleName(StringRef ModuleName)
override {
577 LoadedModules.push_back(ModuleName.str());
582 for (
const std::string &LoadedModule : LoadedModules)
585 LoadedModules.clear();
588 void markAllUnavailable() {
589 for (
const std::string &LoadedModule : LoadedModules) {
592 M->HasIncompatibleModuleFile =
true;
596 SmallVector<Module *, 2> Stack;
598 while (!Stack.empty()) {
599 Module *Current = Stack.pop_back_val();
603 llvm::append_range(Stack, SubmodulesRange);
607 LoadedModules.clear();
614 bool AllowPCHWithCompilerErrors,
void *DeserializationListener,
615 bool OwnDeserializationListener) {
622 DeserializationListener, OwnDeserializationListener,
Preamble,
627 StringRef Path, StringRef Sysroot,
632 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
633 ArrayRef<std::shared_ptr<DependencyCollector>> DependencyCollectors,
634 void *DeserializationListener,
bool OwnDeserializationListener,
635 bool Preamble,
bool UseGlobalModuleIndex) {
637 PP.getHeaderSearchInfo().getHeaderSearchOpts();
639 auto Reader = llvm::makeIntrusiveRefCnt<ASTReader>(
640 PP, ModCache, &Context, PCHContainerRdr, CodeGenOpts, Extensions,
641 Sysroot.empty() ?
"" : Sysroot.data(), DisableValidation,
642 AllowPCHWithCompilerErrors,
false,
649 Context.setExternalSource(Reader);
651 Reader->setDeserializationListener(
653 OwnDeserializationListener);
655 for (
auto &Listener : DependencyCollectors)
656 Listener->attachToASTReader(*Reader);
658 auto Listener = std::make_unique<ReadModuleNames>(PP);
659 auto &ListenerRef = *Listener;
661 std::move(Listener));
670 PP.setPredefines(Reader->getSuggestedPredefines());
671 ListenerRef.registerAll();
687 ListenerRef.markAllUnavailable();
688 Context.setExternalSource(
nullptr);
714 if (!CompletionConsumer) {
727 timerGroup.reset(
new llvm::TimerGroup(
"clang",
"Clang time report"));
728 FrontendTimer.reset(
new llvm::Timer(
"frontend",
"Front end", *timerGroup));
748 TUKind, CompletionConsumer));
754 if (ExternalSemaSrc) {
755 TheSema->addExternalSource(ExternalSemaSrc);
756 ExternalSemaSrc->InitializeSema(*TheSema);
762 (void)TheSema->APINotes.loadCurrentModuleAPINotes(
774 for (
auto &O : OutputFiles)
775 llvm::handleAllErrors(
777 [&](
const llvm::vfs::TempFileOutputError &E) {
778 getDiagnostics().Report(diag::err_unable_to_rename_temp)
779 << E.getTempPath() << E.getOutputPath()
780 << E.convertToErrorCode().message();
782 [&](
const llvm::vfs::OutputError &E) {
783 getDiagnostics().Report(diag::err_fe_unable_to_open_output)
784 << E.getOutputPath() << E.convertToErrorCode().message();
786 [&](
const llvm::ErrorInfoBase &EIB) {
787 getDiagnostics().Report(diag::err_fe_unable_to_open_output)
788 << O.getPath() << EIB.message();
792 if (DeleteBuiltModules) {
793 for (
auto &
Module : BuiltModules)
794 llvm::sys::fs::remove(
Module.second);
795 BuiltModules.clear();
800 bool Binary, StringRef InFile, StringRef Extension,
bool RemoveFileOnSignal,
801 bool CreateMissingDirectories,
bool ForceUseTemporary) {
803 std::optional<SmallString<128>> PathStorage;
804 if (OutputPath.empty()) {
805 if (InFile ==
"-" || Extension.empty()) {
808 PathStorage.emplace(InFile);
809 llvm::sys::path::replace_extension(*PathStorage, Extension);
810 OutputPath = *PathStorage;
816 CreateMissingDirectories);
820 return std::make_unique<llvm::raw_null_ostream>();
827 assert(!OutputMgr &&
"Already has an output manager");
828 OutputMgr = std::move(NewOutputs);
832 assert(!OutputMgr &&
"Already has an output manager");
833 OutputMgr = llvm::makeIntrusiveRefCnt<llvm::vfs::OnDiskOutputBackend>();
847std::unique_ptr<raw_pwrite_stream>
849 bool RemoveFileOnSignal,
bool UseTemporary,
850 bool CreateMissingDirectories) {
852 createOutputFileImpl(OutputPath,
Binary, RemoveFileOnSignal, UseTemporary,
853 CreateMissingDirectories);
855 return std::move(*OS);
857 << OutputPath << errorToErrorCode(OS.takeError()).message();
862CompilerInstance::createOutputFileImpl(StringRef OutputPath,
bool Binary,
863 bool RemoveFileOnSignal,
865 bool CreateMissingDirectories) {
866 assert((!CreateMissingDirectories || UseTemporary) &&
867 "CreateMissingDirectories is only allowed when using temporary files");
871 std::optional<SmallString<128>> AbsPath;
872 if (OutputPath !=
"-" && !llvm::sys::path::is_absolute(OutputPath)) {
874 "File Manager is required to fix up relative path.\n");
876 AbsPath.emplace(OutputPath);
878 OutputPath = *AbsPath;
886 .setDiscardOnSignal(RemoveFileOnSignal)
887 .setAtomicWrite(UseTemporary)
888 .setImplyCreateDirectories(UseTemporary && CreateMissingDirectories));
890 return O.takeError();
892 O->discardOnDestroy([](llvm::Error E) { consumeError(std::move(E)); });
893 OutputFiles.push_back(std::move(*O));
894 return OutputFiles.back().createProxy();
916 SourceMgr.setMainFileID(SourceMgr.createFileID(Input.
getBuffer(), Kind));
917 assert(SourceMgr.getMainFileID().isValid() &&
918 "Couldn't establish MainFileID!");
922 StringRef InputFile = Input.
getFile();
925 auto FileOrErr = InputFile ==
"-"
927 : FileMgr.getFileRef(InputFile,
true);
929 auto EC = llvm::errorToErrorCode(FileOrErr.takeError());
930 if (InputFile !=
"-")
931 Diags.
Report(diag::err_fe_error_reading) << InputFile << EC.message();
933 Diags.
Report(diag::err_fe_error_reading_stdin) << EC.message();
937 SourceMgr.setMainFileID(
940 assert(SourceMgr.getMainFileID().isValid() &&
941 "Couldn't establish MainFileID!");
948 assert(
hasDiagnostics() &&
"Diagnostics engine is not initialized!");
950 assert(!
getFrontendOpts().ShowVersion &&
"Client must handle '-version'!");
971 OS <<
"clang -cc1 version " CLANG_VERSION_STRING <<
" based upon LLVM "
972 << LLVM_VERSION_STRING <<
" default target "
973 << llvm::sys::getDefaultTargetTriple() <<
"\n";
976 llvm::EnableStatistics(
false);
990 if (llvm::Error Err = Act.
Execute()) {
991 consumeError(std::move(Err));
1004 llvm::PrintStatistics(OS);
1007 if (!StatsFile.empty()) {
1008 llvm::sys::fs::OpenFlags FileFlags = llvm::sys::fs::OF_TextWithCRLF;
1010 FileFlags |= llvm::sys::fs::OF_Append;
1013 std::make_unique<llvm::raw_fd_ostream>(StatsFile, EC, FileFlags);
1016 << StatsFile << EC.message();
1018 llvm::PrintStatisticsJSON(*StatS);
1037 OS << NumWarnings <<
" warning" << (NumWarnings == 1 ?
"" :
"s");
1038 if (NumWarnings && NumErrors)
1041 OS << NumErrors <<
" error" << (NumErrors == 1 ?
"" :
"s");
1042 if (NumWarnings || NumErrors) {
1046 OS <<
" when compiling for host";
1048 OS <<
" when compiling for "
1061 if (llvm::sys::DynamicLibrary::LoadLibraryPermanently(Path.c_str(), &
Error))
1068 if (
auto PassPlugin = llvm::PassPlugin::Load(Path)) {
1069 PassPlugins.emplace_back(std::make_unique<llvm::PassPlugin>(*PassPlugin));
1072 << Path <<
toString(PassPlugin.takeError());
1077 for (
const FrontendPluginRegistry::entry &Plugin :
1078 FrontendPluginRegistry::entries()) {
1079 std::unique_ptr<PluginASTAction> P(Plugin.instantiate());
1091 if (LangOpts.OpenCL)
1100std::unique_ptr<CompilerInstance> CompilerInstance::cloneForModuleCompileImpl(
1103 std::optional<ThreadSafeCloneConfig> ThreadSafeConfig) {
1105 auto Invocation = std::make_shared<CompilerInvocation>(
getInvocation());
1107 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
1111 Invocation->resetNonModularOptions();
1115 HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
1116 llvm::erase_if(PPOpts.
Macros,
1117 [&HSOpts](
const std::pair<std::string, bool> &def) {
1118 StringRef MacroDef = def.first;
1119 return HSOpts.ModulesIgnoreMacros.contains(
1120 llvm::CachedHashString(MacroDef.split(
'=').first));
1124 Invocation->getLangOpts().ModuleName =
1128 Invocation->getLangOpts().CurrentModule = std::string(ModuleName);
1133 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
1134 FrontendOpts.
OutputFile = ModuleFileName.str();
1141 FrontendOpts.
Inputs = {std::move(Input)};
1146 DiagnosticOptions &DiagOpts = Invocation->getDiagnosticOpts();
1148 DiagOpts.VerifyDiagnostics = 0;
1151 "Module hash mismatch!");
1153 std::shared_ptr<ModuleCache> ModCache;
1154 if (ThreadSafeConfig) {
1155 ModCache = ThreadSafeConfig->getModuleCache();
1157 ModCache = this->ModCache;
1161 auto InstancePtr = std::make_unique<CompilerInstance>(
1163 auto &Instance = *InstancePtr;
1165 auto &
Inv = Instance.getInvocation();
1167 if (ThreadSafeConfig) {
1168 Instance.setVirtualFileSystem(ThreadSafeConfig->getVFS());
1169 Instance.createFileManager();
1175 Instance.createFileManager();
1178 if (ThreadSafeConfig) {
1179 Instance.createDiagnostics(&ThreadSafeConfig->getDiagConsumer(),
1182 Instance.createDiagnostics(
1187 Instance.getDiagnostics().setSuppressSystemWarnings(
false);
1189 Instance.createSourceManager();
1190 SourceManager &SourceMgr = Instance.getSourceManager();
1192 if (ThreadSafeConfig) {
1198 SourceMgr.pushModuleBuildStack(
1203 Instance.FailedModules = FailedModules;
1208 if (GetDependencyDirectives)
1209 Instance.GetDependencyDirectives =
1210 GetDependencyDirectives->cloneFor(Instance.getFileManager());
1212 if (ThreadSafeConfig) {
1213 Instance.setModuleDepCollector(ThreadSafeConfig->getModuleDepCollector());
1220 Inv.getDependencyOutputOpts() = DependencyOutputOptions();
1226class PrettyStackTraceBuildModule :
public llvm::PrettyStackTraceEntry {
1227 StringRef ModuleName;
1228 StringRef ModuleFileName;
1231 PrettyStackTraceBuildModule(StringRef ModuleName, StringRef ModuleFileName)
1232 : ModuleName(ModuleName), ModuleFileName(ModuleFileName) {}
1233 void print(raw_ostream &OS)
const override {
1234 OS <<
"Building module '" << ModuleName <<
"' as '" << ModuleFileName
1240std::unique_ptr<llvm::MemoryBuffer>
1243 CompilerInstance &Instance) {
1244 PrettyStackTraceBuildModule CrashInfo(ModuleName,
ModuleFileName);
1245 llvm::TimeTraceScope TimeScope(
"Module Compile", ModuleName);
1262 bool Crashed = !llvm::CrashRecoveryContext().RunSafelyOnNewStack(
1264 auto OS = std::make_unique<llvm::raw_svector_ostream>(Buffer);
1266 std::unique_ptr<FrontendAction> Action =
1267 std::make_unique<GenerateModuleFromModuleMapAction>(std::move(OS));
1269 if (
auto WrapGenModuleAction = Instance.getGenModuleActionWrapper())
1270 Action = WrapGenModuleAction(Instance.getFrontendOpts(),
1273 Instance.ExecuteAction(*Action);
1285 FailedModules = std::move(Instance.FailedModules);
1290 Instance.setSema(
nullptr);
1291 Instance.setASTConsumer(
nullptr);
1294 Instance.clearOutputFiles(
true);
1308 if (Instance.getDiagnostics().hasErrorOccurred() &&
1309 !Instance.getFrontendOpts().AllowPCMWithCompilerErrors)
1312 return std::make_unique<llvm::SmallVectorMemoryBuffer>(
1313 std::move(Buffer), Instance.getFrontendOpts().OutputFile);
1318 StringRef Filename = llvm::sys::path::filename(
File.getName());
1320 if (Filename ==
"module_private.map")
1321 llvm::sys::path::append(PublicFilename,
"module.map");
1322 else if (Filename ==
"module.private.modulemap")
1323 llvm::sys::path::append(PublicFilename,
"module.modulemap");
1325 return std::nullopt;
1326 return FileMgr.getOptionalFileRef(PublicFilename);
1331 std::optional<ThreadSafeCloneConfig> ThreadSafeConfig) {
1347 while (Loc.
isValid() && isModuleMap(SourceMgr.getFileCharacteristic(Loc))) {
1348 ModuleMapFID = SourceMgr.getFileID(Loc);
1349 Loc = SourceMgr.getIncludeLoc(ModuleMapFID);
1353 SourceMgr.getFileEntryRefForID(ModuleMapFID);
1354 assert(ModuleMapFile &&
"Top-level module map with no FileID");
1361 ModuleMapFile = PublicMMFile;
1373 return cloneForModuleCompileImpl(
1374 ImportLoc, ModuleName,
1377 std::move(ThreadSafeConfig));
1385 llvm::sys::path::append(FakeModuleMapFile,
"__inferred_module.map");
1387 std::string InferredModuleMapContent;
1388 llvm::raw_string_ostream OS(InferredModuleMapContent);
1391 auto Instance = cloneForModuleCompileImpl(
1392 ImportLoc, ModuleName,
1395 std::move(ThreadSafeConfig));
1397 std::unique_ptr<llvm::MemoryBuffer> ModuleMapBuffer =
1398 llvm::MemoryBuffer::getMemBufferCopy(InferredModuleMapContent);
1399 FileEntryRef ModuleMapFile = Instance->getFileManager().getVirtualFileRef(
1400 FakeModuleMapFile, InferredModuleMapContent.size(), 0);
1401 Instance->getSourceManager().overrideFileContents(ModuleMapFile,
1402 std::move(ModuleMapBuffer));
1414 bool *OutOfDate,
bool *Missing) {
1425 ModuleLoadCapabilities);
1455 std::unique_ptr<llvm::MemoryBuffer> Buffer;
1467 diag::err_module_not_built)
1473 std::error_code EC =
1477 diag::err_module_not_written)
1495 StringRef ExtractedBuffer = Rdr.
ExtractPCH(*Buffer);
1498 Buffer = llvm::MemoryBuffer::getMemBufferCopy(ExtractedBuffer);
1536 if (llvm::Error Err = Lock->tryLock().moveInto(Owned)) {
1559 switch (Lock->waitForUnlockFor(std::chrono::seconds(Timeout))) {
1560 case llvm::WaitForUnlockResult::Success:
1562 case llvm::WaitForUnlockResult::OwnerDied:
1564 case llvm::WaitForUnlockResult::Timeout:
1571 Lock->unsafeUnlock();
1576 bool OutOfDate =
false;
1577 bool Missing =
false;
1581 if (!OutOfDate && !Missing)
1641 for (
auto *MD = LatestLocalMD; MD; MD = MD->getPrevious()) {
1643 FileID FID = SourceMgr.getFileID(MDLoc);
1649 !SourceMgr.isWrittenInCommandLineFile(MDLoc))
1651 if (
auto *DMD = dyn_cast<DefMacroDirective>(MD))
1652 CmdLineDefinition = DMD->getMacroInfo();
1657 if (CurrentDefinition == CmdLineDefinition) {
1659 }
else if (!CurrentDefinition) {
1662 PP.
Diag(ImportLoc, diag::warn_module_config_macro_undef)
1664 auto LatestDef = LatestLocalMD->getDefinition();
1665 assert(LatestDef.isUndefined() &&
1666 "predefined macro went away with no #undef?");
1667 PP.
Diag(LatestDef.getUndefLocation(), diag::note_module_def_undef_here)
1670 }
else if (!CmdLineDefinition) {
1673 PP.
Diag(ImportLoc, diag::warn_module_config_macro_undef)
1675 PP.
Diag(CurrentDefinition->getDefinitionLoc(),
1676 diag::note_module_def_undef_here)
1678 }
else if (!CurrentDefinition->isIdenticalTo(*CmdLineDefinition, PP,
1681 PP.
Diag(ImportLoc, diag::warn_module_config_macro_undef)
1683 PP.
Diag(CurrentDefinition->getDefinitionLoc(),
1684 diag::note_module_def_undef_here)
1692 for (
const StringRef ConMacro : TopModule->
ConfigMacros) {
1708 .getHeaderSearchInfo()
1709 .getSpecificModuleCachePath()
1716 std::string Sysroot = HSOpts.
Sysroot;
1719 std::unique_ptr<llvm::Timer> ReadTimer;
1722 ReadTimer = std::make_unique<llvm::Timer>(
"reading_modules",
1723 "Reading modules", *timerGroup);
1724 TheASTReader = llvm::makeIntrusiveRefCnt<ASTReader>(
1728 Sysroot.empty() ?
"" : Sysroot.c_str(),
1737 TheASTReader->setDeserializationListener(
1744 TheASTReader->InitializeSema(
getSema());
1748 for (
auto &Listener : DependencyCollectors)
1749 Listener->attachToASTReader(*TheASTReader);
1756 Timer.init(
"preloading." + std::string(
FileName.str()),
1757 "Preloading " + std::string(
FileName.str()), *timerGroup);
1758 llvm::TimeRegion TimeLoading(timerGroup ? &Timer :
nullptr);
1766 bool ConfigMismatchIsRecoverable =
1771 auto Listener = std::make_unique<ReadModuleNames>(*PP);
1772 auto &ListenerRef = *Listener;
1774 std::move(Listener));
1777 switch (TheASTReader->ReadAST(
1780 &LoadedModuleFile)) {
1784 ListenerRef.registerAll();
1790 diag::warn_ast_file_config_mismatch)
1794 ListenerRef.markAllUnavailable();
1806 MS_PrebuiltModulePath,
1807 MS_ModuleBuildPragma
1815 const std::map<std::string, std::string, std::less<>> &BuiltModules,
1817 assert(ModuleFilename.
empty() &&
"Already has a module source?");
1821 auto BuiltModuleIt = BuiltModules.find(ModuleName);
1822 if (BuiltModuleIt != BuiltModules.end()) {
1824 return MS_ModuleBuildPragma;
1834 if (!ModuleFilename.
empty())
1835 return MS_PrebuiltModulePath;
1841 return MS_ModuleCache;
1844 return MS_ModuleNotFound;
1849 bool IsInclusionDirective) {
1853 HS.
lookupModule(ModuleName, ImportLoc,
true, !IsInclusionDirective);
1863 ModuleFileName ModuleFilename;
1864 ModuleSource Source =
1866 SourceLocation ModuleNameLoc = ModuleNameRange.
getBegin();
1867 if (Source == MS_ModuleNotFound) {
1870 << ModuleName << ModuleNameRange;
1873 if (ModuleFilename.
empty()) {
1892 Timer.init(
"loading." + std::string(ModuleFilename.
str()),
1893 "Loading " + std::string(ModuleFilename.
str()), *timerGroup);
1894 llvm::TimeRegion TimeLoading(timerGroup ? &Timer :
nullptr);
1895 llvm::TimeTraceScope TimeScope(
"Module Load", ModuleName);
1899 unsigned ARRFlags = Source == MS_ModuleCache
1902 : Source == MS_PrebuiltModulePath
1906 Source == MS_PrebuiltModulePath
1908 : Source == MS_ModuleBuildPragma
1911 ImportLoc, ARRFlags)) {
1915 assert(Source != MS_ModuleCache &&
1916 "missing module, but file loaded from cache");
1920 M = HS.
lookupModule(ModuleName, ImportLoc,
true, !IsInclusionDirective);
1929 return ModuleLoadResult();
1938 if (Source == MS_PrebuiltModulePath)
1942 diag::warn_ast_file_config_mismatch)
1951 return ModuleLoadResult();
1955 return ModuleLoadResult();
1959 if (Source != MS_ModuleCache) {
1963 return ModuleLoadResult();
1967 assert(M &&
"missing module, but trying to compile for cache");
1971 ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1972 for (; Pos != PosEnd; ++Pos) {
1973 if (Pos->first == ModuleName)
1977 if (Pos != PosEnd) {
1978 SmallString<256> CyclePath;
1979 for (; Pos != PosEnd; ++Pos) {
1980 CyclePath += Pos->first;
1981 CyclePath +=
" -> ";
1983 CyclePath += ModuleName;
1986 << ModuleName << CyclePath;
1991 if (FailedModules.contains(ModuleName)) {
1993 << ModuleName << SourceRange(ImportLoc, ModuleNameLoc);
2001 "undiagnosed error in compileModuleAndReadAST");
2002 FailedModules.insert(ModuleName);
2014 bool IsInclusionDirective) {
2016 StringRef ModuleName = Path[0].getIdentifierInfo()->getName();
2022 if (ImportLoc.
isValid() && LastModuleImportLoc == ImportLoc) {
2024 if (LastModuleImportResult && ModuleName !=
getLangOpts().CurrentModule)
2025 TheASTReader->makeModuleVisible(LastModuleImportResult,
Visibility,
2027 return LastModuleImportResult;
2041 }
else if (ModuleName ==
getLangOpts().CurrentModule) {
2043 Module = PP->getHeaderSearchInfo().lookupModule(
2044 ModuleName, ImportLoc,
true,
2045 !IsInclusionDirective);
2057 ModuleName, ImportLoc,
true, !IsInclusionDirective);
2060 PPCb->moduleLoadSkipped(
Module);
2063 std::vector<clang::Module *> Worklist{
Module};
2064 while (!Worklist.empty()) {
2066 Worklist.pop_back();
2069 Worklist.push_back(SubM);
2074 SourceLocation ModuleNameEndLoc = Path.back().getLoc().getLocWithOffset(
2075 Path.back().getIdentifierInfo()->getLength());
2078 IsInclusionDirective);
2082 DisableGeneratingGlobalModuleIndex =
true;
2094 bool MapPrivateSubModToTopLevel =
false;
2095 for (
unsigned I = 1, N = Path.size(); I != N; ++I) {
2096 StringRef Name = Path[I].getIdentifierInfo()->getName();
2105 PrivateModule.append(
"_Private");
2108 auto &II = PP->getIdentifierTable().get(
2109 PrivateModule, PP->getIdentifierInfo(
Module->
Name)->getTokenID());
2110 PrivPath.emplace_back(Path[0].getLoc(), &II);
2114 if (PP->getHeaderSearchInfo().lookupModule(PrivateModule, ImportLoc,
true,
2115 !IsInclusionDirective) ||
2117 PP->getHeaderSearchInfo()) != MS_ModuleNotFound)
2120 MapPrivateSubModToTopLevel =
true;
2121 PP->markClangModuleAsAffecting(
Module);
2123 diag::warn_no_priv_submodule_use_toplevel, ImportLoc)) {
2125 diag::warn_no_priv_submodule_use_toplevel)
2128 <<
SourceRange(Path[0].getLoc(), Path[I].getLoc())
2132 diag::note_private_top_level_defined);
2140 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
2144 Name.edit_distance(SubModule->Name,
2145 true, BestEditDistance);
2146 if (ED <= BestEditDistance) {
2147 if (ED < BestEditDistance) {
2149 BestEditDistance = ED;
2152 Best.push_back(SubModule->Name);
2157 if (Best.size() == 1) {
2159 diag::err_no_submodule_suggest)
2161 << Best[0] <<
SourceRange(Path[0].getLoc(), Path[I - 1].getLoc())
2174 <<
SourceRange(Path[0].getLoc(), Path[I - 1].getLoc());
2193 <<
SourceRange(Path.front().getLoc(), Path.back().getLoc());
2202 <<
SourceRange(Path.front().getLoc(), Path.back().getLoc());
2203 LastModuleImportLoc = ImportLoc;
2217 LastModuleImportLoc = ImportLoc;
2219 return LastModuleImportResult;
2223 StringRef ModuleName,
2227 for (
auto &
C : CleanModuleName)
2236 if (std::error_code EC = llvm::sys::fs::createTemporaryFile(
2242 std::string ModuleMapFileName = (CleanModuleName +
".map").str();
2249 std::string NullTerminatedSource(Source.str());
2251 auto Other = cloneForModuleCompileImpl(ImportLoc, ModuleName, Input,
2257 ModuleMapFileName, NullTerminatedSource.size(), 0);
2258 Other->getSourceManager().overrideFileContents(
2259 ModuleMapFile, llvm::MemoryBuffer::getMemBuffer(NullTerminatedSource));
2261 Other->BuiltModules = std::move(BuiltModules);
2262 Other->DeleteBuiltModules =
false;
2265 std::unique_ptr<llvm::MemoryBuffer> Buffer =
2267 BuiltModules = std::move(
Other->BuiltModules);
2270 llvm::raw_fd_ostream OS(FD,
true);
2271 BuiltModules[std::string(ModuleName)] = std::string(
ModuleFileName);
2272 OS << Buffer->getBuffer();
2285 TheASTReader->makeModuleVisible(Mod,
Visibility, ImportLoc);
2291 .getHeaderSearchInfo()
2292 .getSpecificModuleCachePath()
2302 TheASTReader->loadGlobalIndex();
2307 llvm::sys::fs::create_directories(
2308 getPreprocessor().getHeaderSearchInfo().getSpecificModuleCachePath());
2312 .getHeaderSearchInfo()
2313 .getSpecificModuleCachePath())) {
2318 consumeError(std::move(Err));
2321 TheASTReader->resetForReload();
2322 TheASTReader->loadGlobalIndex();
2323 GlobalIndex = TheASTReader->getGlobalIndex();
2327 if (!HaveFullGlobalModuleIndex && GlobalIndex && !
buildingModule()) {
2333 bool RecreateIndex =
false;
2336 Module *TheModule = I->second;
2339 Path.emplace_back(TriggerLoc,
2341 std::reverse(Path.begin(), Path.end());
2344 RecreateIndex =
true;
2347 if (RecreateIndex) {
2351 .getHeaderSearchInfo()
2352 .getSpecificModuleCachePath())) {
2354 consumeError(std::move(Err));
2357 TheASTReader->resetForReload();
2358 TheASTReader->loadGlobalIndex();
2359 GlobalIndex = TheASTReader->getGlobalIndex();
2361 HaveFullGlobalModuleIndex =
true;
2395 ExternalSemaSrc = std::move(ESS);
Defines the clang::ASTContext interface.
Defines the Diagnostic-related interfaces.
static void collectVFSEntries(CompilerInstance &CI, std::shared_ptr< ModuleDependencyCollector > MDC)
static bool EnableCodeCompletion(Preprocessor &PP, StringRef Filename, unsigned Line, unsigned Column)
static bool compileModuleAndReadAST(CompilerInstance &ImportingInstance, SourceLocation ImportLoc, SourceLocation ModuleNameLoc, Module *Module, ModuleFileName ModuleFileName)
Compile a module in a separate compiler instance and read the AST, returning true if the module compi...
static void SetupSerializedDiagnostics(DiagnosticOptions &DiagOpts, DiagnosticsEngine &Diags, StringRef OutputFile)
static bool readASTAfterCompileModule(CompilerInstance &ImportingInstance, SourceLocation ImportLoc, SourceLocation ModuleNameLoc, Module *Module, ModuleFileName ModuleFileName, bool *OutOfDate, bool *Missing)
Read the AST right after compiling the module.
static CompileOrReadResult compileModuleBehindLockOrRead(CompilerInstance &ImportingInstance, SourceLocation ImportLoc, SourceLocation ModuleNameLoc, Module *Module, ModuleFileName ModuleFileName)
Attempt to compile the module in a separate compiler instance behind a lock (to avoid building the sa...
static Language getLanguageFromOptions(const LangOptions &LangOpts)
Determine the appropriate source input kind based on language options.
static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro, Module *Mod, SourceLocation ImportLoc)
Diagnose differences between the current definition of the given configuration macro and the definiti...
static void collectHeaderMaps(const HeaderSearch &HS, std::shared_ptr< ModuleDependencyCollector > MDC)
CompileOrReadResult
The result of compileModuleBehindLockOrRead().
@ Compiled
We successfully compiled the module and we still need to read it.
@ Read
We read a module file compiled by another instance.
@ FailedToRead
We failed to read the module file compiled by another instance.
@ FailedToCompile
We failed to compile the module.
static void InitializeFileRemapping(DiagnosticsEngine &Diags, SourceManager &SourceMgr, FileManager &FileMgr, const PreprocessorOptions &InitOpts)
static void collectIncludePCH(CompilerInstance &CI, std::shared_ptr< ModuleDependencyCollector > MDC)
static OptionalFileEntryRef getPublicModuleMap(FileEntryRef File, FileManager &FileMgr)
static ModuleSource selectModuleSource(Module *M, StringRef ModuleName, ModuleFileName &ModuleFilename, const std::map< std::string, std::string, std::less<> > &BuiltModules, HeaderSearch &HS)
Select a source for loading the named module and compute the filename to load it from.
static bool compileModuleImpl(CompilerInstance &ImportingInstance, SourceLocation ImportLoc, SourceLocation ModuleNameLoc, Module *Module, ModuleFileName ModuleFileName)
Compile a module in a separate compiler instance.
static void checkConfigMacros(Preprocessor &PP, Module *M, SourceLocation ImportLoc)
static void SetUpDiagnosticLog(DiagnosticOptions &DiagOpts, const CodeGenOptions *CodeGenOpts, DiagnosticsEngine &Diags)
Defines the clang::FileManager interface and associated types.
Defines the clang::FrontendAction interface and various convenience abstract classes (clang::ASTFront...
static void print(llvm::raw_ostream &OS, const T &V, ASTContext &ASTCtx, QualType Ty)
Defines the clang::Preprocessor interface.
static std::string toString(const clang::SanitizerSet &Sanitizers)
Produce a string containing comma-separated names of sanitizers in Sanitizers set.
Defines the SourceManager interface.
Defines utilities for dealing with stack allocation and stack space.
Defines version macros and version-related utility functions for Clang.
virtual void Initialize(ASTContext &Context)
Initialize - This is called to initialize the consumer, providing the ASTContext.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
void setASTMutationListener(ASTMutationListener *Listener)
Attach an AST mutation listener to the AST context.
void setExternalSource(IntrusiveRefCntPtr< ExternalASTSource > Source)
Attach an external AST source to the AST context.
Abstract interface for callback invocations by the ASTReader.
RAII object to temporarily add an AST callback listener.
@ ARR_Missing
The client can handle an AST file that cannot load because it is missing.
@ ARR_None
The client can't handle any AST loading failures.
@ ARR_ConfigurationMismatch
The client can handle an AST file that cannot load because it's compiled configuration doesn't match ...
@ ARR_OutOfDate
The client can handle an AST file that cannot load because it is out-of-date relative to its input fi...
@ ARR_TreatModuleWithErrorsAsOutOfDate
If a module file is marked with errors treat it as out-of-date so the caller can rebuild it.
static bool readASTFileControlBlock(StringRef Filename, FileManager &FileMgr, const ModuleCache &ModCache, const PCHContainerReader &PCHContainerRdr, bool FindModuleFileExtensions, ASTReaderListener &Listener, bool ValidateDiagnosticOptions, unsigned ClientLoadCapabilities=ARR_ConfigurationMismatch|ARR_OutOfDate)
Read the control block for the named AST file.
ASTReadResult
The result of reading the control block of an AST file, which can fail for various reasons.
@ Success
The control block was read successfully.
@ ConfigurationMismatch
The AST file was written with a different language/target configuration.
@ OutOfDate
The AST file is out-of-date relative to its input files, and needs to be regenerated.
@ Failure
The AST file itself appears corrupted.
@ VersionMismatch
The AST file was written by a different version of Clang.
@ HadErrors
The AST file has errors.
@ Missing
The AST file was missing.
ChainedDiagnosticConsumer - Chain two diagnostic clients so that diagnostics go to the first client a...
Abstract interface for a consumer of code-completion information.
Options controlling the behavior of code completion.
CodeGenOptions - Track various options which control how the code is optimized and passed to the back...
std::string DwarfDebugFlags
The string to embed in the debug information for the compile unit, if non-empty.
CompilerInstance - Helper class for managing a single instance of the Clang compiler.
bool hasOutputManager() const
bool loadModuleFile(ModuleFileName FileName, serialization::ModuleFile *&LoadedModuleFile)
void createPCHExternalASTSource(StringRef Path, DisableValidationForModuleKind DisableValidation, bool AllowPCHWithCompilerErrors, void *DeserializationListener, bool OwnDeserializationListener)
Create an external AST source to read a PCH file and attach it to the AST context.
DiagnosticConsumer & getDiagnosticClient() const
~CompilerInstance() override
void createPreprocessor(TranslationUnitKind TUKind)
Create the preprocessor, using the invocation, file, and source managers, and replace any existing on...
bool lookupMissingImports(StringRef Name, SourceLocation TriggerLoc) override
Check global module index for missing imports.
void setOutputManager(IntrusiveRefCntPtr< llvm::vfs::OutputBackend > NewOutputs)
Set the output manager.
void createDiagnostics(DiagnosticConsumer *Client=nullptr, bool ShouldOwnClient=true)
Create the diagnostics engine using the invocation's diagnostic options and replace any existing one ...
DependencyOutputOptions & getDependencyOutputOpts()
bool hasFileManager() const
TargetInfo * getAuxTarget() const
const PCHContainerReader & getPCHContainerReader() const
Return the appropriate PCHContainerReader depending on the current CodeGenOptions.
DiagnosticsEngine & getDiagnostics() const
Get the current diagnostics engine.
GlobalModuleIndex * loadGlobalModuleIndex(SourceLocation TriggerLoc) override
Load, create, or return global module.
raw_ostream & getVerboseOutputStream()
Get the current stream for verbose output.
std::unique_ptr< raw_pwrite_stream > createDefaultOutputFile(bool Binary=true, StringRef BaseInput="", StringRef Extension="", bool RemoveFileOnSignal=true, bool CreateMissingDirectories=false, bool ForceUseTemporary=false)
Create the default output file (from the invocation's options) and add it to the list of tracked outp...
void setExternalSemaSource(IntrusiveRefCntPtr< ExternalSemaSource > ESS)
GenModuleActionWrapperFunc getGenModuleActionWrapper() const
ModuleLoadResult loadModule(SourceLocation ImportLoc, ModuleIdPath Path, Module::NameVisibilityKind Visibility, bool IsInclusionDirective) override
Attempt to load the given module.
FileSystemOptions & getFileSystemOpts()
bool InitializeSourceManager(const FrontendInputFile &Input)
InitializeSourceManager - Initialize the source manager to set InputFile as the main file.
void createFileManager()
Create the file manager and replace any existing one with it.
FileManager & getFileManager() const
Return the current file manager to the caller.
void setBuildGlobalModuleIndex(bool Build)
Set the flag indicating whether we should (re)build the global module index.
void createOutputManager()
Create an output manager.
std::unique_ptr< Sema > takeSema()
std::unique_ptr< llvm::MemoryBuffer > compileModule(SourceLocation ImportLoc, StringRef ModuleName, StringRef ModuleFileName, CompilerInstance &Instance)
Compile a module file for the given module, using the options provided by the importing compiler inst...
void printDiagnosticStats()
At the end of a compilation, print the number of warnings/errors.
void setASTConsumer(std::unique_ptr< ASTConsumer > Value)
setASTConsumer - Replace the current AST consumer; the compiler instance takes ownership of Value.
PreprocessorOutputOptions & getPreprocessorOutputOpts()
IntrusiveRefCntPtr< FileManager > getFileManagerPtr() const
ModuleCache & getModuleCache() const
IntrusiveRefCntPtr< ASTReader > getASTReader() const
void setTarget(TargetInfo *Value)
Replace the current Target.
void setModuleDepCollector(std::shared_ptr< ModuleDependencyCollector > Collector)
void addDependencyCollector(std::shared_ptr< DependencyCollector > Listener)
void createASTContext()
Create the AST context.
std::unique_ptr< raw_pwrite_stream > createOutputFile(StringRef OutputPath, bool Binary, bool RemoveFileOnSignal, bool UseTemporary, bool CreateMissingDirectories=false)
Create a new output file, optionally deriving the output path name, and add it to the list of tracked...
bool hasASTContext() const
void createModuleFromSource(SourceLocation ImportLoc, StringRef ModuleName, StringRef Source) override
Attempt to create the given module from the specified source buffer.
Preprocessor & getPreprocessor() const
Return the current preprocessor.
ASTContext & getASTContext() const
IntrusiveRefCntPtr< llvm::vfs::FileSystem > getVirtualFileSystemPtr() const
void LoadRequestedPlugins()
Load the list of plugins requested in the FrontendOptions.
TargetOptions & getTargetOpts()
void createVirtualFileSystem(IntrusiveRefCntPtr< llvm::vfs::FileSystem > BaseFS=llvm::vfs::getRealFileSystem(), DiagnosticConsumer *DC=nullptr)
Create a virtual file system instance based on the invocation.
void setASTReader(IntrusiveRefCntPtr< ASTReader > Reader)
FrontendOptions & getFrontendOpts()
std::shared_ptr< ModuleDependencyCollector > getModuleDepCollector() const
bool hasDiagnostics() const
void setSema(Sema *S)
Replace the current Sema; the compiler instance takes ownership of S.
std::unique_ptr< CompilerInstance > cloneForModuleCompile(SourceLocation ImportLoc, const Module *Module, StringRef ModuleFileName, std::optional< ThreadSafeCloneConfig > ThreadSafeConfig=std::nullopt)
Creates a new CompilerInstance for compiling a module.
void setSourceManager(llvm::IntrusiveRefCntPtr< SourceManager > Value)
setSourceManager - Replace the current source manager.
void setASTContext(llvm::IntrusiveRefCntPtr< ASTContext > Value)
setASTContext - Replace the current AST context.
HeaderSearchOptions & getHeaderSearchOpts()
void createFrontendTimer()
Create the frontend timer and replace any existing one with it.
void createSourceManager()
Create the source manager and replace any existing one with it.
CompilerInvocation & getInvocation()
void setVerboseOutputStream(raw_ostream &Value)
Replace the current stream for verbose output.
PreprocessorOptions & getPreprocessorOpts()
ASTConsumer & getASTConsumer() const
void setFileManager(IntrusiveRefCntPtr< FileManager > Value)
Replace the current file manager.
TargetInfo & getTarget() const
llvm::vfs::OutputBackend & getOutputManager()
llvm::vfs::FileSystem & getVirtualFileSystem() const
void createCodeCompletionConsumer()
Create a code completion consumer using the invocation; note that this will cause the source manager ...
void setCodeCompletionConsumer(CodeCompleteConsumer *Value)
setCodeCompletionConsumer - Replace the current code completion consumer; the compiler instance takes...
bool ExecuteAction(FrontendAction &Act)
ExecuteAction - Execute the provided action against the compiler's CompilerInvocation object.
std::shared_ptr< PCHContainerOperations > getPCHContainerOperations() const
void clearOutputFiles(bool EraseFiles)
clearOutputFiles - Clear the output file list.
DiagnosticOptions & getDiagnosticOpts()
LangOptions & getLangOpts()
llvm::vfs::OutputBackend & getOrCreateOutputManager()
CodeGenOptions & getCodeGenOpts()
SourceManager & getSourceManager() const
Return the current source manager.
void setDiagnostics(llvm::IntrusiveRefCntPtr< DiagnosticsEngine > Value)
setDiagnostics - Replace the current diagnostics engine.
bool shouldBuildGlobalModuleIndex() const
Indicates whether we should (re)build the global module index.
bool hasSourceManager() const
bool hasASTConsumer() const
APINotesOptions & getAPINotesOpts()
std::unique_ptr< raw_pwrite_stream > createNullOutputFile()
void setAuxTarget(TargetInfo *Value)
Replace the current AuxTarget.
void makeModuleVisible(Module *Mod, Module::NameVisibilityKind Visibility, SourceLocation ImportLoc) override
Make the given module visible.
bool hasPreprocessor() const
void setPreprocessor(std::shared_ptr< Preprocessor > Value)
Replace the current preprocessor.
void createSema(TranslationUnitKind TUKind, CodeCompleteConsumer *CompletionConsumer)
Create the Sema object to be used for parsing.
LangOptions & getLangOpts()
Mutable getters.
FrontendOptions & getFrontendOpts()
std::string computeContextHash() const
Compute the context hash - a string that uniquely identifies compiler settings.
DependencyOutputOptions - Options for controlling the compiler dependency file generation.
ShowIncludesDestination ShowIncludesDest
Destination of cl.exe style /showIncludes info.
std::string DOTOutputFile
The file to write GraphViz-formatted header dependencies to.
std::string ModuleDependencyOutputDir
The directory to copy module dependencies to when collecting them.
std::string OutputFile
The file to write dependency output to.
std::string HeaderIncludeOutputFile
The file to write header include output to.
unsigned ShowHeaderIncludes
Show header inclusions (-H).
Abstract interface, implemented by clients of the front-end, which formats and prints fully processed...
unsigned getNumErrors() const
unsigned getNumWarnings() const
static llvm::IntrusiveRefCntPtr< DiagnosticIDs > create()
Options for controlling the compiler diagnostics engine.
std::string DiagnosticLogFile
The file to log diagnostic output to.
std::vector< std::string > SystemHeaderWarningsModules
The list of -Wsystem-headers-in-module=... options used to override whether -Wsystem-headers is enabl...
std::string DiagnosticSerializationFile
The file to serialize diagnostics to (non-appending).
Concrete class used by the front-end to report problems and issues.
DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID)
Issue the message to the client.
bool hasErrorOccurred() const
void setClient(DiagnosticConsumer *client, bool ShouldOwnClient=true)
Set the diagnostic client associated with this diagnostic object.
std::unique_ptr< DiagnosticConsumer > takeClient()
Return the current diagnostic client along with ownership of that client.
DiagnosticConsumer * getClient()
Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const
Based on the way the client configured the DiagnosticsEngine object, classify the specified diagnosti...
bool ownsClient() const
Determine whether this DiagnosticsEngine object own its client.
StringRef getName() const
A reference to a FileEntry that includes the name of the file as it was accessed by the FileManager's...
StringRef getName() const
The name of this FileEntry.
StringRef getNameAsRequested() const
The name of this FileEntry, as originally requested without applying any remappings for VFS 'use-exte...
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Implements support for file system lookup, file system caching, and directory search management.
void AddStats(const FileManager &Other)
Import statistics from a child FileManager and add them to this current FileManager.
OptionalFileEntryRef getOptionalFileRef(StringRef Filename, bool OpenFile=false, bool CacheFailure=true)
Get a FileEntryRef if it exists, without doing anything on error.
static bool fixupRelativePath(const FileSystemOptions &FileSystemOpts, SmallVectorImpl< char > &Path)
static FixItHint CreateReplacement(CharSourceRange RemoveRange, StringRef Code)
Create a code modification hint that replaces the given source range with the given code string.
Abstract base class for actions which can be performed by the frontend.
virtual void EndSourceFile()
Perform any per-file post processing, deallocate per-file objects, and run statistics and output file...
bool PrepareToExecute(CompilerInstance &CI)
Prepare the action to execute on the given compiler instance.
llvm::Error Execute()
Set the source manager's main input file, and run the action.
bool BeginSourceFile(CompilerInstance &CI, const FrontendInputFile &Input)
Prepare the action for processing the input file Input.
virtual bool isModelParsingAction() const
Is this action invoked on a model file?
FrontendOptions - Options for controlling the behavior of the frontend.
unsigned BuildingImplicitModule
Whether we are performing an implicit module build.
unsigned AllowPCMWithCompilerErrors
Output (and read) PCM files regardless of compiler errors.
unsigned BuildingImplicitModuleUsesLock
Whether to use a filesystem lock when building implicit modules.
unsigned ModulesShareFileManager
Whether to share the FileManager when building modules.
std::optional< std::string > AuxTargetCPU
Auxiliary target CPU for CUDA/HIP compilation.
std::string StatsFile
Filename to write statistics to.
std::string OutputFile
The output file, if any.
std::string ActionName
The name of the action to run when using a plugin action.
ParsedSourceLocation CodeCompletionAt
If given, enable code completion at the provided location.
std::string OriginalModuleMap
When the input is a module map, the original module map file from which that map was inferred,...
unsigned GenerateGlobalModuleIndex
Whether we can generate the global module index if needed.
unsigned DisableFree
Disable memory freeing on exit.
SmallVector< FrontendInputFile, 0 > Inputs
The input files and their types.
frontend::ActionKind ProgramAction
The frontend action to perform.
std::optional< std::vector< std::string > > AuxTargetFeatures
Auxiliary target features for CUDA/HIP compilation.
unsigned ImplicitModulesLockTimeoutSeconds
The time in seconds to wait on an implicit module lock before timing out.
A global index for a set of module files, providing information about the identifiers within those mo...
llvm::SmallPtrSet< ModuleFile *, 4 > HitSet
A set of module files in which we found a result.
bool lookupIdentifier(llvm::StringRef Name, HitSet &Hits)
Look for all of the module files with information about the given identifier, e.g....
static llvm::Error writeIndex(FileManager &FileMgr, const PCHContainerReader &PCHContainerRdr, llvm::StringRef Path)
Write a global index into the given.
One of these records is kept for each identifier that is lexed.
bool hadMacroDefinition() const
Returns true if this identifier was #defined to some value at any moment.
llvm::MemoryBuffer & addBuiltPCM(llvm::StringRef Filename, std::unique_ptr< llvm::MemoryBuffer > Buffer)
Store a just-built PCM under the Filename.
@ FPE_Default
Used internally to represent initial unspecified value.
@ FPE_Ignore
Assume that floating-point exceptions are masked.
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
std::string ModuleName
The module currently being compiled as specified by -fmodule-name.
Encapsulates the data about a macro definition (e.g.
The module cache used for compiling modules implicitly.
virtual std::error_code write(StringRef Path, llvm::MemoryBufferRef Buffer)=0
Write the PCM contents to the given path in the module cache.
virtual InMemoryModuleCache & getInMemoryModuleCache()=0
Returns this process's view of the module cache.
virtual void updateModuleTimestamp(StringRef ModuleFilename)=0
Updates the timestamp denoting the last time inputs of the module file were validated.
virtual std::unique_ptr< llvm::AdvisoryLock > getLock(StringRef ModuleFilename)=0
Returns lock for the given module file. The lock is initially unlocked.
Identifies a module file to be loaded.
bool empty() const
Checks whether the module file name is empty.
std::optional< ModuleFileKey > makeKey(FileManager &FileMgr) const
Creates the deduplication key for use in ModuleManager.
static ModuleFileName makeExplicit(std::string Name)
Creates a file name for an explicit module.
StringRef str() const
Returns the plain module file name.
Describes the result of attempting to load a module.
bool buildingModule() const
Returns true if this instance is building a module.
ModuleLoader(bool BuildingModule=false)
llvm::StringMap< Module * >::const_iterator module_iterator
module_iterator module_begin() const
OptionalFileEntryRef getModuleMapFileForUniquing(const Module *M) const
std::optional< Module * > getCachedModuleLoad(const IdentifierInfo &II)
Return a cached module load.
module_iterator module_end() const
FileID getContainingModuleMapFileID(const Module *Module) const
Retrieve the module map file containing the definition of the given module.
void resolveLinkAsDependencies(Module *Mod)
Use PendingLinkAsModule information to mark top level link names that are going to be replaced by exp...
void cacheModuleLoad(const IdentifierInfo &II, Module *M)
Cache a module load. M might be nullptr.
void loadAllParsedModules()
Module * findOrLoadModule(StringRef Name)
Describes a module or submodule.
StringRef getTopLevelModuleName() const
Retrieve the name of the top-level module.
Module * findSubmodule(StringRef Name) const
Find the submodule with the given name.
std::vector< std::string > ConfigMacros
The set of "configuration macros", which are macros that (intentionally) change how this module is bu...
unsigned IsUnimportable
Whether this module has declared itself unimportable, either because it's missing a requirement from ...
NameVisibilityKind
Describes the visibility of the various names within a particular module.
@ Hidden
All of the names in this module are hidden.
void print(raw_ostream &OS, unsigned Indent=0, bool Dump=false) const
Print the module map for this module to the given stream.
const ModuleFileKey * getASTFileKey() const
The serialized AST file key for this module, if one was created.
SourceLocation DefinitionLoc
The location of the module definition.
unsigned IsSystem
Whether this is a "system" module (which assumes that all headers in it are system headers).
std::string Name
The name of this module.
llvm::iterator_range< submodule_iterator > submodules()
OptionalDirectoryEntryRef Directory
The build directory of this module.
unsigned IsFromModuleFile
Whether this module was loaded from a module file.
unsigned HasIncompatibleModuleFile
Whether we tried and failed to load a module file for this module.
std::string getFullModuleName(bool AllowStringLiterals=false) const
Retrieve the full name of this module, including the path from its top-level module.
unsigned IsAvailable
Whether this module is available in the current translation unit.
Module * getTopLevelModule()
Retrieve the top-level module for this (sub)module, which may be this module.
This abstract interface provides operations for unwrapping containers for serialized ASTs (precompile...
virtual llvm::StringRef ExtractPCH(llvm::MemoryBufferRef Buffer) const =0
Returns the serialized AST inside the PCH container Buffer.
This interface provides a way to observe the actions of the preprocessor as it does its thing.
@ ReplaceAction
Replace the main action.
PreprocessorOptions - This class is used for passing the various options used in preprocessor initial...
std::vector< std::pair< std::string, std::string > > RemappedFiles
The set of file remappings, which take existing files on the system (the first part of each pair) and...
std::pair< unsigned, bool > PrecompiledPreambleBytes
If non-zero, the implicit PCH include is actually a precompiled preamble that covers this number of b...
bool RemappedFilesKeepOriginalName
True if the SourceManager should report the original file name for contents of files that were remapp...
bool RetainRemappedFileBuffers
Whether the compiler instance should retain (i.e., not free) the buffers associated with remapped fil...
bool DetailedRecord
Whether we should maintain a detailed record of all macro definitions and expansions.
std::string ImplicitPCHInclude
The implicit PCH included at the start of the translation unit, or empty.
DisableValidationForModuleKind DisablePCHOrModuleValidation
Whether to disable most of the normal validation performed on precompiled headers and module files.
std::vector< std::pair< std::string, bool > > Macros
std::vector< std::pair< std::string, llvm::MemoryBuffer * > > RemappedFileBuffers
The set of file-to-buffer remappings, which take existing files on the system (the first part of each...
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
const MacroInfo * getMacroInfo(const IdentifierInfo *II) const
MacroDirective * getLocalMacroDirectiveHistory(const IdentifierInfo *II) const
Given an identifier, return the latest non-imported macro directive for that identifier.
bool SetCodeCompletionPoint(FileEntryRef File, unsigned Line, unsigned Column)
Specify the point at which code-completion will be performed.
IdentifierInfo * getIdentifierInfo(StringRef Name) const
Return information about the specified preprocessor identifier token.
SourceManager & getSourceManager() const
static bool checkModuleIsAvailable(const LangOptions &LangOpts, const TargetInfo &TargetInfo, const Module &M, DiagnosticsEngine &Diags)
Check that the given module is available, producing a diagnostic if not.
FileManager & getFileManager() const
FileID getPredefinesFileID() const
Returns the FileID for the preprocessor predefines.
HeaderSearch & getHeaderSearchInfo() const
DiagnosticsEngine & getDiagnostics() const
DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) const
Forwarding function for diagnostics.
A simple code-completion consumer that prints the results it receives in a simple format.
Sema - This implements semantic analysis and AST building for C.
ASTReaderListenter implementation to set SuggestedPredefines of ASTReader which is required to use a ...
Encodes a location in the source.
bool isValid() const
Return true if this is a valid SourceLocation object.
This class handles loading and caching of source files into memory.
ModuleBuildStack getModuleBuildStack() const
Retrieve the module build stack.
A trivial tuple used to represent a source range.
SourceLocation getBegin() const
CharacteristicKind getFileCharacteristic() const
Return whether this is a system header or not.
This is a discriminated union of FileInfo and ExpansionInfo.
const FileInfo & getFile() const
Exposes information about the current target.
static TargetInfo * CreateTargetInfo(DiagnosticsEngine &Diags, TargetOptions &Opts)
Construct a target for the given options.
const llvm::Triple & getTriple() const
Returns the target triple of the primary target.
virtual void setAuxTarget(const TargetInfo *Aux)
void noSignedCharForObjCBool()
virtual void adjust(DiagnosticsEngine &Diags, LangOptions &Opts, const TargetInfo *Aux)
Set forced language options.
std::string CPU
If given, the name of the target CPU to generate code for.
VerifyDiagnosticConsumer - Create a diagnostic client which will use markers in the input source to c...
Information about a module that has been loaded by the ASTReader.
Defines the clang::TargetInfo interface.
CharacteristicKind
Indicates whether a file or directory holds normal user code, system code, or system code which is im...
@ HeaderSearch
Remove unused header search paths including header maps.
@ OS
Indicates that the tracking object is a descendant of a referenced-counted OSObject,...
@ PluginAction
Run a plugin action,.
@ RewriteObjC
ObjC->C Rewriter.
bool Inv(InterpState &S, CodePtr OpPC)
@ MK_PCH
File is a PCH file treated as such.
@ MK_Preamble
File is a PCH file treated as the preamble.
@ MK_ExplicitModule
File is an explicitly-loaded module.
@ MK_ImplicitModule
File is an implicitly-loaded module.
@ MK_PrebuiltModule
File is from a prebuilt module path.
std::unique_ptr< DiagnosticConsumer > create(StringRef OutputFile, DiagnosticOptions &DiagOpts, bool MergeChildRecords=false)
Returns a DiagnosticConsumer that serializes diagnostics to a bitcode file.
The JSON file list parser is used to communicate input to InstallAPI.
CustomizableOptional< FileEntryRef > OptionalFileEntryRef
ArrayRef< IdentifierLoc > ModuleIdPath
A sequence of identifier/location pairs used to describe a particular module or submodule,...
ArrayRef< std::pair< std::string, FullSourceLoc > > ModuleBuildStack
The stack used when building modules on demand, which is used to provide a link between the source ma...
void ApplyHeaderSearchOptions(HeaderSearch &HS, const HeaderSearchOptions &HSOpts, const LangOptions &Lang, const llvm::Triple &triple)
Apply the header search options to get given HeaderSearch object.
std::shared_ptr< ModuleCache > createCrossProcessModuleCache()
Creates new ModuleCache backed by a file system directory that may be operated on by multiple process...
nullptr
This class represents a compute construct, representing a 'Kind' of ‘parallel’, 'serial',...
void InitializePreprocessor(Preprocessor &PP, const PreprocessorOptions &PPOpts, const PCHContainerReader &PCHContainerRdr, const FrontendOptions &FEOpts, const CodeGenOptions &CodeGenOpts)
InitializePreprocessor - Initialize the preprocessor getting it and the environment ready to process ...
LLVM_READONLY bool isAlphanumeric(unsigned char c)
Return true if this character is an ASCII letter or digit: [a-zA-Z0-9].
@ Module
Module linkage, which indicates that the entity can be referred to from other translation units withi...
Language
The language for the input, used to select and validate the language standard and possible actions.
@ C
Languages that the frontend can parse and compile.
@ Result
The result type of a method or function.
IntrusiveRefCntPtr< llvm::vfs::FileSystem > createVFSFromCompilerInvocation(const CompilerInvocation &CI, DiagnosticsEngine &Diags)
constexpr size_t DesiredStackSize
The amount of stack space that Clang would like to be provided with.
void noteBottomOfStack(bool ForceSet=false)
Call this once on each thread, as soon after starting the thread as feasible, to note the approximate...
void ProcessWarningOptions(DiagnosticsEngine &Diags, const DiagnosticOptions &Opts, llvm::vfs::FileSystem &VFS, bool ReportDiags=true)
ProcessWarningOptions - Initialize the diagnostic client and process the warning options specified on...
TranslationUnitKind
Describes the kind of translation unit being processed.
void AttachHeaderIncludeGen(Preprocessor &PP, const DependencyOutputOptions &DepOpts, bool ShowAllHeaders=false, StringRef OutputPath={}, bool ShowDepth=true, bool MSStyle=false)
AttachHeaderIncludeGen - Create a header include list generator, and attach it to the given preproces...
DisableValidationForModuleKind
Whether to disable the normal validation performed on precompiled headers and module files when they ...
@ Other
Other implicit parameter.
Visibility
Describes the different kinds of visibility that a declaration may have.
void AttachDependencyGraphGen(Preprocessor &PP, StringRef OutputFile, StringRef SysRoot)
AttachDependencyGraphGen - Create a dependency graph generator, and attach it to the given preprocess...
A source location that has been parsed on the command line.