blob: cd67166d518fa2a81ca52653f04b32b6c4029759 [file] [log] [blame]
Daniel Dunbar636404a2009-11-13 03:51:44 +00001//===--- CompilerInstance.cpp ---------------------------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#include "clang/Frontend/CompilerInstance.h"
Daniel Dunbar56d9c292009-11-14 02:47:17 +000011#include "clang/AST/ASTConsumer.h"
Daniel Dunbardf3e30c2009-11-13 08:20:47 +000012#include "clang/AST/ASTContext.h"
Douglas Gregorbcfc7d02011-12-02 23:42:12 +000013#include "clang/AST/Decl.h"
Daniel Dunbar636404a2009-11-13 03:51:44 +000014#include "clang/Basic/Diagnostic.h"
Daniel Dunbar546a6762009-11-13 04:12:06 +000015#include "clang/Basic/FileManager.h"
16#include "clang/Basic/SourceManager.h"
Daniel Dunbar636404a2009-11-13 03:51:44 +000017#include "clang/Basic/TargetInfo.h"
Daniel Dunbar4f2bc552010-01-13 00:48:06 +000018#include "clang/Basic/Version.h"
Alp Tokerf988d002014-06-06 10:36:22 +000019#include "clang/Config/config.h"
David Blaikie8b00dcb2011-09-26 00:21:47 +000020#include "clang/Frontend/ChainedDiagnosticConsumer.h"
Daniel Dunbar4f2bc552010-01-13 00:48:06 +000021#include "clang/Frontend/FrontendAction.h"
Douglas Gregorfaeb1d42011-09-12 23:31:24 +000022#include "clang/Frontend/FrontendActions.h"
Daniel Dunbarf7093b52009-11-13 09:36:05 +000023#include "clang/Frontend/FrontendDiagnostic.h"
Daniel Dunbar2083c322011-04-07 18:31:10 +000024#include "clang/Frontend/LogDiagnosticPrinter.h"
Ted Kremenek4610ea22011-10-29 00:12:39 +000025#include "clang/Frontend/SerializedDiagnosticPrinter.h"
Daniel Dunbar7d75afc2009-11-13 05:52:34 +000026#include "clang/Frontend/TextDiagnosticPrinter.h"
Daniel Dunbaraaa148f2009-11-13 05:52:11 +000027#include "clang/Frontend/Utils.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000028#include "clang/Frontend/VerifyDiagnosticConsumer.h"
29#include "clang/Lex/HeaderSearch.h"
30#include "clang/Lex/PTHManager.h"
31#include "clang/Lex/Preprocessor.h"
Mehdi Amini9670f842016-07-18 19:02:11 +000032#include "clang/Lex/PreprocessorOptions.h"
Daniel Dunbarf7093b52009-11-13 09:36:05 +000033#include "clang/Sema/CodeCompleteConsumer.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000034#include "clang/Sema/Sema.h"
35#include "clang/Serialization/ASTReader.h"
John Thompson2255f2c2014-04-23 12:57:01 +000036#include "clang/Serialization/GlobalModuleIndex.h"
Douglas Gregor171b7802010-03-30 17:33:59 +000037#include "llvm/ADT/Statistic.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000038#include "llvm/Support/CrashRecoveryContext.h"
Rafael Espindola71de0b62014-06-13 17:20:50 +000039#include "llvm/Support/Errc.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000040#include "llvm/Support/FileSystem.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000041#include "llvm/Support/Host.h"
Douglas Gregore2124892012-01-29 20:15:24 +000042#include "llvm/Support/LockFileManager.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000043#include "llvm/Support/MemoryBuffer.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000044#include "llvm/Support/Path.h"
45#include "llvm/Support/Program.h"
46#include "llvm/Support/Signals.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000047#include "llvm/Support/Timer.h"
48#include "llvm/Support/raw_ostream.h"
Douglas Gregor527b1c92013-03-25 21:19:16 +000049#include <sys/stat.h>
Rafael Espindola8a8e5542014-06-12 17:19:42 +000050#include <system_error>
Douglas Gregor37da3272013-03-25 21:51:16 +000051#include <time.h>
Benjamin Kramercfeacf52016-05-27 14:27:13 +000052#include <utility>
Douglas Gregor54a88812011-10-05 14:53:30 +000053
Daniel Dunbar636404a2009-11-13 03:51:44 +000054using namespace clang;
55
Adrian Prantlbb165fb2015-06-20 18:53:08 +000056CompilerInstance::CompilerInstance(
57 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
58 bool BuildingModule)
59 : ModuleLoader(BuildingModule), Invocation(new CompilerInvocation()),
Benjamin Kramercfeacf52016-05-27 14:27:13 +000060 ModuleManager(nullptr),
61 ThePCHContainerOperations(std::move(PCHContainerOps)),
Adrian Prantlbb165fb2015-06-20 18:53:08 +000062 BuildGlobalModuleIndex(false), HaveFullGlobalModuleIndex(false),
63 ModuleBuildFailed(false) {}
Daniel Dunbar636404a2009-11-13 03:51:44 +000064
65CompilerInstance::~CompilerInstance() {
Benjamin Kramer3c717b42012-10-14 19:21:21 +000066 assert(OutputFiles.empty() && "Still output files in flight?");
Daniel Dunbare922d9b2010-02-16 01:54:47 +000067}
68
Daniel Dunbar68242252010-01-30 21:47:07 +000069void CompilerInstance::setInvocation(CompilerInvocation *Value) {
Ted Kremenek5e14d392011-03-21 18:40:17 +000070 Invocation = Value;
Daniel Dunbar68242252010-01-30 21:47:07 +000071}
72
Douglas Gregorc1bbec82013-01-25 00:45:27 +000073bool CompilerInstance::shouldBuildGlobalModuleIndex() const {
Douglas Gregore060e572013-01-25 01:03:03 +000074 return (BuildGlobalModuleIndex ||
Douglas Gregor11ef0b72013-03-22 21:26:48 +000075 (ModuleManager && ModuleManager->isGlobalIndexUnavailable() &&
76 getFrontendOpts().GenerateGlobalModuleIndex)) &&
Douglas Gregore060e572013-01-25 01:03:03 +000077 !ModuleBuildFailed;
Douglas Gregorc1bbec82013-01-25 00:45:27 +000078}
79
David Blaikie9c902b52011-09-25 23:23:43 +000080void CompilerInstance::setDiagnostics(DiagnosticsEngine *Value) {
Douglas Gregor7f95d262010-04-05 23:52:57 +000081 Diagnostics = Value;
Daniel Dunbare01dc862009-11-14 01:20:40 +000082}
83
Artem Belevichb5bc9232015-09-22 17:23:22 +000084void CompilerInstance::setTarget(TargetInfo *Value) { Target = Value; }
85void CompilerInstance::setAuxTarget(TargetInfo *Value) { AuxTarget = Value; }
Daniel Dunbare01dc862009-11-14 01:20:40 +000086
87void CompilerInstance::setFileManager(FileManager *Value) {
Ted Kremenek5e14d392011-03-21 18:40:17 +000088 FileMgr = Value;
Ben Langmuirc8130a72014-02-20 21:59:23 +000089 if (Value)
90 VirtualFileSystem = Value->getVirtualFileSystem();
91 else
92 VirtualFileSystem.reset();
Daniel Dunbare01dc862009-11-14 01:20:40 +000093}
94
NAKAMURA Takumi82a35112011-10-08 11:31:46 +000095void CompilerInstance::setSourceManager(SourceManager *Value) {
Ted Kremenek5e14d392011-03-21 18:40:17 +000096 SourceMgr = Value;
Daniel Dunbare01dc862009-11-14 01:20:40 +000097}
98
Ted Kremenek5e14d392011-03-21 18:40:17 +000099void CompilerInstance::setPreprocessor(Preprocessor *Value) { PP = Value; }
Daniel Dunbare01dc862009-11-14 01:20:40 +0000100
Richard Smith293534b2015-08-18 20:39:29 +0000101void CompilerInstance::setASTContext(ASTContext *Value) {
102 Context = Value;
103
104 if (Context && Consumer)
105 getASTConsumer().Initialize(getASTContext());
106}
Daniel Dunbare01dc862009-11-14 01:20:40 +0000107
Douglas Gregor0e93f012010-08-12 23:31:19 +0000108void CompilerInstance::setSema(Sema *S) {
109 TheSema.reset(S);
110}
111
David Blaikie6beb6aa2014-08-10 19:56:51 +0000112void CompilerInstance::setASTConsumer(std::unique_ptr<ASTConsumer> Value) {
113 Consumer = std::move(Value);
Richard Smith293534b2015-08-18 20:39:29 +0000114
115 if (Context && Consumer)
116 getASTConsumer().Initialize(getASTContext());
Daniel Dunbar56d9c292009-11-14 02:47:17 +0000117}
118
Daniel Dunbare01dc862009-11-14 01:20:40 +0000119void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
120 CompletionConsumer.reset(Value);
121}
David Blaikie61535812014-08-10 20:12:39 +0000122
123std::unique_ptr<Sema> CompilerInstance::takeSema() {
124 return std::move(TheSema);
125}
126
Argyrios Kyrtzidis1b7ed912014-02-27 04:11:59 +0000127IntrusiveRefCntPtr<ASTReader> CompilerInstance::getModuleManager() const {
128 return ModuleManager;
129}
130void CompilerInstance::setModuleManager(IntrusiveRefCntPtr<ASTReader> Reader) {
Benjamin Kramerd6da1a02016-06-12 20:05:23 +0000131 ModuleManager = std::move(Reader);
Argyrios Kyrtzidis1b7ed912014-02-27 04:11:59 +0000132}
Daniel Dunbare01dc862009-11-14 01:20:40 +0000133
Justin Bogner86d12592014-06-19 19:36:03 +0000134std::shared_ptr<ModuleDependencyCollector>
135CompilerInstance::getModuleDepCollector() const {
136 return ModuleDepCollector;
137}
138
139void CompilerInstance::setModuleDepCollector(
140 std::shared_ptr<ModuleDependencyCollector> Collector) {
Benjamin Kramerd6da1a02016-06-12 20:05:23 +0000141 ModuleDepCollector = std::move(Collector);
Justin Bogner86d12592014-06-19 19:36:03 +0000142}
143
Bruno Cardoso Lopes181225b2016-12-11 04:27:28 +0000144static void collectHeaderMaps(const HeaderSearch &HS,
145 std::shared_ptr<ModuleDependencyCollector> MDC) {
146 SmallVector<std::string, 4> HeaderMapFileNames;
147 HS.getHeaderMapFileNames(HeaderMapFileNames);
148 for (auto &Name : HeaderMapFileNames)
149 MDC->addFile(Name);
150}
151
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000152// Diagnostics
Douglas Gregor811db4e2012-10-23 22:26:28 +0000153static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts,
Daniel Dunbar7b833062011-04-07 18:59:02 +0000154 const CodeGenOptions *CodeGenOpts,
David Blaikie9c902b52011-09-25 23:23:43 +0000155 DiagnosticsEngine &Diags) {
Rafael Espindoladae941a2014-08-25 18:17:04 +0000156 std::error_code EC;
David Blaikie11f8a942014-09-15 17:30:56 +0000157 std::unique_ptr<raw_ostream> StreamOwner;
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000158 raw_ostream *OS = &llvm::errs();
Douglas Gregor811db4e2012-10-23 22:26:28 +0000159 if (DiagOpts->DiagnosticLogFile != "-") {
Daniel Dunbar2083c322011-04-07 18:31:10 +0000160 // Create the output stream.
David Blaikie11f8a942014-09-15 17:30:56 +0000161 auto FileOS = llvm::make_unique<llvm::raw_fd_ostream>(
Rafael Espindoladae941a2014-08-25 18:17:04 +0000162 DiagOpts->DiagnosticLogFile, EC,
David Blaikie11f8a942014-09-15 17:30:56 +0000163 llvm::sys::fs::F_Append | llvm::sys::fs::F_Text);
Rafael Espindoladae941a2014-08-25 18:17:04 +0000164 if (EC) {
Daniel Dunbar2083c322011-04-07 18:31:10 +0000165 Diags.Report(diag::warn_fe_cc_log_diagnostics_failure)
Rafael Espindoladae941a2014-08-25 18:17:04 +0000166 << DiagOpts->DiagnosticLogFile << EC.message();
Daniel Dunbar2083c322011-04-07 18:31:10 +0000167 } else {
168 FileOS->SetUnbuffered();
David Blaikie11f8a942014-09-15 17:30:56 +0000169 OS = FileOS.get();
170 StreamOwner = std::move(FileOS);
Daniel Dunbar2083c322011-04-07 18:31:10 +0000171 }
172 }
173
174 // Chain in the diagnostic client which will log the diagnostics.
David Blaikie7ee25502014-09-15 17:50:10 +0000175 auto Logger = llvm::make_unique<LogDiagnosticPrinter>(*OS, DiagOpts,
176 std::move(StreamOwner));
Daniel Dunbar7b833062011-04-07 18:59:02 +0000177 if (CodeGenOpts)
178 Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
David Blaikie7ee25502014-09-15 17:50:10 +0000179 assert(Diags.ownsClient());
Alexander Kornienko41c247a2014-11-17 23:46:02 +0000180 Diags.setClient(
181 new ChainedDiagnosticConsumer(Diags.takeClient(), std::move(Logger)));
Daniel Dunbar2083c322011-04-07 18:31:10 +0000182}
183
Douglas Gregor811db4e2012-10-23 22:26:28 +0000184static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts,
Ted Kremenek4610ea22011-10-29 00:12:39 +0000185 DiagnosticsEngine &Diags,
186 StringRef OutputFile) {
David Blaikie7ee25502014-09-15 17:50:10 +0000187 auto SerializedConsumer =
Justin Bogner5a6a2fc2014-10-23 22:20:11 +0000188 clang::serialized_diags::create(OutputFile, DiagOpts);
Ahmed Charles9a16beb2014-03-07 19:33:25 +0000189
Alexander Kornienko254b7db2014-11-13 13:08:27 +0000190 if (Diags.ownsClient()) {
191 Diags.setClient(new ChainedDiagnosticConsumer(
Alexander Kornienko41c247a2014-11-17 23:46:02 +0000192 Diags.takeClient(), std::move(SerializedConsumer)));
Alexander Kornienko254b7db2014-11-13 13:08:27 +0000193 } else {
194 Diags.setClient(new ChainedDiagnosticConsumer(
Alexander Kornienko4c0ef3792014-11-17 14:46:28 +0000195 Diags.getClient(), std::move(SerializedConsumer)));
Alexander Kornienko254b7db2014-11-13 13:08:27 +0000196 }
Ted Kremenek4610ea22011-10-29 00:12:39 +0000197}
198
Sean Silvaf1b49e22013-01-20 01:58:28 +0000199void CompilerInstance::createDiagnostics(DiagnosticConsumer *Client,
Douglas Gregor30071cea2013-05-03 23:07:45 +0000200 bool ShouldOwnClient) {
Sean Silvaf1b49e22013-01-20 01:58:28 +0000201 Diagnostics = createDiagnostics(&getDiagnosticOpts(), Client,
Douglas Gregor30071cea2013-05-03 23:07:45 +0000202 ShouldOwnClient, &getCodeGenOpts());
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000203}
204
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000205IntrusiveRefCntPtr<DiagnosticsEngine>
Douglas Gregor811db4e2012-10-23 22:26:28 +0000206CompilerInstance::createDiagnostics(DiagnosticOptions *Opts,
David Blaikiee2eefae2011-09-25 23:39:51 +0000207 DiagnosticConsumer *Client,
Douglas Gregor2b9b4642011-09-13 01:26:44 +0000208 bool ShouldOwnClient,
Daniel Dunbar7b833062011-04-07 18:59:02 +0000209 const CodeGenOptions *CodeGenOpts) {
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000210 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
211 IntrusiveRefCntPtr<DiagnosticsEngine>
Douglas Gregor811db4e2012-10-23 22:26:28 +0000212 Diags(new DiagnosticsEngine(DiagID, Opts));
Daniel Dunbar1b39a2e2009-11-14 07:53:24 +0000213
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000214 // Create the diagnostic client for reporting errors or for
215 // implementing -verify.
Douglas Gregord0e9e3a2011-09-29 00:38:00 +0000216 if (Client) {
Douglas Gregor30071cea2013-05-03 23:07:45 +0000217 Diags->setClient(Client, ShouldOwnClient);
Douglas Gregord0e9e3a2011-09-29 00:38:00 +0000218 } else
Douglas Gregor44c6ee72010-11-11 00:39:14 +0000219 Diags->setClient(new TextDiagnosticPrinter(llvm::errs(), Opts));
Daniel Dunbar50ec0da2009-11-14 03:24:39 +0000220
221 // Chain in -verify checker, if requested.
Douglas Gregor811db4e2012-10-23 22:26:28 +0000222 if (Opts->VerifyDiagnostics)
David Blaikie69609dc2011-09-26 00:38:03 +0000223 Diags->setClient(new VerifyDiagnosticConsumer(*Diags));
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000224
Daniel Dunbar2083c322011-04-07 18:31:10 +0000225 // Chain in -diagnostic-log-file dumper, if requested.
Douglas Gregor811db4e2012-10-23 22:26:28 +0000226 if (!Opts->DiagnosticLogFile.empty())
Daniel Dunbar7b833062011-04-07 18:59:02 +0000227 SetUpDiagnosticLog(Opts, CodeGenOpts, *Diags);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000228
Douglas Gregor811db4e2012-10-23 22:26:28 +0000229 if (!Opts->DiagnosticSerializationFile.empty())
Ted Kremenek4610ea22011-10-29 00:12:39 +0000230 SetupSerializedDiagnostics(Opts, *Diags,
Douglas Gregor811db4e2012-10-23 22:26:28 +0000231 Opts->DiagnosticSerializationFile);
Ted Kremenek4610ea22011-10-29 00:12:39 +0000232
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000233 // Configure our handling of diagnostics.
Douglas Gregor811db4e2012-10-23 22:26:28 +0000234 ProcessWarningOptions(*Diags, *Opts);
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000235
Douglas Gregor7f95d262010-04-05 23:52:57 +0000236 return Diags;
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000237}
238
239// File Manager
240
Daniel Dunbar546a6762009-11-13 04:12:06 +0000241void CompilerInstance::createFileManager() {
Ben Langmuirc8130a72014-02-20 21:59:23 +0000242 if (!hasVirtualFileSystem()) {
243 // TODO: choose the virtual file system based on the CompilerInvocation.
244 setVirtualFileSystem(vfs::getRealFileSystem());
245 }
246 FileMgr = new FileManager(getFileSystemOpts(), VirtualFileSystem);
Daniel Dunbar546a6762009-11-13 04:12:06 +0000247}
248
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000249// Source Manager
250
Chris Lattner5159f612010-11-23 08:35:12 +0000251void CompilerInstance::createSourceManager(FileManager &FileMgr) {
Ted Kremenek5e14d392011-03-21 18:40:17 +0000252 SourceMgr = new SourceManager(getDiagnostics(), FileMgr);
Daniel Dunbar546a6762009-11-13 04:12:06 +0000253}
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000254
Alp Tokerc3580002014-07-07 06:05:00 +0000255// Initialize the remapping of files to alternative contents, e.g.,
256// those specified through other files.
257static void InitializeFileRemapping(DiagnosticsEngine &Diags,
258 SourceManager &SourceMgr,
259 FileManager &FileMgr,
260 const PreprocessorOptions &InitOpts) {
261 // Remap files in the source manager (with buffers).
Alp Toker1b070d22014-07-07 07:47:20 +0000262 for (const auto &RB : InitOpts.RemappedFileBuffers) {
Alp Tokerc3580002014-07-07 06:05:00 +0000263 // Create the file entry for the file that we're mapping from.
264 const FileEntry *FromFile =
Alp Toker1b070d22014-07-07 07:47:20 +0000265 FileMgr.getVirtualFile(RB.first, RB.second->getBufferSize(), 0);
Alp Tokerc3580002014-07-07 06:05:00 +0000266 if (!FromFile) {
Alp Toker1b070d22014-07-07 07:47:20 +0000267 Diags.Report(diag::err_fe_remap_missing_from_file) << RB.first;
Alp Tokerc3580002014-07-07 06:05:00 +0000268 if (!InitOpts.RetainRemappedFileBuffers)
Alp Toker1b070d22014-07-07 07:47:20 +0000269 delete RB.second;
Alp Tokerc3580002014-07-07 06:05:00 +0000270 continue;
271 }
272
273 // Override the contents of the "from" file with the contents of
274 // the "to" file.
Alp Toker1b070d22014-07-07 07:47:20 +0000275 SourceMgr.overrideFileContents(FromFile, RB.second,
Alp Tokerc3580002014-07-07 06:05:00 +0000276 InitOpts.RetainRemappedFileBuffers);
277 }
278
279 // Remap files in the source manager (with other files).
Alp Toker1b070d22014-07-07 07:47:20 +0000280 for (const auto &RF : InitOpts.RemappedFiles) {
Alp Tokerc3580002014-07-07 06:05:00 +0000281 // Find the file that we're mapping to.
Alp Toker1b070d22014-07-07 07:47:20 +0000282 const FileEntry *ToFile = FileMgr.getFile(RF.second);
Alp Tokerc3580002014-07-07 06:05:00 +0000283 if (!ToFile) {
Alp Toker1b070d22014-07-07 07:47:20 +0000284 Diags.Report(diag::err_fe_remap_missing_to_file) << RF.first << RF.second;
Alp Tokerc3580002014-07-07 06:05:00 +0000285 continue;
286 }
287
288 // Create the file entry for the file that we're mapping from.
289 const FileEntry *FromFile =
Alp Toker1b070d22014-07-07 07:47:20 +0000290 FileMgr.getVirtualFile(RF.first, ToFile->getSize(), 0);
Alp Tokerc3580002014-07-07 06:05:00 +0000291 if (!FromFile) {
Alp Toker1b070d22014-07-07 07:47:20 +0000292 Diags.Report(diag::err_fe_remap_missing_from_file) << RF.first;
Alp Tokerc3580002014-07-07 06:05:00 +0000293 continue;
294 }
295
296 // Override the contents of the "from" file with the contents of
297 // the "to" file.
298 SourceMgr.overrideFileContents(FromFile, ToFile);
299 }
300
301 SourceMgr.setOverridenFilesKeepOriginalName(
302 InitOpts.RemappedFilesKeepOriginalName);
303}
304
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000305// Preprocessor
306
Argyrios Kyrtzidise1974dc2014-03-07 07:47:58 +0000307void CompilerInstance::createPreprocessor(TranslationUnitKind TUKind) {
Douglas Gregor08142532011-08-26 23:56:07 +0000308 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000309
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000310 // Create a PTH manager if we are using some form of a token cache.
Craig Topper49a27902014-05-22 04:46:25 +0000311 PTHManager *PTHMgr = nullptr;
Daniel Dunbard6ea9022009-11-17 05:52:41 +0000312 if (!PPOpts.TokenCache.empty())
Douglas Gregor08142532011-08-26 23:56:07 +0000313 PTHMgr = PTHManager::Create(PPOpts.TokenCache, getDiagnostics());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000314
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000315 // Create the Preprocessor.
Douglas Gregorb85b9cc2012-10-24 16:19:39 +0000316 HeaderSearch *HeaderInfo = new HeaderSearch(&getHeaderSearchOpts(),
Manuel Klimek1f76c4e2013-10-24 07:51:24 +0000317 getSourceManager(),
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +0000318 getDiagnostics(),
Douglas Gregor89929282012-01-30 06:01:29 +0000319 getLangOpts(),
320 &getTarget());
Alp Toker96637802014-05-02 03:43:38 +0000321 PP = new Preprocessor(&getPreprocessorOpts(), getDiagnostics(), getLangOpts(),
Douglas Gregor08142532011-08-26 23:56:07 +0000322 getSourceManager(), *HeaderInfo, *this, PTHMgr,
Alp Toker96637802014-05-02 03:43:38 +0000323 /*OwnsHeaderSearch=*/true, TUKind);
Artem Belevichb5bc9232015-09-22 17:23:22 +0000324 PP->Initialize(getTarget(), getAuxTarget());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000325
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000326 // Note that this is different then passing PTHMgr to Preprocessor's ctor.
327 // That argument is used as the IdentifierInfoLookup argument to
328 // IdentifierTable's ctor.
329 if (PTHMgr) {
Douglas Gregor08142532011-08-26 23:56:07 +0000330 PTHMgr->setPreprocessor(&*PP);
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000331 PP->setPTHManager(PTHMgr);
332 }
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000333
Douglas Gregor7f6d60d2010-03-19 16:15:56 +0000334 if (PPOpts.DetailedRecord)
Argyrios Kyrtzidisf3d587e2012-12-04 07:27:05 +0000335 PP->createPreprocessingRecord();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000336
Alp Tokerc3580002014-07-07 06:05:00 +0000337 // Apply remappings to the source manager.
338 InitializeFileRemapping(PP->getDiagnostics(), PP->getSourceManager(),
339 PP->getFileManager(), PPOpts);
340
341 // Predefine macros and configure the preprocessor.
Adrian Prantlfb2398d2015-07-17 01:19:54 +0000342 InitializePreprocessor(*PP, PPOpts, getPCHContainerReader(),
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000343 getFrontendOpts());
Alp Tokerc3580002014-07-07 06:05:00 +0000344
Justin Lebarf91086b2016-11-18 00:41:27 +0000345 // Initialize the header search object. In CUDA compilations, we use the aux
346 // triple (the host triple) to initialize our header search, since we need to
347 // find the host headers in order to compile the CUDA code.
348 const llvm::Triple *HeaderSearchTriple = &PP->getTargetInfo().getTriple();
349 if (PP->getTargetInfo().getTriple().getOS() == llvm::Triple::CUDA &&
350 PP->getAuxTargetInfo())
351 HeaderSearchTriple = &PP->getAuxTargetInfo()->getTriple();
352
Alp Tokerc3580002014-07-07 06:05:00 +0000353 ApplyHeaderSearchOptions(PP->getHeaderSearchInfo(), getHeaderSearchOpts(),
Justin Lebarf91086b2016-11-18 00:41:27 +0000354 PP->getLangOpts(), *HeaderSearchTriple);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000355
Jordan Rose17441582013-01-30 01:52:57 +0000356 PP->setPreprocessedOutput(getPreprocessorOutputOpts().ShowCPP);
357
Richard Smith3938f0c2015-08-15 00:34:15 +0000358 if (PP->getLangOpts().Modules && PP->getLangOpts().ImplicitModules)
Chandler Carruthff8d9432015-03-28 01:10:44 +0000359 PP->getHeaderSearchInfo().setModuleCachePath(getSpecificModuleCachePath());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000360
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000361 // Handle generating dependencies, if requested.
Douglas Gregor08142532011-08-26 23:56:07 +0000362 const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000363 if (!DepOpts.OutputFile.empty())
Ben Langmuircb69b572014-03-07 06:40:32 +0000364 TheDependencyFileGenerator.reset(
365 DependencyFileGenerator::CreateAndAttachToPreprocessor(*PP, DepOpts));
Douglas Gregor2e129652012-02-02 23:45:13 +0000366 if (!DepOpts.DOTOutputFile.empty())
367 AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
Douglas Gregor83d46be2012-02-02 00:54:52 +0000368 getHeaderSearchOpts().Sysroot);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000369
Justin Bogner86d12592014-06-19 19:36:03 +0000370 // If we don't have a collector, but we are collecting module dependencies,
371 // then we're the top level compiler instance and need to create one.
Bruno Cardoso Lopesb1631d92016-03-29 23:47:40 +0000372 if (!ModuleDepCollector && !DepOpts.ModuleDependencyOutputDir.empty()) {
Justin Bogner86d12592014-06-19 19:36:03 +0000373 ModuleDepCollector = std::make_shared<ModuleDependencyCollector>(
374 DepOpts.ModuleDependencyOutputDir);
Bruno Cardoso Lopesb1631d92016-03-29 23:47:40 +0000375 }
376
Bruno Cardoso Lopes181225b2016-12-11 04:27:28 +0000377 // If there is a module dep collector, register with other dep collectors
378 // and also (a) collect header maps and (b) TODO: input vfs overlay files.
379 if (ModuleDepCollector) {
Bruno Cardoso Lopesb1631d92016-03-29 23:47:40 +0000380 addDependencyCollector(ModuleDepCollector);
Bruno Cardoso Lopes181225b2016-12-11 04:27:28 +0000381 collectHeaderMaps(PP->getHeaderSearchInfo(), ModuleDepCollector);
382 }
Bruno Cardoso Lopesb1631d92016-03-29 23:47:40 +0000383
384 for (auto &Listener : DependencyCollectors)
385 Listener->attachToPreprocessor(*PP);
Hans Wennborg0fd62072013-08-09 00:32:23 +0000386
Daniel Dunbar27734fd2011-02-02 15:41:17 +0000387 // Handle generating header include information, if requested.
388 if (DepOpts.ShowHeaderIncludes)
Nico Weberf54146c2016-03-23 18:46:57 +0000389 AttachHeaderIncludeGen(*PP, DepOpts);
Daniel Dunbar1af1d27512011-02-02 21:11:31 +0000390 if (!DepOpts.HeaderIncludeOutputFile.empty()) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000391 StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
Daniel Dunbar1af1d27512011-02-02 21:11:31 +0000392 if (OutputPath == "-")
393 OutputPath = "";
Nico Weberf54146c2016-03-23 18:46:57 +0000394 AttachHeaderIncludeGen(*PP, DepOpts,
Ivan Krasin1193f2c2015-08-13 04:04:37 +0000395 /*ShowAllHeaders=*/true, OutputPath,
Daniel Dunbarfe908a82011-03-21 19:37:38 +0000396 /*ShowDepth=*/false);
Daniel Dunbar1af1d27512011-02-02 21:11:31 +0000397 }
Hans Wennborg0fd62072013-08-09 00:32:23 +0000398
399 if (DepOpts.PrintShowIncludes) {
Nico Weberf54146c2016-03-23 18:46:57 +0000400 AttachHeaderIncludeGen(*PP, DepOpts,
Nico Weber149d95222016-03-23 18:00:22 +0000401 /*ShowAllHeaders=*/true, /*OutputPath=*/"",
Hans Wennborg0fd62072013-08-09 00:32:23 +0000402 /*ShowDepth=*/true, /*MSStyle=*/true);
403 }
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000404}
Daniel Dunbardf3e30c2009-11-13 08:20:47 +0000405
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000406std::string CompilerInstance::getSpecificModuleCachePath() {
407 // Set up the module path, including the hash for the
408 // module-creation options.
Richard Smithd520a252015-07-21 18:07:47 +0000409 SmallString<256> SpecificModuleCache(getHeaderSearchOpts().ModuleCachePath);
410 if (!SpecificModuleCache.empty() && !getHeaderSearchOpts().DisableModuleHash)
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000411 llvm::sys::path::append(SpecificModuleCache,
412 getInvocation().getModuleHash());
413 return SpecificModuleCache.str();
414}
415
Daniel Dunbardf3e30c2009-11-13 08:20:47 +0000416// ASTContext
417
418void CompilerInstance::createASTContext() {
419 Preprocessor &PP = getPreprocessor();
Richard Smith293534b2015-08-18 20:39:29 +0000420 auto *Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
421 PP.getIdentifierTable(), PP.getSelectorTable(),
422 PP.getBuiltinInfo());
Artem Belevichb5bc9232015-09-22 17:23:22 +0000423 Context->InitBuiltinTypes(getTarget(), getAuxTarget());
Richard Smith293534b2015-08-18 20:39:29 +0000424 setASTContext(Context);
Daniel Dunbardf3e30c2009-11-13 08:20:47 +0000425}
Daniel Dunbar599313e2009-11-13 08:21:10 +0000426
427// ExternalASTSource
428
Nico Weber824285e2014-05-08 04:26:47 +0000429void CompilerInstance::createPCHExternalASTSource(
430 StringRef Path, bool DisablePCHValidation, bool AllowPCHWithCompilerErrors,
431 void *DeserializationListener, bool OwnDeserializationListener) {
Sebastian Redl009e7f22010-10-05 16:15:19 +0000432 bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
Richard Smith4eca9b92015-02-04 23:37:59 +0000433 ModuleManager = createPCHExternalASTSource(
Nico Weber824285e2014-05-08 04:26:47 +0000434 Path, getHeaderSearchOpts().Sysroot, DisablePCHValidation,
435 AllowPCHWithCompilerErrors, getPreprocessor(), getASTContext(),
Douglas Gregor6623e1f2015-11-03 18:33:07 +0000436 getPCHContainerReader(),
437 getFrontendOpts().ModuleFileExtensions,
438 DeserializationListener,
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000439 OwnDeserializationListener, Preamble,
Nico Weber824285e2014-05-08 04:26:47 +0000440 getFrontendOpts().UseGlobalModuleIndex);
Daniel Dunbar599313e2009-11-13 08:21:10 +0000441}
442
Richard Smith4eca9b92015-02-04 23:37:59 +0000443IntrusiveRefCntPtr<ASTReader> CompilerInstance::createPCHExternalASTSource(
Yaron Keren5b816062015-07-06 08:47:15 +0000444 StringRef Path, StringRef Sysroot, bool DisablePCHValidation,
Nico Weber824285e2014-05-08 04:26:47 +0000445 bool AllowPCHWithCompilerErrors, Preprocessor &PP, ASTContext &Context,
Adrian Prantlfb2398d2015-07-17 01:19:54 +0000446 const PCHContainerReader &PCHContainerRdr,
Douglas Gregor6623e1f2015-11-03 18:33:07 +0000447 ArrayRef<IntrusiveRefCntPtr<ModuleFileExtension>> Extensions,
Nico Weber824285e2014-05-08 04:26:47 +0000448 void *DeserializationListener, bool OwnDeserializationListener,
449 bool Preamble, bool UseGlobalModuleIndex) {
Ben Langmuirdcf73862014-03-12 00:06:17 +0000450 HeaderSearchOptions &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
451
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000452 IntrusiveRefCntPtr<ASTReader> Reader(new ASTReader(
Douglas Gregor6623e1f2015-11-03 18:33:07 +0000453 PP, Context, PCHContainerRdr, Extensions,
454 Sysroot.empty() ? "" : Sysroot.data(), DisablePCHValidation,
455 AllowPCHWithCompilerErrors, /*AllowConfigurationMismatch*/ false,
456 HSOpts.ModulesValidateSystemHeaders, UseGlobalModuleIndex));
Richard Smith4eca9b92015-02-04 23:37:59 +0000457
458 // We need the external source to be set up before we read the AST, because
459 // eagerly-deserialized declarations may use it.
460 Context.setExternalSource(Reader.get());
Daniel Dunbar599313e2009-11-13 08:21:10 +0000461
Sebastian Redl07a89a82010-07-30 00:29:29 +0000462 Reader->setDeserializationListener(
Nico Weber824285e2014-05-08 04:26:47 +0000463 static_cast<ASTDeserializationListener *>(DeserializationListener),
464 /*TakeOwnership=*/OwnDeserializationListener);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000465 switch (Reader->ReadAST(Path,
466 Preamble ? serialization::MK_Preamble
Douglas Gregor4b29c162012-10-22 23:51:00 +0000467 : serialization::MK_PCH,
Argyrios Kyrtzidis2ec29362012-11-15 18:57:22 +0000468 SourceLocation(),
Ben Langmuir3d4417c2014-02-07 17:31:11 +0000469 ASTReader::ARR_None)) {
Sebastian Redl2c499f62010-08-18 23:56:43 +0000470 case ASTReader::Success:
Daniel Dunbar599313e2009-11-13 08:21:10 +0000471 // Set the predefines buffer as suggested by the PCH reader. Typically, the
472 // predefines buffer will be empty.
473 PP.setPredefines(Reader->getSuggestedPredefines());
Richard Smith4eca9b92015-02-04 23:37:59 +0000474 return Reader;
Daniel Dunbar599313e2009-11-13 08:21:10 +0000475
Sebastian Redl2c499f62010-08-18 23:56:43 +0000476 case ASTReader::Failure:
Daniel Dunbar599313e2009-11-13 08:21:10 +0000477 // Unrecoverable failure: don't even try to process the input file.
478 break;
479
Douglas Gregor7029ce12013-03-19 00:28:20 +0000480 case ASTReader::Missing:
Douglas Gregorc9ad5fb2012-10-22 22:50:17 +0000481 case ASTReader::OutOfDate:
482 case ASTReader::VersionMismatch:
483 case ASTReader::ConfigurationMismatch:
484 case ASTReader::HadErrors:
Daniel Dunbar599313e2009-11-13 08:21:10 +0000485 // No suitable PCH file could be found. Return an error.
486 break;
487 }
488
Richard Smith4eca9b92015-02-04 23:37:59 +0000489 Context.setExternalSource(nullptr);
Craig Topper49a27902014-05-22 04:46:25 +0000490 return nullptr;
Daniel Dunbar599313e2009-11-13 08:21:10 +0000491}
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000492
493// Code Completion
494
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000495static bool EnableCodeCompletion(Preprocessor &PP,
Benjamin Kramer0772c422016-02-13 13:42:54 +0000496 StringRef Filename,
Douglas Gregor8e984da2010-08-04 16:47:14 +0000497 unsigned Line,
498 unsigned Column) {
499 // Tell the source manager to chop off the given file at a specific
500 // line and column.
Chris Lattner5159f612010-11-23 08:35:12 +0000501 const FileEntry *Entry = PP.getFileManager().getFile(Filename);
Douglas Gregor8e984da2010-08-04 16:47:14 +0000502 if (!Entry) {
503 PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
504 << Filename;
505 return true;
506 }
507
508 // Truncate the named file at the given line/column.
509 PP.SetCodeCompletionPoint(Entry, Line, Column);
510 return false;
511}
512
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000513void CompilerInstance::createCodeCompletionConsumer() {
514 const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
Douglas Gregor8e984da2010-08-04 16:47:14 +0000515 if (!CompletionConsumer) {
Erik Verbruggen2fca3c22012-04-12 10:31:12 +0000516 setCodeCompletionConsumer(
Douglas Gregor8e984da2010-08-04 16:47:14 +0000517 createCodeCompletionConsumer(getPreprocessor(),
518 Loc.FileName, Loc.Line, Loc.Column,
Dmitri Gribenko3292d062012-07-02 17:35:10 +0000519 getFrontendOpts().CodeCompleteOpts,
Douglas Gregor8e984da2010-08-04 16:47:14 +0000520 llvm::outs()));
521 if (!CompletionConsumer)
522 return;
523 } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
524 Loc.Line, Loc.Column)) {
Craig Topper49a27902014-05-22 04:46:25 +0000525 setCodeCompletionConsumer(nullptr);
Douglas Gregor00a0cf72010-03-16 06:04:47 +0000526 return;
Douglas Gregor8e984da2010-08-04 16:47:14 +0000527 }
Douglas Gregorf09935f2009-12-01 05:55:20 +0000528
529 if (CompletionConsumer->isOutputBinary() &&
Rafael Espindolaa3346d82013-06-12 20:44:26 +0000530 llvm::sys::ChangeStdoutToBinary()) {
Douglas Gregorf09935f2009-12-01 05:55:20 +0000531 getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
Craig Topper49a27902014-05-22 04:46:25 +0000532 setCodeCompletionConsumer(nullptr);
Douglas Gregorf09935f2009-12-01 05:55:20 +0000533 }
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000534}
535
Kovarththanan Rajaratnam5505dff2009-11-29 09:57:35 +0000536void CompilerInstance::createFrontendTimer() {
Matthias Braunae032b62016-11-18 19:43:25 +0000537 FrontendTimerGroup.reset(
538 new llvm::TimerGroup("frontend", "Clang front-end time report"));
Richard Smithce18a182015-07-14 00:26:00 +0000539 FrontendTimer.reset(
Matthias Braunae032b62016-11-18 19:43:25 +0000540 new llvm::Timer("frontend", "Clang front-end timer",
541 *FrontendTimerGroup));
Kovarththanan Rajaratnam5505dff2009-11-29 09:57:35 +0000542}
543
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000544CodeCompleteConsumer *
545CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
Yaron Keren5b816062015-07-06 08:47:15 +0000546 StringRef Filename,
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000547 unsigned Line,
548 unsigned Column,
Dmitri Gribenko3292d062012-07-02 17:35:10 +0000549 const CodeCompleteOptions &Opts,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000550 raw_ostream &OS) {
Douglas Gregor8e984da2010-08-04 16:47:14 +0000551 if (EnableCodeCompletion(PP, Filename, Line, Column))
Craig Topper49a27902014-05-22 04:46:25 +0000552 return nullptr;
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000553
554 // Set up the creation routine for code-completion.
Dmitri Gribenko3292d062012-07-02 17:35:10 +0000555 return new PrintingCodeCompleteConsumer(Opts, OS);
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000556}
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000557
Douglas Gregor69f74f82011-08-25 22:30:56 +0000558void CompilerInstance::createSema(TranslationUnitKind TUKind,
Douglas Gregor0e93f012010-08-12 23:31:19 +0000559 CodeCompleteConsumer *CompletionConsumer) {
560 TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
Douglas Gregor69f74f82011-08-25 22:30:56 +0000561 TUKind, CompletionConsumer));
Benjamin Kramer7de99692016-11-16 18:15:26 +0000562 // Attach the external sema source if there is any.
563 if (ExternalSemaSrc) {
564 TheSema->addExternalSource(ExternalSemaSrc.get());
565 ExternalSemaSrc->InitializeSema(*TheSema);
566 }
Douglas Gregor0e93f012010-08-12 23:31:19 +0000567}
568
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000569// Output Files
570
Rafael Espindola269ec0f2015-04-10 14:11:52 +0000571void CompilerInstance::addOutputFile(OutputFile &&OutFile) {
Rafael Espindola269ec0f2015-04-10 14:11:52 +0000572 OutputFiles.push_back(std::move(OutFile));
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000573}
574
Kovarththanan Rajaratnam1c558cd2010-03-06 12:07:48 +0000575void CompilerInstance::clearOutputFiles(bool EraseFiles) {
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000576 for (OutputFile &OF : OutputFiles) {
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000577 if (!OF.TempFilename.empty()) {
Anders Carlssonb5c356a2011-03-06 22:25:35 +0000578 if (EraseFiles) {
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000579 llvm::sys::fs::remove(OF.TempFilename);
Anders Carlssonb5c356a2011-03-06 22:25:35 +0000580 } else {
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000581 SmallString<128> NewOutFile(OF.Filename);
Anders Carlssonb5c356a2011-03-06 22:25:35 +0000582
Argyrios Kyrtzidis71731d62010-11-03 22:45:23 +0000583 // If '-working-directory' was passed, the output filename should be
584 // relative to that.
Anders Carlsson9ba8fb12011-03-14 01:13:54 +0000585 FileMgr->FixupRelativePath(NewOutFile);
Rafael Espindolac0809172014-06-12 14:02:15 +0000586 if (std::error_code ec =
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000587 llvm::sys::fs::rename(OF.TempFilename, NewOutFile)) {
Manuel Klimek3ef9c442012-05-16 20:55:58 +0000588 getDiagnostics().Report(diag::err_unable_to_rename_temp)
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000589 << OF.TempFilename << OF.Filename << ec.message();
Anders Carlssonb5c356a2011-03-06 22:25:35 +0000590
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000591 llvm::sys::fs::remove(OF.TempFilename);
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000592 }
593 }
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000594 } else if (!OF.Filename.empty() && EraseFiles)
595 llvm::sys::fs::remove(OF.Filename);
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000596 }
597 OutputFiles.clear();
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000598 NonSeekStream.reset();
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000599}
600
Peter Collingbourne03f89072016-07-15 00:55:40 +0000601std::unique_ptr<raw_pwrite_stream>
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000602CompilerInstance::createDefaultOutputFile(bool Binary, StringRef InFile,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000603 StringRef Extension) {
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000604 return createOutputFile(getFrontendOpts().OutputFile, Binary,
Daniel Dunbarae77b3d2012-03-03 00:36:06 +0000605 /*RemoveFileOnSignal=*/true, InFile, Extension,
606 /*UseTemporary=*/true);
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000607}
608
Peter Collingbourne03f89072016-07-15 00:55:40 +0000609std::unique_ptr<raw_pwrite_stream> CompilerInstance::createNullOutputFile() {
610 return llvm::make_unique<llvm::raw_null_ostream>();
Alp Tokerea046722014-06-03 17:23:34 +0000611}
612
Peter Collingbourne03f89072016-07-15 00:55:40 +0000613std::unique_ptr<raw_pwrite_stream>
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000614CompilerInstance::createOutputFile(StringRef OutputPath, bool Binary,
615 bool RemoveFileOnSignal, StringRef InFile,
616 StringRef Extension, bool UseTemporary,
Daniel Dunbarb9c62c02012-03-03 00:36:02 +0000617 bool CreateMissingDirectories) {
Rafael Espindoladae941a2014-08-25 18:17:04 +0000618 std::string OutputPathName, TempPathName;
619 std::error_code EC;
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000620 std::unique_ptr<raw_pwrite_stream> OS = createOutputFile(
Rafael Espindoladae941a2014-08-25 18:17:04 +0000621 OutputPath, EC, Binary, RemoveFileOnSignal, InFile, Extension,
Rafael Espindolac80a4062015-04-10 14:30:43 +0000622 UseTemporary, CreateMissingDirectories, &OutputPathName, &TempPathName);
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000623 if (!OS) {
Rafael Espindoladae941a2014-08-25 18:17:04 +0000624 getDiagnostics().Report(diag::err_fe_unable_to_open_output) << OutputPath
625 << EC.message();
Craig Topper49a27902014-05-22 04:46:25 +0000626 return nullptr;
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000627 }
628
629 // Add the output file -- but don't try to remove "-", since this means we are
630 // using stdin.
Peter Collingbourne03f89072016-07-15 00:55:40 +0000631 addOutputFile(
632 OutputFile((OutputPathName != "-") ? OutputPathName : "", TempPathName));
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000633
Peter Collingbourne03f89072016-07-15 00:55:40 +0000634 return OS;
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000635}
636
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000637std::unique_ptr<llvm::raw_pwrite_stream> CompilerInstance::createOutputFile(
Rafael Espindoladae941a2014-08-25 18:17:04 +0000638 StringRef OutputPath, std::error_code &Error, bool Binary,
639 bool RemoveFileOnSignal, StringRef InFile, StringRef Extension,
640 bool UseTemporary, bool CreateMissingDirectories,
641 std::string *ResultPathName, std::string *TempPathName) {
Daniel Dunbarb9c62c02012-03-03 00:36:02 +0000642 assert((!CreateMissingDirectories || UseTemporary) &&
643 "CreateMissingDirectories is only allowed when using temporary files");
644
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000645 std::string OutFile, TempFile;
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000646 if (!OutputPath.empty()) {
647 OutFile = OutputPath;
648 } else if (InFile == "-") {
649 OutFile = "-";
650 } else if (!Extension.empty()) {
Rafael Espindola399ab332013-06-26 04:32:59 +0000651 SmallString<128> Path(InFile);
652 llvm::sys::path::replace_extension(Path, Extension);
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000653 OutFile = Path.str();
654 } else {
655 OutFile = "-";
656 }
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000657
Ahmed Charlesb8984322014-03-07 20:03:18 +0000658 std::unique_ptr<llvm::raw_fd_ostream> OS;
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000659 std::string OSFile;
660
Rafael Espindola73c23a72013-06-27 18:26:26 +0000661 if (UseTemporary) {
662 if (OutFile == "-")
663 UseTemporary = false;
664 else {
665 llvm::sys::fs::file_status Status;
666 llvm::sys::fs::status(OutputPath, Status);
667 if (llvm::sys::fs::exists(Status)) {
668 // Fail early if we can't write to the final destination.
Douglas Katzman8bfac2c2015-09-17 16:45:12 +0000669 if (!llvm::sys::fs::can_write(OutputPath)) {
Rafael Espindolaee4e08b2015-10-05 11:49:35 +0000670 Error = make_error_code(llvm::errc::operation_not_permitted);
Craig Topper49a27902014-05-22 04:46:25 +0000671 return nullptr;
Douglas Katzman8bfac2c2015-09-17 16:45:12 +0000672 }
Rafael Espindola73c23a72013-06-27 18:26:26 +0000673
674 // Don't use a temporary if the output is a special file. This handles
675 // things like '-o /dev/null'
676 if (!llvm::sys::fs::is_regular_file(Status))
677 UseTemporary = false;
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000678 }
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000679 }
680 }
681
Rafael Espindola73c23a72013-06-27 18:26:26 +0000682 if (UseTemporary) {
Rafael Espindola73c23a72013-06-27 18:26:26 +0000683 // Create a temporary file.
684 SmallString<128> TempPath;
685 TempPath = OutFile;
686 TempPath += "-%%%%%%%%";
687 int fd;
Rafael Espindolac0809172014-06-12 14:02:15 +0000688 std::error_code EC =
Yaron Keren92e1b622015-03-18 10:17:07 +0000689 llvm::sys::fs::createUniqueFile(TempPath, fd, TempPath);
Rafael Espindola157f34b2013-06-28 03:49:04 +0000690
691 if (CreateMissingDirectories &&
Rafael Espindola71de0b62014-06-13 17:20:50 +0000692 EC == llvm::errc::no_such_file_or_directory) {
Rafael Espindola157f34b2013-06-28 03:49:04 +0000693 StringRef Parent = llvm::sys::path::parent_path(OutputPath);
694 EC = llvm::sys::fs::create_directories(Parent);
695 if (!EC) {
Yaron Keren92e1b622015-03-18 10:17:07 +0000696 EC = llvm::sys::fs::createUniqueFile(TempPath, fd, TempPath);
Rafael Espindola157f34b2013-06-28 03:49:04 +0000697 }
698 }
699
700 if (!EC) {
NAKAMURA Takumi69f35282014-08-11 06:53:11 +0000701 OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
Rafael Espindola73c23a72013-06-27 18:26:26 +0000702 OSFile = TempFile = TempPath.str();
703 }
704 // If we failed to create the temporary, fallback to writing to the file
705 // directly. This handles the corner case where we cannot write to the
706 // directory, but can write to the file.
707 }
708
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000709 if (!OS) {
710 OSFile = OutFile;
NAKAMURA Takumi69f35282014-08-11 06:53:11 +0000711 OS.reset(new llvm::raw_fd_ostream(
Rafael Espindoladae941a2014-08-25 18:17:04 +0000712 OSFile, Error,
NAKAMURA Takumi69f35282014-08-11 06:53:11 +0000713 (Binary ? llvm::sys::fs::F_None : llvm::sys::fs::F_Text)));
Rafael Espindoladae941a2014-08-25 18:17:04 +0000714 if (Error)
Craig Topper49a27902014-05-22 04:46:25 +0000715 return nullptr;
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000716 }
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000717
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000718 // Make sure the out stream file gets removed if we crash.
Daniel Dunbare326f9b2011-01-31 22:00:42 +0000719 if (RemoveFileOnSignal)
Rafael Espindola18556de2013-06-13 21:02:40 +0000720 llvm::sys::RemoveFileOnSignal(OSFile);
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000721
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000722 if (ResultPathName)
723 *ResultPathName = OutFile;
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000724 if (TempPathName)
725 *TempPathName = TempFile;
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000726
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000727 if (!Binary || OS->supportsSeeking())
728 return std::move(OS);
729
730 auto B = llvm::make_unique<llvm::buffer_ostream>(*OS);
731 assert(!NonSeekStream);
732 NonSeekStream = std::move(OS);
733 return std::move(B);
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000734}
Daniel Dunbar409e8902009-11-14 07:53:04 +0000735
736// Initialization Utilities
737
Argyrios Kyrtzidis1b3240b2012-11-09 19:40:33 +0000738bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
Nico Weber2ca4be92016-03-01 23:16:44 +0000739 return InitializeSourceManager(
740 Input, getDiagnostics(), getFileManager(), getSourceManager(),
741 hasPreprocessor() ? &getPreprocessor().getHeaderSearchInfo() : nullptr,
Nico Weber4b5aede2016-03-13 02:44:13 +0000742 getDependencyOutputOpts(), getFrontendOpts());
Daniel Dunbar409e8902009-11-14 07:53:04 +0000743}
744
Nico Weber2ca4be92016-03-01 23:16:44 +0000745// static
Nico Weber4b5aede2016-03-13 02:44:13 +0000746bool CompilerInstance::InitializeSourceManager(
747 const FrontendInputFile &Input, DiagnosticsEngine &Diags,
748 FileManager &FileMgr, SourceManager &SourceMgr, HeaderSearch *HS,
749 DependencyOutputOptions &DepOpts, const FrontendOptions &Opts) {
Argyrios Kyrtzidis1b3240b2012-11-09 19:40:33 +0000750 SrcMgr::CharacteristicKind
Argyrios Kyrtzidis873c8582012-11-09 19:40:39 +0000751 Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
Argyrios Kyrtzidis1b3240b2012-11-09 19:40:33 +0000752
Argyrios Kyrtzidis6566e232012-11-09 19:40:45 +0000753 if (Input.isBuffer()) {
David Blaikie50a5f972014-08-29 07:59:55 +0000754 SourceMgr.setMainFileID(SourceMgr.createFileID(
755 std::unique_ptr<llvm::MemoryBuffer>(Input.getBuffer()), Kind));
Yaron Keren8b563662015-10-03 10:46:20 +0000756 assert(SourceMgr.getMainFileID().isValid() &&
Argyrios Kyrtzidis6566e232012-11-09 19:40:45 +0000757 "Couldn't establish MainFileID!");
758 return true;
759 }
760
761 StringRef InputFile = Input.getFile();
762
Argyrios Kyrtzidis7c06d862011-09-19 20:40:35 +0000763 // Figure out where to get and map in the main file.
764 if (InputFile != "-") {
Nico Weber2ca4be92016-03-01 23:16:44 +0000765 const FileEntry *File;
766 if (Opts.FindPchSource.empty()) {
767 File = FileMgr.getFile(InputFile, /*OpenFile=*/true);
768 } else {
769 // When building a pch file in clang-cl mode, the .h file is built as if
770 // it was included by a cc file. Since the driver doesn't know about
771 // all include search directories, the frontend must search the input
772 // file through HeaderSearch here, as if it had been included by the
773 // cc file at Opts.FindPchSource.
774 const FileEntry *FindFile = FileMgr.getFile(Opts.FindPchSource);
775 if (!FindFile) {
776 Diags.Report(diag::err_fe_error_reading) << Opts.FindPchSource;
777 return false;
778 }
779 const DirectoryLookup *UnusedCurDir;
780 SmallVector<std::pair<const FileEntry *, const DirectoryEntry *>, 16>
781 Includers;
782 Includers.push_back(std::make_pair(FindFile, FindFile->getDir()));
783 File = HS->LookupFile(InputFile, SourceLocation(), /*isAngled=*/false,
784 /*FromDir=*/nullptr,
785 /*CurDir=*/UnusedCurDir, Includers,
786 /*SearchPath=*/nullptr,
787 /*RelativePath=*/nullptr,
788 /*RequestingModule=*/nullptr,
789 /*SuggestedModule=*/nullptr, /*SkipCache=*/true);
Nico Weber4b5aede2016-03-13 02:44:13 +0000790 // Also add the header to /showIncludes output.
791 if (File)
Nico Weberf54146c2016-03-23 18:46:57 +0000792 DepOpts.ShowIncludesPretendHeader = File->getName();
Nico Weber2ca4be92016-03-01 23:16:44 +0000793 }
Dan Gohman52765212010-10-26 21:13:51 +0000794 if (!File) {
Daniel Dunbar409e8902009-11-14 07:53:04 +0000795 Diags.Report(diag::err_fe_error_reading) << InputFile;
796 return false;
797 }
Daniel Dunbare2951f42012-11-05 22:53:33 +0000798
799 // The natural SourceManager infrastructure can't currently handle named
800 // pipes, but we would at least like to accept them for the main
Benjamin Kramer3841fa32013-08-12 13:46:52 +0000801 // file. Detect them here, read them with the volatile flag so FileMgr will
802 // pick up the correct size, and simply override their contents as we do for
803 // STDIN.
Daniel Dunbare2951f42012-11-05 22:53:33 +0000804 if (File->isNamedPipe()) {
Benjamin Kramera8857962014-10-26 22:44:13 +0000805 auto MB = FileMgr.getBufferForFile(File, /*isVolatile=*/true);
806 if (MB) {
Benjamin Kramer3841fa32013-08-12 13:46:52 +0000807 // Create a new virtual file that will have the correct size.
Benjamin Kramera8857962014-10-26 22:44:13 +0000808 File = FileMgr.getVirtualFile(InputFile, (*MB)->getBufferSize(), 0);
809 SourceMgr.overrideFileContents(File, std::move(*MB));
Benjamin Kramer3841fa32013-08-12 13:46:52 +0000810 } else {
Benjamin Kramera8857962014-10-26 22:44:13 +0000811 Diags.Report(diag::err_cannot_open_file) << InputFile
812 << MB.getError().message();
Daniel Dunbare2951f42012-11-05 22:53:33 +0000813 return false;
814 }
Daniel Dunbare2951f42012-11-05 22:53:33 +0000815 }
Daniel Dunbardb0745a2012-11-27 00:04:16 +0000816
Alp Tokerb671e342014-05-21 01:12:41 +0000817 SourceMgr.setMainFileID(
818 SourceMgr.createFileID(File, SourceLocation(), Kind));
Daniel Dunbar409e8902009-11-14 07:53:04 +0000819 } else {
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000820 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> SBOrErr =
821 llvm::MemoryBuffer::getSTDIN();
822 if (std::error_code EC = SBOrErr.getError()) {
823 Diags.Report(diag::err_fe_error_reading_stdin) << EC.message();
Daniel Dunbar409e8902009-11-14 07:53:04 +0000824 return false;
825 }
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000826 std::unique_ptr<llvm::MemoryBuffer> SB = std::move(SBOrErr.get());
827
Dan Gohman2f76cd72010-10-26 23:21:25 +0000828 const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
Chris Lattner5159f612010-11-23 08:35:12 +0000829 SB->getBufferSize(), 0);
Alp Tokerb671e342014-05-21 01:12:41 +0000830 SourceMgr.setMainFileID(
831 SourceMgr.createFileID(File, SourceLocation(), Kind));
David Blaikie49cc3182014-08-27 20:54:45 +0000832 SourceMgr.overrideFileContents(File, std::move(SB));
Daniel Dunbar409e8902009-11-14 07:53:04 +0000833 }
834
Yaron Keren8b563662015-10-03 10:46:20 +0000835 assert(SourceMgr.getMainFileID().isValid() &&
Dan Gohman52765212010-10-26 21:13:51 +0000836 "Couldn't establish MainFileID!");
Daniel Dunbar409e8902009-11-14 07:53:04 +0000837 return true;
838}
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000839
840// High-Level Operations
841
842bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
843 assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
844 assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
845 assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
846
847 // FIXME: Take this as an argument, once all the APIs we used have moved to
848 // taking it as an input instead of hard-coding llvm::errs.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000849 raw_ostream &OS = llvm::errs();
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000850
851 // Create the target instance.
Alp Toker80758082014-07-06 05:26:44 +0000852 setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(),
Saleem Abdulrasool10a49722016-04-08 16:52:00 +0000853 getInvocation().TargetOpts));
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000854 if (!hasTarget())
855 return false;
856
Artem Belevichb5bc9232015-09-22 17:23:22 +0000857 // Create TargetInfo for the other side of CUDA compilation.
858 if (getLangOpts().CUDA && !getFrontendOpts().AuxTriple.empty()) {
Justin Lebar76945b22016-04-29 23:05:19 +0000859 auto TO = std::make_shared<TargetOptions>();
Artem Belevichb5bc9232015-09-22 17:23:22 +0000860 TO->Triple = getFrontendOpts().AuxTriple;
Justin Lebar76945b22016-04-29 23:05:19 +0000861 TO->HostTriple = getTarget().getTriple().str();
Saleem Abdulrasool10a49722016-04-08 16:52:00 +0000862 setAuxTarget(TargetInfo::CreateTargetInfo(getDiagnostics(), TO));
Artem Belevichb5bc9232015-09-22 17:23:22 +0000863 }
864
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000865 // Inform the target of the language options.
866 //
867 // FIXME: We shouldn't need to do this, the target should be immutable once
868 // created. This complexity should be lifted elsewhere.
Alp Toker74437972014-07-06 05:14:24 +0000869 getTarget().adjust(getLangOpts());
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000870
Yaxun Liu2c17e822016-08-09 19:43:38 +0000871 // Adjust target options based on codegen options.
872 getTarget().adjustTargetOptions(getCodeGenOpts(), getTargetOpts());
873
Fariborz Jahanian29898f42012-04-16 21:03:30 +0000874 // rewriter project will change target built-in bool type from its default.
875 if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
876 getTarget().noSignedCharForObjCBool();
877
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000878 // Validate/process some options.
879 if (getHeaderSearchOpts().Verbose)
880 OS << "clang -cc1 version " CLANG_VERSION_STRING
Alp Tokerf988d002014-06-06 10:36:22 +0000881 << " based upon " << BACKEND_PACKAGE_STRING
Sebastian Pop8188c8a2011-11-01 21:33:06 +0000882 << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000883
884 if (getFrontendOpts().ShowTimers)
885 createFrontendTimer();
886
Matthias Braunabb6eea2016-09-26 18:53:34 +0000887 if (getFrontendOpts().ShowStats || !getFrontendOpts().StatsFile.empty())
Matthias Braunec1c5a22016-09-27 19:38:59 +0000888 llvm::EnableStatistics(false);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000889
Vedant Kumar5b60ad62015-11-16 00:59:34 +0000890 for (const FrontendInputFile &FIF : getFrontendOpts().Inputs) {
Ted Kremenekeeccb302014-08-27 15:14:15 +0000891 // Reset the ID tables if we are reusing the SourceManager and parsing
892 // regular files.
893 if (hasSourceManager() && !Act.isModelParsingAction())
Daniel Dunbaraed46fc2010-06-07 23:23:50 +0000894 getSourceManager().clearIDTables();
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000895
Vedant Kumar5b60ad62015-11-16 00:59:34 +0000896 if (Act.BeginSourceFile(*this, FIF)) {
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000897 Act.Execute();
898 Act.EndSourceFile();
899 }
900 }
901
Argyrios Kyrtzidis7910d7b2011-12-07 05:52:12 +0000902 // Notify the diagnostic client that all files were processed.
903 getDiagnostics().getClient()->finish();
904
Chris Lattner198cb4d2010-04-07 18:47:42 +0000905 if (getDiagnosticOpts().ShowCarets) {
Argyrios Kyrtzidisc79346a2010-11-18 20:06:46 +0000906 // We can have multiple diagnostics sharing one diagnostic client.
907 // Get the total number of warnings/errors from the client.
908 unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
909 unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000910
Chris Lattner198cb4d2010-04-07 18:47:42 +0000911 if (NumWarnings)
912 OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
913 if (NumWarnings && NumErrors)
914 OS << " and ";
915 if (NumErrors)
916 OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
917 if (NumWarnings || NumErrors)
918 OS << " generated.\n";
919 }
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000920
Matthias Braunabb6eea2016-09-26 18:53:34 +0000921 if (getFrontendOpts().ShowStats) {
922 if (hasFileManager()) {
923 getFileManager().PrintStats();
924 OS << '\n';
925 }
926 llvm::PrintStatistics(OS);
927 }
928 StringRef StatsFile = getFrontendOpts().StatsFile;
929 if (!StatsFile.empty()) {
930 std::error_code EC;
931 auto StatS = llvm::make_unique<llvm::raw_fd_ostream>(StatsFile, EC,
932 llvm::sys::fs::F_Text);
933 if (EC) {
934 getDiagnostics().Report(diag::warn_fe_unable_to_open_stats_file)
935 << StatsFile << EC.message();
936 } else {
937 llvm::PrintStatisticsJSON(*StatS);
938 }
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000939 }
940
Argyrios Kyrtzidisbc467932010-11-18 21:13:57 +0000941 return !getDiagnostics().getClient()->getNumErrors();
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000942}
943
Douglas Gregorfaeb1d42011-09-12 23:31:24 +0000944/// \brief Determine the appropriate source input kind based on language
945/// options.
946static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
947 if (LangOpts.OpenCL)
948 return IK_OpenCL;
949 if (LangOpts.CUDA)
950 return IK_CUDA;
951 if (LangOpts.ObjC1)
952 return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
953 return LangOpts.CPlusPlus? IK_CXX : IK_C;
954}
955
Douglas Gregor514b6362011-11-29 19:06:37 +0000956/// \brief Compile a module file for the given module, using the options
Ben Langmuirb797d592014-07-19 16:29:28 +0000957/// provided by the importing compiler instance. Returns true if the module
958/// was built without errors.
959static bool compileModuleImpl(CompilerInstance &ImportingInstance,
960 SourceLocation ImportLoc,
961 Module *Module,
962 StringRef ModuleFileName) {
Douglas Gregor514b6362011-11-29 19:06:37 +0000963 ModuleMap &ModMap
964 = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
965
Douglas Gregorfaeb1d42011-09-12 23:31:24 +0000966 // Construct a compiler invocation for creating this module.
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000967 IntrusiveRefCntPtr<CompilerInvocation> Invocation
Douglas Gregorfaeb1d42011-09-12 23:31:24 +0000968 (new CompilerInvocation(ImportingInstance.getInvocation()));
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000969
Douglas Gregorf545f672011-11-29 21:59:16 +0000970 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
971
Douglas Gregor44bf68d2011-09-15 20:53:28 +0000972 // For any options that aren't intended to affect how a module is built,
973 // reset them to their default values.
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000974 Invocation->getLangOpts()->resetNonModularOptions();
Douglas Gregorf545f672011-11-29 21:59:16 +0000975 PPOpts.resetNonModularOptions();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000976
Douglas Gregor5dc38992013-02-07 00:21:12 +0000977 // Remove any macro definitions that are explicitly ignored by the module.
978 // They aren't supposed to affect how the module is built anyway.
979 const HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
Benjamin Kramerbbdd7642014-03-01 14:48:57 +0000980 PPOpts.Macros.erase(
981 std::remove_if(PPOpts.Macros.begin(), PPOpts.Macros.end(),
982 [&HSOpts](const std::pair<std::string, bool> &def) {
983 StringRef MacroDef = def.first;
Justin Lebar5e83dfe2016-10-21 21:45:01 +0000984 return HSOpts.ModulesIgnoreMacros.count(
985 llvm::CachedHashString(MacroDef.split('=').first)) > 0;
Benjamin Kramerbbdd7642014-03-01 14:48:57 +0000986 }),
987 PPOpts.Macros.end());
Douglas Gregor5dc38992013-02-07 00:21:12 +0000988
Douglas Gregor7d106e42011-11-15 19:35:01 +0000989 // Note the name of the module we're building.
Douglas Gregor6dc57922011-11-29 18:31:39 +0000990 Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
Douglas Gregor7d106e42011-11-15 19:35:01 +0000991
Douglas Gregor7a626572012-11-29 23:55:25 +0000992 // Make sure that the failed-module structure has been allocated in
993 // the importing instance, and propagate the pointer to the newly-created
994 // instance.
995 PreprocessorOptions &ImportingPPOpts
996 = ImportingInstance.getInvocation().getPreprocessorOpts();
997 if (!ImportingPPOpts.FailedModules)
998 ImportingPPOpts.FailedModules = new PreprocessorOptions::FailedModulesSet;
999 PPOpts.FailedModules = ImportingPPOpts.FailedModules;
1000
Douglas Gregorf545f672011-11-29 21:59:16 +00001001 // If there is a module map file, build the module using the module map.
Douglas Gregor44bf68d2011-09-15 20:53:28 +00001002 // Set up the inputs/outputs so that we build the module from its umbrella
1003 // header.
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001004 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
Douglas Gregor1735f4e2011-09-13 23:15:45 +00001005 FrontendOpts.OutputFile = ModuleFileName.str();
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001006 FrontendOpts.DisableFree = false;
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001007 FrontendOpts.GenerateGlobalModuleIndex = false;
Richard Smithe75ee0f2015-08-17 07:13:32 +00001008 FrontendOpts.BuildingImplicitModule = true;
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001009 FrontendOpts.Inputs.clear();
Douglas Gregorf545f672011-11-29 21:59:16 +00001010 InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +00001011
Douglas Gregorf545f672011-11-29 21:59:16 +00001012 // Don't free the remapped file buffers; they are owned by our caller.
1013 PPOpts.RetainRemappedFileBuffers = true;
1014
Douglas Gregor2b9b4642011-09-13 01:26:44 +00001015 Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
Douglas Gregor3728ea72011-09-13 23:20:27 +00001016 assert(ImportingInstance.getInvocation().getModuleHash() ==
Douglas Gregorf545f672011-11-29 21:59:16 +00001017 Invocation->getModuleHash() && "Module hash mismatch!");
1018
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001019 // Construct a compiler instance that will be used to actually create the
1020 // module.
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001021 CompilerInstance Instance(ImportingInstance.getPCHContainerOperations(),
1022 /*BuildingModule=*/true);
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001023 Instance.setInvocation(&*Invocation);
Douglas Gregor6b930962013-05-03 22:58:43 +00001024
1025 Instance.createDiagnostics(new ForwardingDiagnosticConsumer(
1026 ImportingInstance.getDiagnosticClient()),
Douglas Gregor30071cea2013-05-03 23:07:45 +00001027 /*ShouldOwnClient=*/true);
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001028
Ben Langmuirc8130a72014-02-20 21:59:23 +00001029 Instance.setVirtualFileSystem(&ImportingInstance.getVirtualFileSystem());
1030
Douglas Gregor63365432012-11-30 22:11:57 +00001031 // Note that this module is part of the module build stack, so that we
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001032 // can detect cycles in the module graph.
Ben Langmuird066d4c2014-02-28 21:16:07 +00001033 Instance.setFileManager(&ImportingInstance.getFileManager());
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001034 Instance.createSourceManager(Instance.getFileManager());
1035 SourceManager &SourceMgr = Instance.getSourceManager();
Douglas Gregor63365432012-11-30 22:11:57 +00001036 SourceMgr.setModuleBuildStack(
1037 ImportingInstance.getSourceManager().getModuleBuildStack());
1038 SourceMgr.pushModuleBuildStack(Module->getTopLevelModuleName(),
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001039 FullSourceLoc(ImportLoc, ImportingInstance.getSourceManager()));
1040
Justin Bogner86d12592014-06-19 19:36:03 +00001041 // If we're collecting module dependencies, we need to share a collector
Richard Smith38c1e6d2015-08-09 06:03:55 +00001042 // between all of the module CompilerInstances. Other than that, we don't
1043 // want to produce any dependency output from the module build.
Justin Bogner86d12592014-06-19 19:36:03 +00001044 Instance.setModuleDepCollector(ImportingInstance.getModuleDepCollector());
Richard Smith38c1e6d2015-08-09 06:03:55 +00001045 Invocation->getDependencyOutputOpts() = DependencyOutputOptions();
Justin Bogner86d12592014-06-19 19:36:03 +00001046
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001047 // Get or create the module map that we'll use to build this module.
1048 std::string InferredModuleMapContent;
1049 if (const FileEntry *ModuleMapFile =
1050 ModMap.getContainingModuleMapFile(Module)) {
1051 // Use the module map where this module resides.
Benjamin Kramer3204b152015-05-29 19:42:19 +00001052 FrontendOpts.Inputs.emplace_back(ModuleMapFile->getName(), IK);
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001053 } else {
Richard Smith2b63d152015-05-16 02:28:53 +00001054 SmallString<128> FakeModuleMapFile(Module->Directory->getName());
1055 llvm::sys::path::append(FakeModuleMapFile, "__inferred_module.map");
Benjamin Kramer3204b152015-05-29 19:42:19 +00001056 FrontendOpts.Inputs.emplace_back(FakeModuleMapFile, IK);
Richard Smith2b63d152015-05-16 02:28:53 +00001057
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001058 llvm::raw_string_ostream OS(InferredModuleMapContent);
1059 Module->print(OS);
1060 OS.flush();
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001061
Rafael Espindolad87f8d72014-08-27 20:03:29 +00001062 std::unique_ptr<llvm::MemoryBuffer> ModuleMapBuffer =
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001063 llvm::MemoryBuffer::getMemBuffer(InferredModuleMapContent);
1064 ModuleMapFile = Instance.getFileManager().getVirtualFile(
Richard Smith2b63d152015-05-16 02:28:53 +00001065 FakeModuleMapFile, InferredModuleMapContent.size(), 0);
David Blaikie49cc3182014-08-27 20:54:45 +00001066 SourceMgr.overrideFileContents(ModuleMapFile, std::move(ModuleMapBuffer));
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001067 }
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001068
Ben Langmuir9d6448b2014-08-09 00:57:23 +00001069 // Construct a module-generating action. Passing through the module map is
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001070 // safe because the FileManager is shared between the compiler instances.
Richard Smithbbcc9f02016-08-26 00:14:38 +00001071 GenerateModuleFromModuleMapAction CreateModuleAction(
Ben Langmuir9d6448b2014-08-09 00:57:23 +00001072 ModMap.getModuleMapFileForUniquing(Module), Module->IsSystem);
Richard Smith99891da2014-10-14 02:08:30 +00001073
1074 ImportingInstance.getDiagnostics().Report(ImportLoc,
1075 diag::remark_module_build)
1076 << Module->Name << ModuleFileName;
1077
Douglas Gregor51e0b542011-10-04 00:21:21 +00001078 // Execute the action to actually build the module in-place. Use a separate
1079 // thread so that we get a stack large enough.
1080 const unsigned ThreadStackSize = 8 << 20;
1081 llvm::CrashRecoveryContext CRC;
Richard Smith841f1c72014-03-04 21:50:01 +00001082 CRC.RunSafelyOnThread([&]() { Instance.ExecuteAction(CreateModuleAction); },
1083 ThreadStackSize);
Douglas Gregor6b930962013-05-03 22:58:43 +00001084
Richard Smith99891da2014-10-14 02:08:30 +00001085 ImportingInstance.getDiagnostics().Report(ImportLoc,
1086 diag::remark_module_build_done)
1087 << Module->Name;
1088
Douglas Gregorf545f672011-11-29 21:59:16 +00001089 // Delete the temporary module map file.
1090 // FIXME: Even though we're executing under crash protection, it would still
1091 // be nice to do this with RemoveFileOnSignal when we can. However, that
1092 // doesn't make sense for all clients, so clean this up manually.
Benjamin Kramer13afbf42012-10-14 19:50:53 +00001093 Instance.clearOutputFiles(/*EraseFiles=*/true);
Douglas Gregor5e306b12013-01-23 22:38:11 +00001094
1095 // We've rebuilt a module. If we're allowed to generate or update the global
1096 // module index, record that fact in the importing compiler instance.
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001097 if (ImportingInstance.getFrontendOpts().GenerateGlobalModuleIndex) {
Douglas Gregor5e306b12013-01-23 22:38:11 +00001098 ImportingInstance.setBuildGlobalModuleIndex(true);
1099 }
Ben Langmuirb797d592014-07-19 16:29:28 +00001100
1101 return !Instance.getDiagnostics().hasErrorOccurred();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +00001102}
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001103
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001104static bool compileAndLoadModule(CompilerInstance &ImportingInstance,
1105 SourceLocation ImportLoc,
Ben Langmuirb797d592014-07-19 16:29:28 +00001106 SourceLocation ModuleNameLoc, Module *Module,
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001107 StringRef ModuleFileName) {
Ben Langmuird213aab2014-09-26 22:42:23 +00001108 DiagnosticsEngine &Diags = ImportingInstance.getDiagnostics();
1109
Ben Langmuirb797d592014-07-19 16:29:28 +00001110 auto diagnoseBuildFailure = [&] {
Ben Langmuird213aab2014-09-26 22:42:23 +00001111 Diags.Report(ModuleNameLoc, diag::err_module_not_built)
Ben Langmuirb797d592014-07-19 16:29:28 +00001112 << Module->Name << SourceRange(ImportLoc, ModuleNameLoc);
1113 };
1114
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001115 // FIXME: have LockFileManager return an error_code so that we can
1116 // avoid the mkdir when the directory already exists.
1117 StringRef Dir = llvm::sys::path::parent_path(ModuleFileName);
1118 llvm::sys::fs::create_directories(Dir);
1119
1120 while (1) {
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001121 unsigned ModuleLoadCapabilities = ASTReader::ARR_Missing;
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001122 llvm::LockFileManager Locked(ModuleFileName);
1123 switch (Locked) {
1124 case llvm::LockFileManager::LFS_Error:
Ben Langmuird213aab2014-09-26 22:42:23 +00001125 Diags.Report(ModuleNameLoc, diag::err_module_lock_failure)
Bruno Cardoso Lopes4a522222016-06-04 01:13:22 +00001126 << Module->Name << Locked.getErrorMessage();
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001127 return false;
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001128
1129 case llvm::LockFileManager::LFS_Owned:
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001130 // We're responsible for building the module ourselves.
Ben Langmuirb797d592014-07-19 16:29:28 +00001131 if (!compileModuleImpl(ImportingInstance, ModuleNameLoc, Module,
1132 ModuleFileName)) {
1133 diagnoseBuildFailure();
1134 return false;
1135 }
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001136 break;
1137
1138 case llvm::LockFileManager::LFS_Shared:
1139 // Someone else is responsible for building the module. Wait for them to
1140 // finish.
Ben Langmuir1daf4802015-02-09 20:35:13 +00001141 switch (Locked.waitForUnlock()) {
1142 case llvm::LockFileManager::Res_Success:
1143 ModuleLoadCapabilities |= ASTReader::ARR_OutOfDate;
1144 break;
1145 case llvm::LockFileManager::Res_OwnerDied:
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001146 continue; // try again to get the lock.
Ben Langmuir1daf4802015-02-09 20:35:13 +00001147 case llvm::LockFileManager::Res_Timeout:
1148 Diags.Report(ModuleNameLoc, diag::err_module_lock_timeout)
1149 << Module->Name;
1150 // Clear the lock file so that future invokations can make progress.
1151 Locked.unsafeRemoveLockFile();
1152 return false;
1153 }
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001154 break;
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001155 }
1156
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001157 // Try to read the module file, now that we've compiled it.
1158 ASTReader::ASTReadResult ReadResult =
1159 ImportingInstance.getModuleManager()->ReadAST(
Richard Smithe842a472014-10-22 02:05:46 +00001160 ModuleFileName, serialization::MK_ImplicitModule, ImportLoc,
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001161 ModuleLoadCapabilities);
1162
1163 if (ReadResult == ASTReader::OutOfDate &&
1164 Locked == llvm::LockFileManager::LFS_Shared) {
1165 // The module may be out of date in the presence of file system races,
1166 // or if one of its imports depends on header search paths that are not
1167 // consistent with this ImportingInstance. Try again...
1168 continue;
1169 } else if (ReadResult == ASTReader::Missing) {
Ben Langmuirb797d592014-07-19 16:29:28 +00001170 diagnoseBuildFailure();
Ben Langmuird213aab2014-09-26 22:42:23 +00001171 } else if (ReadResult != ASTReader::Success &&
1172 !Diags.hasErrorOccurred()) {
1173 // The ASTReader didn't diagnose the error, so conservatively report it.
1174 diagnoseBuildFailure();
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001175 }
1176 return ReadResult == ASTReader::Success;
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001177 }
1178}
1179
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001180/// \brief Diagnose differences between the current definition of the given
1181/// configuration macro and the definition provided on the command line.
1182static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
1183 Module *Mod, SourceLocation ImportLoc) {
1184 IdentifierInfo *Id = PP.getIdentifierInfo(ConfigMacro);
1185 SourceManager &SourceMgr = PP.getSourceManager();
1186
1187 // If this identifier has never had a macro definition, then it could
1188 // not have changed.
1189 if (!Id->hadMacroDefinition())
1190 return;
Richard Smith20e883e2015-04-29 23:20:19 +00001191 auto *LatestLocalMD = PP.getLocalMacroDirectiveHistory(Id);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001192
Richard Smith20e883e2015-04-29 23:20:19 +00001193 // Find the macro definition from the command line.
1194 MacroInfo *CmdLineDefinition = nullptr;
1195 for (auto *MD = LatestLocalMD; MD; MD = MD->getPrevious()) {
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001196 // We only care about the predefines buffer.
Richard Smith20e883e2015-04-29 23:20:19 +00001197 FileID FID = SourceMgr.getFileID(MD->getLocation());
1198 if (FID.isInvalid() || FID != PP.getPredefinesFileID())
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001199 continue;
Richard Smith20e883e2015-04-29 23:20:19 +00001200 if (auto *DMD = dyn_cast<DefMacroDirective>(MD))
1201 CmdLineDefinition = DMD->getMacroInfo();
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001202 break;
1203 }
1204
Richard Smith20e883e2015-04-29 23:20:19 +00001205 auto *CurrentDefinition = PP.getMacroInfo(Id);
1206 if (CurrentDefinition == CmdLineDefinition) {
1207 // Macro matches. Nothing to do.
1208 } else if (!CurrentDefinition) {
1209 // This macro was defined on the command line, then #undef'd later.
1210 // Complain.
1211 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1212 << true << ConfigMacro << Mod->getFullModuleName();
1213 auto LatestDef = LatestLocalMD->getDefinition();
1214 assert(LatestDef.isUndefined() &&
1215 "predefined macro went away with no #undef?");
1216 PP.Diag(LatestDef.getUndefLocation(), diag::note_module_def_undef_here)
1217 << true;
1218 return;
1219 } else if (!CmdLineDefinition) {
1220 // There was no definition for this macro in the predefines buffer,
1221 // but there was a local definition. Complain.
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001222 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1223 << false << ConfigMacro << Mod->getFullModuleName();
Richard Smith20e883e2015-04-29 23:20:19 +00001224 PP.Diag(CurrentDefinition->getDefinitionLoc(),
1225 diag::note_module_def_undef_here)
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001226 << false;
Richard Smith20e883e2015-04-29 23:20:19 +00001227 } else if (!CurrentDefinition->isIdenticalTo(*CmdLineDefinition, PP,
1228 /*Syntactically=*/true)) {
1229 // The macro definitions differ.
1230 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1231 << false << ConfigMacro << Mod->getFullModuleName();
1232 PP.Diag(CurrentDefinition->getDefinitionLoc(),
1233 diag::note_module_def_undef_here)
1234 << false;
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001235 }
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001236}
1237
Douglas Gregor527b1c92013-03-25 21:19:16 +00001238/// \brief Write a new timestamp file with the given path.
1239static void writeTimestampFile(StringRef TimestampFile) {
Rafael Espindoladae941a2014-08-25 18:17:04 +00001240 std::error_code EC;
1241 llvm::raw_fd_ostream Out(TimestampFile.str(), EC, llvm::sys::fs::F_None);
Douglas Gregor527b1c92013-03-25 21:19:16 +00001242}
1243
1244/// \brief Prune the module cache of modules that haven't been accessed in
1245/// a long time.
1246static void pruneModuleCache(const HeaderSearchOptions &HSOpts) {
1247 struct stat StatBuf;
1248 llvm::SmallString<128> TimestampFile;
1249 TimestampFile = HSOpts.ModuleCachePath;
Richard Smith3938f0c2015-08-15 00:34:15 +00001250 assert(!TimestampFile.empty());
Douglas Gregor527b1c92013-03-25 21:19:16 +00001251 llvm::sys::path::append(TimestampFile, "modules.timestamp");
1252
1253 // Try to stat() the timestamp file.
1254 if (::stat(TimestampFile.c_str(), &StatBuf)) {
1255 // If the timestamp file wasn't there, create one now.
1256 if (errno == ENOENT) {
1257 writeTimestampFile(TimestampFile);
1258 }
1259 return;
1260 }
1261
1262 // Check whether the time stamp is older than our pruning interval.
1263 // If not, do nothing.
1264 time_t TimeStampModTime = StatBuf.st_mtime;
Craig Topper49a27902014-05-22 04:46:25 +00001265 time_t CurrentTime = time(nullptr);
Benjamin Kramerdbcf5032013-03-29 17:39:43 +00001266 if (CurrentTime - TimeStampModTime <= time_t(HSOpts.ModuleCachePruneInterval))
Douglas Gregor527b1c92013-03-25 21:19:16 +00001267 return;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001268
1269 // Write a new timestamp file so that nobody else attempts to prune.
1270 // There is a benign race condition here, if two Clang instances happen to
1271 // notice at the same time that the timestamp is out-of-date.
1272 writeTimestampFile(TimestampFile);
1273
1274 // Walk the entire module cache, looking for unused module files and module
1275 // indices.
Rafael Espindolac0809172014-06-12 14:02:15 +00001276 std::error_code EC;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001277 SmallString<128> ModuleCachePathNative;
1278 llvm::sys::path::native(HSOpts.ModuleCachePath, ModuleCachePathNative);
Yaron Keren92e1b622015-03-18 10:17:07 +00001279 for (llvm::sys::fs::directory_iterator Dir(ModuleCachePathNative, EC), DirEnd;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001280 Dir != DirEnd && !EC; Dir.increment(EC)) {
1281 // If we don't have a directory, there's nothing to look into.
Rafael Espindolaa07f7202013-07-17 04:23:07 +00001282 if (!llvm::sys::fs::is_directory(Dir->path()))
Douglas Gregor527b1c92013-03-25 21:19:16 +00001283 continue;
1284
1285 // Walk all of the files within this directory.
Douglas Gregor527b1c92013-03-25 21:19:16 +00001286 for (llvm::sys::fs::directory_iterator File(Dir->path(), EC), FileEnd;
1287 File != FileEnd && !EC; File.increment(EC)) {
1288 // We only care about module and global module index files.
Dmitri Gribenkof430da42014-02-12 10:33:14 +00001289 StringRef Extension = llvm::sys::path::extension(File->path());
1290 if (Extension != ".pcm" && Extension != ".timestamp" &&
1291 llvm::sys::path::filename(File->path()) != "modules.idx")
Douglas Gregor527b1c92013-03-25 21:19:16 +00001292 continue;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001293
1294 // Look at this file. If we can't stat it, there's nothing interesting
1295 // there.
Dmitri Gribenkof430da42014-02-12 10:33:14 +00001296 if (::stat(File->path().c_str(), &StatBuf))
Douglas Gregor527b1c92013-03-25 21:19:16 +00001297 continue;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001298
1299 // If the file has been used recently enough, leave it there.
1300 time_t FileAccessTime = StatBuf.st_atime;
Benjamin Kramerdbcf5032013-03-29 17:39:43 +00001301 if (CurrentTime - FileAccessTime <=
1302 time_t(HSOpts.ModuleCachePruneAfter)) {
Douglas Gregor527b1c92013-03-25 21:19:16 +00001303 continue;
1304 }
1305
1306 // Remove the file.
Dmitri Gribenkof430da42014-02-12 10:33:14 +00001307 llvm::sys::fs::remove(File->path());
1308
1309 // Remove the timestamp file.
1310 std::string TimpestampFilename = File->path() + ".timestamp";
1311 llvm::sys::fs::remove(TimpestampFilename);
Douglas Gregor527b1c92013-03-25 21:19:16 +00001312 }
1313
1314 // If we removed all of the files in the directory, remove the directory
1315 // itself.
Dmitri Gribenkof430da42014-02-12 10:33:14 +00001316 if (llvm::sys::fs::directory_iterator(Dir->path(), EC) ==
1317 llvm::sys::fs::directory_iterator() && !EC)
Rafael Espindola2a008782014-01-10 21:32:14 +00001318 llvm::sys::fs::remove(Dir->path());
Douglas Gregor527b1c92013-03-25 21:19:16 +00001319 }
1320}
1321
John Thompson2255f2c2014-04-23 12:57:01 +00001322void CompilerInstance::createModuleManager() {
1323 if (!ModuleManager) {
1324 if (!hasASTContext())
1325 createASTContext();
1326
Chandler Carruth580dd292015-03-24 21:44:25 +00001327 // If we're implicitly building modules but not currently recursively
1328 // building a module, check whether we need to prune the module cache.
Richard Smith3938f0c2015-08-15 00:34:15 +00001329 if (getSourceManager().getModuleBuildStack().empty() &&
1330 !getPreprocessor().getHeaderSearchInfo().getModuleCachePath().empty() &&
John Thompson2255f2c2014-04-23 12:57:01 +00001331 getHeaderSearchOpts().ModuleCachePruneInterval > 0 &&
1332 getHeaderSearchOpts().ModuleCachePruneAfter > 0) {
1333 pruneModuleCache(getHeaderSearchOpts());
1334 }
1335
1336 HeaderSearchOptions &HSOpts = getHeaderSearchOpts();
1337 std::string Sysroot = HSOpts.Sysroot;
1338 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
Richard Smithce18a182015-07-14 00:26:00 +00001339 std::unique_ptr<llvm::Timer> ReadTimer;
1340 if (FrontendTimerGroup)
Matthias Braunae032b62016-11-18 19:43:25 +00001341 ReadTimer = llvm::make_unique<llvm::Timer>("reading_modules",
1342 "Reading modules",
Richard Smithce18a182015-07-14 00:26:00 +00001343 *FrontendTimerGroup);
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001344 ModuleManager = new ASTReader(
Richard Smith293534b2015-08-18 20:39:29 +00001345 getPreprocessor(), getASTContext(), getPCHContainerReader(),
Douglas Gregor6623e1f2015-11-03 18:33:07 +00001346 getFrontendOpts().ModuleFileExtensions,
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001347 Sysroot.empty() ? "" : Sysroot.c_str(), PPOpts.DisablePCHValidation,
1348 /*AllowASTWithCompilerErrors=*/false,
1349 /*AllowConfigurationMismatch=*/false,
1350 HSOpts.ModulesValidateSystemHeaders,
Richard Smithce18a182015-07-14 00:26:00 +00001351 getFrontendOpts().UseGlobalModuleIndex,
1352 std::move(ReadTimer));
John Thompson2255f2c2014-04-23 12:57:01 +00001353 if (hasASTConsumer()) {
1354 ModuleManager->setDeserializationListener(
1355 getASTConsumer().GetASTDeserializationListener());
1356 getASTContext().setASTMutationListener(
1357 getASTConsumer().GetASTMutationListener());
1358 }
1359 getASTContext().setExternalSource(ModuleManager);
1360 if (hasSema())
1361 ModuleManager->InitializeSema(getSema());
Richard Smith293534b2015-08-18 20:39:29 +00001362 if (hasASTConsumer())
John Thompson2255f2c2014-04-23 12:57:01 +00001363 ModuleManager->StartTranslationUnit(&getASTConsumer());
Richard Smith03f7e612015-08-09 02:28:42 +00001364
1365 if (TheDependencyFileGenerator)
1366 TheDependencyFileGenerator->AttachToASTReader(*ModuleManager);
Richard Smith03f7e612015-08-09 02:28:42 +00001367 for (auto &Listener : DependencyCollectors)
1368 Listener->attachToASTReader(*ModuleManager);
John Thompson2255f2c2014-04-23 12:57:01 +00001369 }
1370}
1371
Richard Smithd4b230b2014-10-27 23:01:16 +00001372bool CompilerInstance::loadModuleFile(StringRef FileName) {
Richard Smithce18a182015-07-14 00:26:00 +00001373 llvm::Timer Timer;
1374 if (FrontendTimerGroup)
Matthias Braunae032b62016-11-18 19:43:25 +00001375 Timer.init("preloading." + FileName.str(), "Preloading " + FileName.str(),
1376 *FrontendTimerGroup);
Richard Smithce18a182015-07-14 00:26:00 +00001377 llvm::TimeRegion TimeLoading(FrontendTimerGroup ? &Timer : nullptr);
1378
Richard Smithd4b230b2014-10-27 23:01:16 +00001379 // Helper to recursively read the module names for all modules we're adding.
1380 // We mark these as known and redirect any attempt to load that module to
1381 // the files we were handed.
1382 struct ReadModuleNames : ASTReaderListener {
1383 CompilerInstance &CI;
Richard Smith0f99d6a2015-08-09 08:48:41 +00001384 llvm::SmallVector<IdentifierInfo*, 8> LoadedModules;
Richard Smithe842a472014-10-22 02:05:46 +00001385
Richard Smith0f99d6a2015-08-09 08:48:41 +00001386 ReadModuleNames(CompilerInstance &CI) : CI(CI) {}
Richard Smithe842a472014-10-22 02:05:46 +00001387
Richard Smithd4b230b2014-10-27 23:01:16 +00001388 void ReadModuleName(StringRef ModuleName) override {
Richard Smith0f99d6a2015-08-09 08:48:41 +00001389 LoadedModules.push_back(
1390 CI.getPreprocessor().getIdentifierInfo(ModuleName));
Richard Smithd4b230b2014-10-27 23:01:16 +00001391 }
Richard Smith0f99d6a2015-08-09 08:48:41 +00001392
1393 void registerAll() {
1394 for (auto *II : LoadedModules) {
1395 CI.KnownModules[II] = CI.getPreprocessor()
1396 .getHeaderSearchInfo()
1397 .getModuleMap()
1398 .findModule(II->getName());
1399 }
1400 LoadedModules.clear();
1401 }
Richard Smith8a308ec2015-11-05 00:54:55 +00001402
1403 void markAllUnavailable() {
1404 for (auto *II : LoadedModules) {
1405 if (Module *M = CI.getPreprocessor()
1406 .getHeaderSearchInfo()
1407 .getModuleMap()
Richard Smitha114c462016-12-06 00:40:17 +00001408 .findModule(II->getName())) {
Richard Smith8a308ec2015-11-05 00:54:55 +00001409 M->HasIncompatibleModuleFile = true;
Richard Smitha114c462016-12-06 00:40:17 +00001410
1411 // Mark module as available if the only reason it was unavailable
1412 // was missing headers.
1413 SmallVector<Module *, 2> Stack;
1414 Stack.push_back(M);
1415 while (!Stack.empty()) {
1416 Module *Current = Stack.pop_back_val();
1417 if (Current->IsMissingRequirement) continue;
1418 Current->IsAvailable = true;
1419 Stack.insert(Stack.end(),
1420 Current->submodule_begin(), Current->submodule_end());
1421 }
1422 }
Richard Smith8a308ec2015-11-05 00:54:55 +00001423 }
1424 LoadedModules.clear();
1425 }
Richard Smith0f99d6a2015-08-09 08:48:41 +00001426 };
Richard Smithd4b230b2014-10-27 23:01:16 +00001427
Richard Smith7f330cd2015-03-18 01:42:29 +00001428 // If we don't already have an ASTReader, create one now.
1429 if (!ModuleManager)
1430 createModuleManager();
1431
Richard Smith0f99d6a2015-08-09 08:48:41 +00001432 auto Listener = llvm::make_unique<ReadModuleNames>(*this);
1433 auto &ListenerRef = *Listener;
1434 ASTReader::ListenerScope ReadModuleNamesListener(*ModuleManager,
1435 std::move(Listener));
Richard Smith7f330cd2015-03-18 01:42:29 +00001436
Richard Smith0f99d6a2015-08-09 08:48:41 +00001437 // Try to load the module file.
Richard Smith95dc57a2015-10-16 23:20:19 +00001438 switch (ModuleManager->ReadAST(FileName, serialization::MK_ExplicitModule,
1439 SourceLocation(),
1440 ASTReader::ARR_ConfigurationMismatch)) {
1441 case ASTReader::Success:
Richard Smith8a308ec2015-11-05 00:54:55 +00001442 // We successfully loaded the module file; remember the set of provided
1443 // modules so that we don't try to load implicit modules for them.
1444 ListenerRef.registerAll();
1445 return true;
Richard Smith95dc57a2015-10-16 23:20:19 +00001446
1447 case ASTReader::ConfigurationMismatch:
1448 // Ignore unusable module files.
1449 getDiagnostics().Report(SourceLocation(), diag::warn_module_config_mismatch)
1450 << FileName;
Richard Smith8a308ec2015-11-05 00:54:55 +00001451 // All modules provided by any files we tried and failed to load are now
1452 // unavailable; includes of those modules should now be handled textually.
1453 ListenerRef.markAllUnavailable();
Richard Smith95dc57a2015-10-16 23:20:19 +00001454 return true;
1455
1456 default:
1457 return false;
1458 }
Richard Smithe842a472014-10-22 02:05:46 +00001459}
1460
1461ModuleLoadResult
Douglas Gregor7a626572012-11-29 23:55:25 +00001462CompilerInstance::loadModule(SourceLocation ImportLoc,
1463 ModuleIdPath Path,
1464 Module::NameVisibilityKind Visibility,
1465 bool IsInclusionDirective) {
Richard Smith92304e02013-10-18 22:48:20 +00001466 // Determine what file we're searching from.
1467 StringRef ModuleName = Path[0].first->getName();
1468 SourceLocation ModuleNameLoc = Path[0].second;
1469
Douglas Gregor1805b8a2011-11-30 04:26:53 +00001470 // If we've already handled this import, just return the cached result.
1471 // This one-element cache is important to eliminate redundant diagnostics
1472 // when both the preprocessor and parser see the same import declaration.
Yaron Keren8b563662015-10-03 10:46:20 +00001473 if (ImportLoc.isValid() && LastModuleImportLoc == ImportLoc) {
Douglas Gregorff2be532011-12-01 17:11:21 +00001474 // Make the named module visible.
Richard Smith7e82e012016-02-19 22:25:36 +00001475 if (LastModuleImportResult && ModuleName != getLangOpts().CurrentModule)
Argyrios Kyrtzidis125df052013-02-01 16:36:12 +00001476 ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility,
Richard Smitha7e2cc62015-05-01 01:53:09 +00001477 ImportLoc);
Douglas Gregor69021972011-11-30 17:33:56 +00001478 return LastModuleImportResult;
Douglas Gregorff2be532011-12-01 17:11:21 +00001479 }
Douglas Gregor5196bc62011-11-30 04:03:44 +00001480
Craig Topper49a27902014-05-22 04:46:25 +00001481 clang::Module *Module = nullptr;
Richard Smith92304e02013-10-18 22:48:20 +00001482
Douglas Gregor5196bc62011-11-30 04:03:44 +00001483 // If we don't already have information on this module, load the module now.
Douglas Gregorde3ef502011-11-30 23:21:26 +00001484 llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
Douglas Gregor69021972011-11-30 17:33:56 +00001485 = KnownModules.find(Path[0].first);
Douglas Gregor2537a362011-12-08 17:01:29 +00001486 if (Known != KnownModules.end()) {
1487 // Retrieve the cached top-level module.
1488 Module = Known->second;
Richard Smith7e82e012016-02-19 22:25:36 +00001489 } else if (ModuleName == getLangOpts().CurrentModule) {
Douglas Gregor2537a362011-12-08 17:01:29 +00001490 // This is the module we're building.
Ben Langmuir527040e2014-05-05 05:31:33 +00001491 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
Douglas Gregor2537a362011-12-08 17:01:29 +00001492 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1493 } else {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001494 // Search for a module with the given name.
Douglas Gregor279a6c32012-01-29 17:08:11 +00001495 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
Manman Ren11f2a472016-08-18 17:42:15 +00001496 HeaderSearchOptions &HSOpts =
1497 PP->getHeaderSearchInfo().getHeaderSearchOpts();
1498
1499 std::string ModuleFileName;
1500 bool LoadFromPrebuiltModulePath = false;
1501 // We try to load the module from the prebuilt module paths. If not
1502 // successful, we then try to find it in the module cache.
1503 if (!HSOpts.PrebuiltModulePaths.empty()) {
1504 // Load the module from the prebuilt module path.
1505 ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(
1506 ModuleName, "", /*UsePrebuiltPath*/ true);
1507 if (!ModuleFileName.empty())
1508 LoadFromPrebuiltModulePath = true;
1509 }
1510 if (!LoadFromPrebuiltModulePath && Module) {
1511 // Load the module from the module cache.
1512 ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(Module);
1513 } else if (!LoadFromPrebuiltModulePath) {
1514 // We can't find a module, error out here.
Ben Langmuir9eb229b2014-01-22 23:19:39 +00001515 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1516 << ModuleName
1517 << SourceRange(ImportLoc, ModuleNameLoc);
1518 ModuleBuildFailed = true;
1519 return ModuleLoadResult();
1520 }
1521
Richard Smithd520a252015-07-21 18:07:47 +00001522 if (ModuleFileName.empty()) {
Manman Ren11f2a472016-08-18 17:42:15 +00001523 if (Module && Module->HasIncompatibleModuleFile) {
Richard Smith8a308ec2015-11-05 00:54:55 +00001524 // We tried and failed to load a module file for this module. Fall
1525 // back to textual inclusion for its headers.
Richard Smitha114c462016-12-06 00:40:17 +00001526 return ModuleLoadResult::ConfigMismatch;
Richard Smith8a308ec2015-11-05 00:54:55 +00001527 }
1528
Manuel Klimekd2e8b042015-02-20 11:44:41 +00001529 getDiagnostics().Report(ModuleNameLoc, diag::err_module_build_disabled)
1530 << ModuleName;
1531 ModuleBuildFailed = true;
1532 return ModuleLoadResult();
1533 }
Richard Smithd4b230b2014-10-27 23:01:16 +00001534
Douglas Gregor5196bc62011-11-30 04:03:44 +00001535 // If we don't already have an ASTReader, create one now.
John Thompson2255f2c2014-04-23 12:57:01 +00001536 if (!ModuleManager)
1537 createModuleManager();
Douglas Gregor5196bc62011-11-30 04:03:44 +00001538
Richard Smithce18a182015-07-14 00:26:00 +00001539 llvm::Timer Timer;
1540 if (FrontendTimerGroup)
Matthias Braunae032b62016-11-18 19:43:25 +00001541 Timer.init("loading." + ModuleFileName, "Loading " + ModuleFileName,
1542 *FrontendTimerGroup);
Richard Smithce18a182015-07-14 00:26:00 +00001543 llvm::TimeRegion TimeLoading(FrontendTimerGroup ? &Timer : nullptr);
1544
Manman Ren11f2a472016-08-18 17:42:15 +00001545 // Try to load the module file. If we are trying to load from the prebuilt
1546 // module path, we don't have the module map files and don't know how to
1547 // rebuild modules.
1548 unsigned ARRFlags = LoadFromPrebuiltModulePath ?
1549 ASTReader::ARR_ConfigurationMismatch :
1550 ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing;
Richard Smithe842a472014-10-22 02:05:46 +00001551 switch (ModuleManager->ReadAST(ModuleFileName,
Manman Ren11f2a472016-08-18 17:42:15 +00001552 LoadFromPrebuiltModulePath ?
1553 serialization::MK_PrebuiltModule :
Richard Smith86cc8292015-08-09 08:58:36 +00001554 serialization::MK_ImplicitModule,
Manman Ren11f2a472016-08-18 17:42:15 +00001555 ImportLoc,
1556 ARRFlags)) {
1557 case ASTReader::Success: {
1558 if (LoadFromPrebuiltModulePath && !Module) {
1559 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1560 if (!Module || !Module->getASTFile() ||
1561 FileMgr->getFile(ModuleFileName) != Module->getASTFile()) {
1562 // Error out if Module does not refer to the file in the prebuilt
1563 // module path.
1564 getDiagnostics().Report(ModuleNameLoc, diag::err_module_prebuilt)
1565 << ModuleName;
1566 ModuleBuildFailed = true;
1567 KnownModules[Path[0].first] = nullptr;
1568 return ModuleLoadResult();
1569 }
1570 }
Douglas Gregor5196bc62011-11-30 04:03:44 +00001571 break;
Manman Ren11f2a472016-08-18 17:42:15 +00001572 }
Douglas Gregor5196bc62011-11-30 04:03:44 +00001573
Eli Friedman963ff2c2013-09-17 00:51:29 +00001574 case ASTReader::OutOfDate:
Douglas Gregor7029ce12013-03-19 00:28:20 +00001575 case ASTReader::Missing: {
Manman Ren11f2a472016-08-18 17:42:15 +00001576 if (LoadFromPrebuiltModulePath) {
1577 // We can't rebuild the module without a module map. Since ReadAST
1578 // already produces diagnostics for these two cases, we simply
1579 // error out here.
1580 ModuleBuildFailed = true;
1581 KnownModules[Path[0].first] = nullptr;
1582 return ModuleLoadResult();
1583 }
1584
Eli Friedman963ff2c2013-09-17 00:51:29 +00001585 // The module file is missing or out-of-date. Build it.
Ben Langmuir9eb229b2014-01-22 23:19:39 +00001586 assert(Module && "missing module file");
Douglas Gregor7029ce12013-03-19 00:28:20 +00001587 // Check whether there is a cycle in the module graph.
1588 ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
1589 ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1590 for (; Pos != PosEnd; ++Pos) {
1591 if (Pos->first == ModuleName)
1592 break;
1593 }
1594
1595 if (Pos != PosEnd) {
1596 SmallString<256> CyclePath;
1597 for (; Pos != PosEnd; ++Pos) {
1598 CyclePath += Pos->first;
1599 CyclePath += " -> ";
1600 }
1601 CyclePath += ModuleName;
1602
1603 getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
1604 << ModuleName << CyclePath;
1605 return ModuleLoadResult();
1606 }
Douglas Gregor7a626572012-11-29 23:55:25 +00001607
1608 // Check whether we have already attempted to build this module (but
1609 // failed).
1610 if (getPreprocessorOpts().FailedModules &&
1611 getPreprocessorOpts().FailedModules->hasAlreadyFailed(ModuleName)) {
1612 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_built)
1613 << ModuleName
1614 << SourceRange(ImportLoc, ModuleNameLoc);
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001615 ModuleBuildFailed = true;
Douglas Gregor7a626572012-11-29 23:55:25 +00001616 return ModuleLoadResult();
1617 }
1618
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001619 // Try to compile and then load the module.
1620 if (!compileAndLoadModule(*this, ImportLoc, ModuleNameLoc, Module,
1621 ModuleFileName)) {
Ben Langmuird213aab2014-09-26 22:42:23 +00001622 assert(getDiagnostics().hasErrorOccurred() &&
1623 "undiagnosed error in compileAndLoadModule");
Douglas Gregor0f2b4632013-01-10 02:04:18 +00001624 if (getPreprocessorOpts().FailedModules)
1625 getPreprocessorOpts().FailedModules->addFailed(ModuleName);
Craig Topper49a27902014-05-22 04:46:25 +00001626 KnownModules[Path[0].first] = nullptr;
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001627 ModuleBuildFailed = true;
Douglas Gregor7a626572012-11-29 23:55:25 +00001628 return ModuleLoadResult();
Douglas Gregor188dbef2012-11-07 17:46:15 +00001629 }
1630
1631 // Okay, we've rebuilt and now loaded the module.
1632 break;
1633 }
1634
Douglas Gregorc9ad5fb2012-10-22 22:50:17 +00001635 case ASTReader::ConfigurationMismatch:
Manman Ren11f2a472016-08-18 17:42:15 +00001636 if (LoadFromPrebuiltModulePath)
1637 getDiagnostics().Report(SourceLocation(),
1638 diag::warn_module_config_mismatch)
1639 << ModuleFileName;
1640 // Fall through to error out.
1641 case ASTReader::VersionMismatch:
Douglas Gregorc9ad5fb2012-10-22 22:50:17 +00001642 case ASTReader::HadErrors:
Argyrios Kyrtzidisdc9fdaf2013-05-24 05:44:08 +00001643 ModuleLoader::HadFatalFailure = true;
Richard Smith0f99d6a2015-08-09 08:48:41 +00001644 // FIXME: The ASTReader will already have complained, but can we shoehorn
Douglas Gregor5196bc62011-11-30 04:03:44 +00001645 // that diagnostic information into a more useful form?
Craig Topper49a27902014-05-22 04:46:25 +00001646 KnownModules[Path[0].first] = nullptr;
Douglas Gregor7a626572012-11-29 23:55:25 +00001647 return ModuleLoadResult();
Douglas Gregor5196bc62011-11-30 04:03:44 +00001648
1649 case ASTReader::Failure:
Argyrios Kyrtzidisdc9fdaf2013-05-24 05:44:08 +00001650 ModuleLoader::HadFatalFailure = true;
Douglas Gregor69021972011-11-30 17:33:56 +00001651 // Already complained, but note now that we failed.
Craig Topper49a27902014-05-22 04:46:25 +00001652 KnownModules[Path[0].first] = nullptr;
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001653 ModuleBuildFailed = true;
Douglas Gregor7a626572012-11-29 23:55:25 +00001654 return ModuleLoadResult();
Douglas Gregor5196bc62011-11-30 04:03:44 +00001655 }
Argyrios Kyrtzidis43af5132012-09-29 01:06:04 +00001656
Douglas Gregor69021972011-11-30 17:33:56 +00001657 // Cache the result of this top-level module lookup for later.
1658 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
Douglas Gregor08142532011-08-26 23:56:07 +00001659 }
Douglas Gregor5196bc62011-11-30 04:03:44 +00001660
Douglas Gregor69021972011-11-30 17:33:56 +00001661 // If we never found the module, fail.
1662 if (!Module)
Douglas Gregor7a626572012-11-29 23:55:25 +00001663 return ModuleLoadResult();
Douglas Gregor69021972011-11-30 17:33:56 +00001664
Douglas Gregor5196bc62011-11-30 04:03:44 +00001665 // Verify that the rest of the module path actually corresponds to
1666 // a submodule.
Douglas Gregor69021972011-11-30 17:33:56 +00001667 if (Path.size() > 1) {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001668 for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1669 StringRef Name = Path[I].first->getName();
Douglas Gregoreb90e832012-01-04 23:32:19 +00001670 clang::Module *Sub = Module->findSubmodule(Name);
Douglas Gregor5196bc62011-11-30 04:03:44 +00001671
Douglas Gregoreb90e832012-01-04 23:32:19 +00001672 if (!Sub) {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001673 // Attempt to perform typo correction to find a module name that works.
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001674 SmallVector<StringRef, 2> Best;
Douglas Gregor5196bc62011-11-30 04:03:44 +00001675 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1676
Douglas Gregoreb90e832012-01-04 23:32:19 +00001677 for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1678 JEnd = Module->submodule_end();
Matt Beaumont-Gayeb44eda2011-11-30 19:41:21 +00001679 J != JEnd; ++J) {
Douglas Gregoreb90e832012-01-04 23:32:19 +00001680 unsigned ED = Name.edit_distance((*J)->Name,
Douglas Gregor5196bc62011-11-30 04:03:44 +00001681 /*AllowReplacements=*/true,
1682 BestEditDistance);
1683 if (ED <= BestEditDistance) {
Douglas Gregoreb90e832012-01-04 23:32:19 +00001684 if (ED < BestEditDistance) {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001685 Best.clear();
Douglas Gregoreb90e832012-01-04 23:32:19 +00001686 BestEditDistance = ED;
1687 }
1688
1689 Best.push_back((*J)->Name);
Douglas Gregor5196bc62011-11-30 04:03:44 +00001690 }
1691 }
1692
1693 // If there was a clear winner, user it.
1694 if (Best.size() == 1) {
1695 getDiagnostics().Report(Path[I].second,
1696 diag::err_no_submodule_suggest)
Douglas Gregor69021972011-11-30 17:33:56 +00001697 << Path[I].first << Module->getFullModuleName() << Best[0]
Douglas Gregor5196bc62011-11-30 04:03:44 +00001698 << SourceRange(Path[0].second, Path[I-1].second)
1699 << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1700 Best[0]);
Douglas Gregoreb90e832012-01-04 23:32:19 +00001701
1702 Sub = Module->findSubmodule(Best[0]);
Douglas Gregor5196bc62011-11-30 04:03:44 +00001703 }
1704 }
1705
Douglas Gregoreb90e832012-01-04 23:32:19 +00001706 if (!Sub) {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001707 // No submodule by this name. Complain, and don't look for further
1708 // submodules.
1709 getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
Douglas Gregor69021972011-11-30 17:33:56 +00001710 << Path[I].first << Module->getFullModuleName()
Douglas Gregor5196bc62011-11-30 04:03:44 +00001711 << SourceRange(Path[0].second, Path[I-1].second);
1712 break;
1713 }
1714
Douglas Gregoreb90e832012-01-04 23:32:19 +00001715 Module = Sub;
Douglas Gregor5196bc62011-11-30 04:03:44 +00001716 }
Douglas Gregor08142532011-08-26 23:56:07 +00001717 }
Ben Langmuirb537a3a2014-07-23 15:30:23 +00001718
Douglas Gregor2537a362011-12-08 17:01:29 +00001719 // Make the named module visible, if it's not already part of the module
1720 // we are parsing.
Douglas Gregor98a52db2011-12-20 00:28:52 +00001721 if (ModuleName != getLangOpts().CurrentModule) {
1722 if (!Module->IsFromModuleFile) {
1723 // We have an umbrella header or directory that doesn't actually include
1724 // all of the headers within the directory it covers. Complain about
1725 // this missing submodule and recover by forgetting that we ever saw
1726 // this submodule.
1727 // FIXME: Should we detect this at module load time? It seems fairly
1728 // expensive (and rare).
1729 getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1730 << Module->getFullModuleName()
1731 << SourceRange(Path.front().second, Path.back().second);
Craig Topper49a27902014-05-22 04:46:25 +00001732
Richard Smitha114c462016-12-06 00:40:17 +00001733 return ModuleLoadResult::MissingExpected;
Douglas Gregor98a52db2011-12-20 00:28:52 +00001734 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00001735
1736 // Check whether this module is available.
Richard Smitha3feee22013-10-28 22:18:19 +00001737 clang::Module::Requirement Requirement;
Richard Smith3c1a41a2014-12-02 00:08:08 +00001738 clang::Module::UnresolvedHeaderDirective MissingHeader;
Daniel Jasper0761a8a2013-12-17 10:31:37 +00001739 if (!Module->isAvailable(getLangOpts(), getTarget(), Requirement,
1740 MissingHeader)) {
1741 if (MissingHeader.FileNameLoc.isValid()) {
1742 getDiagnostics().Report(MissingHeader.FileNameLoc,
1743 diag::err_module_header_missing)
1744 << MissingHeader.IsUmbrella << MissingHeader.FileName;
1745 } else {
1746 getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1747 << Module->getFullModuleName()
1748 << Requirement.second << Requirement.first
1749 << SourceRange(Path.front().second, Path.back().second);
1750 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00001751 LastModuleImportLoc = ImportLoc;
Douglas Gregor7a626572012-11-29 23:55:25 +00001752 LastModuleImportResult = ModuleLoadResult();
1753 return ModuleLoadResult();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00001754 }
1755
Richard Smitha7e2cc62015-05-01 01:53:09 +00001756 ModuleManager->makeModuleVisible(Module, Visibility, ImportLoc);
Douglas Gregor98a52db2011-12-20 00:28:52 +00001757 }
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001758
1759 // Check for any configuration macros that have changed.
1760 clang::Module *TopModule = Module->getTopLevelModule();
1761 for (unsigned I = 0, N = TopModule->ConfigMacros.size(); I != N; ++I) {
1762 checkConfigMacro(getPreprocessor(), TopModule->ConfigMacros[I],
1763 Module, ImportLoc);
1764 }
1765
Douglas Gregor1805b8a2011-11-30 04:26:53 +00001766 LastModuleImportLoc = ImportLoc;
Richard Smitha114c462016-12-06 00:40:17 +00001767 LastModuleImportResult = ModuleLoadResult(Module);
Douglas Gregor7a626572012-11-29 23:55:25 +00001768 return LastModuleImportResult;
Douglas Gregor08142532011-08-26 23:56:07 +00001769}
Douglas Gregorc147b0b2013-01-12 01:29:50 +00001770
1771void CompilerInstance::makeModuleVisible(Module *Mod,
Argyrios Kyrtzidis125df052013-02-01 16:36:12 +00001772 Module::NameVisibilityKind Visibility,
Richard Smitha7e2cc62015-05-01 01:53:09 +00001773 SourceLocation ImportLoc) {
Richard Smith42413142015-05-15 20:05:43 +00001774 if (!ModuleManager)
1775 createModuleManager();
1776 if (!ModuleManager)
1777 return;
1778
Richard Smitha7e2cc62015-05-01 01:53:09 +00001779 ModuleManager->makeModuleVisible(Mod, Visibility, ImportLoc);
Douglas Gregorc147b0b2013-01-12 01:29:50 +00001780}
1781
John Thompson2255f2c2014-04-23 12:57:01 +00001782GlobalModuleIndex *CompilerInstance::loadGlobalModuleIndex(
1783 SourceLocation TriggerLoc) {
Richard Smith3938f0c2015-08-15 00:34:15 +00001784 if (getPreprocessor().getHeaderSearchInfo().getModuleCachePath().empty())
1785 return nullptr;
John Thompson2255f2c2014-04-23 12:57:01 +00001786 if (!ModuleManager)
1787 createModuleManager();
1788 // Can't do anything if we don't have the module manager.
1789 if (!ModuleManager)
Craig Topper49a27902014-05-22 04:46:25 +00001790 return nullptr;
John Thompson2255f2c2014-04-23 12:57:01 +00001791 // Get an existing global index. This loads it if not already
1792 // loaded.
1793 ModuleManager->loadGlobalIndex();
1794 GlobalModuleIndex *GlobalIndex = ModuleManager->getGlobalIndex();
1795 // If the global index doesn't exist, create it.
1796 if (!GlobalIndex && shouldBuildGlobalModuleIndex() && hasFileManager() &&
1797 hasPreprocessor()) {
1798 llvm::sys::fs::create_directories(
1799 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1800 GlobalModuleIndex::writeIndex(
Adrian Prantlfb2398d2015-07-17 01:19:54 +00001801 getFileManager(), getPCHContainerReader(),
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001802 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
John Thompson2255f2c2014-04-23 12:57:01 +00001803 ModuleManager->resetForReload();
1804 ModuleManager->loadGlobalIndex();
1805 GlobalIndex = ModuleManager->getGlobalIndex();
1806 }
1807 // For finding modules needing to be imported for fixit messages,
1808 // we need to make the global index cover all modules, so we do that here.
1809 if (!HaveFullGlobalModuleIndex && GlobalIndex && !buildingModule()) {
1810 ModuleMap &MMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
1811 bool RecreateIndex = false;
1812 for (ModuleMap::module_iterator I = MMap.module_begin(),
1813 E = MMap.module_end(); I != E; ++I) {
1814 Module *TheModule = I->second;
1815 const FileEntry *Entry = TheModule->getASTFile();
1816 if (!Entry) {
1817 SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
1818 Path.push_back(std::make_pair(
Richard Smith629d8e62015-08-11 00:03:28 +00001819 getPreprocessor().getIdentifierInfo(TheModule->Name), TriggerLoc));
John Thompson2255f2c2014-04-23 12:57:01 +00001820 std::reverse(Path.begin(), Path.end());
Richard Smith629d8e62015-08-11 00:03:28 +00001821 // Load a module as hidden. This also adds it to the global index.
1822 loadModule(TheModule->DefinitionLoc, Path, Module::Hidden, false);
John Thompson2255f2c2014-04-23 12:57:01 +00001823 RecreateIndex = true;
1824 }
1825 }
1826 if (RecreateIndex) {
1827 GlobalModuleIndex::writeIndex(
Adrian Prantlfb2398d2015-07-17 01:19:54 +00001828 getFileManager(), getPCHContainerReader(),
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001829 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
John Thompson2255f2c2014-04-23 12:57:01 +00001830 ModuleManager->resetForReload();
1831 ModuleManager->loadGlobalIndex();
1832 GlobalIndex = ModuleManager->getGlobalIndex();
1833 }
1834 HaveFullGlobalModuleIndex = true;
1835 }
1836 return GlobalIndex;
1837}
John Thompson2d94bbb2014-04-23 19:04:32 +00001838
1839// Check global module index for missing imports.
1840bool
1841CompilerInstance::lookupMissingImports(StringRef Name,
1842 SourceLocation TriggerLoc) {
1843 // Look for the symbol in non-imported modules, but only if an error
1844 // actually occurred.
1845 if (!buildingModule()) {
1846 // Load global module index, or retrieve a previously loaded one.
1847 GlobalModuleIndex *GlobalIndex = loadGlobalModuleIndex(
1848 TriggerLoc);
1849
1850 // Only if we have a global index.
1851 if (GlobalIndex) {
1852 GlobalModuleIndex::HitSet FoundModules;
1853
1854 // Find the modules that reference the identifier.
1855 // Note that this only finds top-level modules.
1856 // We'll let diagnoseTypo find the actual declaration module.
1857 if (GlobalIndex->lookupIdentifier(Name, FoundModules))
1858 return true;
1859 }
1860 }
1861
1862 return false;
1863}
David Blaikiea97eaa12014-08-29 16:53:14 +00001864void CompilerInstance::resetAndLeakSema() { BuryPointer(takeSema()); }
Benjamin Kramer7de99692016-11-16 18:15:26 +00001865
1866void CompilerInstance::setExternalSemaSource(
1867 IntrusiveRefCntPtr<ExternalSemaSource> ESS) {
1868 ExternalSemaSrc = std::move(ESS);
1869}