1//===--- CompilerInstance.cpp ---------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "clang/Frontend/CompilerInstance.h"
10#include "clang/AST/ASTConsumer.h"
11#include "clang/AST/ASTContext.h"
12#include "clang/AST/Decl.h"
13#include "clang/Basic/AtomicLineLogger.h"
14#include "clang/Basic/CharInfo.h"
15#include "clang/Basic/Diagnostic.h"
16#include "clang/Basic/DiagnosticFrontend.h"
17#include "clang/Basic/DiagnosticOptions.h"
18#include "clang/Basic/FileManager.h"
19#include "clang/Basic/LangStandard.h"
20#include "clang/Basic/SourceManager.h"
21#include "clang/Basic/Stack.h"
22#include "clang/Basic/TargetInfo.h"
23#include "clang/Basic/Version.h"
24#include "clang/Config/config.h"
25#include "clang/Frontend/ChainedDiagnosticConsumer.h"
26#include "clang/Frontend/FrontendAction.h"
27#include "clang/Frontend/FrontendActions.h"
28#include "clang/Frontend/FrontendPluginRegistry.h"
29#include "clang/Frontend/LogDiagnosticPrinter.h"
30#include "clang/Frontend/SARIFDiagnosticPrinter.h"
31#include "clang/Frontend/SerializedDiagnosticPrinter.h"
32#include "clang/Frontend/TextDiagnosticPrinter.h"
33#include "clang/Frontend/Utils.h"
34#include "clang/Frontend/VerifyDiagnosticConsumer.h"
35#include "clang/Lex/HeaderSearch.h"
36#include "clang/Lex/Preprocessor.h"
37#include "clang/Lex/PreprocessorOptions.h"
38#include "clang/Lex/TextEncoding.h"
39#include "clang/Sema/CodeCompleteConsumer.h"
40#include "clang/Sema/ParsedAttr.h"
41#include "clang/Sema/Sema.h"
42#include "clang/Serialization/ASTReader.h"
43#include "clang/Serialization/GlobalModuleIndex.h"
44#include "clang/Serialization/InMemoryModuleCache.h"
45#include "clang/Serialization/ModuleCache.h"
46#include "clang/Serialization/ModuleManager.h"
47#include "clang/Serialization/SerializationDiagnostic.h"
48#include "llvm/ADT/IntrusiveRefCntPtr.h"
49#include "llvm/ADT/STLExtras.h"
50#include "llvm/ADT/ScopeExit.h"
51#include "llvm/ADT/Statistic.h"
52#include "llvm/Config/llvm-config.h"
53#include "llvm/Plugins/PassPlugin.h"
54#include "llvm/Support/AdvisoryLock.h"
55#include "llvm/Support/BuryPointer.h"
56#include "llvm/Support/CrashRecoveryContext.h"
57#include "llvm/Support/Errc.h"
58#include "llvm/Support/FileSystem.h"
59#include "llvm/Support/MemoryBuffer.h"
60#include "llvm/Support/Path.h"
61#include "llvm/Support/Signals.h"
62#include "llvm/Support/SmallVectorMemoryBuffer.h"
63#include "llvm/Support/Threading.h"
64#include "llvm/Support/TimeProfiler.h"
65#include "llvm/Support/Timer.h"
66#include "llvm/Support/VirtualFileSystem.h"
67#include "llvm/Support/VirtualOutputBackends.h"
68#include "llvm/Support/VirtualOutputError.h"
69#include "llvm/Support/raw_ostream.h"
70#include "llvm/TargetParser/Host.h"
71#include <optional>
72#include <time.h>
73#include <utility>
74
75using namespace clang;
76
77CompilerInstance::CompilerInstance(
78 std::shared_ptr<CompilerInvocation> Invocation,
79 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
80 std::shared_ptr<ModuleCache> ModCache)
81 : ModuleLoader(/*BuildingModule=*/ModCache != nullptr),
82 Invocation(std::move(Invocation)),
83 ModCache(ModCache ? std::move(ModCache)
84 : createCrossProcessModuleCache()),
85 ThePCHContainerOperations(std::move(PCHContainerOps)) {
86 assert(this->Invocation && "Invocation must not be null");
87}
88
89CompilerInstance::~CompilerInstance() {
90 assert(OutputFiles.empty() && "Still output files in flight?");
91}
92
93bool CompilerInstance::shouldBuildGlobalModuleIndex() const {
94 return (BuildGlobalModuleIndex ||
95 (TheASTReader && TheASTReader->isGlobalIndexUnavailable() &&
96 getFrontendOpts().GenerateGlobalModuleIndex)) &&
97 !DisableGeneratingGlobalModuleIndex;
98}
99
100void CompilerInstance::setDiagnostics(
101 llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Value) {
102 Diagnostics = std::move(Value);
103}
104
105void CompilerInstance::setVerboseOutputStream(raw_ostream &Value) {
106 OwnedVerboseOutputStream.reset();
107 VerboseOutputStream = &Value;
108}
109
110void CompilerInstance::setVerboseOutputStream(std::unique_ptr<raw_ostream> Value) {
111 OwnedVerboseOutputStream.swap(u&: Value);
112 VerboseOutputStream = OwnedVerboseOutputStream.get();
113}
114
115void CompilerInstance::setTarget(TargetInfo *Value) { Target = Value; }
116void CompilerInstance::setAuxTarget(TargetInfo *Value) { AuxTarget = Value; }
117
118bool CompilerInstance::createTarget() {
119 // Create the target instance.
120 setTarget(TargetInfo::CreateTargetInfo(Diags&: getDiagnostics(),
121 Opts&: getInvocation().getTargetOpts()));
122 if (!hasTarget())
123 return false;
124
125 if (getLangOpts().SYCLIsDevice && !getTarget().getTriple().isGPU()) {
126 getDiagnostics().Report(DiagID: diag::err_sycl_device_invalid_target)
127 << getTarget().getTriple().str();
128 return false;
129 }
130
131 // Check whether AuxTarget exists, if not, then create TargetInfo for the
132 // other side of CUDA/OpenMP/SYCL compilation.
133 if (!getAuxTarget() &&
134 (getLangOpts().CUDA || getLangOpts().isTargetDevice()) &&
135 !getFrontendOpts().AuxTriple.empty()) {
136 auto &TO = AuxTargetOpts = std::make_unique<TargetOptions>();
137 TO->Triple = llvm::Triple::normalize(Str: getFrontendOpts().AuxTriple);
138 if (getFrontendOpts().AuxTargetCPU)
139 TO->CPU = *getFrontendOpts().AuxTargetCPU;
140 if (getFrontendOpts().AuxTargetFeatures)
141 TO->FeaturesAsWritten = *getFrontendOpts().AuxTargetFeatures;
142 TO->HostTriple = getTarget().getTriple().str();
143 setAuxTarget(TargetInfo::CreateTargetInfo(Diags&: getDiagnostics(), Opts&: *TO));
144 }
145
146 if (!getTarget().hasStrictFP() && !getLangOpts().ExpStrictFP) {
147 if (getLangOpts().RoundingMath) {
148 getDiagnostics().Report(DiagID: diag::warn_fe_backend_unsupported_fp_rounding);
149 getLangOpts().RoundingMath = false;
150 }
151 auto FPExc = getLangOpts().getFPExceptionMode();
152 if (FPExc != LangOptions::FPE_Default && FPExc != LangOptions::FPE_Ignore) {
153 getDiagnostics().Report(DiagID: diag::warn_fe_backend_unsupported_fp_exceptions);
154 getLangOpts().setFPExceptionMode(LangOptions::FPE_Ignore);
155 }
156 // FIXME: can we disable FEnvAccess?
157 }
158
159 // We should do it here because target knows nothing about
160 // language options when it's being created.
161 if (getLangOpts().OpenCL &&
162 !getTarget().validateOpenCLTarget(Opts: getLangOpts(), Diags&: getDiagnostics()))
163 return false;
164
165 // Inform the target of the language options.
166 // FIXME: We shouldn't need to do this, the target should be immutable once
167 // created. This complexity should be lifted elsewhere.
168 getTarget().adjust(Diags&: getDiagnostics(), Opts&: getLangOpts(), Aux: getAuxTarget());
169
170 if (auto *Aux = getAuxTarget())
171 getTarget().setAuxTarget(Aux);
172
173 return true;
174}
175
176void CompilerInstance::setFileManager(IntrusiveRefCntPtr<FileManager> Value) {
177 assert(Value == nullptr ||
178 getVirtualFileSystemPtr() == Value->getVirtualFileSystemPtr());
179 FileMgr = std::move(Value);
180}
181
182void CompilerInstance::setSourceManager(
183 llvm::IntrusiveRefCntPtr<SourceManager> Value) {
184 SourceMgr = std::move(Value);
185}
186
187void CompilerInstance::setPreprocessor(std::shared_ptr<Preprocessor> Value) {
188 PP = std::move(Value);
189}
190
191IntrusiveRefCntPtr<ASTContext> CompilerInstance::getASTContextPtr() const {
192 assert(Context && "Compiler instance has no AST context!");
193 return Context;
194}
195
196void CompilerInstance::setASTContext(
197 llvm::IntrusiveRefCntPtr<ASTContext> Value) {
198 Context = std::move(Value);
199
200 if (Context && Consumer)
201 getASTConsumer().Initialize(Context&: getASTContext());
202}
203
204void CompilerInstance::setSema(Sema *S) {
205 TheSema.reset(p: S);
206}
207
208void CompilerInstance::setASTConsumer(std::unique_ptr<ASTConsumer> Value) {
209 Consumer = std::move(Value);
210
211 if (Context && Consumer)
212 getASTConsumer().Initialize(Context&: getASTContext());
213}
214
215void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
216 CompletionConsumer.reset(p: Value);
217}
218
219std::unique_ptr<Sema> CompilerInstance::takeSema() {
220 return std::move(TheSema);
221}
222
223IntrusiveRefCntPtr<ASTReader> CompilerInstance::getASTReader() const {
224 return TheASTReader;
225}
226void CompilerInstance::setASTReader(IntrusiveRefCntPtr<ASTReader> Reader) {
227 assert(ModCache.get() == &Reader->getModuleManager().getModuleCache() &&
228 "Expected ASTReader to use the same PCM cache");
229 TheASTReader = std::move(Reader);
230}
231
232std::shared_ptr<ModuleDependencyCollector>
233CompilerInstance::getModuleDepCollector() const {
234 return ModuleDepCollector;
235}
236
237void CompilerInstance::setModuleDepCollector(
238 std::shared_ptr<ModuleDependencyCollector> Collector) {
239 ModuleDepCollector = std::move(Collector);
240}
241
242static void collectHeaderMaps(const HeaderSearch &HS,
243 std::shared_ptr<ModuleDependencyCollector> MDC) {
244 SmallVector<std::string, 4> HeaderMapFileNames;
245 HS.getHeaderMapFileNames(Names&: HeaderMapFileNames);
246 for (auto &Name : HeaderMapFileNames)
247 MDC->addFile(Filename: Name);
248}
249
250static void collectIncludePCH(CompilerInstance &CI,
251 std::shared_ptr<ModuleDependencyCollector> MDC) {
252 const PreprocessorOptions &PPOpts = CI.getPreprocessorOpts();
253 if (PPOpts.ImplicitPCHInclude.empty())
254 return;
255
256 StringRef PCHInclude = PPOpts.ImplicitPCHInclude;
257 FileManager &FileMgr = CI.getFileManager();
258 auto PCHDir = FileMgr.getOptionalDirectoryRef(DirName: PCHInclude);
259 if (!PCHDir) {
260 MDC->addFile(Filename: PCHInclude);
261 return;
262 }
263
264 std::error_code EC;
265 SmallString<128> DirNative;
266 llvm::sys::path::native(path: PCHDir->getName(), result&: DirNative);
267 llvm::vfs::FileSystem &FS = FileMgr.getVirtualFileSystem();
268 SimpleASTReaderListener Validator(CI.getPreprocessor());
269 for (llvm::vfs::directory_iterator Dir = FS.dir_begin(Dir: DirNative, EC), DirEnd;
270 Dir != DirEnd && !EC; Dir.increment(EC)) {
271 // Check whether this is an AST file. ASTReader::isAcceptableASTFile is not
272 // used here since we're not interested in validating the PCH at this time,
273 // but only to check whether this is a file containing an AST.
274 if (!ASTReader::readASTFileControlBlock(
275 Filename: Dir->path(), FileMgr, ModCache: CI.getModuleCache(),
276 PCHContainerRdr: CI.getPCHContainerReader(),
277 /*FindModuleFileExtensions=*/false, Listener&: Validator,
278 /*ValidateDiagnosticOptions=*/false))
279 MDC->addFile(Filename: Dir->path());
280 }
281}
282
283static void collectVFSEntries(CompilerInstance &CI,
284 std::shared_ptr<ModuleDependencyCollector> MDC) {
285 // Collect all VFS found.
286 SmallVector<llvm::vfs::YAMLVFSEntry, 16> VFSEntries;
287 CI.getVirtualFileSystem().visit(Callback: [&](llvm::vfs::FileSystem &VFS) {
288 if (auto *RedirectingVFS = dyn_cast<llvm::vfs::RedirectingFileSystem>(Val: &VFS))
289 llvm::vfs::collectVFSEntries(VFS&: *RedirectingVFS, CollectedEntries&: VFSEntries);
290 });
291
292 for (auto &E : VFSEntries)
293 MDC->addFile(Filename: E.VPath, FileDst: E.RPath);
294}
295
296void CompilerInstance::createVirtualFileSystem(
297 IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS, DiagnosticConsumer *DC) {
298 bool ShouldOwnClient = false;
299 if (!DC) {
300 DC = new DiagnosticConsumer;
301 ShouldOwnClient = true;
302 }
303
304 DiagnosticOptions DiagOpts;
305 DiagnosticsEngine Diags(DiagnosticIDs::create(), DiagOpts, DC,
306 ShouldOwnClient);
307
308 VFS = createVFSFromCompilerInvocation(CI: getInvocation(), Diags,
309 BaseFS: std::move(BaseFS));
310 // FIXME: Should this go into createVFSFromCompilerInvocation?
311 if (getFrontendOpts().ShowStats)
312 VFS =
313 llvm::makeIntrusiveRefCnt<llvm::vfs::TracingFileSystem>(A: std::move(VFS));
314}
315
316// Diagnostics
317static void SetUpDiagnosticLog(DiagnosticOptions &DiagOpts,
318 const CodeGenOptions *CodeGenOpts,
319 DiagnosticsEngine &Diags) {
320 std::error_code EC;
321 std::unique_ptr<raw_ostream> StreamOwner;
322 raw_ostream *OS = &llvm::errs();
323 if (DiagOpts.DiagnosticLogFile != "-") {
324 // Create the output stream.
325 auto FileOS = std::make_unique<llvm::raw_fd_ostream>(
326 args&: DiagOpts.DiagnosticLogFile, args&: EC,
327 args: llvm::sys::fs::OF_Append | llvm::sys::fs::OF_TextWithCRLF);
328 if (EC) {
329 Diags.Report(DiagID: diag::warn_fe_cc_log_diagnostics_failure)
330 << DiagOpts.DiagnosticLogFile << EC.message();
331 } else {
332 FileOS->SetUnbuffered();
333 OS = FileOS.get();
334 StreamOwner = std::move(FileOS);
335 }
336 }
337
338 // Chain in the diagnostic client which will log the diagnostics.
339 auto Logger = std::make_unique<LogDiagnosticPrinter>(args&: *OS, args&: DiagOpts,
340 args: std::move(StreamOwner));
341 if (CodeGenOpts)
342 Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
343 if (Diags.ownsClient()) {
344 Diags.setClient(
345 client: new ChainedDiagnosticConsumer(Diags.takeClient(), std::move(Logger)));
346 } else {
347 Diags.setClient(
348 client: new ChainedDiagnosticConsumer(Diags.getClient(), std::move(Logger)));
349 }
350}
351
352static void SetupSerializedDiagnostics(DiagnosticOptions &DiagOpts,
353 DiagnosticsEngine &Diags,
354 StringRef OutputFile) {
355 auto SerializedConsumer =
356 clang::serialized_diags::create(OutputFile, DiagOpts);
357
358 if (Diags.ownsClient()) {
359 Diags.setClient(client: new ChainedDiagnosticConsumer(
360 Diags.takeClient(), std::move(SerializedConsumer)));
361 } else {
362 Diags.setClient(client: new ChainedDiagnosticConsumer(
363 Diags.getClient(), std::move(SerializedConsumer)));
364 }
365}
366
367void CompilerInstance::createDiagnostics(DiagnosticConsumer *Client,
368 bool ShouldOwnClient) {
369 Diagnostics = createDiagnostics(VFS&: getVirtualFileSystem(), Opts&: getDiagnosticOpts(),
370 Client, ShouldOwnClient, CodeGenOpts: &getCodeGenOpts());
371}
372
373IntrusiveRefCntPtr<DiagnosticsEngine> CompilerInstance::createDiagnostics(
374 llvm::vfs::FileSystem &VFS, DiagnosticOptions &Opts,
375 DiagnosticConsumer *Client, bool ShouldOwnClient,
376 const CodeGenOptions *CodeGenOpts) {
377 auto Diags = llvm::makeIntrusiveRefCnt<DiagnosticsEngine>(
378 A: DiagnosticIDs::create(), A&: Opts);
379
380 // Create the diagnostic client for reporting errors or for
381 // implementing -verify.
382 if (Client) {
383 Diags->setClient(client: Client, ShouldOwnClient);
384 } else if (Opts.getFormat() == DiagnosticOptions::SARIF) {
385 Diags->setClient(client: new SARIFDiagnosticPrinter(llvm::errs(), Opts));
386 } else
387 Diags->setClient(client: new TextDiagnosticPrinter(llvm::errs(), Opts));
388
389 // Chain in -verify checker, if requested.
390 if (Opts.VerifyDiagnostics)
391 Diags->setClient(client: new VerifyDiagnosticConsumer(*Diags));
392
393 // Chain in -diagnostic-log-file dumper, if requested.
394 if (!Opts.DiagnosticLogFile.empty())
395 SetUpDiagnosticLog(DiagOpts&: Opts, CodeGenOpts, Diags&: *Diags);
396
397 if (!Opts.DiagnosticSerializationFile.empty())
398 SetupSerializedDiagnostics(DiagOpts&: Opts, Diags&: *Diags, OutputFile: Opts.DiagnosticSerializationFile);
399
400 // Configure our handling of diagnostics.
401 ProcessWarningOptions(Diags&: *Diags, Opts, VFS);
402
403 return Diags;
404}
405
406// File Manager
407
408void CompilerInstance::createFileManager() {
409 assert(VFS && "CompilerInstance needs a VFS for creating FileManager");
410 FileMgr = llvm::makeIntrusiveRefCnt<FileManager>(A&: getFileSystemOpts(), A&: VFS);
411}
412
413// Source Manager
414
415void CompilerInstance::createSourceManager() {
416 assert(Diagnostics && "DiagnosticsEngine needed for creating SourceManager");
417 assert(FileMgr && "FileManager needed for creating SourceManager");
418 SourceMgr = llvm::makeIntrusiveRefCnt<SourceManager>(A&: getDiagnostics(),
419 A&: getFileManager());
420}
421
422// Initialize the remapping of files to alternative contents, e.g.,
423// those specified through other files.
424static void InitializeFileRemapping(DiagnosticsEngine &Diags,
425 SourceManager &SourceMgr,
426 FileManager &FileMgr,
427 const PreprocessorOptions &InitOpts) {
428 // Remap files in the source manager (with buffers).
429 for (const auto &RB : InitOpts.RemappedFileBuffers) {
430 // Create the file entry for the file that we're mapping from.
431 FileEntryRef FromFile =
432 FileMgr.getVirtualFileRef(Filename: RB.first, Size: RB.second->getBufferSize(), ModificationTime: 0);
433
434 // Override the contents of the "from" file with the contents of the
435 // "to" file. If the caller owns the buffers, then pass a MemoryBufferRef;
436 // otherwise, pass as a std::unique_ptr<MemoryBuffer> to transfer ownership
437 // to the SourceManager.
438 if (InitOpts.RetainRemappedFileBuffers)
439 SourceMgr.overrideFileContents(SourceFile: FromFile, Buffer: RB.second->getMemBufferRef());
440 else
441 SourceMgr.overrideFileContents(
442 SourceFile: FromFile, Buffer: std::unique_ptr<llvm::MemoryBuffer>(RB.second));
443 }
444
445 // Remap files in the source manager (with other files).
446 for (const auto &RF : InitOpts.RemappedFiles) {
447 // Find the file that we're mapping to.
448 OptionalFileEntryRef ToFile = FileMgr.getOptionalFileRef(Filename: RF.second);
449 if (!ToFile) {
450 Diags.Report(DiagID: diag::err_fe_remap_missing_to_file) << RF.first << RF.second;
451 continue;
452 }
453
454 // Create the file entry for the file that we're mapping from.
455 FileEntryRef FromFile =
456 FileMgr.getVirtualFileRef(Filename: RF.first, Size: ToFile->getSize(), ModificationTime: 0);
457
458 // Override the contents of the "from" file with the contents of
459 // the "to" file.
460 SourceMgr.overrideFileContents(SourceFile: FromFile, NewFile: *ToFile);
461 }
462
463 SourceMgr.setOverridenFilesKeepOriginalName(
464 InitOpts.RemappedFilesKeepOriginalName);
465}
466
467// Preprocessor
468
469void CompilerInstance::createPreprocessor(TranslationUnitKind TUKind) {
470 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
471
472 // The AST reader holds a reference to the old preprocessor (if any).
473 TheASTReader.reset();
474
475 // Create the Preprocessor.
476 HeaderSearch *HeaderInfo =
477 new HeaderSearch(getHeaderSearchOpts(), getSourceManager(),
478 getDiagnostics(), getLangOpts(), &getTarget());
479 PP = std::make_shared<Preprocessor>(args&: Invocation->getPreprocessorOpts(),
480 args&: getDiagnostics(), args&: getLangOpts(),
481 args&: getSourceManager(), args&: *HeaderInfo, args&: *this,
482 /*IdentifierInfoLookup=*/args: nullptr,
483 /*OwnsHeaderSearch=*/args: true, args&: TUKind);
484 getTarget().adjust(Diags&: getDiagnostics(), Opts&: getLangOpts(), Aux: getAuxTarget());
485 PP->Initialize(Target: getTarget(), AuxTarget: getAuxTarget());
486
487 if (PPOpts.DetailedRecord)
488 PP->createPreprocessingRecord();
489
490 // Apply remappings to the source manager.
491 InitializeFileRemapping(Diags&: PP->getDiagnostics(), SourceMgr&: PP->getSourceManager(),
492 FileMgr&: PP->getFileManager(), InitOpts: PPOpts);
493
494 // Predefine macros and configure the preprocessor.
495 InitializePreprocessor(PP&: *PP, PPOpts, PCHContainerRdr: getPCHContainerReader(),
496 FEOpts: getFrontendOpts(), CodeGenOpts: getCodeGenOpts());
497
498 // Initialize the header search object. In CUDA compilations, we use the aux
499 // triple (the host triple) to initialize our header search, since we need to
500 // find the host headers in order to compile the CUDA code.
501 const llvm::Triple *HeaderSearchTriple = &PP->getTargetInfo().getTriple();
502 if (PP->getTargetInfo().getTriple().getOS() == llvm::Triple::CUDA &&
503 PP->getAuxTargetInfo())
504 HeaderSearchTriple = &PP->getAuxTargetInfo()->getTriple();
505
506 ApplyHeaderSearchOptions(HS&: PP->getHeaderSearchInfo(), HSOpts: getHeaderSearchOpts(),
507 Lang: PP->getLangOpts(), triple: *HeaderSearchTriple);
508
509 PP->setPreprocessedOutput(getPreprocessorOutputOpts().ShowCPP);
510
511 if (PP->getLangOpts().Modules && PP->getLangOpts().ImplicitModules) {
512 // FIXME: We already might've computed the context hash and the specific
513 // module cache path in `FrontendAction::BeginSourceFile()` when turning
514 // "-include-pch <DIR>" into "-include-pch <DIR>/<FILE>". Reuse those here.
515 PP->getHeaderSearchInfo().initializeModuleCachePath(
516 ContextHash: getInvocation().computeContextHash());
517 }
518
519 // Handle generating dependencies, if requested.
520 const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
521 if (!DepOpts.OutputFile.empty())
522 addDependencyCollector(Listener: std::make_shared<DependencyFileGenerator>(args: DepOpts));
523 if (!DepOpts.DOTOutputFile.empty())
524 AttachDependencyGraphGen(PP&: *PP, OutputFile: DepOpts.DOTOutputFile,
525 SysRoot: getHeaderSearchOpts().Sysroot);
526
527 // If we don't have a collector, but we are collecting module dependencies,
528 // then we're the top level compiler instance and need to create one.
529 if (!ModuleDepCollector && !DepOpts.ModuleDependencyOutputDir.empty()) {
530 ModuleDepCollector = std::make_shared<ModuleDependencyCollector>(
531 args: DepOpts.ModuleDependencyOutputDir, args: getVirtualFileSystemPtr());
532 }
533
534 // If there is a module dep collector, register with other dep collectors
535 // and also (a) collect header maps and (b) TODO: input vfs overlay files.
536 if (ModuleDepCollector) {
537 addDependencyCollector(Listener: ModuleDepCollector);
538 collectHeaderMaps(HS: PP->getHeaderSearchInfo(), MDC: ModuleDepCollector);
539 collectIncludePCH(CI&: *this, MDC: ModuleDepCollector);
540 collectVFSEntries(CI&: *this, MDC: ModuleDepCollector);
541 }
542
543 // Modules need an output manager.
544 if (!hasOutputManager())
545 createOutputManager();
546
547 for (auto &Listener : DependencyCollectors)
548 Listener->attachToPreprocessor(PP&: *PP);
549
550 // Handle generating header include information, if requested.
551 if (DepOpts.ShowHeaderIncludes)
552 AttachHeaderIncludeGen(PP&: *PP, DepOpts);
553 if (!DepOpts.HeaderIncludeOutputFile.empty()) {
554 StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
555 if (OutputPath == "-")
556 OutputPath = "";
557 AttachHeaderIncludeGen(PP&: *PP, DepOpts,
558 /*ShowAllHeaders=*/true, OutputPath,
559 /*ShowDepth=*/false);
560 }
561
562 if (DepOpts.ShowIncludesDest != ShowIncludesDestination::None) {
563 AttachHeaderIncludeGen(PP&: *PP, DepOpts,
564 /*ShowAllHeaders=*/true, /*OutputPath=*/"",
565 /*ShowDepth=*/true, /*MSStyle=*/true);
566 }
567
568 if (GetDependencyDirectives)
569 PP->setDependencyDirectivesGetter(*GetDependencyDirectives);
570
571 if (auto EC = TextEncoding::setConvertersFromOptions(TE&: PP->getTextEncoding(),
572 Opts: getLangOpts()))
573 PP->getDiagnostics().Report(DiagID: clang::diag::err_fe_text_encoding_config)
574 << PP->getTextEncoding().getLiteralEncoding();
575}
576
577// ASTContext
578
579void CompilerInstance::createASTContext() {
580 Preprocessor &PP = getPreprocessor();
581 auto Context = llvm::makeIntrusiveRefCnt<ASTContext>(
582 A&: getLangOpts(), A&: PP.getSourceManager(), A&: PP.getIdentifierTable(),
583 A&: PP.getSelectorTable(), A&: PP.getBuiltinInfo(), A: PP.TUKind);
584 Context->InitBuiltinTypes(Target: getTarget(), AuxTarget: getAuxTarget());
585 setASTContext(std::move(Context));
586}
587
588// ExternalASTSource
589
590namespace {
591// Helper to recursively read the module names for all modules we're adding.
592// We mark these as known and redirect any attempt to load that module to
593// the files we were handed.
594struct ReadModuleNames : ASTReaderListener {
595 Preprocessor &PP;
596 llvm::SmallVector<std::string, 8> LoadedModules;
597
598 ReadModuleNames(Preprocessor &PP) : PP(PP) {}
599
600 void ReadModuleName(StringRef ModuleName) override {
601 // Keep the module name as a string for now. It's not safe to create a new
602 // IdentifierInfo from an ASTReader callback.
603 LoadedModules.push_back(Elt: ModuleName.str());
604 }
605
606 void registerAll() {
607 ModuleMap &MM = PP.getHeaderSearchInfo().getModuleMap();
608 for (const std::string &LoadedModule : LoadedModules)
609 MM.cacheModuleLoad(II: *PP.getIdentifierInfo(Name: LoadedModule),
610 M: MM.findOrLoadModule(Name: LoadedModule));
611 LoadedModules.clear();
612 }
613
614 void markAllUnavailable() {
615 for (const std::string &LoadedModule : LoadedModules) {
616 if (Module *M = PP.getHeaderSearchInfo().getModuleMap().findOrLoadModule(
617 Name: LoadedModule)) {
618 M->HasIncompatibleModuleFile = true;
619
620 // Mark module as available if the only reason it was unavailable
621 // was missing headers.
622 SmallVector<Module *, 2> Stack;
623 Stack.push_back(Elt: M);
624 while (!Stack.empty()) {
625 Module *Current = Stack.pop_back_val();
626 if (Current->IsUnimportable) continue;
627 Current->IsAvailable = true;
628 auto SubmodulesRange = Current->submodules();
629 llvm::append_range(C&: Stack, R&: SubmodulesRange);
630 }
631 }
632 }
633 LoadedModules.clear();
634 }
635};
636} // namespace
637
638void CompilerInstance::createPCHExternalASTSource(
639 StringRef Path, DisableValidationForModuleKind DisableValidation,
640 bool AllowPCHWithCompilerErrors, void *DeserializationListener,
641 bool OwnDeserializationListener) {
642 bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
643 TheASTReader = createPCHExternalASTSource(
644 Path, Sysroot: getHeaderSearchOpts().Sysroot, DisableValidation,
645 AllowPCHWithCompilerErrors, PP&: getPreprocessor(), ModCache&: getModuleCache(),
646 Context&: getASTContext(), PCHContainerRdr: getPCHContainerReader(), CodeGenOpts: getCodeGenOpts(),
647 Extensions: getFrontendOpts().ModuleFileExtensions, DependencyCollectors,
648 DeserializationListener, OwnDeserializationListener, Preamble,
649 UseGlobalModuleIndex: getFrontendOpts().UseGlobalModuleIndex);
650}
651
652IntrusiveRefCntPtr<ASTReader> CompilerInstance::createPCHExternalASTSource(
653 StringRef Path, StringRef Sysroot,
654 DisableValidationForModuleKind DisableValidation,
655 bool AllowPCHWithCompilerErrors, Preprocessor &PP, ModuleCache &ModCache,
656 ASTContext &Context, const PCHContainerReader &PCHContainerRdr,
657 const CodeGenOptions &CodeGenOpts,
658 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
659 ArrayRef<std::shared_ptr<DependencyCollector>> DependencyCollectors,
660 void *DeserializationListener, bool OwnDeserializationListener,
661 bool Preamble, bool UseGlobalModuleIndex) {
662 const HeaderSearchOptions &HSOpts =
663 PP.getHeaderSearchInfo().getHeaderSearchOpts();
664
665 auto Reader = llvm::makeIntrusiveRefCnt<ASTReader>(
666 A&: PP, A&: ModCache, A: &Context, A: PCHContainerRdr, A: CodeGenOpts, A&: Extensions,
667 A: Sysroot.empty() ? "" : Sysroot.data(), A&: DisableValidation,
668 A&: AllowPCHWithCompilerErrors, /*AllowConfigurationMismatch*/ A: false,
669 A: HSOpts.ModulesValidateSystemHeaders,
670 A: HSOpts.ModulesForceValidateUserHeaders,
671 A: HSOpts.ValidateASTInputFilesContent, A&: UseGlobalModuleIndex);
672
673 // We need the external source to be set up before we read the AST, because
674 // eagerly-deserialized declarations may use it.
675 Context.setExternalSource(Reader);
676
677 Reader->setDeserializationListener(
678 Listener: static_cast<ASTDeserializationListener *>(DeserializationListener),
679 /*TakeOwnership=*/OwnDeserializationListener);
680
681 for (auto &Listener : DependencyCollectors)
682 Listener->attachToASTReader(R&: *Reader);
683
684 auto Listener = std::make_unique<ReadModuleNames>(args&: PP);
685 auto &ListenerRef = *Listener;
686 ASTReader::ListenerScope ReadModuleNamesListener(*Reader,
687 std::move(Listener));
688
689 switch (Reader->ReadAST(FileName: ModuleFileName::makeExplicit(Name: Path),
690 Type: Preamble ? serialization::MK_Preamble
691 : serialization::MK_PCH,
692 ImportLoc: SourceLocation(), ClientLoadCapabilities: ASTReader::ARR_None)) {
693 case ASTReader::Success:
694 // Set the predefines buffer as suggested by the PCH reader. Typically, the
695 // predefines buffer will be empty.
696 PP.setPredefines(Reader->getSuggestedPredefines());
697 ListenerRef.registerAll();
698 return Reader;
699
700 case ASTReader::Failure:
701 // Unrecoverable failure: don't even try to process the input file.
702 break;
703
704 case ASTReader::Missing:
705 case ASTReader::OutOfDate:
706 case ASTReader::VersionMismatch:
707 case ASTReader::ConfigurationMismatch:
708 case ASTReader::HadErrors:
709 // No suitable PCH file could be found. Return an error.
710 break;
711 }
712
713 ListenerRef.markAllUnavailable();
714 Context.setExternalSource(nullptr);
715 return nullptr;
716}
717
718// Code Completion
719
720static bool EnableCodeCompletion(Preprocessor &PP,
721 StringRef Filename,
722 unsigned Line,
723 unsigned Column) {
724 // Tell the source manager to chop off the given file at a specific
725 // line and column.
726 auto Entry = PP.getFileManager().getOptionalFileRef(Filename);
727 if (!Entry) {
728 PP.getDiagnostics().Report(DiagID: diag::err_fe_invalid_code_complete_file)
729 << Filename;
730 return true;
731 }
732
733 // Truncate the named file at the given line/column.
734 PP.SetCodeCompletionPoint(File: *Entry, Line, Column);
735 return false;
736}
737
738void CompilerInstance::createCodeCompletionConsumer() {
739 const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
740 if (!CompletionConsumer) {
741 setCodeCompletionConsumer(createCodeCompletionConsumer(
742 PP&: getPreprocessor(), Filename: Loc.FileName, Line: Loc.Line, Column: Loc.Column,
743 Opts: getFrontendOpts().CodeCompleteOpts, OS&: llvm::outs()));
744 return;
745 } else if (EnableCodeCompletion(PP&: getPreprocessor(), Filename: Loc.FileName,
746 Line: Loc.Line, Column: Loc.Column)) {
747 setCodeCompletionConsumer(nullptr);
748 return;
749 }
750}
751
752void CompilerInstance::createFrontendTimer() {
753 timerGroup.reset(p: new llvm::TimerGroup("clang", "Clang time report"));
754 FrontendTimer.reset(p: new llvm::Timer("frontend", "Front end", *timerGroup));
755}
756
757CodeCompleteConsumer *
758CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
759 StringRef Filename,
760 unsigned Line,
761 unsigned Column,
762 const CodeCompleteOptions &Opts,
763 raw_ostream &OS) {
764 if (EnableCodeCompletion(PP, Filename, Line, Column))
765 return nullptr;
766
767 // Set up the creation routine for code-completion.
768 return new PrintingCodeCompleteConsumer(Opts, OS);
769}
770
771void CompilerInstance::createSema(TranslationUnitKind TUKind,
772 CodeCompleteConsumer *CompletionConsumer) {
773 TheSema.reset(p: new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
774 TUKind, CompletionConsumer));
775
776 // Set up API notes.
777 TheSema->APINotes.setSwiftVersion(getAPINotesOpts().SwiftVersion);
778
779 // Attach the external sema source if there is any.
780 if (ExternalSemaSrc) {
781 TheSema->addExternalSource(E: ExternalSemaSrc);
782 ExternalSemaSrc->InitializeSema(S&: *TheSema);
783 }
784
785 // If we're building a module and are supposed to load API notes,
786 // notify the API notes manager.
787 if (auto *currentModule = getPreprocessor().getCurrentModule()) {
788 (void)TheSema->APINotes.loadCurrentModuleAPINotes(
789 M: currentModule, LookInModule: getLangOpts().APINotesModules,
790 SearchPaths: getAPINotesOpts().ModuleSearchPaths);
791 }
792}
793
794// Output Files
795
796void CompilerInstance::clearOutputFiles(bool EraseFiles) {
797 // The ASTConsumer can own streams that write to the output files.
798 assert(!hasASTConsumer() && "ASTConsumer should be reset");
799 if (!EraseFiles) {
800 for (auto &O : OutputFiles)
801 llvm::handleAllErrors(
802 E: O.keep(),
803 Handlers: [&](const llvm::vfs::TempFileOutputError &E) {
804 getDiagnostics().Report(DiagID: diag::err_unable_to_rename_temp)
805 << E.getTempPath() << E.getOutputPath()
806 << E.convertToErrorCode().message();
807 },
808 Handlers: [&](const llvm::vfs::OutputError &E) {
809 getDiagnostics().Report(DiagID: diag::err_fe_unable_to_open_output)
810 << E.getOutputPath() << E.convertToErrorCode().message();
811 },
812 Handlers: [&](const llvm::ErrorInfoBase &EIB) { // Handle any remaining error
813 getDiagnostics().Report(DiagID: diag::err_fe_unable_to_open_output)
814 << O.getPath() << EIB.message();
815 });
816 }
817 OutputFiles.clear();
818 if (DeleteBuiltModules) {
819 for (auto &Module : BuiltModules)
820 llvm::sys::fs::remove(path: Module.second);
821 BuiltModules.clear();
822 }
823}
824
825std::unique_ptr<raw_pwrite_stream> CompilerInstance::createDefaultOutputFile(
826 bool Binary, StringRef InFile, StringRef Extension, bool RemoveFileOnSignal,
827 bool CreateMissingDirectories, bool ForceUseTemporary,
828 bool SetOnlyIfDifferent) {
829 StringRef OutputPath = getFrontendOpts().OutputFile;
830 std::optional<SmallString<128>> PathStorage;
831 if (OutputPath.empty()) {
832 if (InFile == "-" || Extension.empty()) {
833 OutputPath = "-";
834 } else {
835 PathStorage.emplace(args&: InFile);
836 llvm::sys::path::replace_extension(path&: *PathStorage, extension: Extension);
837 OutputPath = *PathStorage;
838 }
839 }
840
841 return createOutputFile(OutputPath, Binary, RemoveFileOnSignal,
842 UseTemporary: getFrontendOpts().UseTemporary || ForceUseTemporary,
843 CreateMissingDirectories, SetOnlyIfDifferent);
844}
845
846std::unique_ptr<raw_pwrite_stream> CompilerInstance::createNullOutputFile() {
847 return std::make_unique<llvm::raw_null_ostream>();
848}
849
850// Output Manager
851
852void CompilerInstance::setOutputManager(
853 IntrusiveRefCntPtr<llvm::vfs::OutputBackend> NewOutputs) {
854 assert(!OutputMgr && "Already has an output manager");
855 OutputMgr = std::move(NewOutputs);
856}
857
858void CompilerInstance::createOutputManager() {
859 assert(!OutputMgr && "Already has an output manager");
860 OutputMgr = llvm::makeIntrusiveRefCnt<llvm::vfs::OnDiskOutputBackend>();
861}
862
863llvm::vfs::OutputBackend &CompilerInstance::getOutputManager() {
864 assert(OutputMgr);
865 return *OutputMgr;
866}
867
868llvm::vfs::OutputBackend &CompilerInstance::getOrCreateOutputManager() {
869 if (!hasOutputManager())
870 createOutputManager();
871 return getOutputManager();
872}
873
874std::unique_ptr<raw_pwrite_stream> CompilerInstance::createOutputFile(
875 StringRef OutputPath, bool Binary, bool RemoveFileOnSignal,
876 bool UseTemporary, bool CreateMissingDirectories, bool SetOnlyIfDifferent) {
877 Expected<std::unique_ptr<raw_pwrite_stream>> OS =
878 createOutputFileImpl(OutputPath, Binary, RemoveFileOnSignal, UseTemporary,
879 CreateMissingDirectories, SetOnlyIfDifferent);
880 if (OS)
881 return std::move(*OS);
882 getDiagnostics().Report(DiagID: diag::err_fe_unable_to_open_output)
883 << OutputPath << errorToErrorCode(Err: OS.takeError()).message();
884 return nullptr;
885}
886
887Expected<std::unique_ptr<llvm::raw_pwrite_stream>>
888CompilerInstance::createOutputFileImpl(StringRef OutputPath, bool Binary,
889 bool RemoveFileOnSignal,
890 bool UseTemporary,
891 bool CreateMissingDirectories,
892 bool SetOnlyIfDifferent) {
893 assert((!CreateMissingDirectories || UseTemporary) &&
894 "CreateMissingDirectories is only allowed when using temporary files");
895
896 // If '-working-directory' was passed, the output filename should be
897 // relative to that.
898 std::optional<SmallString<128>> AbsPath;
899 if (OutputPath != "-" && !llvm::sys::path::is_absolute(path: OutputPath)) {
900 assert(hasFileManager() &&
901 "File Manager is required to fix up relative path.\n");
902
903 AbsPath.emplace(args&: OutputPath);
904 FileManager::fixupRelativePath(FileSystemOpts: getFileSystemOpts(), Path&: *AbsPath);
905 OutputPath = *AbsPath;
906 }
907
908 using namespace llvm::vfs;
909 Expected<OutputFile> O = getOrCreateOutputManager().createFile(
910 Path: OutputPath,
911 Config: OutputConfig()
912 .setTextWithCRLF(!Binary)
913 .setDiscardOnSignal(RemoveFileOnSignal)
914 .setAtomicWrite(UseTemporary)
915 .setImplyCreateDirectories(UseTemporary && CreateMissingDirectories)
916 .setOnlyIfDifferent(SetOnlyIfDifferent));
917 if (!O)
918 return O.takeError();
919
920 O->discardOnDestroy(Handler: [](llvm::Error E) { consumeError(Err: std::move(E)); });
921 OutputFiles.push_back(x: std::move(*O));
922 return OutputFiles.back().createProxy();
923}
924
925// Initialization Utilities
926
927bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
928 return InitializeSourceManager(Input, Diags&: getDiagnostics(), FileMgr&: getFileManager(),
929 SourceMgr&: getSourceManager());
930}
931
932// static
933bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input,
934 DiagnosticsEngine &Diags,
935 FileManager &FileMgr,
936 SourceManager &SourceMgr) {
937 SrcMgr::CharacteristicKind Kind =
938 Input.getKind().getFormat() == InputKind::ModuleMap
939 ? Input.isSystem() ? SrcMgr::C_System_ModuleMap
940 : SrcMgr::C_User_ModuleMap
941 : Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
942
943 if (Input.isBuffer()) {
944 SourceMgr.setMainFileID(SourceMgr.createFileID(Buffer: Input.getBuffer(), FileCharacter: Kind));
945 assert(SourceMgr.getMainFileID().isValid() &&
946 "Couldn't establish MainFileID!");
947 return true;
948 }
949
950 StringRef InputFile = Input.getFile();
951
952 // Figure out where to get and map in the main file.
953 auto FileOrErr = InputFile == "-"
954 ? FileMgr.getSTDIN()
955 : FileMgr.getFileRef(Filename: InputFile, /*OpenFile=*/true);
956 if (!FileOrErr) {
957 auto EC = llvm::errorToErrorCode(Err: FileOrErr.takeError());
958 if (InputFile != "-")
959 Diags.Report(DiagID: diag::err_fe_error_reading) << InputFile << EC.message();
960 else
961 Diags.Report(DiagID: diag::err_fe_error_reading_stdin) << EC.message();
962 return false;
963 }
964
965 SourceMgr.setMainFileID(
966 SourceMgr.createFileID(SourceFile: *FileOrErr, IncludePos: SourceLocation(), FileCharacter: Kind));
967
968 assert(SourceMgr.getMainFileID().isValid() &&
969 "Couldn't establish MainFileID!");
970 return true;
971}
972
973// High-Level Operations
974
975void CompilerInstance::PrepareForExecution() {
976 // Set up the frontend timer for -ftime-report. BackendConsumer uses
977 // getTimerGroup() and getFrontendTimer() when TimePasses is set. In the
978 // cc1 driver path this was done in cc1_main before calling
979 // ExecuteCompilerInvocation; we consolidate it here so that all tools
980 // (cc1, clang-repl, libclang, etc.) get consistent behavior.
981 if (getCodeGenOpts().TimePasses && !FrontendTimer) {
982 createFrontendTimer();
983 getFrontendTimer().startTimer();
984 }
985
986 // FIXME: Consider consolidating additional per-instance setup here:
987 // - llvm::timeTraceProfilerInitialize) when TimeTracePath is set.
988 // - Plugin loading (LoadRequestedPlugins) and -mllvm argument processing.
989}
990
991bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
992 assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
993 assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
994 assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
995
996 llvm::TimeTraceScope TimeScope("ExecuteCompiler");
997
998 PrepareForExecution();
999
1000 // Mark this point as the bottom of the stack if we don't have somewhere
1001 // better. We generally expect frontend actions to be invoked with (nearly)
1002 // DesiredStackSpace available.
1003 noteBottomOfStack();
1004
1005 raw_ostream &OS = getVerboseOutputStream();
1006
1007 if (!Act.PrepareToExecute(CI&: *this))
1008 return false;
1009
1010 if (!createTarget())
1011 return false;
1012
1013 // rewriter project will change target built-in bool type from its default.
1014 if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
1015 getTarget().noSignedCharForObjCBool();
1016
1017 // Validate/process some options.
1018 if (getHeaderSearchOpts().Verbose)
1019 OS << "clang -cc1 version " CLANG_VERSION_STRING << " based upon LLVM "
1020 << LLVM_VERSION_STRING << " default target "
1021 << llvm::sys::getDefaultTargetTriple() << "\n";
1022
1023 if (getFrontendOpts().ShowStats || !getFrontendOpts().StatsFile.empty())
1024 llvm::EnableStatistics(DoPrintOnExit: false);
1025
1026 // Sort vectors containing toc data and no toc data variables to facilitate
1027 // binary search later.
1028 llvm::sort(C&: getCodeGenOpts().TocDataVarsUserSpecified);
1029 llvm::sort(C&: getCodeGenOpts().NoTocDataVars);
1030
1031 for (const FrontendInputFile &FIF : getFrontendOpts().Inputs) {
1032 // Reset the ID tables if we are reusing the SourceManager and parsing
1033 // regular files.
1034 if (hasSourceManager() && !Act.isModelParsingAction())
1035 getSourceManager().clearIDTables();
1036
1037 ModuleImportResults.clear();
1038
1039 if (Act.BeginSourceFile(CI&: *this, Input: FIF)) {
1040 if (llvm::Error Err = Act.Execute()) {
1041 consumeError(Err: std::move(Err)); // FIXME this drops errors on the floor.
1042 }
1043 Act.EndSourceFile();
1044 }
1045 }
1046
1047 printDiagnosticStats();
1048
1049 if (getFrontendOpts().ShowStats) {
1050 if (hasFileManager()) {
1051 getFileManager().PrintStats();
1052 OS << '\n';
1053 }
1054 llvm::PrintStatistics(OS);
1055 }
1056 StringRef StatsFile = getFrontendOpts().StatsFile;
1057 if (!StatsFile.empty()) {
1058 llvm::sys::fs::OpenFlags FileFlags = llvm::sys::fs::OF_TextWithCRLF;
1059 if (getFrontendOpts().AppendStats)
1060 FileFlags |= llvm::sys::fs::OF_Append;
1061 std::error_code EC;
1062 auto StatS =
1063 std::make_unique<llvm::raw_fd_ostream>(args&: StatsFile, args&: EC, args&: FileFlags);
1064 if (EC) {
1065 getDiagnostics().Report(DiagID: diag::warn_fe_unable_to_open_stats_file)
1066 << StatsFile << EC.message();
1067 } else {
1068 llvm::PrintStatisticsJSON(OS&: *StatS);
1069 }
1070 }
1071
1072 return !getDiagnostics().getClient()->getNumErrors();
1073}
1074
1075void CompilerInstance::printDiagnosticStats() {
1076 if (!getDiagnosticOpts().ShowCarets)
1077 return;
1078
1079 raw_ostream &OS = getVerboseOutputStream();
1080
1081 // We can have multiple diagnostics sharing one diagnostic client.
1082 // Get the total number of warnings/errors from the client.
1083 unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
1084 unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
1085
1086 if (NumWarnings)
1087 OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
1088 if (NumWarnings && NumErrors)
1089 OS << " and ";
1090 if (NumErrors)
1091 OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
1092 if (NumWarnings || NumErrors) {
1093 OS << " generated";
1094 if (getLangOpts().CUDA) {
1095 if (!getLangOpts().CUDAIsDevice) {
1096 OS << " when compiling for host";
1097 } else {
1098 OS << " when compiling for "
1099 << (!getTargetOpts().CPU.empty() ? getTargetOpts().CPU
1100 : getTarget().getTriple().str());
1101 }
1102 }
1103 OS << ".\n";
1104 }
1105}
1106
1107void CompilerInstance::LoadRequestedPlugins() {
1108 // Load any requested plugins.
1109 for (const std::string &Path : getFrontendOpts().Plugins) {
1110 std::string Error;
1111 if (llvm::sys::DynamicLibrary::LoadLibraryPermanently(Filename: Path.c_str(), ErrMsg: &Error))
1112 getDiagnostics().Report(DiagID: diag::err_fe_unable_to_load_plugin)
1113 << Path << Error;
1114 }
1115
1116 // Load and store pass plugins for the back-end.
1117 for (const std::string &Path : getCodeGenOpts().PassPlugins) {
1118 if (auto PassPlugin = llvm::PassPlugin::load(Filename: Path)) {
1119 PassPlugins.emplace_back(args: std::make_unique<llvm::PassPlugin>(args&: *PassPlugin));
1120 } else {
1121 getDiagnostics().Report(DiagID: diag::err_fe_unable_to_load_plugin)
1122 << Path << toString(E: PassPlugin.takeError());
1123 }
1124 }
1125
1126 // Check if any of the loaded plugins replaces the main AST action
1127 for (const FrontendPluginRegistry::entry &Plugin :
1128 FrontendPluginRegistry::entries()) {
1129 std::unique_ptr<PluginASTAction> P(Plugin.instantiate());
1130 if (P->getActionType() == PluginASTAction::ReplaceAction) {
1131 getFrontendOpts().ProgramAction = clang::frontend::PluginAction;
1132 getFrontendOpts().ActionName = Plugin.getName().str();
1133 break;
1134 }
1135 }
1136}
1137
1138void CompilerInstance::parseLLVMArgs() {
1139 if (!getFrontendOpts().LLVMArgs.empty()) {
1140 unsigned NumArgs = getFrontendOpts().LLVMArgs.size();
1141 auto Args = std::make_unique<const char *[]>(num: NumArgs + 2);
1142 Args[0] = "clang (LLVM option parsing)";
1143 for (unsigned i = 0; i != NumArgs; ++i)
1144 Args[i + 1] = getFrontendOpts().LLVMArgs[i].c_str();
1145 Args[NumArgs + 1] = nullptr;
1146 llvm::cl::ParseCommandLineOptions(argc: NumArgs + 1, argv: Args.get(), /*Overview=*/"",
1147 /*Errs=*/nullptr,
1148 /*VFS=*/&getVirtualFileSystem());
1149 }
1150}
1151
1152/// Determine the appropriate source input kind based on language
1153/// options.
1154static Language getLanguageFromOptions(const LangOptions &LangOpts) {
1155 if (LangOpts.OpenCL)
1156 return Language::OpenCL;
1157 if (LangOpts.CUDA)
1158 return Language::CUDA;
1159 if (LangOpts.ObjC)
1160 return LangOpts.CPlusPlus ? Language::ObjCXX : Language::ObjC;
1161 return LangOpts.CPlusPlus ? Language::CXX : Language::C;
1162}
1163
1164std::unique_ptr<CompilerInstance> CompilerInstance::cloneForModuleCompileImpl(
1165 SourceLocation ImportLoc, StringRef ModuleName, FrontendInputFile Input,
1166 StringRef OriginalModuleMapFile, StringRef ModuleFileName,
1167 ArrayRef<std::string> DirectoryDependencies,
1168 std::optional<ThreadSafeCloneConfig> ThreadSafeConfig) {
1169 // Construct a compiler invocation for creating this module.
1170 auto Invocation = std::make_shared<CompilerInvocation>(args&: getInvocation());
1171
1172 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
1173
1174 // For any options that aren't intended to affect how a module is built,
1175 // reset them to their default values.
1176 Invocation->resetNonModularOptions();
1177
1178 // Remove any macro definitions that are explicitly ignored by the module.
1179 // They aren't supposed to affect how the module is built anyway.
1180 HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
1181 llvm::erase_if(C&: PPOpts.Macros,
1182 P: [&HSOpts](const std::pair<std::string, bool> &def) {
1183 StringRef MacroDef = def.first;
1184 return HSOpts.ModulesIgnoreMacros.contains(
1185 key: llvm::CachedHashString(MacroDef.split(Separator: '=').first));
1186 });
1187 HSOpts.ModulesIgnoreMacros.clear();
1188
1189 // Remove any search paths that are explicitly ignored by the module.
1190 // They aren't supposed to affect how the module is built anyway.
1191 if (!HSOpts.ModulesIgnoreSearchPaths.empty())
1192 llvm::erase_if(C&: HSOpts.UserEntries,
1193 P: [&HSOpts](const HeaderSearchOptions::Entry &E) {
1194 return HSOpts.ModulesIgnoreSearchPaths.contains(
1195 key: llvm::CachedHashString(E.Path));
1196 });
1197 HSOpts.ModulesIgnoreSearchPaths.clear();
1198
1199 // If the original compiler invocation had -fmodule-name, pass it through.
1200 Invocation->getLangOpts().ModuleName =
1201 getInvocation().getLangOpts().ModuleName;
1202
1203 // Note the name of the module we're building.
1204 Invocation->getLangOpts().CurrentModule = std::string(ModuleName);
1205
1206 // If there is a module map file, build the module using the module map.
1207 // Set up the inputs/outputs so that we build the module from its umbrella
1208 // header.
1209 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
1210 FrontendOpts.OutputFile = ModuleFileName.str();
1211 FrontendOpts.DisableFree = false;
1212 FrontendOpts.GenerateGlobalModuleIndex = false;
1213 FrontendOpts.BuildingImplicitModule = true;
1214 FrontendOpts.OriginalModuleMap = std::string(OriginalModuleMapFile);
1215 // Force implicitly-built modules to hash the content of the module file.
1216 HSOpts.ModulesHashContent = true;
1217 FrontendOpts.Inputs = {std::move(Input)};
1218
1219 // Don't free the remapped file buffers; they are owned by our caller.
1220 PPOpts.RetainRemappedFileBuffers = true;
1221
1222 DiagnosticOptions &DiagOpts = Invocation->getDiagnosticOpts();
1223
1224 DiagOpts.VerifyDiagnostics = 0;
1225 assert(getInvocation().computeContextHash() ==
1226 Invocation->computeContextHash() &&
1227 "Module hash mismatch!");
1228
1229 std::shared_ptr<ModuleCache> ModCache;
1230 if (ThreadSafeConfig) {
1231 ModCache = ThreadSafeConfig->getModuleCache();
1232 } else {
1233 ModCache = this->ModCache;
1234 }
1235
1236 // Construct a compiler instance that will be used to create the module.
1237 auto InstancePtr = std::make_unique<CompilerInstance>(
1238 args: std::move(Invocation), args: getPCHContainerOperations(), args: std::move(ModCache));
1239 auto &Instance = *InstancePtr;
1240
1241 auto &Inv = Instance.getInvocation();
1242
1243 if (ThreadSafeConfig) {
1244 Instance.setVirtualFileSystem(ThreadSafeConfig->getVFS());
1245 Instance.createFileManager();
1246 } else if (FrontendOpts.ModulesShareFileManager) {
1247 Instance.setVirtualFileSystem(getVirtualFileSystemPtr());
1248 Instance.setFileManager(getFileManagerPtr());
1249 } else {
1250 Instance.setVirtualFileSystem(getVirtualFileSystemPtr());
1251 Instance.createFileManager();
1252 }
1253
1254 if (ThreadSafeConfig) {
1255 Instance.createDiagnostics(Client: &ThreadSafeConfig->getDiagConsumer(),
1256 /*ShouldOwnClient=*/false);
1257 } else {
1258 Instance.createDiagnostics(
1259 Client: new ForwardingDiagnosticConsumer(getDiagnosticClient()),
1260 /*ShouldOwnClient=*/true);
1261 }
1262 if (llvm::is_contained(Range&: DiagOpts.SystemHeaderWarningsModules, Element: ModuleName))
1263 Instance.getDiagnostics().setSuppressSystemWarnings(false);
1264
1265 Instance.createSourceManager();
1266 SourceManager &SourceMgr = Instance.getSourceManager();
1267
1268 if (ThreadSafeConfig) {
1269 // Detecting cycles in the module graph is responsibility of the client.
1270 } else {
1271 // Note that this module is part of the module build stack, so that we
1272 // can detect cycles in the module graph.
1273 SourceMgr.setModuleBuildStack(getSourceManager().getModuleBuildStack());
1274 SourceMgr.pushModuleBuildStack(
1275 moduleName: ModuleName, importLoc: FullSourceLoc(ImportLoc, getSourceManager()));
1276 }
1277
1278 // Make a copy for the new instance.
1279 Instance.FailedModules = FailedModules;
1280
1281 // An inferred framework is built from module map text printed by this
1282 // instance rather than by repeating the inference, so directories the
1283 // inference enumerated (its Frameworks subdirectory) are only known here.
1284 Instance.setInheritedDirectoryDependencies(DirectoryDependencies);
1285
1286 // Pass along the GenModuleActionWrapper callback.
1287 Instance.setGenModuleActionWrapper(getGenModuleActionWrapper());
1288
1289 if (GetDependencyDirectives)
1290 Instance.GetDependencyDirectives =
1291 GetDependencyDirectives->cloneFor(FileMgr&: Instance.getFileManager());
1292
1293 if (ThreadSafeConfig) {
1294 Instance.setModuleDepCollector(ThreadSafeConfig->getModuleDepCollector());
1295 } else {
1296 // If we're collecting module dependencies, we need to share a collector
1297 // between all of the module CompilerInstances. Other than that, we don't
1298 // want to produce any dependency output from the module build.
1299 Instance.setModuleDepCollector(getModuleDepCollector());
1300 }
1301 Inv.getDependencyOutputOpts() = DependencyOutputOptions();
1302
1303 return InstancePtr;
1304}
1305
1306namespace {
1307class PrettyStackTraceBuildModule : public llvm::PrettyStackTraceEntry {
1308 StringRef ModuleName;
1309 StringRef ModuleFileName;
1310
1311public:
1312 PrettyStackTraceBuildModule(StringRef ModuleName, StringRef ModuleFileName)
1313 : ModuleName(ModuleName), ModuleFileName(ModuleFileName) {}
1314 void print(raw_ostream &OS) const override {
1315 OS << "Building module '" << ModuleName << "' as '" << ModuleFileName
1316 << "'\n";
1317 }
1318};
1319} // namespace
1320
1321std::unique_ptr<llvm::MemoryBuffer>
1322CompilerInstance::compileModule(SourceLocation ImportLoc, StringRef ModuleName,
1323 StringRef ModuleFileName,
1324 CompilerInstance &Instance) {
1325 PrettyStackTraceBuildModule CrashInfo(ModuleName, ModuleFileName);
1326 llvm::TimeTraceScope TimeScope("Module Compile", ModuleName);
1327
1328 // Never compile a module that's already finalized - this would cause the
1329 // existing module to be freed, causing crashes if it is later referenced
1330 if (getModuleCache().getInMemoryModuleCache().isPCMFinal(Filename: ModuleFileName)) {
1331 getDiagnostics().Report(Loc: ImportLoc, DiagID: diag::err_module_rebuild_finalized)
1332 << ModuleName;
1333 return nullptr;
1334 }
1335
1336 getDiagnostics().Report(Loc: ImportLoc, DiagID: diag::remark_module_build)
1337 << ModuleName << ModuleFileName;
1338
1339 SmallString<0> Buffer;
1340
1341 // Execute the action to actually build the module in-place. Use a separate
1342 // thread so that we get a stack large enough.
1343 uint64_t ParentTID = llvm::get_threadid();
1344 bool Crashed = !llvm::CrashRecoveryContext().RunSafelyOnNewStack(
1345 [&]() {
1346 getModuleCache().getLogger().log()
1347 << "module_compile_thread: parent=" << ParentTID
1348 << " pcm_compile: " << ModuleFileName;
1349
1350 auto OS = std::make_unique<llvm::raw_svector_ostream>(args&: Buffer);
1351
1352 std::unique_ptr<FrontendAction> Action =
1353 std::make_unique<GenerateModuleFromModuleMapAction>(args: std::move(OS));
1354
1355 if (auto WrapGenModuleAction = Instance.getGenModuleActionWrapper())
1356 Action = WrapGenModuleAction(Instance.getFrontendOpts(),
1357 std::move(Action));
1358
1359 Instance.ExecuteAction(Act&: *Action);
1360 },
1361 RequestedStackSize: DesiredStackSize);
1362
1363 getDiagnostics().Report(Loc: ImportLoc, DiagID: diag::remark_module_build_done)
1364 << ModuleName;
1365
1366 // Propagate the statistics to the parent FileManager.
1367 if (!getFrontendOpts().ModulesShareFileManager)
1368 getFileManager().AddStats(Other: Instance.getFileManager());
1369
1370 // Propagate the failed modules to the parent instance.
1371 FailedModules = std::move(Instance.FailedModules);
1372
1373 if (Crashed) {
1374 // Clear the ASTConsumer if it hasn't been already, in case it owns streams
1375 // that must be closed before clearing output files.
1376 Instance.setSema(nullptr);
1377 Instance.setASTConsumer(nullptr);
1378
1379 // Delete any remaining temporary files related to Instance.
1380 Instance.clearOutputFiles(/*EraseFiles=*/true);
1381 }
1382
1383 // We've rebuilt a module. If we're allowed to generate or update the global
1384 // module index, record that fact in the importing compiler instance.
1385 if (getFrontendOpts().GenerateGlobalModuleIndex) {
1386 setBuildGlobalModuleIndex(true);
1387 }
1388
1389 if (Crashed)
1390 return nullptr;
1391
1392 // Unless \p AllowPCMWithCompilerErrors is set, return 'failure' if errors
1393 // occurred.
1394 if (Instance.getDiagnostics().hasErrorOccurred() &&
1395 !Instance.getFrontendOpts().AllowPCMWithCompilerErrors)
1396 return nullptr;
1397
1398 return std::make_unique<llvm::SmallVectorMemoryBuffer>(
1399 args: std::move(Buffer), args&: Instance.getFrontendOpts().OutputFile);
1400}
1401
1402static OptionalFileEntryRef getPublicModuleMap(FileEntryRef File,
1403 FileManager &FileMgr) {
1404 StringRef Filename = llvm::sys::path::filename(path: File.getName());
1405 SmallString<128> PublicFilename(File.getDir().getName());
1406 if (Filename == "module_private.map")
1407 llvm::sys::path::append(path&: PublicFilename, a: "module.map");
1408 else if (Filename == "module.private.modulemap")
1409 llvm::sys::path::append(path&: PublicFilename, a: "module.modulemap");
1410 else
1411 return std::nullopt;
1412 return FileMgr.getOptionalFileRef(Filename: PublicFilename);
1413}
1414
1415std::unique_ptr<CompilerInstance> CompilerInstance::cloneForModuleCompile(
1416 SourceLocation ImportLoc, const Module *Module, StringRef ModuleFileName,
1417 std::optional<ThreadSafeCloneConfig> ThreadSafeConfig) {
1418 StringRef ModuleName = Module->getTopLevelModuleName();
1419
1420 InputKind IK(getLanguageFromOptions(LangOpts: getLangOpts()), InputKind::ModuleMap);
1421
1422 // Get or create the module map that we'll use to build this module.
1423 ModuleMap &ModMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
1424 SourceManager &SourceMgr = getSourceManager();
1425
1426 if (FileID ModuleMapFID = ModMap.getContainingModuleMapFileID(Module);
1427 ModuleMapFID.isValid()) {
1428 // We want to use the top-level module map. If we don't, the compiling
1429 // instance may think the containing module map is a top-level one, while
1430 // the importing instance knows it's included from a parent module map via
1431 // the extern directive. This mismatch could bite us later.
1432 SourceLocation Loc = SourceMgr.getIncludeLoc(FID: ModuleMapFID);
1433 while (Loc.isValid() && isModuleMap(CK: SourceMgr.getFileCharacteristic(Loc))) {
1434 ModuleMapFID = SourceMgr.getFileID(SpellingLoc: Loc);
1435 Loc = SourceMgr.getIncludeLoc(FID: ModuleMapFID);
1436 }
1437
1438 OptionalFileEntryRef ModuleMapFile =
1439 SourceMgr.getFileEntryRefForID(FID: ModuleMapFID);
1440 assert(ModuleMapFile && "Top-level module map with no FileID");
1441
1442 // Canonicalize compilation to start with the public module map. This is
1443 // vital for submodules declarations in the private module maps to be
1444 // correctly parsed when depending on a top level module in the public one.
1445 if (OptionalFileEntryRef PublicMMFile =
1446 getPublicModuleMap(File: *ModuleMapFile, FileMgr&: getFileManager()))
1447 ModuleMapFile = PublicMMFile;
1448
1449 StringRef ModuleMapFilePath = ModuleMapFile->getNameAsRequested();
1450
1451 // Use the systemness of the module map as parsed instead of using the
1452 // IsSystem attribute of the module. If the module has [system] but the
1453 // module map is not in a system path, then this would incorrectly parse
1454 // any other modules in that module map as system too.
1455 const SrcMgr::SLocEntry &SLoc = SourceMgr.getSLocEntry(FID: ModuleMapFID);
1456 bool IsSystem = isSystem(CK: SLoc.getFile().getFileCharacteristic());
1457
1458 // Use the module map where this module resides.
1459 return cloneForModuleCompileImpl(
1460 ImportLoc, ModuleName,
1461 Input: FrontendInputFile(ModuleMapFilePath, IK, IsSystem),
1462 OriginalModuleMapFile: ModMap.getModuleMapFileForUniquing(M: Module)->getName(), ModuleFileName,
1463 DirectoryDependencies: Module->getDirectoryDependencies(), ThreadSafeConfig: std::move(ThreadSafeConfig));
1464 }
1465
1466 // FIXME: We only need to fake up an input file here as a way of
1467 // transporting the module's directory to the module map parser. We should
1468 // be able to do that more directly, and parse from a memory buffer without
1469 // inventing this file.
1470 SmallString<128> FakeModuleMapFile(Module->Directory->getName());
1471 llvm::sys::path::append(path&: FakeModuleMapFile, a: "__inferred_module.map");
1472
1473 std::string InferredModuleMapContent;
1474 llvm::raw_string_ostream OS(InferredModuleMapContent);
1475 Module->print(OS);
1476
1477 auto Instance = cloneForModuleCompileImpl(
1478 ImportLoc, ModuleName,
1479 Input: FrontendInputFile(FakeModuleMapFile, IK, +Module->IsSystem),
1480 OriginalModuleMapFile: ModMap.getModuleMapFileForUniquing(M: Module)->getName(), ModuleFileName,
1481 DirectoryDependencies: Module->getDirectoryDependencies(), ThreadSafeConfig: std::move(ThreadSafeConfig));
1482
1483 std::unique_ptr<llvm::MemoryBuffer> ModuleMapBuffer =
1484 llvm::MemoryBuffer::getMemBufferCopy(InputData: InferredModuleMapContent);
1485 FileEntryRef ModuleMapFile = Instance->getFileManager().getVirtualFileRef(
1486 Filename: FakeModuleMapFile, Size: InferredModuleMapContent.size(), ModificationTime: 0);
1487 Instance->getSourceManager().overrideFileContents(SourceFile: ModuleMapFile,
1488 Buffer: std::move(ModuleMapBuffer));
1489
1490 return Instance;
1491}
1492
1493/// Read the AST right after compiling the module.
1494/// Returns true on success, false on failure.
1495static bool readASTAfterCompileModule(CompilerInstance &ImportingInstance,
1496 SourceLocation ImportLoc,
1497 SourceLocation ModuleNameLoc,
1498 Module *Module,
1499 ModuleFileName ModuleFileName,
1500 bool *OutOfDate, bool *Missing) {
1501 DiagnosticsEngine &Diags = ImportingInstance.getDiagnostics();
1502
1503 unsigned ModuleLoadCapabilities = ASTReader::ARR_Missing;
1504 if (OutOfDate)
1505 ModuleLoadCapabilities |= ASTReader::ARR_OutOfDate;
1506
1507 // Try to read the module file, now that we've compiled it.
1508 ASTReader::ASTReadResult ReadResult =
1509 ImportingInstance.getASTReader()->ReadAST(
1510 FileName: ModuleFileName, Type: serialization::MK_ImplicitModule, ImportLoc,
1511 ClientLoadCapabilities: ModuleLoadCapabilities);
1512 if (ReadResult == ASTReader::Success)
1513 return true;
1514
1515 // The caller wants to handle out-of-date failures.
1516 if (OutOfDate && ReadResult == ASTReader::OutOfDate) {
1517 *OutOfDate = true;
1518 return false;
1519 }
1520
1521 // The caller wants to handle missing module files.
1522 if (Missing && ReadResult == ASTReader::Missing) {
1523 *Missing = true;
1524 return false;
1525 }
1526
1527 // The ASTReader didn't diagnose the error, so conservatively report it.
1528 if (ReadResult == ASTReader::Missing || !Diags.hasErrorOccurred())
1529 Diags.Report(Loc: ModuleNameLoc, DiagID: diag::err_module_not_built)
1530 << Module->Name << SourceRange(ImportLoc, ModuleNameLoc);
1531
1532 return false;
1533}
1534
1535/// Compile a module in a separate compiler instance.
1536/// Returns true on success, false on failure.
1537static bool compileModuleImpl(CompilerInstance &ImportingInstance,
1538 SourceLocation ImportLoc,
1539 SourceLocation ModuleNameLoc, Module *Module,
1540 ModuleFileName ModuleFileName) {
1541 std::unique_ptr<llvm::MemoryBuffer> Buffer;
1542
1543 {
1544 auto Instance = ImportingInstance.cloneForModuleCompile(
1545 ImportLoc: ModuleNameLoc, Module, ModuleFileName);
1546
1547 Buffer = ImportingInstance.compileModule(ImportLoc: ModuleNameLoc,
1548 ModuleName: Module->getTopLevelModuleName(),
1549 ModuleFileName, Instance&: *Instance);
1550
1551 if (!Buffer) {
1552 ImportingInstance.getDiagnostics().Report(Loc: ModuleNameLoc,
1553 DiagID: diag::err_module_not_built)
1554 << Module->Name << SourceRange(ImportLoc, ModuleNameLoc);
1555 return false;
1556 }
1557 }
1558
1559 off_t Size;
1560 time_t ModTime;
1561 std::error_code EC = ImportingInstance.getModuleCache().write(
1562 Path: ModuleFileName, Buffer: *Buffer, Size, ModTime);
1563 if (EC) {
1564 ImportingInstance.getDiagnostics().Report(Loc: ModuleNameLoc,
1565 DiagID: diag::err_module_not_written)
1566 << Module->Name << ModuleFileName << EC.message()
1567 << SourceRange(ImportLoc, ModuleNameLoc);
1568 return false;
1569 }
1570
1571 // The module is built successfully, we can update its timestamp now.
1572 if (ImportingInstance.getPreprocessor()
1573 .getHeaderSearchInfo()
1574 .getHeaderSearchOpts()
1575 .ModulesValidateOncePerBuildSession) {
1576 ImportingInstance.getModuleCache().updateModuleTimestamp(ModuleFilename: ModuleFileName);
1577 }
1578
1579 // This isn't strictly necessary, but it's more efficient to extract the AST
1580 // file (which may be wrapped in an object file) now rather than doing so
1581 // repeatedly in the readers.
1582 const PCHContainerReader &Rdr = ImportingInstance.getPCHContainerReader();
1583 StringRef ExtractedBuffer = Rdr.ExtractPCH(Buffer: *Buffer);
1584 // FIXME: Avoid the copy here by having InMemoryModuleCache accept both the
1585 // owning buffer and the StringRef.
1586 Buffer = llvm::MemoryBuffer::getMemBufferCopy(InputData: ExtractedBuffer);
1587
1588 ImportingInstance.getModuleCache().getInMemoryModuleCache().addBuiltPCM(
1589 Filename: ModuleFileName, Buffer: std::move(Buffer), Size, ModTime);
1590
1591 return true;
1592}
1593
1594/// The result of `compileModuleBehindLockOrRead()`.
1595enum class CompileOrReadResult : uint8_t {
1596 /// We failed to compile the module.
1597 FailedToCompile,
1598 /// We successfully compiled the module and we still need to read it.
1599 Compiled,
1600 /// We failed to read the module file compiled by another instance.
1601 FailedToRead,
1602 /// We read a module file compiled by another instance.
1603 Read,
1604};
1605
1606/// Attempt to compile the module in a separate compiler instance behind a lock
1607/// (to avoid building the same module in multiple compiler instances), or read
1608/// the AST produced by another compiler instance.
1609static CompileOrReadResult
1610compileModuleBehindLockOrRead(CompilerInstance &ImportingInstance,
1611 SourceLocation ImportLoc,
1612 SourceLocation ModuleNameLoc, Module *Module,
1613 ModuleFileName ModuleFileName) {
1614 DiagnosticsEngine &Diags = ImportingInstance.getDiagnostics();
1615
1616 Diags.Report(Loc: ModuleNameLoc, DiagID: diag::remark_module_lock)
1617 << ModuleFileName << Module->Name;
1618
1619 auto &ModuleCache = ImportingInstance.getModuleCache();
1620
1621 while (true) {
1622 auto Lock = ModuleCache.getLock(ModuleFilename: ModuleFileName);
1623 bool Owned;
1624 if (llvm::Error Err = Lock->tryLock().moveInto(Value&: Owned)) {
1625 // ModuleCache takes care of correctness and locks are only necessary for
1626 // performance. Fallback to building the module in case of any lock
1627 // related errors.
1628 Diags.Report(Loc: ModuleNameLoc, DiagID: diag::remark_module_lock_failure)
1629 << Module->Name << toString(E: std::move(Err));
1630 if (!compileModuleImpl(ImportingInstance, ImportLoc, ModuleNameLoc,
1631 Module, ModuleFileName))
1632 return CompileOrReadResult::FailedToCompile;
1633 return CompileOrReadResult::Compiled;
1634 }
1635 if (Owned) {
1636 // We're responsible for building the module ourselves.
1637 if (!compileModuleImpl(ImportingInstance, ImportLoc, ModuleNameLoc,
1638 Module, ModuleFileName))
1639 return CompileOrReadResult::FailedToCompile;
1640 return CompileOrReadResult::Compiled;
1641 }
1642
1643 // Someone else is responsible for building the module. Wait for them to
1644 // finish.
1645 unsigned Timeout =
1646 ImportingInstance.getFrontendOpts().ImplicitModulesLockTimeoutSeconds;
1647 switch (Lock->waitForUnlockFor(MaxSeconds: std::chrono::seconds(Timeout))) {
1648 case llvm::WaitForUnlockResult::Success:
1649 break; // The interesting case.
1650 case llvm::WaitForUnlockResult::OwnerDied:
1651 continue; // try again to get the lock.
1652 case llvm::WaitForUnlockResult::Timeout:
1653 // Since the InMemoryModuleCache takes care of correctness, we try waiting
1654 // for someone else to complete the build so that it does not happen
1655 // twice. In case of timeout, try to build it ourselves again.
1656 Diags.Report(Loc: ModuleNameLoc, DiagID: diag::remark_module_lock_timeout)
1657 << Module->Name;
1658 // Clear the lock file so that future invocations can make progress.
1659 Lock->unsafeUnlock();
1660 continue;
1661 }
1662
1663 // Read the module that was just written by someone else.
1664 bool OutOfDate = false;
1665 bool Missing = false;
1666 if (readASTAfterCompileModule(ImportingInstance, ImportLoc, ModuleNameLoc,
1667 Module, ModuleFileName, OutOfDate: &OutOfDate, Missing: &Missing))
1668 return CompileOrReadResult::Read;
1669 if (!OutOfDate && !Missing)
1670 return CompileOrReadResult::FailedToRead;
1671
1672 // The module may be missing or out of date in the presence of file system
1673 // races. It may also be out of date if one of its imports depends on header
1674 // search paths that are not consistent with this ImportingInstance.
1675 // Try again...
1676 }
1677}
1678
1679/// Compile a module in a separate compiler instance and read the AST,
1680/// returning true if the module compiles without errors, potentially using a
1681/// lock manager to avoid building the same module in multiple compiler
1682/// instances.
1683static bool compileModuleAndReadAST(CompilerInstance &ImportingInstance,
1684 SourceLocation ImportLoc,
1685 SourceLocation ModuleNameLoc,
1686 Module *Module,
1687 ModuleFileName ModuleFileName) {
1688 if (ImportingInstance.getInvocation()
1689 .getFrontendOpts()
1690 .BuildingImplicitModuleUsesLock) {
1691 switch (compileModuleBehindLockOrRead(
1692 ImportingInstance, ImportLoc, ModuleNameLoc, Module, ModuleFileName)) {
1693 case CompileOrReadResult::FailedToRead:
1694 case CompileOrReadResult::FailedToCompile:
1695 return false;
1696 case CompileOrReadResult::Read:
1697 return true;
1698 case CompileOrReadResult::Compiled:
1699 // We successfully compiled the module under a lock. Let's read it from
1700 // the in-memory module cache now.
1701 break;
1702 }
1703 } else {
1704 if (!compileModuleImpl(ImportingInstance, ImportLoc, ModuleNameLoc, Module,
1705 ModuleFileName))
1706 return false;
1707 }
1708
1709 return readASTAfterCompileModule(ImportingInstance, ImportLoc, ModuleNameLoc,
1710 Module, ModuleFileName,
1711 /*OutOfDate=*/nullptr, /*Missing=*/nullptr);
1712}
1713
1714/// Diagnose differences between the current definition of the given
1715/// configuration macro and the definition provided on the command line.
1716static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
1717 Module *Mod, SourceLocation ImportLoc) {
1718 IdentifierInfo *Id = PP.getIdentifierInfo(Name: ConfigMacro);
1719 SourceManager &SourceMgr = PP.getSourceManager();
1720
1721 // If this identifier has never had a macro definition, then it could
1722 // not have changed.
1723 if (!Id->hadMacroDefinition())
1724 return;
1725 auto *LatestLocalMD = PP.getLocalMacroDirectiveHistory(II: Id);
1726
1727 // Find the macro definition from the command line.
1728 MacroInfo *CmdLineDefinition = nullptr;
1729 for (auto *MD = LatestLocalMD; MD; MD = MD->getPrevious()) {
1730 SourceLocation MDLoc = MD->getLocation();
1731 FileID FID = SourceMgr.getFileID(SpellingLoc: MDLoc);
1732 if (FID.isInvalid())
1733 continue;
1734 // We only care about the predefines buffer, or if the macro is defined
1735 // over the command line transitively through a PCH.
1736 if (FID != PP.getPredefinesFileID() &&
1737 !SourceMgr.isWrittenInCommandLineFile(Loc: MDLoc))
1738 continue;
1739 if (auto *DMD = dyn_cast<DefMacroDirective>(Val: MD))
1740 CmdLineDefinition = DMD->getMacroInfo();
1741 break;
1742 }
1743
1744 auto *CurrentDefinition = PP.getMacroInfo(II: Id);
1745 if (CurrentDefinition == CmdLineDefinition) {
1746 // Macro matches. Nothing to do.
1747 } else if (!CurrentDefinition) {
1748 // This macro was defined on the command line, then #undef'd later.
1749 // Complain.
1750 PP.Diag(Loc: ImportLoc, DiagID: diag::warn_module_config_macro_undef)
1751 << true << ConfigMacro << Mod->getFullModuleName();
1752 auto LatestDef = LatestLocalMD->getDefinition();
1753 assert(LatestDef.isUndefined() &&
1754 "predefined macro went away with no #undef?");
1755 PP.Diag(Loc: LatestDef.getUndefLocation(), DiagID: diag::note_module_def_undef_here)
1756 << true;
1757 return;
1758 } else if (!CmdLineDefinition) {
1759 // There was no definition for this macro in the command line,
1760 // but there was a local definition. Complain.
1761 PP.Diag(Loc: ImportLoc, DiagID: diag::warn_module_config_macro_undef)
1762 << false << ConfigMacro << Mod->getFullModuleName();
1763 PP.Diag(Loc: CurrentDefinition->getDefinitionLoc(),
1764 DiagID: diag::note_module_def_undef_here)
1765 << false;
1766 } else if (!CurrentDefinition->isIdenticalTo(Other: *CmdLineDefinition, PP,
1767 /*Syntactically=*/true)) {
1768 // The macro definitions differ.
1769 PP.Diag(Loc: ImportLoc, DiagID: diag::warn_module_config_macro_undef)
1770 << false << ConfigMacro << Mod->getFullModuleName();
1771 PP.Diag(Loc: CurrentDefinition->getDefinitionLoc(),
1772 DiagID: diag::note_module_def_undef_here)
1773 << false;
1774 }
1775}
1776
1777static void checkConfigMacros(Preprocessor &PP, Module *M,
1778 SourceLocation ImportLoc) {
1779 clang::Module *TopModule = M->getTopLevelModule();
1780 for (const StringRef ConMacro : TopModule->ConfigMacros) {
1781 checkConfigMacro(PP, ConfigMacro: ConMacro, Mod: M, ImportLoc);
1782 }
1783}
1784
1785void CompilerInstance::createASTReader() {
1786 if (TheASTReader)
1787 return;
1788
1789 if (!hasASTContext())
1790 createASTContext();
1791
1792 // If we're implicitly building modules but not currently recursively
1793 // building a module, check whether we need to prune the module cache.
1794 if (getSourceManager().getModuleBuildStack().empty() &&
1795 !getPreprocessor()
1796 .getHeaderSearchInfo()
1797 .getSpecificModuleCachePath()
1798 .empty())
1799 ModCache->maybePrune(Path: getHeaderSearchOpts().ModuleCachePath,
1800 PruneInterval: getHeaderSearchOpts().ModuleCachePruneInterval,
1801 PruneAfter: getHeaderSearchOpts().ModuleCachePruneAfter);
1802
1803 HeaderSearchOptions &HSOpts = getHeaderSearchOpts();
1804 std::string Sysroot = HSOpts.Sysroot;
1805 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
1806 const FrontendOptions &FEOpts = getFrontendOpts();
1807 std::unique_ptr<llvm::Timer> ReadTimer;
1808
1809 if (timerGroup)
1810 ReadTimer = std::make_unique<llvm::Timer>(args: "reading_modules",
1811 args: "Reading modules", args&: *timerGroup);
1812 TheASTReader = llvm::makeIntrusiveRefCnt<ASTReader>(
1813 A&: getPreprocessor(), A&: getModuleCache(), A: &getASTContext(),
1814 A: getPCHContainerReader(), A&: getCodeGenOpts(),
1815 A&: getFrontendOpts().ModuleFileExtensions,
1816 A: Sysroot.empty() ? "" : Sysroot.c_str(),
1817 A: PPOpts.DisablePCHOrModuleValidation,
1818 /*AllowASTWithCompilerErrors=*/A: FEOpts.AllowPCMWithCompilerErrors,
1819 /*AllowConfigurationMismatch=*/A: false,
1820 A: +HSOpts.ModulesValidateSystemHeaders,
1821 A: +HSOpts.ModulesForceValidateUserHeaders,
1822 A: +HSOpts.ValidateASTInputFilesContent,
1823 A: +getFrontendOpts().UseGlobalModuleIndex, A: std::move(ReadTimer));
1824 if (hasASTConsumer()) {
1825 TheASTReader->setDeserializationListener(
1826 Listener: getASTConsumer().GetASTDeserializationListener());
1827 getASTContext().setASTMutationListener(
1828 getASTConsumer().GetASTMutationListener());
1829 }
1830 getASTContext().setExternalSource(TheASTReader);
1831 if (hasSema())
1832 TheASTReader->InitializeSema(S&: getSema());
1833 if (hasASTConsumer())
1834 TheASTReader->StartTranslationUnit(Consumer: &getASTConsumer());
1835
1836 for (auto &Listener : DependencyCollectors)
1837 Listener->attachToASTReader(R&: *TheASTReader);
1838}
1839
1840bool CompilerInstance::loadModuleFile(
1841 ModuleFileName FileName, serialization::ModuleFile *&LoadedModuleFile) {
1842 llvm::Timer Timer;
1843 if (timerGroup)
1844 Timer.init(TimerName: "preloading." + std::string(FileName.str()),
1845 TimerDescription: "Preloading " + std::string(FileName.str()), tg&: *timerGroup);
1846 llvm::TimeRegion TimeLoading(timerGroup ? &Timer : nullptr);
1847
1848 // If we don't already have an ASTReader, create one now.
1849 if (!TheASTReader)
1850 createASTReader();
1851
1852 // If -Wmodule-file-config-mismatch is mapped as an error or worse, allow the
1853 // ASTReader to diagnose it, since it can produce better errors that we can.
1854 bool ConfigMismatchIsRecoverable =
1855 getDiagnostics().getDiagnosticLevel(DiagID: diag::warn_ast_file_config_mismatch,
1856 Loc: SourceLocation()) <=
1857 DiagnosticsEngine::Warning;
1858
1859 auto Listener = std::make_unique<ReadModuleNames>(args&: *PP);
1860 auto &ListenerRef = *Listener;
1861 ASTReader::ListenerScope ReadModuleNamesListener(*TheASTReader,
1862 std::move(Listener));
1863
1864 // Try to load the module file.
1865 switch (TheASTReader->ReadAST(
1866 FileName, Type: serialization::MK_ExplicitModule, ImportLoc: SourceLocation(),
1867 ClientLoadCapabilities: ConfigMismatchIsRecoverable ? ASTReader::ARR_ConfigurationMismatch : 0,
1868 NewLoadedModuleFile: &LoadedModuleFile)) {
1869 case ASTReader::Success:
1870 // We successfully loaded the module file; remember the set of provided
1871 // modules so that we don't try to load implicit modules for them.
1872 ListenerRef.registerAll();
1873 return true;
1874
1875 case ASTReader::ConfigurationMismatch:
1876 // Ignore unusable module files.
1877 getDiagnostics().Report(Loc: SourceLocation(),
1878 DiagID: diag::warn_ast_file_config_mismatch)
1879 << FileName;
1880 // All modules provided by any files we tried and failed to load are now
1881 // unavailable; includes of those modules should now be handled textually.
1882 ListenerRef.markAllUnavailable();
1883 return true;
1884
1885 default:
1886 return false;
1887 }
1888}
1889
1890namespace {
1891enum ModuleSource {
1892 MS_ModuleNotFound,
1893 MS_ModuleCache,
1894 MS_PrebuiltModulePath,
1895 MS_ModuleBuildPragma
1896};
1897} // end namespace
1898
1899/// Select a source for loading the named module and compute the filename to
1900/// load it from.
1901static ModuleSource selectModuleSource(
1902 Module *M, StringRef ModuleName, ModuleFileName &ModuleFilename,
1903 const std::map<std::string, std::string, std::less<>> &BuiltModules,
1904 HeaderSearch &HS) {
1905 assert(ModuleFilename.empty() && "Already has a module source?");
1906
1907 // Check to see if the module has been built as part of this compilation
1908 // via a module build pragma.
1909 auto BuiltModuleIt = BuiltModules.find(x: ModuleName);
1910 if (BuiltModuleIt != BuiltModules.end()) {
1911 ModuleFilename = ModuleFileName::makeExplicit(Name: BuiltModuleIt->second);
1912 return MS_ModuleBuildPragma;
1913 }
1914
1915 // Try to load the module from the prebuilt module path.
1916 const HeaderSearchOptions &HSOpts = HS.getHeaderSearchOpts();
1917 if (!HSOpts.PrebuiltModuleFiles.empty() ||
1918 !HSOpts.PrebuiltModulePaths.empty()) {
1919 ModuleFilename = HS.getPrebuiltModuleFileName(ModuleName);
1920 if (HSOpts.EnablePrebuiltImplicitModules && ModuleFilename.empty())
1921 ModuleFilename = HS.getPrebuiltImplicitModuleFileName(Module: M);
1922 if (!ModuleFilename.empty())
1923 return MS_PrebuiltModulePath;
1924 }
1925
1926 // Try to load the module from the module cache.
1927 if (M) {
1928 ModuleFilename = HS.getCachedModuleFileName(Module: M);
1929 return MS_ModuleCache;
1930 }
1931
1932 return MS_ModuleNotFound;
1933}
1934
1935ModuleLoadResult CompilerInstance::findOrCompileModuleAndReadAST(
1936 StringRef ModuleName, SourceLocation ImportLoc, SourceRange ModuleNameRange,
1937 bool IsInclusionDirective) {
1938 // Search for a module with the given name.
1939 HeaderSearch &HS = PP->getHeaderSearchInfo();
1940 Module *M =
1941 HS.lookupModule(ModuleName, ImportLoc, AllowSearch: true, AllowExtraModuleMapSearch: !IsInclusionDirective);
1942
1943 // Check for any configuration macros that have changed. This is done
1944 // immediately before potentially building a module in case this module
1945 // depends on having one of its configuration macros defined to successfully
1946 // build. If this is not done the user will never see the warning.
1947 if (M)
1948 checkConfigMacros(PP&: getPreprocessor(), M, ImportLoc);
1949
1950 // Select the source and filename for loading the named module.
1951 ModuleFileName ModuleFilename;
1952 ModuleSource Source =
1953 selectModuleSource(M, ModuleName, ModuleFilename, BuiltModules, HS);
1954 SourceLocation ModuleNameLoc = ModuleNameRange.getBegin();
1955 if (Source == MS_ModuleNotFound) {
1956 // We can't find a module, error out here.
1957 getDiagnostics().Report(Loc: ModuleNameLoc, DiagID: diag::err_module_not_found)
1958 << ModuleName << ModuleNameRange;
1959 return nullptr;
1960 }
1961 if (ModuleFilename.empty()) {
1962 if (M && M->HasIncompatibleModuleFile) {
1963 // We tried and failed to load a module file for this module. Fall
1964 // back to textual inclusion for its headers.
1965 return ModuleLoadResult::ConfigMismatch;
1966 }
1967
1968 getDiagnostics().Report(Loc: ModuleNameLoc, DiagID: diag::err_module_build_disabled)
1969 << ModuleName;
1970 return nullptr;
1971 }
1972
1973 // Create an ASTReader on demand.
1974 if (!getASTReader())
1975 createASTReader();
1976
1977 // Time how long it takes to load the module.
1978 llvm::Timer Timer;
1979 if (timerGroup)
1980 Timer.init(TimerName: "loading." + std::string(ModuleFilename.str()),
1981 TimerDescription: "Loading " + std::string(ModuleFilename.str()), tg&: *timerGroup);
1982 llvm::TimeRegion TimeLoading(timerGroup ? &Timer : nullptr);
1983 llvm::TimeTraceScope TimeScope("Module Load", ModuleName);
1984
1985 // Try to load the module file. If we are not trying to load from the
1986 // module cache, we don't know how to rebuild modules.
1987 unsigned ARRFlags = Source == MS_ModuleCache
1988 ? ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing |
1989 ASTReader::ARR_TreatModuleWithErrorsAsOutOfDate
1990 : Source == MS_PrebuiltModulePath
1991 ? 0
1992 : ASTReader::ARR_ConfigurationMismatch;
1993 switch (getASTReader()->ReadAST(FileName: ModuleFilename,
1994 Type: Source == MS_PrebuiltModulePath
1995 ? serialization::MK_PrebuiltModule
1996 : Source == MS_ModuleBuildPragma
1997 ? serialization::MK_ExplicitModule
1998 : serialization::MK_ImplicitModule,
1999 ImportLoc, ClientLoadCapabilities: ARRFlags)) {
2000 case ASTReader::Success: {
2001 if (M)
2002 return M;
2003 assert(Source != MS_ModuleCache &&
2004 "missing module, but file loaded from cache");
2005
2006 // A prebuilt module is indexed as a ModuleFile; the Module does not exist
2007 // until the first call to ReadAST. Look it up now.
2008 M = HS.lookupModule(ModuleName, ImportLoc, AllowSearch: true, AllowExtraModuleMapSearch: !IsInclusionDirective);
2009
2010 // Check whether M refers to the file in the prebuilt module path.
2011 if (M && M->getASTFileKey() &&
2012 *M->getASTFileKey() ==
2013 getASTReader()->getModuleManager().makeKey(Name: ModuleFilename))
2014 return M;
2015
2016 getDiagnostics().Report(Loc: ModuleNameLoc, DiagID: diag::err_module_prebuilt)
2017 << ModuleName;
2018 return ModuleLoadResult();
2019 }
2020
2021 case ASTReader::OutOfDate:
2022 case ASTReader::Missing:
2023 // The most interesting case.
2024 break;
2025
2026 case ASTReader::ConfigurationMismatch:
2027 if (Source == MS_PrebuiltModulePath)
2028 // FIXME: We shouldn't be setting HadFatalFailure below if we only
2029 // produce a warning here!
2030 getDiagnostics().Report(Loc: SourceLocation(),
2031 DiagID: diag::warn_ast_file_config_mismatch)
2032 << ModuleFilename;
2033 // Fall through to error out.
2034 [[fallthrough]];
2035 case ASTReader::VersionMismatch:
2036 case ASTReader::HadErrors:
2037 ModuleLoader::HadFatalFailure = true;
2038 // FIXME: The ASTReader will already have complained, but can we shoehorn
2039 // that diagnostic information into a more useful form?
2040 return ModuleLoadResult();
2041
2042 case ASTReader::Failure:
2043 ModuleLoader::HadFatalFailure = true;
2044 return ModuleLoadResult();
2045 }
2046
2047 // ReadAST returned Missing or OutOfDate.
2048 if (Source != MS_ModuleCache) {
2049 // We don't know the desired configuration for this module and don't
2050 // necessarily even have a module map. Since ReadAST already produces
2051 // diagnostics for these two cases, we simply error out here.
2052 return ModuleLoadResult();
2053 }
2054
2055 // The module file is missing or out-of-date. Build it.
2056 assert(M && "missing module, but trying to compile for cache");
2057
2058 // Check whether there is a cycle in the module graph.
2059 ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
2060 ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
2061 for (; Pos != PosEnd; ++Pos) {
2062 if (Pos->first == ModuleName)
2063 break;
2064 }
2065
2066 if (Pos != PosEnd) {
2067 SmallString<256> CyclePath;
2068 for (; Pos != PosEnd; ++Pos) {
2069 CyclePath += Pos->first;
2070 CyclePath += " -> ";
2071 }
2072 CyclePath += ModuleName;
2073
2074 getDiagnostics().Report(Loc: ModuleNameLoc, DiagID: diag::err_module_cycle)
2075 << ModuleName << CyclePath;
2076 return nullptr;
2077 }
2078
2079 // Check whether we have already attempted to build this module (but failed).
2080 if (FailedModules.contains(key: ModuleName)) {
2081 getDiagnostics().Report(Loc: ModuleNameLoc, DiagID: diag::err_module_not_built)
2082 << ModuleName << SourceRange(ImportLoc, ModuleNameLoc);
2083 return nullptr;
2084 }
2085
2086 // Try to compile and then read the AST.
2087 if (!compileModuleAndReadAST(ImportingInstance&: *this, ImportLoc, ModuleNameLoc, Module: M,
2088 ModuleFileName: ModuleFilename)) {
2089 assert(getDiagnostics().hasErrorOccurred() &&
2090 "undiagnosed error in compileModuleAndReadAST");
2091 FailedModules.insert(key: ModuleName);
2092 return nullptr;
2093 }
2094
2095 // Okay, we've rebuilt and now loaded the module.
2096 return M;
2097}
2098
2099ModuleLoadResult
2100CompilerInstance::loadModule(SourceLocation ImportLoc,
2101 ModuleIdPath Path,
2102 Module::NameVisibilityKind Visibility,
2103 bool IsInclusionDirective) {
2104 // Determine what file we're searching from.
2105 StringRef ModuleName = Path[0].getIdentifierInfo()->getName();
2106 SourceLocation ModuleNameLoc = Path[0].getLoc();
2107
2108 // If we've already handled this import, just return the cached result.
2109 // This cache eliminates redundant diagnostics when both the preprocessor
2110 // and parser see the same import declaration.
2111 if (ImportLoc.isValid()) {
2112 auto CacheIt = ModuleImportResults.find(Val: ImportLoc);
2113 if (CacheIt != ModuleImportResults.end()) {
2114 if (CacheIt->second && ModuleName != getLangOpts().CurrentModule)
2115 TheASTReader->makeModuleVisible(Mod: CacheIt->second, NameVisibility: Visibility, ImportLoc);
2116 return CacheIt->second;
2117 }
2118 }
2119
2120 // If we don't already have information on this module, load the module now.
2121 Module *Module = nullptr;
2122 ModuleMap &MM = getPreprocessor().getHeaderSearchInfo().getModuleMap();
2123 if (auto MaybeModule = MM.getCachedModuleLoad(II: *Path[0].getIdentifierInfo())) {
2124 // Use the cached result, which may be nullptr.
2125 Module = *MaybeModule;
2126 // Config macros are already checked before building a module, but they need
2127 // to be checked at each import location in case any of the config macros
2128 // have a new value at the current `ImportLoc`.
2129 if (Module)
2130 checkConfigMacros(PP&: getPreprocessor(), M: Module, ImportLoc);
2131 } else if (ModuleName == getLangOpts().CurrentModule) {
2132 // This is the module we're building.
2133 Module = PP->getHeaderSearchInfo().lookupModule(
2134 ModuleName, ImportLoc, /*AllowSearch*/ true,
2135 /*AllowExtraModuleMapSearch*/ !IsInclusionDirective);
2136
2137 // Config macros do not need to be checked here for two reasons.
2138 // * This will always be textual inclusion, and thus the config macros
2139 // actually do impact the content of the header.
2140 // * `Preprocessor::HandleHeaderIncludeOrImport` will never call this
2141 // function as the `#include` or `#import` is textual.
2142
2143 MM.cacheModuleLoad(II: *Path[0].getIdentifierInfo(), M: Module);
2144 } else if (getPreprocessorOpts().SingleModuleParseMode) {
2145 // This mimics how findOrCompileModuleAndReadAST() finds the module.
2146 Module = getPreprocessor().getHeaderSearchInfo().lookupModule(
2147 ModuleName, ImportLoc, AllowSearch: true, AllowExtraModuleMapSearch: !IsInclusionDirective);
2148 if (Module) {
2149 if (PPCallbacks *PPCb = getPreprocessor().getPPCallbacks())
2150 PPCb->moduleLoadSkipped(Skipped: Module);
2151 // Mark the module and its submodules as if they were loaded from a PCM.
2152 // This prevents emission of the "missing submodule" diagnostic below.
2153 std::vector<clang::Module *> Worklist{Module};
2154 while (!Worklist.empty()) {
2155 clang::Module *M = Worklist.back();
2156 Worklist.pop_back();
2157 M->IsFromModuleFile = true;
2158 for (clang::Module *SubM : M->submodules())
2159 Worklist.push_back(x: SubM);
2160 }
2161 }
2162 MM.cacheModuleLoad(II: *Path[0].getIdentifierInfo(), M: Module);
2163 } else {
2164 SourceLocation ModuleNameEndLoc = Path.back().getLoc().getLocWithOffset(
2165 Offset: Path.back().getIdentifierInfo()->getLength());
2166 ModuleLoadResult Result = findOrCompileModuleAndReadAST(
2167 ModuleName, ImportLoc, ModuleNameRange: SourceRange{ModuleNameLoc, ModuleNameEndLoc},
2168 IsInclusionDirective);
2169 if (!Result.isNormal())
2170 return Result;
2171 if (!Result)
2172 DisableGeneratingGlobalModuleIndex = true;
2173 Module = Result;
2174 MM.cacheModuleLoad(II: *Path[0].getIdentifierInfo(), M: Module);
2175 }
2176
2177 // If we never found the module, fail. Otherwise, verify the module and link
2178 // it up.
2179 if (!Module)
2180 return ModuleLoadResult();
2181
2182 // Verify that the rest of the module path actually corresponds to
2183 // a submodule.
2184 bool MapPrivateSubModToTopLevel = false;
2185 for (unsigned I = 1, N = Path.size(); I != N; ++I) {
2186 StringRef Name = Path[I].getIdentifierInfo()->getName();
2187 clang::Module *Sub = Module->findSubmodule(Name);
2188
2189 // If the user is requesting Foo.Private and it doesn't exist, try to
2190 // match Foo_Private and emit a warning asking for the user to write
2191 // @import Foo_Private instead. FIXME: remove this when existing clients
2192 // migrate off of Foo.Private syntax.
2193 if (!Sub && Name == "Private" && Module == Module->getTopLevelModule()) {
2194 SmallString<128> PrivateModule(Module->Name);
2195 PrivateModule.append(RHS: "_Private");
2196
2197 SmallVector<IdentifierLoc, 2> PrivPath;
2198 auto &II = PP->getIdentifierTable().get(
2199 Name: PrivateModule, TokenCode: PP->getIdentifierInfo(Name: Module->Name)->getTokenID());
2200 PrivPath.emplace_back(Args: Path[0].getLoc(), Args: &II);
2201
2202 ModuleFileName FileName;
2203 // If there is a modulemap module or prebuilt module, load it.
2204 if (PP->getHeaderSearchInfo().lookupModule(ModuleName: PrivateModule, ImportLoc, AllowSearch: true,
2205 AllowExtraModuleMapSearch: !IsInclusionDirective) ||
2206 selectModuleSource(M: nullptr, ModuleName: PrivateModule, ModuleFilename&: FileName, BuiltModules,
2207 HS&: PP->getHeaderSearchInfo()) != MS_ModuleNotFound)
2208 Sub = loadModule(ImportLoc, Path: PrivPath, Visibility, IsInclusionDirective);
2209 if (Sub) {
2210 MapPrivateSubModToTopLevel = true;
2211 PP->markClangModuleAsAffecting(M: Module);
2212 if (!getDiagnostics().isIgnored(
2213 DiagID: diag::warn_no_priv_submodule_use_toplevel, Loc: ImportLoc)) {
2214 getDiagnostics().Report(Loc: Path[I].getLoc(),
2215 DiagID: diag::warn_no_priv_submodule_use_toplevel)
2216 << Path[I].getIdentifierInfo() << Module->getFullModuleName()
2217 << PrivateModule
2218 << SourceRange(Path[0].getLoc(), Path[I].getLoc())
2219 << FixItHint::CreateReplacement(RemoveRange: SourceRange(Path[0].getLoc()),
2220 Code: PrivateModule);
2221 getDiagnostics().Report(Loc: Sub->DefinitionLoc,
2222 DiagID: diag::note_private_top_level_defined);
2223 }
2224 }
2225 }
2226
2227 if (!Sub) {
2228 // Attempt to perform typo correction to find a module name that works.
2229 SmallVector<StringRef, 2> Best;
2230 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
2231
2232 for (class Module *SubModule : Module->submodules()) {
2233 unsigned ED =
2234 Name.edit_distance(Other: SubModule->Name,
2235 /*AllowReplacements=*/true, MaxEditDistance: BestEditDistance);
2236 if (ED <= BestEditDistance) {
2237 if (ED < BestEditDistance) {
2238 Best.clear();
2239 BestEditDistance = ED;
2240 }
2241
2242 Best.push_back(Elt: SubModule->Name);
2243 }
2244 }
2245
2246 // If there was a clear winner, user it.
2247 if (Best.size() == 1) {
2248 getDiagnostics().Report(Loc: Path[I].getLoc(),
2249 DiagID: diag::err_no_submodule_suggest)
2250 << Path[I].getIdentifierInfo() << Module->getFullModuleName()
2251 << Best[0] << SourceRange(Path[0].getLoc(), Path[I - 1].getLoc())
2252 << FixItHint::CreateReplacement(RemoveRange: SourceRange(Path[I].getLoc()),
2253 Code: Best[0]);
2254
2255 Sub = Module->findSubmodule(Name: Best[0]);
2256 }
2257 }
2258
2259 if (!Sub) {
2260 // No submodule by this name. Complain, and don't look for further
2261 // submodules.
2262 getDiagnostics().Report(Loc: Path[I].getLoc(), DiagID: diag::err_no_submodule)
2263 << Path[I].getIdentifierInfo() << Module->getFullModuleName()
2264 << SourceRange(Path[0].getLoc(), Path[I - 1].getLoc());
2265 break;
2266 }
2267
2268 Module = Sub;
2269 }
2270
2271 // Make the named module visible, if it's not already part of the module
2272 // we are parsing.
2273 if (ModuleName != getLangOpts().CurrentModule) {
2274 if (!Module->IsFromModuleFile && !MapPrivateSubModToTopLevel) {
2275 // We have an umbrella header or directory that doesn't actually include
2276 // all of the headers within the directory it covers. Complain about
2277 // this missing submodule and recover by forgetting that we ever saw
2278 // this submodule.
2279 // FIXME: Should we detect this at module load time? It seems fairly
2280 // expensive (and rare).
2281 getDiagnostics().Report(Loc: ImportLoc, DiagID: diag::warn_missing_submodule)
2282 << Module->getFullModuleName()
2283 << SourceRange(Path.front().getLoc(), Path.back().getLoc());
2284
2285 return ModuleLoadResult(Module, ModuleLoadResult::MissingExpected);
2286 }
2287
2288 // Check whether this module is available.
2289 if (Preprocessor::checkModuleIsAvailable(LangOpts: getLangOpts(), TargetInfo: getTarget(),
2290 M: *Module, Diags&: getDiagnostics())) {
2291 getDiagnostics().Report(Loc: ImportLoc, DiagID: diag::note_module_import_here)
2292 << SourceRange(Path.front().getLoc(), Path.back().getLoc());
2293 ModuleImportResults[ImportLoc] = ModuleLoadResult();
2294 return ModuleLoadResult();
2295 }
2296
2297 TheASTReader->makeModuleVisible(Mod: Module, NameVisibility: Visibility, ImportLoc);
2298 }
2299
2300 // Resolve any remaining module using export_as for this one.
2301 getPreprocessor()
2302 .getHeaderSearchInfo()
2303 .getModuleMap()
2304 .resolveLinkAsDependencies(Mod: Module->getTopLevelModule());
2305
2306 ModuleImportResults[ImportLoc] = ModuleLoadResult(Module);
2307 return ModuleLoadResult(Module);
2308}
2309
2310void CompilerInstance::createModuleFromSource(SourceLocation ImportLoc,
2311 StringRef ModuleName,
2312 StringRef Source) {
2313 // Avoid creating filenames with special characters.
2314 SmallString<128> CleanModuleName(ModuleName);
2315 for (auto &C : CleanModuleName)
2316 if (!isAlphanumeric(c: C))
2317 C = '_';
2318
2319 // FIXME: Using a randomized filename here means that our intermediate .pcm
2320 // output is nondeterministic (as .pcm files refer to each other by name).
2321 // Can this affect the output in any way?
2322 SmallString<128> ModuleFileName;
2323 int FD;
2324 if (std::error_code EC = llvm::sys::fs::createTemporaryFile(
2325 Prefix: CleanModuleName, Suffix: "pcm", ResultFD&: FD, ResultPath&: ModuleFileName)) {
2326 getDiagnostics().Report(Loc: ImportLoc, DiagID: diag::err_fe_unable_to_open_output)
2327 << ModuleFileName << EC.message();
2328 return;
2329 }
2330 std::string ModuleMapFileName = (CleanModuleName + ".map").str();
2331
2332 FrontendInputFile Input(
2333 ModuleMapFileName,
2334 InputKind(getLanguageFromOptions(LangOpts: Invocation->getLangOpts()),
2335 InputKind::ModuleMap, /*Preprocessed*/true));
2336
2337 std::string NullTerminatedSource(Source.str());
2338
2339 auto Other = cloneForModuleCompileImpl(ImportLoc, ModuleName, Input,
2340 OriginalModuleMapFile: StringRef(), ModuleFileName);
2341
2342 // Create a virtual file containing our desired source.
2343 // FIXME: We shouldn't need to do this.
2344 FileEntryRef ModuleMapFile = Other->getFileManager().getVirtualFileRef(
2345 Filename: ModuleMapFileName, Size: NullTerminatedSource.size(), ModificationTime: 0);
2346 Other->getSourceManager().overrideFileContents(
2347 SourceFile: ModuleMapFile, Buffer: llvm::MemoryBuffer::getMemBuffer(InputData: NullTerminatedSource));
2348
2349 Other->BuiltModules = std::move(BuiltModules);
2350 Other->DeleteBuiltModules = false;
2351
2352 // Build the module, inheriting any modules that we've built locally.
2353 std::unique_ptr<llvm::MemoryBuffer> Buffer =
2354 compileModule(ImportLoc, ModuleName, ModuleFileName, Instance&: *Other);
2355 BuiltModules = std::move(Other->BuiltModules);
2356
2357 if (Buffer) {
2358 llvm::raw_fd_ostream OS(FD, /*shouldClose=*/true);
2359 BuiltModules[std::string(ModuleName)] = std::string(ModuleFileName);
2360 OS << Buffer->getBuffer();
2361 llvm::sys::RemoveFileOnSignal(Filename: ModuleFileName);
2362 }
2363}
2364
2365void CompilerInstance::makeModuleVisible(Module *Mod,
2366 Module::NameVisibilityKind Visibility,
2367 SourceLocation ImportLoc) {
2368 if (!TheASTReader)
2369 createASTReader();
2370 if (!TheASTReader)
2371 return;
2372
2373 TheASTReader->makeModuleVisible(Mod, NameVisibility: Visibility, ImportLoc);
2374}
2375
2376GlobalModuleIndex *CompilerInstance::loadGlobalModuleIndex(
2377 SourceLocation TriggerLoc) {
2378 if (getPreprocessor()
2379 .getHeaderSearchInfo()
2380 .getSpecificModuleCachePath()
2381 .empty())
2382 return nullptr;
2383 if (!TheASTReader)
2384 createASTReader();
2385 // Can't do anything if we don't have the module manager.
2386 if (!TheASTReader)
2387 return nullptr;
2388 // Get an existing global index. This loads it if not already
2389 // loaded.
2390 TheASTReader->loadGlobalIndex();
2391 GlobalModuleIndex *GlobalIndex = TheASTReader->getGlobalIndex();
2392 // If the global index doesn't exist, create it.
2393 if (!GlobalIndex && shouldBuildGlobalModuleIndex() && hasFileManager() &&
2394 hasPreprocessor()) {
2395 llvm::sys::fs::create_directories(
2396 path: getPreprocessor().getHeaderSearchInfo().getSpecificModuleCachePath());
2397 if (llvm::Error Err = GlobalModuleIndex::writeIndex(
2398 FileMgr&: getFileManager(), PCHContainerRdr: getPCHContainerReader(),
2399 Path: getPreprocessor()
2400 .getHeaderSearchInfo()
2401 .getSpecificModuleCachePath())) {
2402 // FIXME this drops the error on the floor. This code is only used for
2403 // typo correction and drops more than just this one source of errors
2404 // (such as the directory creation failure above). It should handle the
2405 // error.
2406 consumeError(Err: std::move(Err));
2407 return nullptr;
2408 }
2409 TheASTReader->resetForReload();
2410 TheASTReader->loadGlobalIndex();
2411 GlobalIndex = TheASTReader->getGlobalIndex();
2412 }
2413 // For finding modules needing to be imported for fixit messages,
2414 // we need to make the global index cover all modules, so we do that here.
2415 if (!HaveFullGlobalModuleIndex && GlobalIndex && !buildingModule()) {
2416 ModuleMap &MMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
2417
2418 // Load modules that were parsed from module maps but not loaded yet.
2419 MMap.loadAllParsedModules();
2420
2421 bool RecreateIndex = false;
2422 for (ModuleMap::module_iterator I = MMap.module_begin(),
2423 E = MMap.module_end(); I != E; ++I) {
2424 Module *TheModule = I->second;
2425 if (!TheModule->getASTFileKey()) {
2426 SmallVector<IdentifierLoc, 2> Path;
2427 Path.emplace_back(Args&: TriggerLoc,
2428 Args: getPreprocessor().getIdentifierInfo(Name: TheModule->Name));
2429 std::reverse(first: Path.begin(), last: Path.end());
2430 // Load a module as hidden. This also adds it to the global index.
2431 loadModule(ImportLoc: TheModule->DefinitionLoc, Path, Visibility: Module::Hidden, IsInclusionDirective: false);
2432 RecreateIndex = true;
2433 }
2434 }
2435 if (RecreateIndex) {
2436 if (llvm::Error Err = GlobalModuleIndex::writeIndex(
2437 FileMgr&: getFileManager(), PCHContainerRdr: getPCHContainerReader(),
2438 Path: getPreprocessor()
2439 .getHeaderSearchInfo()
2440 .getSpecificModuleCachePath())) {
2441 // FIXME As above, this drops the error on the floor.
2442 consumeError(Err: std::move(Err));
2443 return nullptr;
2444 }
2445 TheASTReader->resetForReload();
2446 TheASTReader->loadGlobalIndex();
2447 GlobalIndex = TheASTReader->getGlobalIndex();
2448 }
2449 HaveFullGlobalModuleIndex = true;
2450 }
2451 return GlobalIndex;
2452}
2453
2454// Check global module index for missing imports.
2455bool
2456CompilerInstance::lookupMissingImports(StringRef Name,
2457 SourceLocation TriggerLoc) {
2458 // Look for the symbol in non-imported modules, but only if an error
2459 // actually occurred.
2460 if (!buildingModule()) {
2461 // Load global module index, or retrieve a previously loaded one.
2462 GlobalModuleIndex *GlobalIndex = loadGlobalModuleIndex(
2463 TriggerLoc);
2464
2465 // Only if we have a global index.
2466 if (GlobalIndex) {
2467 GlobalModuleIndex::HitSet FoundModules;
2468
2469 // Find the modules that reference the identifier.
2470 // Note that this only finds top-level modules.
2471 // We'll let diagnoseTypo find the actual declaration module.
2472 if (GlobalIndex->lookupIdentifier(Name, Hits&: FoundModules))
2473 return true;
2474 }
2475 }
2476
2477 return false;
2478}
2479void CompilerInstance::resetAndLeakSema() { llvm::BuryPointer(Ptr: takeSema()); }
2480
2481void CompilerInstance::setExternalSemaSource(
2482 IntrusiveRefCntPtr<ExternalSemaSource> ESS) {
2483 ExternalSemaSrc = std::move(ESS);
2484}
2485