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/CharInfo.h"
14 #include "clang/Basic/Diagnostic.h"
15 #include "clang/Basic/FileManager.h"
16 #include "clang/Basic/LangStandard.h"
17 #include "clang/Basic/SourceManager.h"
18 #include "clang/Basic/Stack.h"
19 #include "clang/Basic/TargetInfo.h"
20 #include "clang/Basic/Version.h"
21 #include "clang/Config/config.h"
22 #include "clang/Frontend/ChainedDiagnosticConsumer.h"
23 #include "clang/Frontend/FrontendAction.h"
24 #include "clang/Frontend/FrontendActions.h"
25 #include "clang/Frontend/FrontendDiagnostic.h"
26 #include "clang/Frontend/LogDiagnosticPrinter.h"
27 #include "clang/Frontend/SerializedDiagnosticPrinter.h"
28 #include "clang/Frontend/TextDiagnosticPrinter.h"
29 #include "clang/Frontend/Utils.h"
30 #include "clang/Frontend/VerifyDiagnosticConsumer.h"
31 #include "clang/Lex/HeaderSearch.h"
32 #include "clang/Lex/Preprocessor.h"
33 #include "clang/Lex/PreprocessorOptions.h"
34 #include "clang/Sema/CodeCompleteConsumer.h"
35 #include "clang/Sema/Sema.h"
36 #include "clang/Serialization/ASTReader.h"
37 #include "clang/Serialization/GlobalModuleIndex.h"
38 #include "clang/Serialization/InMemoryModuleCache.h"
39 #include "llvm/ADT/Statistic.h"
40 #include "llvm/Support/BuryPointer.h"
41 #include "llvm/Support/CrashRecoveryContext.h"
42 #include "llvm/Support/Errc.h"
43 #include "llvm/Support/FileSystem.h"
44 #include "llvm/Support/Host.h"
45 #include "llvm/Support/LockFileManager.h"
46 #include "llvm/Support/MemoryBuffer.h"
47 #include "llvm/Support/Path.h"
48 #include "llvm/Support/Program.h"
49 #include "llvm/Support/Signals.h"
50 #include "llvm/Support/TimeProfiler.h"
51 #include "llvm/Support/Timer.h"
52 #include "llvm/Support/raw_ostream.h"
53 #include <time.h>
54 #include <utility>
55
56 using namespace clang;
57
CompilerInstance(std::shared_ptr<PCHContainerOperations> PCHContainerOps,InMemoryModuleCache * SharedModuleCache)58 CompilerInstance::CompilerInstance(
59 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
60 InMemoryModuleCache *SharedModuleCache)
61 : ModuleLoader(/* BuildingModule = */ SharedModuleCache),
62 Invocation(new CompilerInvocation()),
63 ModuleCache(SharedModuleCache ? SharedModuleCache
64 : new InMemoryModuleCache),
65 ThePCHContainerOperations(std::move(PCHContainerOps)) {}
66
~CompilerInstance()67 CompilerInstance::~CompilerInstance() {
68 assert(OutputFiles.empty() && "Still output files in flight?");
69 }
70
setInvocation(std::shared_ptr<CompilerInvocation> Value)71 void CompilerInstance::setInvocation(
72 std::shared_ptr<CompilerInvocation> Value) {
73 Invocation = std::move(Value);
74 }
75
shouldBuildGlobalModuleIndex() const76 bool CompilerInstance::shouldBuildGlobalModuleIndex() const {
77 return (BuildGlobalModuleIndex ||
78 (TheASTReader && TheASTReader->isGlobalIndexUnavailable() &&
79 getFrontendOpts().GenerateGlobalModuleIndex)) &&
80 !DisableGeneratingGlobalModuleIndex;
81 }
82
setDiagnostics(DiagnosticsEngine * Value)83 void CompilerInstance::setDiagnostics(DiagnosticsEngine *Value) {
84 Diagnostics = Value;
85 }
86
setVerboseOutputStream(raw_ostream & Value)87 void CompilerInstance::setVerboseOutputStream(raw_ostream &Value) {
88 OwnedVerboseOutputStream.reset();
89 VerboseOutputStream = &Value;
90 }
91
setVerboseOutputStream(std::unique_ptr<raw_ostream> Value)92 void CompilerInstance::setVerboseOutputStream(std::unique_ptr<raw_ostream> Value) {
93 OwnedVerboseOutputStream.swap(Value);
94 VerboseOutputStream = OwnedVerboseOutputStream.get();
95 }
96
setTarget(TargetInfo * Value)97 void CompilerInstance::setTarget(TargetInfo *Value) { Target = Value; }
setAuxTarget(TargetInfo * Value)98 void CompilerInstance::setAuxTarget(TargetInfo *Value) { AuxTarget = Value; }
99
createTarget()100 bool CompilerInstance::createTarget() {
101 // Create the target instance.
102 setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(),
103 getInvocation().TargetOpts));
104 if (!hasTarget())
105 return false;
106
107 // Check whether AuxTarget exists, if not, then create TargetInfo for the
108 // other side of CUDA/OpenMP/SYCL compilation.
109 if (!getAuxTarget() &&
110 (getLangOpts().CUDA || getLangOpts().OpenMPIsDevice ||
111 getLangOpts().SYCLIsDevice) &&
112 !getFrontendOpts().AuxTriple.empty()) {
113 auto TO = std::make_shared<TargetOptions>();
114 TO->Triple = llvm::Triple::normalize(getFrontendOpts().AuxTriple);
115 if (getFrontendOpts().AuxTargetCPU)
116 TO->CPU = getFrontendOpts().AuxTargetCPU.getValue();
117 if (getFrontendOpts().AuxTargetFeatures)
118 TO->FeaturesAsWritten = getFrontendOpts().AuxTargetFeatures.getValue();
119 TO->HostTriple = getTarget().getTriple().str();
120 setAuxTarget(TargetInfo::CreateTargetInfo(getDiagnostics(), TO));
121 }
122
123 if (!getTarget().hasStrictFP() && !getLangOpts().ExpStrictFP) {
124 if (getLangOpts().getFPRoundingMode() !=
125 llvm::RoundingMode::NearestTiesToEven) {
126 getDiagnostics().Report(diag::warn_fe_backend_unsupported_fp_rounding);
127 getLangOpts().setFPRoundingMode(llvm::RoundingMode::NearestTiesToEven);
128 }
129 if (getLangOpts().getFPExceptionMode() != LangOptions::FPE_Ignore) {
130 getDiagnostics().Report(diag::warn_fe_backend_unsupported_fp_exceptions);
131 getLangOpts().setFPExceptionMode(LangOptions::FPE_Ignore);
132 }
133 // FIXME: can we disable FEnvAccess?
134 }
135
136 // We should do it here because target knows nothing about
137 // language options when it's being created.
138 if (getLangOpts().OpenCL &&
139 !getTarget().validateOpenCLTarget(getLangOpts(), getDiagnostics()))
140 return false;
141
142 // Inform the target of the language options.
143 // FIXME: We shouldn't need to do this, the target should be immutable once
144 // created. This complexity should be lifted elsewhere.
145 getTarget().adjust(getDiagnostics(), getLangOpts());
146
147 // Adjust target options based on codegen options.
148 getTarget().adjustTargetOptions(getCodeGenOpts(), getTargetOpts());
149
150 if (auto *Aux = getAuxTarget())
151 getTarget().setAuxTarget(Aux);
152
153 return true;
154 }
155
getVirtualFileSystem() const156 llvm::vfs::FileSystem &CompilerInstance::getVirtualFileSystem() const {
157 return getFileManager().getVirtualFileSystem();
158 }
159
setFileManager(FileManager * Value)160 void CompilerInstance::setFileManager(FileManager *Value) {
161 FileMgr = Value;
162 }
163
setSourceManager(SourceManager * Value)164 void CompilerInstance::setSourceManager(SourceManager *Value) {
165 SourceMgr = Value;
166 }
167
setPreprocessor(std::shared_ptr<Preprocessor> Value)168 void CompilerInstance::setPreprocessor(std::shared_ptr<Preprocessor> Value) {
169 PP = std::move(Value);
170 }
171
setASTContext(ASTContext * Value)172 void CompilerInstance::setASTContext(ASTContext *Value) {
173 Context = Value;
174
175 if (Context && Consumer)
176 getASTConsumer().Initialize(getASTContext());
177 }
178
setSema(Sema * S)179 void CompilerInstance::setSema(Sema *S) {
180 TheSema.reset(S);
181 }
182
setASTConsumer(std::unique_ptr<ASTConsumer> Value)183 void CompilerInstance::setASTConsumer(std::unique_ptr<ASTConsumer> Value) {
184 Consumer = std::move(Value);
185
186 if (Context && Consumer)
187 getASTConsumer().Initialize(getASTContext());
188 }
189
setCodeCompletionConsumer(CodeCompleteConsumer * Value)190 void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
191 CompletionConsumer.reset(Value);
192 }
193
takeSema()194 std::unique_ptr<Sema> CompilerInstance::takeSema() {
195 return std::move(TheSema);
196 }
197
getASTReader() const198 IntrusiveRefCntPtr<ASTReader> CompilerInstance::getASTReader() const {
199 return TheASTReader;
200 }
setASTReader(IntrusiveRefCntPtr<ASTReader> Reader)201 void CompilerInstance::setASTReader(IntrusiveRefCntPtr<ASTReader> Reader) {
202 assert(ModuleCache.get() == &Reader->getModuleManager().getModuleCache() &&
203 "Expected ASTReader to use the same PCM cache");
204 TheASTReader = std::move(Reader);
205 }
206
207 std::shared_ptr<ModuleDependencyCollector>
getModuleDepCollector() const208 CompilerInstance::getModuleDepCollector() const {
209 return ModuleDepCollector;
210 }
211
setModuleDepCollector(std::shared_ptr<ModuleDependencyCollector> Collector)212 void CompilerInstance::setModuleDepCollector(
213 std::shared_ptr<ModuleDependencyCollector> Collector) {
214 ModuleDepCollector = std::move(Collector);
215 }
216
collectHeaderMaps(const HeaderSearch & HS,std::shared_ptr<ModuleDependencyCollector> MDC)217 static void collectHeaderMaps(const HeaderSearch &HS,
218 std::shared_ptr<ModuleDependencyCollector> MDC) {
219 SmallVector<std::string, 4> HeaderMapFileNames;
220 HS.getHeaderMapFileNames(HeaderMapFileNames);
221 for (auto &Name : HeaderMapFileNames)
222 MDC->addFile(Name);
223 }
224
collectIncludePCH(CompilerInstance & CI,std::shared_ptr<ModuleDependencyCollector> MDC)225 static void collectIncludePCH(CompilerInstance &CI,
226 std::shared_ptr<ModuleDependencyCollector> MDC) {
227 const PreprocessorOptions &PPOpts = CI.getPreprocessorOpts();
228 if (PPOpts.ImplicitPCHInclude.empty())
229 return;
230
231 StringRef PCHInclude = PPOpts.ImplicitPCHInclude;
232 FileManager &FileMgr = CI.getFileManager();
233 auto PCHDir = FileMgr.getDirectory(PCHInclude);
234 if (!PCHDir) {
235 MDC->addFile(PCHInclude);
236 return;
237 }
238
239 std::error_code EC;
240 SmallString<128> DirNative;
241 llvm::sys::path::native((*PCHDir)->getName(), DirNative);
242 llvm::vfs::FileSystem &FS = FileMgr.getVirtualFileSystem();
243 SimpleASTReaderListener Validator(CI.getPreprocessor());
244 for (llvm::vfs::directory_iterator Dir = FS.dir_begin(DirNative, EC), DirEnd;
245 Dir != DirEnd && !EC; Dir.increment(EC)) {
246 // Check whether this is an AST file. ASTReader::isAcceptableASTFile is not
247 // used here since we're not interested in validating the PCH at this time,
248 // but only to check whether this is a file containing an AST.
249 if (!ASTReader::readASTFileControlBlock(
250 Dir->path(), FileMgr, CI.getPCHContainerReader(),
251 /*FindModuleFileExtensions=*/false, Validator,
252 /*ValidateDiagnosticOptions=*/false))
253 MDC->addFile(Dir->path());
254 }
255 }
256
collectVFSEntries(CompilerInstance & CI,std::shared_ptr<ModuleDependencyCollector> MDC)257 static void collectVFSEntries(CompilerInstance &CI,
258 std::shared_ptr<ModuleDependencyCollector> MDC) {
259 if (CI.getHeaderSearchOpts().VFSOverlayFiles.empty())
260 return;
261
262 // Collect all VFS found.
263 SmallVector<llvm::vfs::YAMLVFSEntry, 16> VFSEntries;
264 for (const std::string &VFSFile : CI.getHeaderSearchOpts().VFSOverlayFiles) {
265 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Buffer =
266 llvm::MemoryBuffer::getFile(VFSFile);
267 if (!Buffer)
268 return;
269 llvm::vfs::collectVFSFromYAML(std::move(Buffer.get()),
270 /*DiagHandler*/ nullptr, VFSFile, VFSEntries);
271 }
272
273 for (auto &E : VFSEntries)
274 MDC->addFile(E.VPath, E.RPath);
275 }
276
277 // Diagnostics
SetUpDiagnosticLog(DiagnosticOptions * DiagOpts,const CodeGenOptions * CodeGenOpts,DiagnosticsEngine & Diags)278 static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts,
279 const CodeGenOptions *CodeGenOpts,
280 DiagnosticsEngine &Diags) {
281 std::error_code EC;
282 std::unique_ptr<raw_ostream> StreamOwner;
283 raw_ostream *OS = &llvm::errs();
284 if (DiagOpts->DiagnosticLogFile != "-") {
285 // Create the output stream.
286 auto FileOS = std::make_unique<llvm::raw_fd_ostream>(
287 DiagOpts->DiagnosticLogFile, EC,
288 llvm::sys::fs::OF_Append | llvm::sys::fs::OF_TextWithCRLF);
289 if (EC) {
290 Diags.Report(diag::warn_fe_cc_log_diagnostics_failure)
291 << DiagOpts->DiagnosticLogFile << EC.message();
292 } else {
293 FileOS->SetUnbuffered();
294 OS = FileOS.get();
295 StreamOwner = std::move(FileOS);
296 }
297 }
298
299 // Chain in the diagnostic client which will log the diagnostics.
300 auto Logger = std::make_unique<LogDiagnosticPrinter>(*OS, DiagOpts,
301 std::move(StreamOwner));
302 if (CodeGenOpts)
303 Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
304 if (Diags.ownsClient()) {
305 Diags.setClient(
306 new ChainedDiagnosticConsumer(Diags.takeClient(), std::move(Logger)));
307 } else {
308 Diags.setClient(
309 new ChainedDiagnosticConsumer(Diags.getClient(), std::move(Logger)));
310 }
311 }
312
SetupSerializedDiagnostics(DiagnosticOptions * DiagOpts,DiagnosticsEngine & Diags,StringRef OutputFile)313 static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts,
314 DiagnosticsEngine &Diags,
315 StringRef OutputFile) {
316 auto SerializedConsumer =
317 clang::serialized_diags::create(OutputFile, DiagOpts);
318
319 if (Diags.ownsClient()) {
320 Diags.setClient(new ChainedDiagnosticConsumer(
321 Diags.takeClient(), std::move(SerializedConsumer)));
322 } else {
323 Diags.setClient(new ChainedDiagnosticConsumer(
324 Diags.getClient(), std::move(SerializedConsumer)));
325 }
326 }
327
createDiagnostics(DiagnosticConsumer * Client,bool ShouldOwnClient)328 void CompilerInstance::createDiagnostics(DiagnosticConsumer *Client,
329 bool ShouldOwnClient) {
330 Diagnostics = createDiagnostics(&getDiagnosticOpts(), Client,
331 ShouldOwnClient, &getCodeGenOpts());
332 }
333
334 IntrusiveRefCntPtr<DiagnosticsEngine>
createDiagnostics(DiagnosticOptions * Opts,DiagnosticConsumer * Client,bool ShouldOwnClient,const CodeGenOptions * CodeGenOpts)335 CompilerInstance::createDiagnostics(DiagnosticOptions *Opts,
336 DiagnosticConsumer *Client,
337 bool ShouldOwnClient,
338 const CodeGenOptions *CodeGenOpts) {
339 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
340 IntrusiveRefCntPtr<DiagnosticsEngine>
341 Diags(new DiagnosticsEngine(DiagID, Opts));
342
343 // Create the diagnostic client for reporting errors or for
344 // implementing -verify.
345 if (Client) {
346 Diags->setClient(Client, ShouldOwnClient);
347 } else
348 Diags->setClient(new TextDiagnosticPrinter(llvm::errs(), Opts));
349
350 // Chain in -verify checker, if requested.
351 if (Opts->VerifyDiagnostics)
352 Diags->setClient(new VerifyDiagnosticConsumer(*Diags));
353
354 // Chain in -diagnostic-log-file dumper, if requested.
355 if (!Opts->DiagnosticLogFile.empty())
356 SetUpDiagnosticLog(Opts, CodeGenOpts, *Diags);
357
358 if (!Opts->DiagnosticSerializationFile.empty())
359 SetupSerializedDiagnostics(Opts, *Diags,
360 Opts->DiagnosticSerializationFile);
361
362 // Configure our handling of diagnostics.
363 ProcessWarningOptions(*Diags, *Opts);
364
365 return Diags;
366 }
367
368 // File Manager
369
createFileManager(IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS)370 FileManager *CompilerInstance::createFileManager(
371 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS) {
372 if (!VFS)
373 VFS = FileMgr ? &FileMgr->getVirtualFileSystem()
374 : createVFSFromCompilerInvocation(getInvocation(),
375 getDiagnostics());
376 assert(VFS && "FileManager has no VFS?");
377 FileMgr = new FileManager(getFileSystemOpts(), std::move(VFS));
378 return FileMgr.get();
379 }
380
381 // Source Manager
382
createSourceManager(FileManager & FileMgr)383 void CompilerInstance::createSourceManager(FileManager &FileMgr) {
384 SourceMgr = new SourceManager(getDiagnostics(), FileMgr);
385 }
386
387 // Initialize the remapping of files to alternative contents, e.g.,
388 // those specified through other files.
InitializeFileRemapping(DiagnosticsEngine & Diags,SourceManager & SourceMgr,FileManager & FileMgr,const PreprocessorOptions & InitOpts)389 static void InitializeFileRemapping(DiagnosticsEngine &Diags,
390 SourceManager &SourceMgr,
391 FileManager &FileMgr,
392 const PreprocessorOptions &InitOpts) {
393 // Remap files in the source manager (with buffers).
394 for (const auto &RB : InitOpts.RemappedFileBuffers) {
395 // Create the file entry for the file that we're mapping from.
396 const FileEntry *FromFile =
397 FileMgr.getVirtualFile(RB.first, RB.second->getBufferSize(), 0);
398 if (!FromFile) {
399 Diags.Report(diag::err_fe_remap_missing_from_file) << RB.first;
400 if (!InitOpts.RetainRemappedFileBuffers)
401 delete RB.second;
402 continue;
403 }
404
405 // Override the contents of the "from" file with the contents of the
406 // "to" file. If the caller owns the buffers, then pass a MemoryBufferRef;
407 // otherwise, pass as a std::unique_ptr<MemoryBuffer> to transfer ownership
408 // to the SourceManager.
409 if (InitOpts.RetainRemappedFileBuffers)
410 SourceMgr.overrideFileContents(FromFile, RB.second->getMemBufferRef());
411 else
412 SourceMgr.overrideFileContents(
413 FromFile, std::unique_ptr<llvm::MemoryBuffer>(
414 const_cast<llvm::MemoryBuffer *>(RB.second)));
415 }
416
417 // Remap files in the source manager (with other files).
418 for (const auto &RF : InitOpts.RemappedFiles) {
419 // Find the file that we're mapping to.
420 auto ToFile = FileMgr.getFile(RF.second);
421 if (!ToFile) {
422 Diags.Report(diag::err_fe_remap_missing_to_file) << RF.first << RF.second;
423 continue;
424 }
425
426 // Create the file entry for the file that we're mapping from.
427 const FileEntry *FromFile =
428 FileMgr.getVirtualFile(RF.first, (*ToFile)->getSize(), 0);
429 if (!FromFile) {
430 Diags.Report(diag::err_fe_remap_missing_from_file) << RF.first;
431 continue;
432 }
433
434 // Override the contents of the "from" file with the contents of
435 // the "to" file.
436 SourceMgr.overrideFileContents(FromFile, *ToFile);
437 }
438
439 SourceMgr.setOverridenFilesKeepOriginalName(
440 InitOpts.RemappedFilesKeepOriginalName);
441 }
442
443 // Preprocessor
444
createPreprocessor(TranslationUnitKind TUKind)445 void CompilerInstance::createPreprocessor(TranslationUnitKind TUKind) {
446 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
447
448 // The AST reader holds a reference to the old preprocessor (if any).
449 TheASTReader.reset();
450
451 // Create the Preprocessor.
452 HeaderSearch *HeaderInfo =
453 new HeaderSearch(getHeaderSearchOptsPtr(), getSourceManager(),
454 getDiagnostics(), getLangOpts(), &getTarget());
455 PP = std::make_shared<Preprocessor>(Invocation->getPreprocessorOptsPtr(),
456 getDiagnostics(), getLangOpts(),
457 getSourceManager(), *HeaderInfo, *this,
458 /*IdentifierInfoLookup=*/nullptr,
459 /*OwnsHeaderSearch=*/true, TUKind);
460 getTarget().adjust(getDiagnostics(), getLangOpts());
461 PP->Initialize(getTarget(), getAuxTarget());
462
463 if (PPOpts.DetailedRecord)
464 PP->createPreprocessingRecord();
465
466 // Apply remappings to the source manager.
467 InitializeFileRemapping(PP->getDiagnostics(), PP->getSourceManager(),
468 PP->getFileManager(), PPOpts);
469
470 // Predefine macros and configure the preprocessor.
471 InitializePreprocessor(*PP, PPOpts, getPCHContainerReader(),
472 getFrontendOpts());
473
474 // Initialize the header search object. In CUDA compilations, we use the aux
475 // triple (the host triple) to initialize our header search, since we need to
476 // find the host headers in order to compile the CUDA code.
477 const llvm::Triple *HeaderSearchTriple = &PP->getTargetInfo().getTriple();
478 if (PP->getTargetInfo().getTriple().getOS() == llvm::Triple::CUDA &&
479 PP->getAuxTargetInfo())
480 HeaderSearchTriple = &PP->getAuxTargetInfo()->getTriple();
481
482 ApplyHeaderSearchOptions(PP->getHeaderSearchInfo(), getHeaderSearchOpts(),
483 PP->getLangOpts(), *HeaderSearchTriple);
484
485 PP->setPreprocessedOutput(getPreprocessorOutputOpts().ShowCPP);
486
487 if (PP->getLangOpts().Modules && PP->getLangOpts().ImplicitModules) {
488 std::string ModuleHash = getInvocation().getModuleHash();
489 PP->getHeaderSearchInfo().setModuleHash(ModuleHash);
490 PP->getHeaderSearchInfo().setModuleCachePath(
491 getSpecificModuleCachePath(ModuleHash));
492 }
493
494 // Handle generating dependencies, if requested.
495 const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
496 if (!DepOpts.OutputFile.empty())
497 addDependencyCollector(std::make_shared<DependencyFileGenerator>(DepOpts));
498 if (!DepOpts.DOTOutputFile.empty())
499 AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
500 getHeaderSearchOpts().Sysroot);
501
502 // If we don't have a collector, but we are collecting module dependencies,
503 // then we're the top level compiler instance and need to create one.
504 if (!ModuleDepCollector && !DepOpts.ModuleDependencyOutputDir.empty()) {
505 ModuleDepCollector = std::make_shared<ModuleDependencyCollector>(
506 DepOpts.ModuleDependencyOutputDir);
507 }
508
509 // If there is a module dep collector, register with other dep collectors
510 // and also (a) collect header maps and (b) TODO: input vfs overlay files.
511 if (ModuleDepCollector) {
512 addDependencyCollector(ModuleDepCollector);
513 collectHeaderMaps(PP->getHeaderSearchInfo(), ModuleDepCollector);
514 collectIncludePCH(*this, ModuleDepCollector);
515 collectVFSEntries(*this, ModuleDepCollector);
516 }
517
518 for (auto &Listener : DependencyCollectors)
519 Listener->attachToPreprocessor(*PP);
520
521 // Handle generating header include information, if requested.
522 if (DepOpts.ShowHeaderIncludes)
523 AttachHeaderIncludeGen(*PP, DepOpts);
524 if (!DepOpts.HeaderIncludeOutputFile.empty()) {
525 StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
526 if (OutputPath == "-")
527 OutputPath = "";
528 AttachHeaderIncludeGen(*PP, DepOpts,
529 /*ShowAllHeaders=*/true, OutputPath,
530 /*ShowDepth=*/false);
531 }
532
533 if (DepOpts.ShowIncludesDest != ShowIncludesDestination::None) {
534 AttachHeaderIncludeGen(*PP, DepOpts,
535 /*ShowAllHeaders=*/true, /*OutputPath=*/"",
536 /*ShowDepth=*/true, /*MSStyle=*/true);
537 }
538 }
539
getSpecificModuleCachePath(StringRef ModuleHash)540 std::string CompilerInstance::getSpecificModuleCachePath(StringRef ModuleHash) {
541 // Set up the module path, including the hash for the module-creation options.
542 SmallString<256> SpecificModuleCache(getHeaderSearchOpts().ModuleCachePath);
543 if (!SpecificModuleCache.empty() && !getHeaderSearchOpts().DisableModuleHash)
544 llvm::sys::path::append(SpecificModuleCache, ModuleHash);
545 return std::string(SpecificModuleCache.str());
546 }
547
548 // ASTContext
549
createASTContext()550 void CompilerInstance::createASTContext() {
551 Preprocessor &PP = getPreprocessor();
552 auto *Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
553 PP.getIdentifierTable(), PP.getSelectorTable(),
554 PP.getBuiltinInfo(), PP.TUKind);
555 Context->InitBuiltinTypes(getTarget(), getAuxTarget());
556 setASTContext(Context);
557 }
558
559 // ExternalASTSource
560
createPCHExternalASTSource(StringRef Path,DisableValidationForModuleKind DisableValidation,bool AllowPCHWithCompilerErrors,void * DeserializationListener,bool OwnDeserializationListener)561 void CompilerInstance::createPCHExternalASTSource(
562 StringRef Path, DisableValidationForModuleKind DisableValidation,
563 bool AllowPCHWithCompilerErrors, void *DeserializationListener,
564 bool OwnDeserializationListener) {
565 bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
566 TheASTReader = createPCHExternalASTSource(
567 Path, getHeaderSearchOpts().Sysroot, DisableValidation,
568 AllowPCHWithCompilerErrors, getPreprocessor(), getModuleCache(),
569 getASTContext(), getPCHContainerReader(),
570 getFrontendOpts().ModuleFileExtensions, DependencyCollectors,
571 DeserializationListener, OwnDeserializationListener, Preamble,
572 getFrontendOpts().UseGlobalModuleIndex);
573 }
574
createPCHExternalASTSource(StringRef Path,StringRef Sysroot,DisableValidationForModuleKind DisableValidation,bool AllowPCHWithCompilerErrors,Preprocessor & PP,InMemoryModuleCache & ModuleCache,ASTContext & Context,const PCHContainerReader & PCHContainerRdr,ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,ArrayRef<std::shared_ptr<DependencyCollector>> DependencyCollectors,void * DeserializationListener,bool OwnDeserializationListener,bool Preamble,bool UseGlobalModuleIndex)575 IntrusiveRefCntPtr<ASTReader> CompilerInstance::createPCHExternalASTSource(
576 StringRef Path, StringRef Sysroot,
577 DisableValidationForModuleKind DisableValidation,
578 bool AllowPCHWithCompilerErrors, Preprocessor &PP,
579 InMemoryModuleCache &ModuleCache, ASTContext &Context,
580 const PCHContainerReader &PCHContainerRdr,
581 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
582 ArrayRef<std::shared_ptr<DependencyCollector>> DependencyCollectors,
583 void *DeserializationListener, bool OwnDeserializationListener,
584 bool Preamble, bool UseGlobalModuleIndex) {
585 HeaderSearchOptions &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
586
587 IntrusiveRefCntPtr<ASTReader> Reader(new ASTReader(
588 PP, ModuleCache, &Context, PCHContainerRdr, Extensions,
589 Sysroot.empty() ? "" : Sysroot.data(), DisableValidation,
590 AllowPCHWithCompilerErrors, /*AllowConfigurationMismatch*/ false,
591 HSOpts.ModulesValidateSystemHeaders, HSOpts.ValidateASTInputFilesContent,
592 UseGlobalModuleIndex));
593
594 // We need the external source to be set up before we read the AST, because
595 // eagerly-deserialized declarations may use it.
596 Context.setExternalSource(Reader.get());
597
598 Reader->setDeserializationListener(
599 static_cast<ASTDeserializationListener *>(DeserializationListener),
600 /*TakeOwnership=*/OwnDeserializationListener);
601
602 for (auto &Listener : DependencyCollectors)
603 Listener->attachToASTReader(*Reader);
604
605 switch (Reader->ReadAST(Path,
606 Preamble ? serialization::MK_Preamble
607 : serialization::MK_PCH,
608 SourceLocation(),
609 ASTReader::ARR_None)) {
610 case ASTReader::Success:
611 // Set the predefines buffer as suggested by the PCH reader. Typically, the
612 // predefines buffer will be empty.
613 PP.setPredefines(Reader->getSuggestedPredefines());
614 return Reader;
615
616 case ASTReader::Failure:
617 // Unrecoverable failure: don't even try to process the input file.
618 break;
619
620 case ASTReader::Missing:
621 case ASTReader::OutOfDate:
622 case ASTReader::VersionMismatch:
623 case ASTReader::ConfigurationMismatch:
624 case ASTReader::HadErrors:
625 // No suitable PCH file could be found. Return an error.
626 break;
627 }
628
629 Context.setExternalSource(nullptr);
630 return nullptr;
631 }
632
633 // Code Completion
634
EnableCodeCompletion(Preprocessor & PP,StringRef Filename,unsigned Line,unsigned Column)635 static bool EnableCodeCompletion(Preprocessor &PP,
636 StringRef Filename,
637 unsigned Line,
638 unsigned Column) {
639 // Tell the source manager to chop off the given file at a specific
640 // line and column.
641 auto Entry = PP.getFileManager().getFile(Filename);
642 if (!Entry) {
643 PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
644 << Filename;
645 return true;
646 }
647
648 // Truncate the named file at the given line/column.
649 PP.SetCodeCompletionPoint(*Entry, Line, Column);
650 return false;
651 }
652
createCodeCompletionConsumer()653 void CompilerInstance::createCodeCompletionConsumer() {
654 const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
655 if (!CompletionConsumer) {
656 setCodeCompletionConsumer(
657 createCodeCompletionConsumer(getPreprocessor(),
658 Loc.FileName, Loc.Line, Loc.Column,
659 getFrontendOpts().CodeCompleteOpts,
660 llvm::outs()));
661 if (!CompletionConsumer)
662 return;
663 } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
664 Loc.Line, Loc.Column)) {
665 setCodeCompletionConsumer(nullptr);
666 return;
667 }
668 }
669
createFrontendTimer()670 void CompilerInstance::createFrontendTimer() {
671 FrontendTimerGroup.reset(
672 new llvm::TimerGroup("frontend", "Clang front-end time report"));
673 FrontendTimer.reset(
674 new llvm::Timer("frontend", "Clang front-end timer",
675 *FrontendTimerGroup));
676 }
677
678 CodeCompleteConsumer *
createCodeCompletionConsumer(Preprocessor & PP,StringRef Filename,unsigned Line,unsigned Column,const CodeCompleteOptions & Opts,raw_ostream & OS)679 CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
680 StringRef Filename,
681 unsigned Line,
682 unsigned Column,
683 const CodeCompleteOptions &Opts,
684 raw_ostream &OS) {
685 if (EnableCodeCompletion(PP, Filename, Line, Column))
686 return nullptr;
687
688 // Set up the creation routine for code-completion.
689 return new PrintingCodeCompleteConsumer(Opts, OS);
690 }
691
createSema(TranslationUnitKind TUKind,CodeCompleteConsumer * CompletionConsumer)692 void CompilerInstance::createSema(TranslationUnitKind TUKind,
693 CodeCompleteConsumer *CompletionConsumer) {
694 TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
695 TUKind, CompletionConsumer));
696 // Attach the external sema source if there is any.
697 if (ExternalSemaSrc) {
698 TheSema->addExternalSource(ExternalSemaSrc.get());
699 ExternalSemaSrc->InitializeSema(*TheSema);
700 }
701 }
702
703 // Output Files
704
clearOutputFiles(bool EraseFiles)705 void CompilerInstance::clearOutputFiles(bool EraseFiles) {
706 // Ignore errors that occur when trying to discard the temp file.
707 for (OutputFile &OF : OutputFiles) {
708 if (EraseFiles) {
709 if (OF.File)
710 consumeError(OF.File->discard());
711 if (!OF.Filename.empty())
712 llvm::sys::fs::remove(OF.Filename);
713 continue;
714 }
715
716 if (!OF.File)
717 continue;
718
719 if (OF.File->TmpName.empty()) {
720 consumeError(OF.File->discard());
721 continue;
722 }
723
724 // If '-working-directory' was passed, the output filename should be
725 // relative to that.
726 SmallString<128> NewOutFile(OF.Filename);
727 FileMgr->FixupRelativePath(NewOutFile);
728
729 llvm::Error E = OF.File->keep(NewOutFile);
730 if (!E)
731 continue;
732
733 getDiagnostics().Report(diag::err_unable_to_rename_temp)
734 << OF.File->TmpName << OF.Filename << std::move(E);
735
736 llvm::sys::fs::remove(OF.File->TmpName);
737 }
738 OutputFiles.clear();
739 if (DeleteBuiltModules) {
740 for (auto &Module : BuiltModules)
741 llvm::sys::fs::remove(Module.second);
742 BuiltModules.clear();
743 }
744 }
745
createDefaultOutputFile(bool Binary,StringRef InFile,StringRef Extension,bool RemoveFileOnSignal,bool CreateMissingDirectories,bool ForceUseTemporary)746 std::unique_ptr<raw_pwrite_stream> CompilerInstance::createDefaultOutputFile(
747 bool Binary, StringRef InFile, StringRef Extension, bool RemoveFileOnSignal,
748 bool CreateMissingDirectories, bool ForceUseTemporary) {
749 StringRef OutputPath = getFrontendOpts().OutputFile;
750 Optional<SmallString<128>> PathStorage;
751 if (OutputPath.empty()) {
752 if (InFile == "-" || Extension.empty()) {
753 OutputPath = "-";
754 } else {
755 PathStorage.emplace(InFile);
756 llvm::sys::path::replace_extension(*PathStorage, Extension);
757 OutputPath = *PathStorage;
758 }
759 }
760
761 return createOutputFile(OutputPath, Binary, RemoveFileOnSignal,
762 getFrontendOpts().UseTemporary || ForceUseTemporary,
763 CreateMissingDirectories);
764 }
765
createNullOutputFile()766 std::unique_ptr<raw_pwrite_stream> CompilerInstance::createNullOutputFile() {
767 return std::make_unique<llvm::raw_null_ostream>();
768 }
769
770 std::unique_ptr<raw_pwrite_stream>
createOutputFile(StringRef OutputPath,bool Binary,bool RemoveFileOnSignal,bool UseTemporary,bool CreateMissingDirectories)771 CompilerInstance::createOutputFile(StringRef OutputPath, bool Binary,
772 bool RemoveFileOnSignal, bool UseTemporary,
773 bool CreateMissingDirectories) {
774 Expected<std::unique_ptr<raw_pwrite_stream>> OS =
775 createOutputFileImpl(OutputPath, Binary, RemoveFileOnSignal, UseTemporary,
776 CreateMissingDirectories);
777 if (OS)
778 return std::move(*OS);
779 getDiagnostics().Report(diag::err_fe_unable_to_open_output)
780 << OutputPath << errorToErrorCode(OS.takeError()).message();
781 return nullptr;
782 }
783
784 Expected<std::unique_ptr<llvm::raw_pwrite_stream>>
createOutputFileImpl(StringRef OutputPath,bool Binary,bool RemoveFileOnSignal,bool UseTemporary,bool CreateMissingDirectories)785 CompilerInstance::createOutputFileImpl(StringRef OutputPath, bool Binary,
786 bool RemoveFileOnSignal,
787 bool UseTemporary,
788 bool CreateMissingDirectories) {
789 assert((!CreateMissingDirectories || UseTemporary) &&
790 "CreateMissingDirectories is only allowed when using temporary files");
791
792 std::unique_ptr<llvm::raw_fd_ostream> OS;
793 Optional<StringRef> OSFile;
794
795 if (UseTemporary) {
796 if (OutputPath == "-")
797 UseTemporary = false;
798 else {
799 llvm::sys::fs::file_status Status;
800 llvm::sys::fs::status(OutputPath, Status);
801 if (llvm::sys::fs::exists(Status)) {
802 // Fail early if we can't write to the final destination.
803 if (!llvm::sys::fs::can_write(OutputPath))
804 return llvm::errorCodeToError(
805 make_error_code(llvm::errc::operation_not_permitted));
806
807 // Don't use a temporary if the output is a special file. This handles
808 // things like '-o /dev/null'
809 if (!llvm::sys::fs::is_regular_file(Status))
810 UseTemporary = false;
811 }
812 }
813 }
814
815 Optional<llvm::sys::fs::TempFile> Temp;
816 if (UseTemporary) {
817 // Create a temporary file.
818 // Insert -%%%%%%%% before the extension (if any), and because some tools
819 // (noticeable, clang's own GlobalModuleIndex.cpp) glob for build
820 // artifacts, also append .tmp.
821 StringRef OutputExtension = llvm::sys::path::extension(OutputPath);
822 SmallString<128> TempPath =
823 StringRef(OutputPath).drop_back(OutputExtension.size());
824 TempPath += "-%%%%%%%%";
825 TempPath += OutputExtension;
826 TempPath += ".tmp";
827 Expected<llvm::sys::fs::TempFile> ExpectedFile =
828 llvm::sys::fs::TempFile::create(
829 TempPath, llvm::sys::fs::all_read | llvm::sys::fs::all_write,
830 Binary ? llvm::sys::fs::OF_None : llvm::sys::fs::OF_Text);
831
832 llvm::Error E = handleErrors(
833 ExpectedFile.takeError(), [&](const llvm::ECError &E) -> llvm::Error {
834 std::error_code EC = E.convertToErrorCode();
835 if (CreateMissingDirectories &&
836 EC == llvm::errc::no_such_file_or_directory) {
837 StringRef Parent = llvm::sys::path::parent_path(OutputPath);
838 EC = llvm::sys::fs::create_directories(Parent);
839 if (!EC) {
840 ExpectedFile = llvm::sys::fs::TempFile::create(TempPath);
841 if (!ExpectedFile)
842 return llvm::errorCodeToError(
843 llvm::errc::no_such_file_or_directory);
844 }
845 }
846 return llvm::errorCodeToError(EC);
847 });
848
849 if (E) {
850 consumeError(std::move(E));
851 } else {
852 Temp = std::move(ExpectedFile.get());
853 OS.reset(new llvm::raw_fd_ostream(Temp->FD, /*shouldClose=*/false));
854 OSFile = Temp->TmpName;
855 }
856 // If we failed to create the temporary, fallback to writing to the file
857 // directly. This handles the corner case where we cannot write to the
858 // directory, but can write to the file.
859 }
860
861 if (!OS) {
862 OSFile = OutputPath;
863 std::error_code EC;
864 OS.reset(new llvm::raw_fd_ostream(
865 *OSFile, EC,
866 (Binary ? llvm::sys::fs::OF_None : llvm::sys::fs::OF_TextWithCRLF)));
867 if (EC)
868 return llvm::errorCodeToError(EC);
869 }
870
871 // Add the output file -- but don't try to remove "-", since this means we are
872 // using stdin.
873 OutputFiles.emplace_back(((OutputPath != "-") ? OutputPath : "").str(),
874 std::move(Temp));
875
876 if (!Binary || OS->supportsSeeking())
877 return std::move(OS);
878
879 return std::make_unique<llvm::buffer_unique_ostream>(std::move(OS));
880 }
881
882 // Initialization Utilities
883
InitializeSourceManager(const FrontendInputFile & Input)884 bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
885 return InitializeSourceManager(Input, getDiagnostics(), getFileManager(),
886 getSourceManager());
887 }
888
889 // static
InitializeSourceManager(const FrontendInputFile & Input,DiagnosticsEngine & Diags,FileManager & FileMgr,SourceManager & SourceMgr)890 bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input,
891 DiagnosticsEngine &Diags,
892 FileManager &FileMgr,
893 SourceManager &SourceMgr) {
894 SrcMgr::CharacteristicKind Kind =
895 Input.getKind().getFormat() == InputKind::ModuleMap
896 ? Input.isSystem() ? SrcMgr::C_System_ModuleMap
897 : SrcMgr::C_User_ModuleMap
898 : Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
899
900 if (Input.isBuffer()) {
901 SourceMgr.setMainFileID(SourceMgr.createFileID(Input.getBuffer(), Kind));
902 assert(SourceMgr.getMainFileID().isValid() &&
903 "Couldn't establish MainFileID!");
904 return true;
905 }
906
907 StringRef InputFile = Input.getFile();
908
909 // Figure out where to get and map in the main file.
910 auto FileOrErr = InputFile == "-"
911 ? FileMgr.getSTDIN()
912 : FileMgr.getFileRef(InputFile, /*OpenFile=*/true);
913 if (!FileOrErr) {
914 // FIXME: include the error in the diagnostic even when it's not stdin.
915 auto EC = llvm::errorToErrorCode(FileOrErr.takeError());
916 if (InputFile != "-")
917 Diags.Report(diag::err_fe_error_reading) << InputFile;
918 else
919 Diags.Report(diag::err_fe_error_reading_stdin) << EC.message();
920 return false;
921 }
922
923 SourceMgr.setMainFileID(
924 SourceMgr.createFileID(*FileOrErr, SourceLocation(), Kind));
925
926 assert(SourceMgr.getMainFileID().isValid() &&
927 "Couldn't establish MainFileID!");
928 return true;
929 }
930
931 // High-Level Operations
932
ExecuteAction(FrontendAction & Act)933 bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
934 assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
935 assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
936 assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
937
938 // Mark this point as the bottom of the stack if we don't have somewhere
939 // better. We generally expect frontend actions to be invoked with (nearly)
940 // DesiredStackSpace available.
941 noteBottomOfStack();
942
943 raw_ostream &OS = getVerboseOutputStream();
944
945 if (!Act.PrepareToExecute(*this))
946 return false;
947
948 if (!createTarget())
949 return false;
950
951 // rewriter project will change target built-in bool type from its default.
952 if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
953 getTarget().noSignedCharForObjCBool();
954
955 // Validate/process some options.
956 if (getHeaderSearchOpts().Verbose)
957 OS << "clang -cc1 version " CLANG_VERSION_STRING
958 << " based upon " << BACKEND_PACKAGE_STRING
959 << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
960
961 if (getCodeGenOpts().TimePasses)
962 createFrontendTimer();
963
964 if (getFrontendOpts().ShowStats || !getFrontendOpts().StatsFile.empty())
965 llvm::EnableStatistics(false);
966
967 for (const FrontendInputFile &FIF : getFrontendOpts().Inputs) {
968 // Reset the ID tables if we are reusing the SourceManager and parsing
969 // regular files.
970 if (hasSourceManager() && !Act.isModelParsingAction())
971 getSourceManager().clearIDTables();
972
973 if (Act.BeginSourceFile(*this, FIF)) {
974 if (llvm::Error Err = Act.Execute()) {
975 consumeError(std::move(Err)); // FIXME this drops errors on the floor.
976 }
977 Act.EndSourceFile();
978 }
979 }
980
981 // Notify the diagnostic client that all files were processed.
982 getDiagnostics().getClient()->finish();
983
984 if (getDiagnosticOpts().ShowCarets) {
985 // We can have multiple diagnostics sharing one diagnostic client.
986 // Get the total number of warnings/errors from the client.
987 unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
988 unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
989
990 if (NumWarnings)
991 OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
992 if (NumWarnings && NumErrors)
993 OS << " and ";
994 if (NumErrors)
995 OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
996 if (NumWarnings || NumErrors) {
997 OS << " generated";
998 if (getLangOpts().CUDA) {
999 if (!getLangOpts().CUDAIsDevice) {
1000 OS << " when compiling for host";
1001 } else {
1002 OS << " when compiling for " << getTargetOpts().CPU;
1003 }
1004 }
1005 OS << ".\n";
1006 }
1007 }
1008
1009 if (getFrontendOpts().ShowStats) {
1010 if (hasFileManager()) {
1011 getFileManager().PrintStats();
1012 OS << '\n';
1013 }
1014 llvm::PrintStatistics(OS);
1015 }
1016 StringRef StatsFile = getFrontendOpts().StatsFile;
1017 if (!StatsFile.empty()) {
1018 std::error_code EC;
1019 auto StatS = std::make_unique<llvm::raw_fd_ostream>(
1020 StatsFile, EC, llvm::sys::fs::OF_TextWithCRLF);
1021 if (EC) {
1022 getDiagnostics().Report(diag::warn_fe_unable_to_open_stats_file)
1023 << StatsFile << EC.message();
1024 } else {
1025 llvm::PrintStatisticsJSON(*StatS);
1026 }
1027 }
1028
1029 return !getDiagnostics().getClient()->getNumErrors();
1030 }
1031
1032 /// Determine the appropriate source input kind based on language
1033 /// options.
getLanguageFromOptions(const LangOptions & LangOpts)1034 static Language getLanguageFromOptions(const LangOptions &LangOpts) {
1035 if (LangOpts.OpenCL)
1036 return Language::OpenCL;
1037 if (LangOpts.CUDA)
1038 return Language::CUDA;
1039 if (LangOpts.ObjC)
1040 return LangOpts.CPlusPlus ? Language::ObjCXX : Language::ObjC;
1041 return LangOpts.CPlusPlus ? Language::CXX : Language::C;
1042 }
1043
1044 /// Compile a module file for the given module, using the options
1045 /// provided by the importing compiler instance. Returns true if the module
1046 /// was built without errors.
1047 static bool
compileModuleImpl(CompilerInstance & ImportingInstance,SourceLocation ImportLoc,StringRef ModuleName,FrontendInputFile Input,StringRef OriginalModuleMapFile,StringRef ModuleFileName,llvm::function_ref<void (CompilerInstance &)> PreBuildStep=[](CompilerInstance &){},llvm::function_ref<void (CompilerInstance &)> PostBuildStep=[](CompilerInstance &){})1048 compileModuleImpl(CompilerInstance &ImportingInstance, SourceLocation ImportLoc,
1049 StringRef ModuleName, FrontendInputFile Input,
1050 StringRef OriginalModuleMapFile, StringRef ModuleFileName,
1051 llvm::function_ref<void(CompilerInstance &)> PreBuildStep =
1052 [](CompilerInstance &) {},
1053 llvm::function_ref<void(CompilerInstance &)> PostBuildStep =
__anon1f9c0d900302(CompilerInstance &) 1054 [](CompilerInstance &) {}) {
1055 llvm::TimeTraceScope TimeScope("Module Compile", ModuleName);
1056
1057 // Never compile a module that's already finalized - this would cause the
1058 // existing module to be freed, causing crashes if it is later referenced
1059 if (ImportingInstance.getModuleCache().isPCMFinal(ModuleFileName)) {
1060 ImportingInstance.getDiagnostics().Report(
1061 ImportLoc, diag::err_module_rebuild_finalized)
1062 << ModuleName;
1063 return false;
1064 }
1065
1066 // Construct a compiler invocation for creating this module.
1067 auto Invocation =
1068 std::make_shared<CompilerInvocation>(ImportingInstance.getInvocation());
1069
1070 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
1071
1072 // For any options that aren't intended to affect how a module is built,
1073 // reset them to their default values.
1074 Invocation->getLangOpts()->resetNonModularOptions();
1075 PPOpts.resetNonModularOptions();
1076
1077 // Remove any macro definitions that are explicitly ignored by the module.
1078 // They aren't supposed to affect how the module is built anyway.
1079 HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
1080 PPOpts.Macros.erase(
1081 std::remove_if(PPOpts.Macros.begin(), PPOpts.Macros.end(),
__anon1f9c0d900402(const std::pair<std::string, bool> &def) 1082 [&HSOpts](const std::pair<std::string, bool> &def) {
1083 StringRef MacroDef = def.first;
1084 return HSOpts.ModulesIgnoreMacros.count(
1085 llvm::CachedHashString(MacroDef.split('=').first)) > 0;
1086 }),
1087 PPOpts.Macros.end());
1088
1089 // If the original compiler invocation had -fmodule-name, pass it through.
1090 Invocation->getLangOpts()->ModuleName =
1091 ImportingInstance.getInvocation().getLangOpts()->ModuleName;
1092
1093 // Note the name of the module we're building.
1094 Invocation->getLangOpts()->CurrentModule = std::string(ModuleName);
1095
1096 // Make sure that the failed-module structure has been allocated in
1097 // the importing instance, and propagate the pointer to the newly-created
1098 // instance.
1099 PreprocessorOptions &ImportingPPOpts
1100 = ImportingInstance.getInvocation().getPreprocessorOpts();
1101 if (!ImportingPPOpts.FailedModules)
1102 ImportingPPOpts.FailedModules =
1103 std::make_shared<PreprocessorOptions::FailedModulesSet>();
1104 PPOpts.FailedModules = ImportingPPOpts.FailedModules;
1105
1106 // If there is a module map file, build the module using the module map.
1107 // Set up the inputs/outputs so that we build the module from its umbrella
1108 // header.
1109 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
1110 FrontendOpts.OutputFile = ModuleFileName.str();
1111 FrontendOpts.DisableFree = false;
1112 FrontendOpts.GenerateGlobalModuleIndex = false;
1113 FrontendOpts.BuildingImplicitModule = true;
1114 FrontendOpts.OriginalModuleMap = std::string(OriginalModuleMapFile);
1115 // Force implicitly-built modules to hash the content of the module file.
1116 HSOpts.ModulesHashContent = true;
1117 FrontendOpts.Inputs = {Input};
1118
1119 // Don't free the remapped file buffers; they are owned by our caller.
1120 PPOpts.RetainRemappedFileBuffers = true;
1121
1122 Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
1123 assert(ImportingInstance.getInvocation().getModuleHash() ==
1124 Invocation->getModuleHash() && "Module hash mismatch!");
1125
1126 // Construct a compiler instance that will be used to actually create the
1127 // module. Since we're sharing an in-memory module cache,
1128 // CompilerInstance::CompilerInstance is responsible for finalizing the
1129 // buffers to prevent use-after-frees.
1130 CompilerInstance Instance(ImportingInstance.getPCHContainerOperations(),
1131 &ImportingInstance.getModuleCache());
1132 auto &Inv = *Invocation;
1133 Instance.setInvocation(std::move(Invocation));
1134
1135 Instance.createDiagnostics(new ForwardingDiagnosticConsumer(
1136 ImportingInstance.getDiagnosticClient()),
1137 /*ShouldOwnClient=*/true);
1138
1139 // Note that this module is part of the module build stack, so that we
1140 // can detect cycles in the module graph.
1141 Instance.setFileManager(&ImportingInstance.getFileManager());
1142 Instance.createSourceManager(Instance.getFileManager());
1143 SourceManager &SourceMgr = Instance.getSourceManager();
1144 SourceMgr.setModuleBuildStack(
1145 ImportingInstance.getSourceManager().getModuleBuildStack());
1146 SourceMgr.pushModuleBuildStack(ModuleName,
1147 FullSourceLoc(ImportLoc, ImportingInstance.getSourceManager()));
1148
1149 // If we're collecting module dependencies, we need to share a collector
1150 // between all of the module CompilerInstances. Other than that, we don't
1151 // want to produce any dependency output from the module build.
1152 Instance.setModuleDepCollector(ImportingInstance.getModuleDepCollector());
1153 Inv.getDependencyOutputOpts() = DependencyOutputOptions();
1154
1155 ImportingInstance.getDiagnostics().Report(ImportLoc,
1156 diag::remark_module_build)
1157 << ModuleName << ModuleFileName;
1158
1159 PreBuildStep(Instance);
1160
1161 // Execute the action to actually build the module in-place. Use a separate
1162 // thread so that we get a stack large enough.
1163 llvm::CrashRecoveryContext CRC;
1164 CRC.RunSafelyOnThread(
__anon1f9c0d900502() 1165 [&]() {
1166 GenerateModuleFromModuleMapAction Action;
1167 Instance.ExecuteAction(Action);
1168 },
1169 DesiredStackSize);
1170
1171 PostBuildStep(Instance);
1172
1173 ImportingInstance.getDiagnostics().Report(ImportLoc,
1174 diag::remark_module_build_done)
1175 << ModuleName;
1176
1177 // Delete any remaining temporary files related to Instance, in case the
1178 // module generation thread crashed.
1179 Instance.clearOutputFiles(/*EraseFiles=*/true);
1180
1181 // If \p AllowPCMWithCompilerErrors is set return 'success' even if errors
1182 // occurred.
1183 return !Instance.getDiagnostics().hasErrorOccurred() ||
1184 Instance.getFrontendOpts().AllowPCMWithCompilerErrors;
1185 }
1186
getPublicModuleMap(const FileEntry * File,FileManager & FileMgr)1187 static const FileEntry *getPublicModuleMap(const FileEntry *File,
1188 FileManager &FileMgr) {
1189 StringRef Filename = llvm::sys::path::filename(File->getName());
1190 SmallString<128> PublicFilename(File->getDir()->getName());
1191 if (Filename == "module_private.map")
1192 llvm::sys::path::append(PublicFilename, "module.map");
1193 else if (Filename == "module.private.modulemap")
1194 llvm::sys::path::append(PublicFilename, "module.modulemap");
1195 else
1196 return nullptr;
1197 if (auto FE = FileMgr.getFile(PublicFilename))
1198 return *FE;
1199 return nullptr;
1200 }
1201
1202 /// Compile a module file for the given module in a separate compiler instance,
1203 /// using the options provided by the importing compiler instance. Returns true
1204 /// if the module was built without errors.
compileModule(CompilerInstance & ImportingInstance,SourceLocation ImportLoc,Module * Module,StringRef ModuleFileName)1205 static bool compileModule(CompilerInstance &ImportingInstance,
1206 SourceLocation ImportLoc, Module *Module,
1207 StringRef ModuleFileName) {
1208 InputKind IK(getLanguageFromOptions(ImportingInstance.getLangOpts()),
1209 InputKind::ModuleMap);
1210
1211 // Get or create the module map that we'll use to build this module.
1212 ModuleMap &ModMap
1213 = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
1214 bool Result;
1215 if (const FileEntry *ModuleMapFile =
1216 ModMap.getContainingModuleMapFile(Module)) {
1217 // Canonicalize compilation to start with the public module map. This is
1218 // vital for submodules declarations in the private module maps to be
1219 // correctly parsed when depending on a top level module in the public one.
1220 if (const FileEntry *PublicMMFile = getPublicModuleMap(
1221 ModuleMapFile, ImportingInstance.getFileManager()))
1222 ModuleMapFile = PublicMMFile;
1223
1224 // Use the module map where this module resides.
1225 Result = compileModuleImpl(
1226 ImportingInstance, ImportLoc, Module->getTopLevelModuleName(),
1227 FrontendInputFile(ModuleMapFile->getName(), IK, +Module->IsSystem),
1228 ModMap.getModuleMapFileForUniquing(Module)->getName(),
1229 ModuleFileName);
1230 } else {
1231 // FIXME: We only need to fake up an input file here as a way of
1232 // transporting the module's directory to the module map parser. We should
1233 // be able to do that more directly, and parse from a memory buffer without
1234 // inventing this file.
1235 SmallString<128> FakeModuleMapFile(Module->Directory->getName());
1236 llvm::sys::path::append(FakeModuleMapFile, "__inferred_module.map");
1237
1238 std::string InferredModuleMapContent;
1239 llvm::raw_string_ostream OS(InferredModuleMapContent);
1240 Module->print(OS);
1241 OS.flush();
1242
1243 Result = compileModuleImpl(
1244 ImportingInstance, ImportLoc, Module->getTopLevelModuleName(),
1245 FrontendInputFile(FakeModuleMapFile, IK, +Module->IsSystem),
1246 ModMap.getModuleMapFileForUniquing(Module)->getName(),
1247 ModuleFileName,
1248 [&](CompilerInstance &Instance) {
1249 std::unique_ptr<llvm::MemoryBuffer> ModuleMapBuffer =
1250 llvm::MemoryBuffer::getMemBuffer(InferredModuleMapContent);
1251 ModuleMapFile = Instance.getFileManager().getVirtualFile(
1252 FakeModuleMapFile, InferredModuleMapContent.size(), 0);
1253 Instance.getSourceManager().overrideFileContents(
1254 ModuleMapFile, std::move(ModuleMapBuffer));
1255 });
1256 }
1257
1258 // We've rebuilt a module. If we're allowed to generate or update the global
1259 // module index, record that fact in the importing compiler instance.
1260 if (ImportingInstance.getFrontendOpts().GenerateGlobalModuleIndex) {
1261 ImportingInstance.setBuildGlobalModuleIndex(true);
1262 }
1263
1264 return Result;
1265 }
1266
1267 /// Compile a module in a separate compiler instance and read the AST,
1268 /// returning true if the module compiles without errors.
1269 ///
1270 /// Uses a lock file manager and exponential backoff to reduce the chances that
1271 /// multiple instances will compete to create the same module. On timeout,
1272 /// deletes the lock file in order to avoid deadlock from crashing processes or
1273 /// bugs in the lock file manager.
compileModuleAndReadAST(CompilerInstance & ImportingInstance,SourceLocation ImportLoc,SourceLocation ModuleNameLoc,Module * Module,StringRef ModuleFileName)1274 static bool compileModuleAndReadAST(CompilerInstance &ImportingInstance,
1275 SourceLocation ImportLoc,
1276 SourceLocation ModuleNameLoc,
1277 Module *Module, StringRef ModuleFileName) {
1278 DiagnosticsEngine &Diags = ImportingInstance.getDiagnostics();
1279
1280 auto diagnoseBuildFailure = [&] {
1281 Diags.Report(ModuleNameLoc, diag::err_module_not_built)
1282 << Module->Name << SourceRange(ImportLoc, ModuleNameLoc);
1283 };
1284
1285 // FIXME: have LockFileManager return an error_code so that we can
1286 // avoid the mkdir when the directory already exists.
1287 StringRef Dir = llvm::sys::path::parent_path(ModuleFileName);
1288 llvm::sys::fs::create_directories(Dir);
1289
1290 while (1) {
1291 unsigned ModuleLoadCapabilities = ASTReader::ARR_Missing;
1292 llvm::LockFileManager Locked(ModuleFileName);
1293 switch (Locked) {
1294 case llvm::LockFileManager::LFS_Error:
1295 // ModuleCache takes care of correctness and locks are only necessary for
1296 // performance. Fallback to building the module in case of any lock
1297 // related errors.
1298 Diags.Report(ModuleNameLoc, diag::remark_module_lock_failure)
1299 << Module->Name << Locked.getErrorMessage();
1300 // Clear out any potential leftover.
1301 Locked.unsafeRemoveLockFile();
1302 LLVM_FALLTHROUGH;
1303 case llvm::LockFileManager::LFS_Owned:
1304 // We're responsible for building the module ourselves.
1305 if (!compileModule(ImportingInstance, ModuleNameLoc, Module,
1306 ModuleFileName)) {
1307 diagnoseBuildFailure();
1308 return false;
1309 }
1310 break;
1311
1312 case llvm::LockFileManager::LFS_Shared:
1313 // Someone else is responsible for building the module. Wait for them to
1314 // finish.
1315 switch (Locked.waitForUnlock()) {
1316 case llvm::LockFileManager::Res_Success:
1317 ModuleLoadCapabilities |= ASTReader::ARR_OutOfDate;
1318 break;
1319 case llvm::LockFileManager::Res_OwnerDied:
1320 continue; // try again to get the lock.
1321 case llvm::LockFileManager::Res_Timeout:
1322 // Since ModuleCache takes care of correctness, we try waiting for
1323 // another process to complete the build so clang does not do it done
1324 // twice. If case of timeout, build it ourselves.
1325 Diags.Report(ModuleNameLoc, diag::remark_module_lock_timeout)
1326 << Module->Name;
1327 // Clear the lock file so that future invocations can make progress.
1328 Locked.unsafeRemoveLockFile();
1329 continue;
1330 }
1331 break;
1332 }
1333
1334 // Try to read the module file, now that we've compiled it.
1335 ASTReader::ASTReadResult ReadResult =
1336 ImportingInstance.getASTReader()->ReadAST(
1337 ModuleFileName, serialization::MK_ImplicitModule, ImportLoc,
1338 ModuleLoadCapabilities);
1339
1340 if (ReadResult == ASTReader::OutOfDate &&
1341 Locked == llvm::LockFileManager::LFS_Shared) {
1342 // The module may be out of date in the presence of file system races,
1343 // or if one of its imports depends on header search paths that are not
1344 // consistent with this ImportingInstance. Try again...
1345 continue;
1346 } else if (ReadResult == ASTReader::Missing) {
1347 diagnoseBuildFailure();
1348 } else if (ReadResult != ASTReader::Success &&
1349 !Diags.hasErrorOccurred()) {
1350 // The ASTReader didn't diagnose the error, so conservatively report it.
1351 diagnoseBuildFailure();
1352 }
1353 return ReadResult == ASTReader::Success;
1354 }
1355 }
1356
1357 /// Diagnose differences between the current definition of the given
1358 /// configuration macro and the definition provided on the command line.
checkConfigMacro(Preprocessor & PP,StringRef ConfigMacro,Module * Mod,SourceLocation ImportLoc)1359 static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
1360 Module *Mod, SourceLocation ImportLoc) {
1361 IdentifierInfo *Id = PP.getIdentifierInfo(ConfigMacro);
1362 SourceManager &SourceMgr = PP.getSourceManager();
1363
1364 // If this identifier has never had a macro definition, then it could
1365 // not have changed.
1366 if (!Id->hadMacroDefinition())
1367 return;
1368 auto *LatestLocalMD = PP.getLocalMacroDirectiveHistory(Id);
1369
1370 // Find the macro definition from the command line.
1371 MacroInfo *CmdLineDefinition = nullptr;
1372 for (auto *MD = LatestLocalMD; MD; MD = MD->getPrevious()) {
1373 // We only care about the predefines buffer.
1374 FileID FID = SourceMgr.getFileID(MD->getLocation());
1375 if (FID.isInvalid() || FID != PP.getPredefinesFileID())
1376 continue;
1377 if (auto *DMD = dyn_cast<DefMacroDirective>(MD))
1378 CmdLineDefinition = DMD->getMacroInfo();
1379 break;
1380 }
1381
1382 auto *CurrentDefinition = PP.getMacroInfo(Id);
1383 if (CurrentDefinition == CmdLineDefinition) {
1384 // Macro matches. Nothing to do.
1385 } else if (!CurrentDefinition) {
1386 // This macro was defined on the command line, then #undef'd later.
1387 // Complain.
1388 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1389 << true << ConfigMacro << Mod->getFullModuleName();
1390 auto LatestDef = LatestLocalMD->getDefinition();
1391 assert(LatestDef.isUndefined() &&
1392 "predefined macro went away with no #undef?");
1393 PP.Diag(LatestDef.getUndefLocation(), diag::note_module_def_undef_here)
1394 << true;
1395 return;
1396 } else if (!CmdLineDefinition) {
1397 // There was no definition for this macro in the predefines buffer,
1398 // but there was a local definition. Complain.
1399 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1400 << false << ConfigMacro << Mod->getFullModuleName();
1401 PP.Diag(CurrentDefinition->getDefinitionLoc(),
1402 diag::note_module_def_undef_here)
1403 << false;
1404 } else if (!CurrentDefinition->isIdenticalTo(*CmdLineDefinition, PP,
1405 /*Syntactically=*/true)) {
1406 // The macro definitions differ.
1407 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1408 << false << ConfigMacro << Mod->getFullModuleName();
1409 PP.Diag(CurrentDefinition->getDefinitionLoc(),
1410 diag::note_module_def_undef_here)
1411 << false;
1412 }
1413 }
1414
1415 /// Write a new timestamp file with the given path.
writeTimestampFile(StringRef TimestampFile)1416 static void writeTimestampFile(StringRef TimestampFile) {
1417 std::error_code EC;
1418 llvm::raw_fd_ostream Out(TimestampFile.str(), EC, llvm::sys::fs::OF_None);
1419 }
1420
1421 /// Prune the module cache of modules that haven't been accessed in
1422 /// a long time.
pruneModuleCache(const HeaderSearchOptions & HSOpts)1423 static void pruneModuleCache(const HeaderSearchOptions &HSOpts) {
1424 llvm::sys::fs::file_status StatBuf;
1425 llvm::SmallString<128> TimestampFile;
1426 TimestampFile = HSOpts.ModuleCachePath;
1427 assert(!TimestampFile.empty());
1428 llvm::sys::path::append(TimestampFile, "modules.timestamp");
1429
1430 // Try to stat() the timestamp file.
1431 if (std::error_code EC = llvm::sys::fs::status(TimestampFile, StatBuf)) {
1432 // If the timestamp file wasn't there, create one now.
1433 if (EC == std::errc::no_such_file_or_directory) {
1434 writeTimestampFile(TimestampFile);
1435 }
1436 return;
1437 }
1438
1439 // Check whether the time stamp is older than our pruning interval.
1440 // If not, do nothing.
1441 time_t TimeStampModTime =
1442 llvm::sys::toTimeT(StatBuf.getLastModificationTime());
1443 time_t CurrentTime = time(nullptr);
1444 if (CurrentTime - TimeStampModTime <= time_t(HSOpts.ModuleCachePruneInterval))
1445 return;
1446
1447 // Write a new timestamp file so that nobody else attempts to prune.
1448 // There is a benign race condition here, if two Clang instances happen to
1449 // notice at the same time that the timestamp is out-of-date.
1450 writeTimestampFile(TimestampFile);
1451
1452 // Walk the entire module cache, looking for unused module files and module
1453 // indices.
1454 std::error_code EC;
1455 SmallString<128> ModuleCachePathNative;
1456 llvm::sys::path::native(HSOpts.ModuleCachePath, ModuleCachePathNative);
1457 for (llvm::sys::fs::directory_iterator Dir(ModuleCachePathNative, EC), DirEnd;
1458 Dir != DirEnd && !EC; Dir.increment(EC)) {
1459 // If we don't have a directory, there's nothing to look into.
1460 if (!llvm::sys::fs::is_directory(Dir->path()))
1461 continue;
1462
1463 // Walk all of the files within this directory.
1464 for (llvm::sys::fs::directory_iterator File(Dir->path(), EC), FileEnd;
1465 File != FileEnd && !EC; File.increment(EC)) {
1466 // We only care about module and global module index files.
1467 StringRef Extension = llvm::sys::path::extension(File->path());
1468 if (Extension != ".pcm" && Extension != ".timestamp" &&
1469 llvm::sys::path::filename(File->path()) != "modules.idx")
1470 continue;
1471
1472 // Look at this file. If we can't stat it, there's nothing interesting
1473 // there.
1474 if (llvm::sys::fs::status(File->path(), StatBuf))
1475 continue;
1476
1477 // If the file has been used recently enough, leave it there.
1478 time_t FileAccessTime = llvm::sys::toTimeT(StatBuf.getLastAccessedTime());
1479 if (CurrentTime - FileAccessTime <=
1480 time_t(HSOpts.ModuleCachePruneAfter)) {
1481 continue;
1482 }
1483
1484 // Remove the file.
1485 llvm::sys::fs::remove(File->path());
1486
1487 // Remove the timestamp file.
1488 std::string TimpestampFilename = File->path() + ".timestamp";
1489 llvm::sys::fs::remove(TimpestampFilename);
1490 }
1491
1492 // If we removed all of the files in the directory, remove the directory
1493 // itself.
1494 if (llvm::sys::fs::directory_iterator(Dir->path(), EC) ==
1495 llvm::sys::fs::directory_iterator() && !EC)
1496 llvm::sys::fs::remove(Dir->path());
1497 }
1498 }
1499
createASTReader()1500 void CompilerInstance::createASTReader() {
1501 if (TheASTReader)
1502 return;
1503
1504 if (!hasASTContext())
1505 createASTContext();
1506
1507 // If we're implicitly building modules but not currently recursively
1508 // building a module, check whether we need to prune the module cache.
1509 if (getSourceManager().getModuleBuildStack().empty() &&
1510 !getPreprocessor().getHeaderSearchInfo().getModuleCachePath().empty() &&
1511 getHeaderSearchOpts().ModuleCachePruneInterval > 0 &&
1512 getHeaderSearchOpts().ModuleCachePruneAfter > 0) {
1513 pruneModuleCache(getHeaderSearchOpts());
1514 }
1515
1516 HeaderSearchOptions &HSOpts = getHeaderSearchOpts();
1517 std::string Sysroot = HSOpts.Sysroot;
1518 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
1519 const FrontendOptions &FEOpts = getFrontendOpts();
1520 std::unique_ptr<llvm::Timer> ReadTimer;
1521
1522 if (FrontendTimerGroup)
1523 ReadTimer = std::make_unique<llvm::Timer>("reading_modules",
1524 "Reading modules",
1525 *FrontendTimerGroup);
1526 TheASTReader = new ASTReader(
1527 getPreprocessor(), getModuleCache(), &getASTContext(),
1528 getPCHContainerReader(), getFrontendOpts().ModuleFileExtensions,
1529 Sysroot.empty() ? "" : Sysroot.c_str(),
1530 PPOpts.DisablePCHOrModuleValidation,
1531 /*AllowASTWithCompilerErrors=*/FEOpts.AllowPCMWithCompilerErrors,
1532 /*AllowConfigurationMismatch=*/false, HSOpts.ModulesValidateSystemHeaders,
1533 HSOpts.ValidateASTInputFilesContent,
1534 getFrontendOpts().UseGlobalModuleIndex, std::move(ReadTimer));
1535 if (hasASTConsumer()) {
1536 TheASTReader->setDeserializationListener(
1537 getASTConsumer().GetASTDeserializationListener());
1538 getASTContext().setASTMutationListener(
1539 getASTConsumer().GetASTMutationListener());
1540 }
1541 getASTContext().setExternalSource(TheASTReader);
1542 if (hasSema())
1543 TheASTReader->InitializeSema(getSema());
1544 if (hasASTConsumer())
1545 TheASTReader->StartTranslationUnit(&getASTConsumer());
1546
1547 for (auto &Listener : DependencyCollectors)
1548 Listener->attachToASTReader(*TheASTReader);
1549 }
1550
loadModuleFile(StringRef FileName)1551 bool CompilerInstance::loadModuleFile(StringRef FileName) {
1552 llvm::Timer Timer;
1553 if (FrontendTimerGroup)
1554 Timer.init("preloading." + FileName.str(), "Preloading " + FileName.str(),
1555 *FrontendTimerGroup);
1556 llvm::TimeRegion TimeLoading(FrontendTimerGroup ? &Timer : nullptr);
1557
1558 // Helper to recursively read the module names for all modules we're adding.
1559 // We mark these as known and redirect any attempt to load that module to
1560 // the files we were handed.
1561 struct ReadModuleNames : ASTReaderListener {
1562 CompilerInstance &CI;
1563 llvm::SmallVector<IdentifierInfo*, 8> LoadedModules;
1564
1565 ReadModuleNames(CompilerInstance &CI) : CI(CI) {}
1566
1567 void ReadModuleName(StringRef ModuleName) override {
1568 LoadedModules.push_back(
1569 CI.getPreprocessor().getIdentifierInfo(ModuleName));
1570 }
1571
1572 void registerAll() {
1573 ModuleMap &MM = CI.getPreprocessor().getHeaderSearchInfo().getModuleMap();
1574 for (auto *II : LoadedModules)
1575 MM.cacheModuleLoad(*II, MM.findModule(II->getName()));
1576 LoadedModules.clear();
1577 }
1578
1579 void markAllUnavailable() {
1580 for (auto *II : LoadedModules) {
1581 if (Module *M = CI.getPreprocessor()
1582 .getHeaderSearchInfo()
1583 .getModuleMap()
1584 .findModule(II->getName())) {
1585 M->HasIncompatibleModuleFile = true;
1586
1587 // Mark module as available if the only reason it was unavailable
1588 // was missing headers.
1589 SmallVector<Module *, 2> Stack;
1590 Stack.push_back(M);
1591 while (!Stack.empty()) {
1592 Module *Current = Stack.pop_back_val();
1593 if (Current->IsUnimportable) continue;
1594 Current->IsAvailable = true;
1595 Stack.insert(Stack.end(),
1596 Current->submodule_begin(), Current->submodule_end());
1597 }
1598 }
1599 }
1600 LoadedModules.clear();
1601 }
1602 };
1603
1604 // If we don't already have an ASTReader, create one now.
1605 if (!TheASTReader)
1606 createASTReader();
1607
1608 // If -Wmodule-file-config-mismatch is mapped as an error or worse, allow the
1609 // ASTReader to diagnose it, since it can produce better errors that we can.
1610 bool ConfigMismatchIsRecoverable =
1611 getDiagnostics().getDiagnosticLevel(diag::warn_module_config_mismatch,
1612 SourceLocation())
1613 <= DiagnosticsEngine::Warning;
1614
1615 auto Listener = std::make_unique<ReadModuleNames>(*this);
1616 auto &ListenerRef = *Listener;
1617 ASTReader::ListenerScope ReadModuleNamesListener(*TheASTReader,
1618 std::move(Listener));
1619
1620 // Try to load the module file.
1621 switch (TheASTReader->ReadAST(
1622 FileName, serialization::MK_ExplicitModule, SourceLocation(),
1623 ConfigMismatchIsRecoverable ? ASTReader::ARR_ConfigurationMismatch : 0)) {
1624 case ASTReader::Success:
1625 // We successfully loaded the module file; remember the set of provided
1626 // modules so that we don't try to load implicit modules for them.
1627 ListenerRef.registerAll();
1628 return true;
1629
1630 case ASTReader::ConfigurationMismatch:
1631 // Ignore unusable module files.
1632 getDiagnostics().Report(SourceLocation(), diag::warn_module_config_mismatch)
1633 << FileName;
1634 // All modules provided by any files we tried and failed to load are now
1635 // unavailable; includes of those modules should now be handled textually.
1636 ListenerRef.markAllUnavailable();
1637 return true;
1638
1639 default:
1640 return false;
1641 }
1642 }
1643
1644 namespace {
1645 enum ModuleSource {
1646 MS_ModuleNotFound,
1647 MS_ModuleCache,
1648 MS_PrebuiltModulePath,
1649 MS_ModuleBuildPragma
1650 };
1651 } // end namespace
1652
1653 /// Select a source for loading the named module and compute the filename to
1654 /// load it from.
selectModuleSource(Module * M,StringRef ModuleName,std::string & ModuleFilename,const std::map<std::string,std::string,std::less<>> & BuiltModules,HeaderSearch & HS)1655 static ModuleSource selectModuleSource(
1656 Module *M, StringRef ModuleName, std::string &ModuleFilename,
1657 const std::map<std::string, std::string, std::less<>> &BuiltModules,
1658 HeaderSearch &HS) {
1659 assert(ModuleFilename.empty() && "Already has a module source?");
1660
1661 // Check to see if the module has been built as part of this compilation
1662 // via a module build pragma.
1663 auto BuiltModuleIt = BuiltModules.find(ModuleName);
1664 if (BuiltModuleIt != BuiltModules.end()) {
1665 ModuleFilename = BuiltModuleIt->second;
1666 return MS_ModuleBuildPragma;
1667 }
1668
1669 // Try to load the module from the prebuilt module path.
1670 const HeaderSearchOptions &HSOpts = HS.getHeaderSearchOpts();
1671 if (!HSOpts.PrebuiltModuleFiles.empty() ||
1672 !HSOpts.PrebuiltModulePaths.empty()) {
1673 ModuleFilename = HS.getPrebuiltModuleFileName(ModuleName);
1674 if (HSOpts.EnablePrebuiltImplicitModules && ModuleFilename.empty())
1675 ModuleFilename = HS.getPrebuiltImplicitModuleFileName(M);
1676 if (!ModuleFilename.empty())
1677 return MS_PrebuiltModulePath;
1678 }
1679
1680 // Try to load the module from the module cache.
1681 if (M) {
1682 ModuleFilename = HS.getCachedModuleFileName(M);
1683 return MS_ModuleCache;
1684 }
1685
1686 return MS_ModuleNotFound;
1687 }
1688
findOrCompileModuleAndReadAST(StringRef ModuleName,SourceLocation ImportLoc,SourceLocation ModuleNameLoc,bool IsInclusionDirective)1689 ModuleLoadResult CompilerInstance::findOrCompileModuleAndReadAST(
1690 StringRef ModuleName, SourceLocation ImportLoc,
1691 SourceLocation ModuleNameLoc, bool IsInclusionDirective) {
1692 // Search for a module with the given name.
1693 HeaderSearch &HS = PP->getHeaderSearchInfo();
1694 Module *M = HS.lookupModule(ModuleName, true, !IsInclusionDirective);
1695
1696 // Select the source and filename for loading the named module.
1697 std::string ModuleFilename;
1698 ModuleSource Source =
1699 selectModuleSource(M, ModuleName, ModuleFilename, BuiltModules, HS);
1700 if (Source == MS_ModuleNotFound) {
1701 // We can't find a module, error out here.
1702 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1703 << ModuleName << SourceRange(ImportLoc, ModuleNameLoc);
1704 return nullptr;
1705 }
1706 if (ModuleFilename.empty()) {
1707 if (M && M->HasIncompatibleModuleFile) {
1708 // We tried and failed to load a module file for this module. Fall
1709 // back to textual inclusion for its headers.
1710 return ModuleLoadResult::ConfigMismatch;
1711 }
1712
1713 getDiagnostics().Report(ModuleNameLoc, diag::err_module_build_disabled)
1714 << ModuleName;
1715 return nullptr;
1716 }
1717
1718 // Create an ASTReader on demand.
1719 if (!getASTReader())
1720 createASTReader();
1721
1722 // Time how long it takes to load the module.
1723 llvm::Timer Timer;
1724 if (FrontendTimerGroup)
1725 Timer.init("loading." + ModuleFilename, "Loading " + ModuleFilename,
1726 *FrontendTimerGroup);
1727 llvm::TimeRegion TimeLoading(FrontendTimerGroup ? &Timer : nullptr);
1728 llvm::TimeTraceScope TimeScope("Module Load", ModuleName);
1729
1730 // Try to load the module file. If we are not trying to load from the
1731 // module cache, we don't know how to rebuild modules.
1732 unsigned ARRFlags = Source == MS_ModuleCache
1733 ? ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing |
1734 ASTReader::ARR_TreatModuleWithErrorsAsOutOfDate
1735 : Source == MS_PrebuiltModulePath
1736 ? 0
1737 : ASTReader::ARR_ConfigurationMismatch;
1738 switch (getASTReader()->ReadAST(ModuleFilename,
1739 Source == MS_PrebuiltModulePath
1740 ? serialization::MK_PrebuiltModule
1741 : Source == MS_ModuleBuildPragma
1742 ? serialization::MK_ExplicitModule
1743 : serialization::MK_ImplicitModule,
1744 ImportLoc, ARRFlags)) {
1745 case ASTReader::Success: {
1746 if (M)
1747 return M;
1748 assert(Source != MS_ModuleCache &&
1749 "missing module, but file loaded from cache");
1750
1751 // A prebuilt module is indexed as a ModuleFile; the Module does not exist
1752 // until the first call to ReadAST. Look it up now.
1753 M = HS.lookupModule(ModuleName, true, !IsInclusionDirective);
1754
1755 // Check whether M refers to the file in the prebuilt module path.
1756 if (M && M->getASTFile())
1757 if (auto ModuleFile = FileMgr->getFile(ModuleFilename))
1758 if (*ModuleFile == M->getASTFile())
1759 return M;
1760
1761 getDiagnostics().Report(ModuleNameLoc, diag::err_module_prebuilt)
1762 << ModuleName;
1763 return ModuleLoadResult();
1764 }
1765
1766 case ASTReader::OutOfDate:
1767 case ASTReader::Missing:
1768 // The most interesting case.
1769 break;
1770
1771 case ASTReader::ConfigurationMismatch:
1772 if (Source == MS_PrebuiltModulePath)
1773 // FIXME: We shouldn't be setting HadFatalFailure below if we only
1774 // produce a warning here!
1775 getDiagnostics().Report(SourceLocation(),
1776 diag::warn_module_config_mismatch)
1777 << ModuleFilename;
1778 // Fall through to error out.
1779 LLVM_FALLTHROUGH;
1780 case ASTReader::VersionMismatch:
1781 case ASTReader::HadErrors:
1782 ModuleLoader::HadFatalFailure = true;
1783 // FIXME: The ASTReader will already have complained, but can we shoehorn
1784 // that diagnostic information into a more useful form?
1785 return ModuleLoadResult();
1786
1787 case ASTReader::Failure:
1788 ModuleLoader::HadFatalFailure = true;
1789 return ModuleLoadResult();
1790 }
1791
1792 // ReadAST returned Missing or OutOfDate.
1793 if (Source != MS_ModuleCache) {
1794 // We don't know the desired configuration for this module and don't
1795 // necessarily even have a module map. Since ReadAST already produces
1796 // diagnostics for these two cases, we simply error out here.
1797 return ModuleLoadResult();
1798 }
1799
1800 // The module file is missing or out-of-date. Build it.
1801 assert(M && "missing module, but trying to compile for cache");
1802
1803 // Check whether there is a cycle in the module graph.
1804 ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
1805 ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1806 for (; Pos != PosEnd; ++Pos) {
1807 if (Pos->first == ModuleName)
1808 break;
1809 }
1810
1811 if (Pos != PosEnd) {
1812 SmallString<256> CyclePath;
1813 for (; Pos != PosEnd; ++Pos) {
1814 CyclePath += Pos->first;
1815 CyclePath += " -> ";
1816 }
1817 CyclePath += ModuleName;
1818
1819 getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
1820 << ModuleName << CyclePath;
1821 return nullptr;
1822 }
1823
1824 // Check whether we have already attempted to build this module (but
1825 // failed).
1826 if (getPreprocessorOpts().FailedModules &&
1827 getPreprocessorOpts().FailedModules->hasAlreadyFailed(ModuleName)) {
1828 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_built)
1829 << ModuleName << SourceRange(ImportLoc, ModuleNameLoc);
1830 return nullptr;
1831 }
1832
1833 // Try to compile and then read the AST.
1834 if (!compileModuleAndReadAST(*this, ImportLoc, ModuleNameLoc, M,
1835 ModuleFilename)) {
1836 assert(getDiagnostics().hasErrorOccurred() &&
1837 "undiagnosed error in compileModuleAndReadAST");
1838 if (getPreprocessorOpts().FailedModules)
1839 getPreprocessorOpts().FailedModules->addFailed(ModuleName);
1840 return nullptr;
1841 }
1842
1843 // Okay, we've rebuilt and now loaded the module.
1844 return M;
1845 }
1846
1847 ModuleLoadResult
loadModule(SourceLocation ImportLoc,ModuleIdPath Path,Module::NameVisibilityKind Visibility,bool IsInclusionDirective)1848 CompilerInstance::loadModule(SourceLocation ImportLoc,
1849 ModuleIdPath Path,
1850 Module::NameVisibilityKind Visibility,
1851 bool IsInclusionDirective) {
1852 // Determine what file we're searching from.
1853 StringRef ModuleName = Path[0].first->getName();
1854 SourceLocation ModuleNameLoc = Path[0].second;
1855
1856 // If we've already handled this import, just return the cached result.
1857 // This one-element cache is important to eliminate redundant diagnostics
1858 // when both the preprocessor and parser see the same import declaration.
1859 if (ImportLoc.isValid() && LastModuleImportLoc == ImportLoc) {
1860 // Make the named module visible.
1861 if (LastModuleImportResult && ModuleName != getLangOpts().CurrentModule)
1862 TheASTReader->makeModuleVisible(LastModuleImportResult, Visibility,
1863 ImportLoc);
1864 return LastModuleImportResult;
1865 }
1866
1867 // If we don't already have information on this module, load the module now.
1868 Module *Module = nullptr;
1869 ModuleMap &MM = getPreprocessor().getHeaderSearchInfo().getModuleMap();
1870 if (auto MaybeModule = MM.getCachedModuleLoad(*Path[0].first)) {
1871 // Use the cached result, which may be nullptr.
1872 Module = *MaybeModule;
1873 } else if (ModuleName == getLangOpts().CurrentModule) {
1874 // This is the module we're building.
1875 Module = PP->getHeaderSearchInfo().lookupModule(
1876 ModuleName, /*AllowSearch*/ true,
1877 /*AllowExtraModuleMapSearch*/ !IsInclusionDirective);
1878 /// FIXME: perhaps we should (a) look for a module using the module name
1879 // to file map (PrebuiltModuleFiles) and (b) diagnose if still not found?
1880 //if (Module == nullptr) {
1881 // getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1882 // << ModuleName;
1883 // DisableGeneratingGlobalModuleIndex = true;
1884 // return ModuleLoadResult();
1885 //}
1886 MM.cacheModuleLoad(*Path[0].first, Module);
1887 } else {
1888 ModuleLoadResult Result = findOrCompileModuleAndReadAST(
1889 ModuleName, ImportLoc, ModuleNameLoc, IsInclusionDirective);
1890 if (!Result.isNormal())
1891 return Result;
1892 if (!Result)
1893 DisableGeneratingGlobalModuleIndex = true;
1894 Module = Result;
1895 MM.cacheModuleLoad(*Path[0].first, Module);
1896 }
1897
1898 // If we never found the module, fail. Otherwise, verify the module and link
1899 // it up.
1900 if (!Module)
1901 return ModuleLoadResult();
1902
1903 // Verify that the rest of the module path actually corresponds to
1904 // a submodule.
1905 bool MapPrivateSubModToTopLevel = false;
1906 if (Path.size() > 1) {
1907 for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1908 StringRef Name = Path[I].first->getName();
1909 clang::Module *Sub = Module->findSubmodule(Name);
1910
1911 // If the user is requesting Foo.Private and it doesn't exist, try to
1912 // match Foo_Private and emit a warning asking for the user to write
1913 // @import Foo_Private instead. FIXME: remove this when existing clients
1914 // migrate off of Foo.Private syntax.
1915 if (!Sub && PP->getLangOpts().ImplicitModules && Name == "Private" &&
1916 Module == Module->getTopLevelModule()) {
1917 SmallString<128> PrivateModule(Module->Name);
1918 PrivateModule.append("_Private");
1919
1920 SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> PrivPath;
1921 auto &II = PP->getIdentifierTable().get(
1922 PrivateModule, PP->getIdentifierInfo(Module->Name)->getTokenID());
1923 PrivPath.push_back(std::make_pair(&II, Path[0].second));
1924
1925 if (PP->getHeaderSearchInfo().lookupModule(PrivateModule, true,
1926 !IsInclusionDirective))
1927 Sub =
1928 loadModule(ImportLoc, PrivPath, Visibility, IsInclusionDirective);
1929 if (Sub) {
1930 MapPrivateSubModToTopLevel = true;
1931 if (!getDiagnostics().isIgnored(
1932 diag::warn_no_priv_submodule_use_toplevel, ImportLoc)) {
1933 getDiagnostics().Report(Path[I].second,
1934 diag::warn_no_priv_submodule_use_toplevel)
1935 << Path[I].first << Module->getFullModuleName() << PrivateModule
1936 << SourceRange(Path[0].second, Path[I].second)
1937 << FixItHint::CreateReplacement(SourceRange(Path[0].second),
1938 PrivateModule);
1939 getDiagnostics().Report(Sub->DefinitionLoc,
1940 diag::note_private_top_level_defined);
1941 }
1942 }
1943 }
1944
1945 if (!Sub) {
1946 // Attempt to perform typo correction to find a module name that works.
1947 SmallVector<StringRef, 2> Best;
1948 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1949
1950 for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1951 JEnd = Module->submodule_end();
1952 J != JEnd; ++J) {
1953 unsigned ED = Name.edit_distance((*J)->Name,
1954 /*AllowReplacements=*/true,
1955 BestEditDistance);
1956 if (ED <= BestEditDistance) {
1957 if (ED < BestEditDistance) {
1958 Best.clear();
1959 BestEditDistance = ED;
1960 }
1961
1962 Best.push_back((*J)->Name);
1963 }
1964 }
1965
1966 // If there was a clear winner, user it.
1967 if (Best.size() == 1) {
1968 getDiagnostics().Report(Path[I].second,
1969 diag::err_no_submodule_suggest)
1970 << Path[I].first << Module->getFullModuleName() << Best[0]
1971 << SourceRange(Path[0].second, Path[I-1].second)
1972 << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1973 Best[0]);
1974
1975 Sub = Module->findSubmodule(Best[0]);
1976 }
1977 }
1978
1979 if (!Sub) {
1980 // No submodule by this name. Complain, and don't look for further
1981 // submodules.
1982 getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
1983 << Path[I].first << Module->getFullModuleName()
1984 << SourceRange(Path[0].second, Path[I-1].second);
1985 break;
1986 }
1987
1988 Module = Sub;
1989 }
1990 }
1991
1992 // Make the named module visible, if it's not already part of the module
1993 // we are parsing.
1994 if (ModuleName != getLangOpts().CurrentModule) {
1995 if (!Module->IsFromModuleFile && !MapPrivateSubModToTopLevel) {
1996 // We have an umbrella header or directory that doesn't actually include
1997 // all of the headers within the directory it covers. Complain about
1998 // this missing submodule and recover by forgetting that we ever saw
1999 // this submodule.
2000 // FIXME: Should we detect this at module load time? It seems fairly
2001 // expensive (and rare).
2002 getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
2003 << Module->getFullModuleName()
2004 << SourceRange(Path.front().second, Path.back().second);
2005
2006 return ModuleLoadResult::MissingExpected;
2007 }
2008
2009 // Check whether this module is available.
2010 if (Preprocessor::checkModuleIsAvailable(getLangOpts(), getTarget(),
2011 getDiagnostics(), Module)) {
2012 getDiagnostics().Report(ImportLoc, diag::note_module_import_here)
2013 << SourceRange(Path.front().second, Path.back().second);
2014 LastModuleImportLoc = ImportLoc;
2015 LastModuleImportResult = ModuleLoadResult();
2016 return ModuleLoadResult();
2017 }
2018
2019 TheASTReader->makeModuleVisible(Module, Visibility, ImportLoc);
2020 }
2021
2022 // Check for any configuration macros that have changed.
2023 clang::Module *TopModule = Module->getTopLevelModule();
2024 for (unsigned I = 0, N = TopModule->ConfigMacros.size(); I != N; ++I) {
2025 checkConfigMacro(getPreprocessor(), TopModule->ConfigMacros[I],
2026 Module, ImportLoc);
2027 }
2028
2029 // Resolve any remaining module using export_as for this one.
2030 getPreprocessor()
2031 .getHeaderSearchInfo()
2032 .getModuleMap()
2033 .resolveLinkAsDependencies(TopModule);
2034
2035 LastModuleImportLoc = ImportLoc;
2036 LastModuleImportResult = ModuleLoadResult(Module);
2037 return LastModuleImportResult;
2038 }
2039
createModuleFromSource(SourceLocation ImportLoc,StringRef ModuleName,StringRef Source)2040 void CompilerInstance::createModuleFromSource(SourceLocation ImportLoc,
2041 StringRef ModuleName,
2042 StringRef Source) {
2043 // Avoid creating filenames with special characters.
2044 SmallString<128> CleanModuleName(ModuleName);
2045 for (auto &C : CleanModuleName)
2046 if (!isAlphanumeric(C))
2047 C = '_';
2048
2049 // FIXME: Using a randomized filename here means that our intermediate .pcm
2050 // output is nondeterministic (as .pcm files refer to each other by name).
2051 // Can this affect the output in any way?
2052 SmallString<128> ModuleFileName;
2053 if (std::error_code EC = llvm::sys::fs::createTemporaryFile(
2054 CleanModuleName, "pcm", ModuleFileName)) {
2055 getDiagnostics().Report(ImportLoc, diag::err_fe_unable_to_open_output)
2056 << ModuleFileName << EC.message();
2057 return;
2058 }
2059 std::string ModuleMapFileName = (CleanModuleName + ".map").str();
2060
2061 FrontendInputFile Input(
2062 ModuleMapFileName,
2063 InputKind(getLanguageFromOptions(*Invocation->getLangOpts()),
2064 InputKind::ModuleMap, /*Preprocessed*/true));
2065
2066 std::string NullTerminatedSource(Source.str());
2067
2068 auto PreBuildStep = [&](CompilerInstance &Other) {
2069 // Create a virtual file containing our desired source.
2070 // FIXME: We shouldn't need to do this.
2071 const FileEntry *ModuleMapFile = Other.getFileManager().getVirtualFile(
2072 ModuleMapFileName, NullTerminatedSource.size(), 0);
2073 Other.getSourceManager().overrideFileContents(
2074 ModuleMapFile,
2075 llvm::MemoryBuffer::getMemBuffer(NullTerminatedSource.c_str()));
2076
2077 Other.BuiltModules = std::move(BuiltModules);
2078 Other.DeleteBuiltModules = false;
2079 };
2080
2081 auto PostBuildStep = [this](CompilerInstance &Other) {
2082 BuiltModules = std::move(Other.BuiltModules);
2083 };
2084
2085 // Build the module, inheriting any modules that we've built locally.
2086 if (compileModuleImpl(*this, ImportLoc, ModuleName, Input, StringRef(),
2087 ModuleFileName, PreBuildStep, PostBuildStep)) {
2088 BuiltModules[std::string(ModuleName)] = std::string(ModuleFileName.str());
2089 llvm::sys::RemoveFileOnSignal(ModuleFileName);
2090 }
2091 }
2092
makeModuleVisible(Module * Mod,Module::NameVisibilityKind Visibility,SourceLocation ImportLoc)2093 void CompilerInstance::makeModuleVisible(Module *Mod,
2094 Module::NameVisibilityKind Visibility,
2095 SourceLocation ImportLoc) {
2096 if (!TheASTReader)
2097 createASTReader();
2098 if (!TheASTReader)
2099 return;
2100
2101 TheASTReader->makeModuleVisible(Mod, Visibility, ImportLoc);
2102 }
2103
loadGlobalModuleIndex(SourceLocation TriggerLoc)2104 GlobalModuleIndex *CompilerInstance::loadGlobalModuleIndex(
2105 SourceLocation TriggerLoc) {
2106 if (getPreprocessor().getHeaderSearchInfo().getModuleCachePath().empty())
2107 return nullptr;
2108 if (!TheASTReader)
2109 createASTReader();
2110 // Can't do anything if we don't have the module manager.
2111 if (!TheASTReader)
2112 return nullptr;
2113 // Get an existing global index. This loads it if not already
2114 // loaded.
2115 TheASTReader->loadGlobalIndex();
2116 GlobalModuleIndex *GlobalIndex = TheASTReader->getGlobalIndex();
2117 // If the global index doesn't exist, create it.
2118 if (!GlobalIndex && shouldBuildGlobalModuleIndex() && hasFileManager() &&
2119 hasPreprocessor()) {
2120 llvm::sys::fs::create_directories(
2121 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
2122 if (llvm::Error Err = GlobalModuleIndex::writeIndex(
2123 getFileManager(), getPCHContainerReader(),
2124 getPreprocessor().getHeaderSearchInfo().getModuleCachePath())) {
2125 // FIXME this drops the error on the floor. This code is only used for
2126 // typo correction and drops more than just this one source of errors
2127 // (such as the directory creation failure above). It should handle the
2128 // error.
2129 consumeError(std::move(Err));
2130 return nullptr;
2131 }
2132 TheASTReader->resetForReload();
2133 TheASTReader->loadGlobalIndex();
2134 GlobalIndex = TheASTReader->getGlobalIndex();
2135 }
2136 // For finding modules needing to be imported for fixit messages,
2137 // we need to make the global index cover all modules, so we do that here.
2138 if (!HaveFullGlobalModuleIndex && GlobalIndex && !buildingModule()) {
2139 ModuleMap &MMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
2140 bool RecreateIndex = false;
2141 for (ModuleMap::module_iterator I = MMap.module_begin(),
2142 E = MMap.module_end(); I != E; ++I) {
2143 Module *TheModule = I->second;
2144 const FileEntry *Entry = TheModule->getASTFile();
2145 if (!Entry) {
2146 SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
2147 Path.push_back(std::make_pair(
2148 getPreprocessor().getIdentifierInfo(TheModule->Name), TriggerLoc));
2149 std::reverse(Path.begin(), Path.end());
2150 // Load a module as hidden. This also adds it to the global index.
2151 loadModule(TheModule->DefinitionLoc, Path, Module::Hidden, false);
2152 RecreateIndex = true;
2153 }
2154 }
2155 if (RecreateIndex) {
2156 if (llvm::Error Err = GlobalModuleIndex::writeIndex(
2157 getFileManager(), getPCHContainerReader(),
2158 getPreprocessor().getHeaderSearchInfo().getModuleCachePath())) {
2159 // FIXME As above, this drops the error on the floor.
2160 consumeError(std::move(Err));
2161 return nullptr;
2162 }
2163 TheASTReader->resetForReload();
2164 TheASTReader->loadGlobalIndex();
2165 GlobalIndex = TheASTReader->getGlobalIndex();
2166 }
2167 HaveFullGlobalModuleIndex = true;
2168 }
2169 return GlobalIndex;
2170 }
2171
2172 // Check global module index for missing imports.
2173 bool
lookupMissingImports(StringRef Name,SourceLocation TriggerLoc)2174 CompilerInstance::lookupMissingImports(StringRef Name,
2175 SourceLocation TriggerLoc) {
2176 // Look for the symbol in non-imported modules, but only if an error
2177 // actually occurred.
2178 if (!buildingModule()) {
2179 // Load global module index, or retrieve a previously loaded one.
2180 GlobalModuleIndex *GlobalIndex = loadGlobalModuleIndex(
2181 TriggerLoc);
2182
2183 // Only if we have a global index.
2184 if (GlobalIndex) {
2185 GlobalModuleIndex::HitSet FoundModules;
2186
2187 // Find the modules that reference the identifier.
2188 // Note that this only finds top-level modules.
2189 // We'll let diagnoseTypo find the actual declaration module.
2190 if (GlobalIndex->lookupIdentifier(Name, FoundModules))
2191 return true;
2192 }
2193 }
2194
2195 return false;
2196 }
resetAndLeakSema()2197 void CompilerInstance::resetAndLeakSema() { llvm::BuryPointer(takeSema()); }
2198
setExternalSemaSource(IntrusiveRefCntPtr<ExternalSemaSource> ESS)2199 void CompilerInstance::setExternalSemaSource(
2200 IntrusiveRefCntPtr<ExternalSemaSource> ESS) {
2201 ExternalSemaSrc = std::move(ESS);
2202 }
2203