blob: afcaa6e87878436dd59df5b9ed9c3c75229eb9e1 [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
David Blaikieea4395e2017-01-06 19:49:01 +000069void CompilerInstance::setInvocation(
70 std::shared_ptr<CompilerInvocation> Value) {
71 Invocation = std::move(Value);
Daniel Dunbar68242252010-01-30 21:47:07 +000072}
73
Douglas Gregorc1bbec82013-01-25 00:45:27 +000074bool CompilerInstance::shouldBuildGlobalModuleIndex() const {
Douglas Gregore060e572013-01-25 01:03:03 +000075 return (BuildGlobalModuleIndex ||
Douglas Gregor11ef0b72013-03-22 21:26:48 +000076 (ModuleManager && ModuleManager->isGlobalIndexUnavailable() &&
77 getFrontendOpts().GenerateGlobalModuleIndex)) &&
Douglas Gregore060e572013-01-25 01:03:03 +000078 !ModuleBuildFailed;
Douglas Gregorc1bbec82013-01-25 00:45:27 +000079}
80
David Blaikie9c902b52011-09-25 23:23:43 +000081void CompilerInstance::setDiagnostics(DiagnosticsEngine *Value) {
Douglas Gregor7f95d262010-04-05 23:52:57 +000082 Diagnostics = Value;
Daniel Dunbare01dc862009-11-14 01:20:40 +000083}
84
Artem Belevichb5bc9232015-09-22 17:23:22 +000085void CompilerInstance::setTarget(TargetInfo *Value) { Target = Value; }
86void CompilerInstance::setAuxTarget(TargetInfo *Value) { AuxTarget = Value; }
Daniel Dunbare01dc862009-11-14 01:20:40 +000087
88void CompilerInstance::setFileManager(FileManager *Value) {
Ted Kremenek5e14d392011-03-21 18:40:17 +000089 FileMgr = Value;
Ben Langmuirc8130a72014-02-20 21:59:23 +000090 if (Value)
91 VirtualFileSystem = Value->getVirtualFileSystem();
92 else
93 VirtualFileSystem.reset();
Daniel Dunbare01dc862009-11-14 01:20:40 +000094}
95
NAKAMURA Takumi82a35112011-10-08 11:31:46 +000096void CompilerInstance::setSourceManager(SourceManager *Value) {
Ted Kremenek5e14d392011-03-21 18:40:17 +000097 SourceMgr = Value;
Daniel Dunbare01dc862009-11-14 01:20:40 +000098}
99
David Blaikie41565462017-01-05 19:48:07 +0000100void CompilerInstance::setPreprocessor(std::shared_ptr<Preprocessor> Value) {
101 PP = std::move(Value);
102}
Daniel Dunbare01dc862009-11-14 01:20:40 +0000103
Richard Smith293534b2015-08-18 20:39:29 +0000104void CompilerInstance::setASTContext(ASTContext *Value) {
105 Context = Value;
106
107 if (Context && Consumer)
108 getASTConsumer().Initialize(getASTContext());
109}
Daniel Dunbare01dc862009-11-14 01:20:40 +0000110
Douglas Gregor0e93f012010-08-12 23:31:19 +0000111void CompilerInstance::setSema(Sema *S) {
112 TheSema.reset(S);
113}
114
David Blaikie6beb6aa2014-08-10 19:56:51 +0000115void CompilerInstance::setASTConsumer(std::unique_ptr<ASTConsumer> Value) {
116 Consumer = std::move(Value);
Richard Smith293534b2015-08-18 20:39:29 +0000117
118 if (Context && Consumer)
119 getASTConsumer().Initialize(getASTContext());
Daniel Dunbar56d9c292009-11-14 02:47:17 +0000120}
121
Daniel Dunbare01dc862009-11-14 01:20:40 +0000122void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
123 CompletionConsumer.reset(Value);
124}
David Blaikie61535812014-08-10 20:12:39 +0000125
126std::unique_ptr<Sema> CompilerInstance::takeSema() {
127 return std::move(TheSema);
128}
129
Argyrios Kyrtzidis1b7ed912014-02-27 04:11:59 +0000130IntrusiveRefCntPtr<ASTReader> CompilerInstance::getModuleManager() const {
131 return ModuleManager;
132}
133void CompilerInstance::setModuleManager(IntrusiveRefCntPtr<ASTReader> Reader) {
Benjamin Kramerd6da1a02016-06-12 20:05:23 +0000134 ModuleManager = std::move(Reader);
Argyrios Kyrtzidis1b7ed912014-02-27 04:11:59 +0000135}
Daniel Dunbare01dc862009-11-14 01:20:40 +0000136
Justin Bogner86d12592014-06-19 19:36:03 +0000137std::shared_ptr<ModuleDependencyCollector>
138CompilerInstance::getModuleDepCollector() const {
139 return ModuleDepCollector;
140}
141
142void CompilerInstance::setModuleDepCollector(
143 std::shared_ptr<ModuleDependencyCollector> Collector) {
Benjamin Kramerd6da1a02016-06-12 20:05:23 +0000144 ModuleDepCollector = std::move(Collector);
Justin Bogner86d12592014-06-19 19:36:03 +0000145}
146
Bruno Cardoso Lopes181225b2016-12-11 04:27:28 +0000147static void collectHeaderMaps(const HeaderSearch &HS,
148 std::shared_ptr<ModuleDependencyCollector> MDC) {
149 SmallVector<std::string, 4> HeaderMapFileNames;
150 HS.getHeaderMapFileNames(HeaderMapFileNames);
151 for (auto &Name : HeaderMapFileNames)
152 MDC->addFile(Name);
153}
154
Bruno Cardoso Lopes7aff2bb2016-12-12 19:28:25 +0000155static void collectIncludePCH(CompilerInstance &CI,
156 std::shared_ptr<ModuleDependencyCollector> MDC) {
157 const PreprocessorOptions &PPOpts = CI.getPreprocessorOpts();
158 if (PPOpts.ImplicitPCHInclude.empty())
159 return;
160
161 StringRef PCHInclude = PPOpts.ImplicitPCHInclude;
162 FileManager &FileMgr = CI.getFileManager();
163 const DirectoryEntry *PCHDir = FileMgr.getDirectory(PCHInclude);
164 if (!PCHDir) {
165 MDC->addFile(PCHInclude);
166 return;
167 }
168
169 std::error_code EC;
170 SmallString<128> DirNative;
171 llvm::sys::path::native(PCHDir->getName(), DirNative);
172 vfs::FileSystem &FS = *FileMgr.getVirtualFileSystem();
173 SimpleASTReaderListener Validator(CI.getPreprocessor());
174 for (vfs::directory_iterator Dir = FS.dir_begin(DirNative, EC), DirEnd;
175 Dir != DirEnd && !EC; Dir.increment(EC)) {
176 // Check whether this is an AST file. ASTReader::isAcceptableASTFile is not
177 // used here since we're not interested in validating the PCH at this time,
178 // but only to check whether this is a file containing an AST.
179 if (!ASTReader::readASTFileControlBlock(
180 Dir->getName(), FileMgr, CI.getPCHContainerReader(),
181 /*FindModuleFileExtensions=*/false, Validator,
182 /*ValidateDiagnosticOptions=*/false))
183 MDC->addFile(Dir->getName());
184 }
185}
186
Bruno Cardoso Lopes82ec4fde2016-12-22 07:06:03 +0000187static void collectVFSEntries(CompilerInstance &CI,
188 std::shared_ptr<ModuleDependencyCollector> MDC) {
189 if (CI.getHeaderSearchOpts().VFSOverlayFiles.empty())
190 return;
191
192 // Collect all VFS found.
193 SmallVector<vfs::YAMLVFSEntry, 16> VFSEntries;
194 for (const std::string &VFSFile : CI.getHeaderSearchOpts().VFSOverlayFiles) {
195 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Buffer =
196 llvm::MemoryBuffer::getFile(VFSFile);
197 if (!Buffer)
198 return;
199 vfs::collectVFSFromYAML(std::move(Buffer.get()), /*DiagHandler*/ nullptr,
200 VFSFile, VFSEntries);
201 }
202
203 for (auto &E : VFSEntries)
204 MDC->addFile(E.VPath, E.RPath);
205}
206
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000207// Diagnostics
Douglas Gregor811db4e2012-10-23 22:26:28 +0000208static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts,
Daniel Dunbar7b833062011-04-07 18:59:02 +0000209 const CodeGenOptions *CodeGenOpts,
David Blaikie9c902b52011-09-25 23:23:43 +0000210 DiagnosticsEngine &Diags) {
Rafael Espindoladae941a2014-08-25 18:17:04 +0000211 std::error_code EC;
David Blaikie11f8a942014-09-15 17:30:56 +0000212 std::unique_ptr<raw_ostream> StreamOwner;
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000213 raw_ostream *OS = &llvm::errs();
Douglas Gregor811db4e2012-10-23 22:26:28 +0000214 if (DiagOpts->DiagnosticLogFile != "-") {
Daniel Dunbar2083c322011-04-07 18:31:10 +0000215 // Create the output stream.
David Blaikie11f8a942014-09-15 17:30:56 +0000216 auto FileOS = llvm::make_unique<llvm::raw_fd_ostream>(
Rafael Espindoladae941a2014-08-25 18:17:04 +0000217 DiagOpts->DiagnosticLogFile, EC,
David Blaikie11f8a942014-09-15 17:30:56 +0000218 llvm::sys::fs::F_Append | llvm::sys::fs::F_Text);
Rafael Espindoladae941a2014-08-25 18:17:04 +0000219 if (EC) {
Daniel Dunbar2083c322011-04-07 18:31:10 +0000220 Diags.Report(diag::warn_fe_cc_log_diagnostics_failure)
Rafael Espindoladae941a2014-08-25 18:17:04 +0000221 << DiagOpts->DiagnosticLogFile << EC.message();
Daniel Dunbar2083c322011-04-07 18:31:10 +0000222 } else {
223 FileOS->SetUnbuffered();
David Blaikie11f8a942014-09-15 17:30:56 +0000224 OS = FileOS.get();
225 StreamOwner = std::move(FileOS);
Daniel Dunbar2083c322011-04-07 18:31:10 +0000226 }
227 }
228
229 // Chain in the diagnostic client which will log the diagnostics.
David Blaikie7ee25502014-09-15 17:50:10 +0000230 auto Logger = llvm::make_unique<LogDiagnosticPrinter>(*OS, DiagOpts,
231 std::move(StreamOwner));
Daniel Dunbar7b833062011-04-07 18:59:02 +0000232 if (CodeGenOpts)
233 Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
David Blaikie7ee25502014-09-15 17:50:10 +0000234 assert(Diags.ownsClient());
Alexander Kornienko41c247a2014-11-17 23:46:02 +0000235 Diags.setClient(
236 new ChainedDiagnosticConsumer(Diags.takeClient(), std::move(Logger)));
Daniel Dunbar2083c322011-04-07 18:31:10 +0000237}
238
Douglas Gregor811db4e2012-10-23 22:26:28 +0000239static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts,
Ted Kremenek4610ea22011-10-29 00:12:39 +0000240 DiagnosticsEngine &Diags,
241 StringRef OutputFile) {
David Blaikie7ee25502014-09-15 17:50:10 +0000242 auto SerializedConsumer =
Justin Bogner5a6a2fc2014-10-23 22:20:11 +0000243 clang::serialized_diags::create(OutputFile, DiagOpts);
Ahmed Charles9a16beb2014-03-07 19:33:25 +0000244
Alexander Kornienko254b7db2014-11-13 13:08:27 +0000245 if (Diags.ownsClient()) {
246 Diags.setClient(new ChainedDiagnosticConsumer(
Alexander Kornienko41c247a2014-11-17 23:46:02 +0000247 Diags.takeClient(), std::move(SerializedConsumer)));
Alexander Kornienko254b7db2014-11-13 13:08:27 +0000248 } else {
249 Diags.setClient(new ChainedDiagnosticConsumer(
Alexander Kornienko4c0ef3792014-11-17 14:46:28 +0000250 Diags.getClient(), std::move(SerializedConsumer)));
Alexander Kornienko254b7db2014-11-13 13:08:27 +0000251 }
Ted Kremenek4610ea22011-10-29 00:12:39 +0000252}
253
Sean Silvaf1b49e22013-01-20 01:58:28 +0000254void CompilerInstance::createDiagnostics(DiagnosticConsumer *Client,
Douglas Gregor30071cea2013-05-03 23:07:45 +0000255 bool ShouldOwnClient) {
Sean Silvaf1b49e22013-01-20 01:58:28 +0000256 Diagnostics = createDiagnostics(&getDiagnosticOpts(), Client,
Douglas Gregor30071cea2013-05-03 23:07:45 +0000257 ShouldOwnClient, &getCodeGenOpts());
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000258}
259
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000260IntrusiveRefCntPtr<DiagnosticsEngine>
Douglas Gregor811db4e2012-10-23 22:26:28 +0000261CompilerInstance::createDiagnostics(DiagnosticOptions *Opts,
David Blaikiee2eefae2011-09-25 23:39:51 +0000262 DiagnosticConsumer *Client,
Douglas Gregor2b9b4642011-09-13 01:26:44 +0000263 bool ShouldOwnClient,
Daniel Dunbar7b833062011-04-07 18:59:02 +0000264 const CodeGenOptions *CodeGenOpts) {
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000265 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
266 IntrusiveRefCntPtr<DiagnosticsEngine>
Douglas Gregor811db4e2012-10-23 22:26:28 +0000267 Diags(new DiagnosticsEngine(DiagID, Opts));
Daniel Dunbar1b39a2e2009-11-14 07:53:24 +0000268
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000269 // Create the diagnostic client for reporting errors or for
270 // implementing -verify.
Douglas Gregord0e9e3a2011-09-29 00:38:00 +0000271 if (Client) {
Douglas Gregor30071cea2013-05-03 23:07:45 +0000272 Diags->setClient(Client, ShouldOwnClient);
Douglas Gregord0e9e3a2011-09-29 00:38:00 +0000273 } else
Douglas Gregor44c6ee72010-11-11 00:39:14 +0000274 Diags->setClient(new TextDiagnosticPrinter(llvm::errs(), Opts));
Daniel Dunbar50ec0da2009-11-14 03:24:39 +0000275
276 // Chain in -verify checker, if requested.
Douglas Gregor811db4e2012-10-23 22:26:28 +0000277 if (Opts->VerifyDiagnostics)
David Blaikie69609dc2011-09-26 00:38:03 +0000278 Diags->setClient(new VerifyDiagnosticConsumer(*Diags));
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000279
Daniel Dunbar2083c322011-04-07 18:31:10 +0000280 // Chain in -diagnostic-log-file dumper, if requested.
Douglas Gregor811db4e2012-10-23 22:26:28 +0000281 if (!Opts->DiagnosticLogFile.empty())
Daniel Dunbar7b833062011-04-07 18:59:02 +0000282 SetUpDiagnosticLog(Opts, CodeGenOpts, *Diags);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000283
Douglas Gregor811db4e2012-10-23 22:26:28 +0000284 if (!Opts->DiagnosticSerializationFile.empty())
Ted Kremenek4610ea22011-10-29 00:12:39 +0000285 SetupSerializedDiagnostics(Opts, *Diags,
Douglas Gregor811db4e2012-10-23 22:26:28 +0000286 Opts->DiagnosticSerializationFile);
Ted Kremenek4610ea22011-10-29 00:12:39 +0000287
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000288 // Configure our handling of diagnostics.
Douglas Gregor811db4e2012-10-23 22:26:28 +0000289 ProcessWarningOptions(*Diags, *Opts);
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000290
Douglas Gregor7f95d262010-04-05 23:52:57 +0000291 return Diags;
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000292}
293
294// File Manager
295
Daniel Dunbar546a6762009-11-13 04:12:06 +0000296void CompilerInstance::createFileManager() {
Ben Langmuirc8130a72014-02-20 21:59:23 +0000297 if (!hasVirtualFileSystem()) {
298 // TODO: choose the virtual file system based on the CompilerInvocation.
299 setVirtualFileSystem(vfs::getRealFileSystem());
300 }
301 FileMgr = new FileManager(getFileSystemOpts(), VirtualFileSystem);
Daniel Dunbar546a6762009-11-13 04:12:06 +0000302}
303
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000304// Source Manager
305
Chris Lattner5159f612010-11-23 08:35:12 +0000306void CompilerInstance::createSourceManager(FileManager &FileMgr) {
Ted Kremenek5e14d392011-03-21 18:40:17 +0000307 SourceMgr = new SourceManager(getDiagnostics(), FileMgr);
Daniel Dunbar546a6762009-11-13 04:12:06 +0000308}
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000309
Alp Tokerc3580002014-07-07 06:05:00 +0000310// Initialize the remapping of files to alternative contents, e.g.,
311// those specified through other files.
312static void InitializeFileRemapping(DiagnosticsEngine &Diags,
313 SourceManager &SourceMgr,
314 FileManager &FileMgr,
315 const PreprocessorOptions &InitOpts) {
316 // Remap files in the source manager (with buffers).
Alp Toker1b070d22014-07-07 07:47:20 +0000317 for (const auto &RB : InitOpts.RemappedFileBuffers) {
Alp Tokerc3580002014-07-07 06:05:00 +0000318 // Create the file entry for the file that we're mapping from.
319 const FileEntry *FromFile =
Alp Toker1b070d22014-07-07 07:47:20 +0000320 FileMgr.getVirtualFile(RB.first, RB.second->getBufferSize(), 0);
Alp Tokerc3580002014-07-07 06:05:00 +0000321 if (!FromFile) {
Alp Toker1b070d22014-07-07 07:47:20 +0000322 Diags.Report(diag::err_fe_remap_missing_from_file) << RB.first;
Alp Tokerc3580002014-07-07 06:05:00 +0000323 if (!InitOpts.RetainRemappedFileBuffers)
Alp Toker1b070d22014-07-07 07:47:20 +0000324 delete RB.second;
Alp Tokerc3580002014-07-07 06:05:00 +0000325 continue;
326 }
327
328 // Override the contents of the "from" file with the contents of
329 // the "to" file.
Alp Toker1b070d22014-07-07 07:47:20 +0000330 SourceMgr.overrideFileContents(FromFile, RB.second,
Alp Tokerc3580002014-07-07 06:05:00 +0000331 InitOpts.RetainRemappedFileBuffers);
332 }
333
334 // Remap files in the source manager (with other files).
Alp Toker1b070d22014-07-07 07:47:20 +0000335 for (const auto &RF : InitOpts.RemappedFiles) {
Alp Tokerc3580002014-07-07 06:05:00 +0000336 // Find the file that we're mapping to.
Alp Toker1b070d22014-07-07 07:47:20 +0000337 const FileEntry *ToFile = FileMgr.getFile(RF.second);
Alp Tokerc3580002014-07-07 06:05:00 +0000338 if (!ToFile) {
Alp Toker1b070d22014-07-07 07:47:20 +0000339 Diags.Report(diag::err_fe_remap_missing_to_file) << RF.first << RF.second;
Alp Tokerc3580002014-07-07 06:05:00 +0000340 continue;
341 }
342
343 // Create the file entry for the file that we're mapping from.
344 const FileEntry *FromFile =
Alp Toker1b070d22014-07-07 07:47:20 +0000345 FileMgr.getVirtualFile(RF.first, ToFile->getSize(), 0);
Alp Tokerc3580002014-07-07 06:05:00 +0000346 if (!FromFile) {
Alp Toker1b070d22014-07-07 07:47:20 +0000347 Diags.Report(diag::err_fe_remap_missing_from_file) << RF.first;
Alp Tokerc3580002014-07-07 06:05:00 +0000348 continue;
349 }
350
351 // Override the contents of the "from" file with the contents of
352 // the "to" file.
353 SourceMgr.overrideFileContents(FromFile, ToFile);
354 }
355
356 SourceMgr.setOverridenFilesKeepOriginalName(
357 InitOpts.RemappedFilesKeepOriginalName);
358}
359
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000360// Preprocessor
361
Argyrios Kyrtzidise1974dc2014-03-07 07:47:58 +0000362void CompilerInstance::createPreprocessor(TranslationUnitKind TUKind) {
Douglas Gregor08142532011-08-26 23:56:07 +0000363 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000364
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000365 // Create a PTH manager if we are using some form of a token cache.
Craig Topper49a27902014-05-22 04:46:25 +0000366 PTHManager *PTHMgr = nullptr;
Daniel Dunbard6ea9022009-11-17 05:52:41 +0000367 if (!PPOpts.TokenCache.empty())
Douglas Gregor08142532011-08-26 23:56:07 +0000368 PTHMgr = PTHManager::Create(PPOpts.TokenCache, getDiagnostics());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000369
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000370 // Create the Preprocessor.
David Blaikie9c28cb32017-01-06 01:04:46 +0000371 HeaderSearch *HeaderInfo =
372 new HeaderSearch(getHeaderSearchOptsPtr(), getSourceManager(),
373 getDiagnostics(), getLangOpts(), &getTarget());
David Blaikie41565462017-01-05 19:48:07 +0000374 PP = std::make_shared<Preprocessor>(
375 Invocation->getPreprocessorOptsPtr(), getDiagnostics(), getLangOpts(),
376 getSourceManager(), *HeaderInfo, *this, PTHMgr,
377 /*OwnsHeaderSearch=*/true, TUKind);
Artem Belevichb5bc9232015-09-22 17:23:22 +0000378 PP->Initialize(getTarget(), getAuxTarget());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000379
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000380 // Note that this is different then passing PTHMgr to Preprocessor's ctor.
381 // That argument is used as the IdentifierInfoLookup argument to
382 // IdentifierTable's ctor.
383 if (PTHMgr) {
Douglas Gregor08142532011-08-26 23:56:07 +0000384 PTHMgr->setPreprocessor(&*PP);
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000385 PP->setPTHManager(PTHMgr);
386 }
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000387
Douglas Gregor7f6d60d2010-03-19 16:15:56 +0000388 if (PPOpts.DetailedRecord)
Argyrios Kyrtzidisf3d587e2012-12-04 07:27:05 +0000389 PP->createPreprocessingRecord();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000390
Alp Tokerc3580002014-07-07 06:05:00 +0000391 // Apply remappings to the source manager.
392 InitializeFileRemapping(PP->getDiagnostics(), PP->getSourceManager(),
393 PP->getFileManager(), PPOpts);
394
395 // Predefine macros and configure the preprocessor.
Adrian Prantlfb2398d2015-07-17 01:19:54 +0000396 InitializePreprocessor(*PP, PPOpts, getPCHContainerReader(),
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000397 getFrontendOpts());
Alp Tokerc3580002014-07-07 06:05:00 +0000398
Justin Lebarf91086b2016-11-18 00:41:27 +0000399 // Initialize the header search object. In CUDA compilations, we use the aux
400 // triple (the host triple) to initialize our header search, since we need to
401 // find the host headers in order to compile the CUDA code.
402 const llvm::Triple *HeaderSearchTriple = &PP->getTargetInfo().getTriple();
403 if (PP->getTargetInfo().getTriple().getOS() == llvm::Triple::CUDA &&
404 PP->getAuxTargetInfo())
405 HeaderSearchTriple = &PP->getAuxTargetInfo()->getTriple();
406
Alp Tokerc3580002014-07-07 06:05:00 +0000407 ApplyHeaderSearchOptions(PP->getHeaderSearchInfo(), getHeaderSearchOpts(),
Justin Lebarf91086b2016-11-18 00:41:27 +0000408 PP->getLangOpts(), *HeaderSearchTriple);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000409
Jordan Rose17441582013-01-30 01:52:57 +0000410 PP->setPreprocessedOutput(getPreprocessorOutputOpts().ShowCPP);
411
Richard Smith3938f0c2015-08-15 00:34:15 +0000412 if (PP->getLangOpts().Modules && PP->getLangOpts().ImplicitModules)
Chandler Carruthff8d9432015-03-28 01:10:44 +0000413 PP->getHeaderSearchInfo().setModuleCachePath(getSpecificModuleCachePath());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000414
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000415 // Handle generating dependencies, if requested.
Douglas Gregor08142532011-08-26 23:56:07 +0000416 const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000417 if (!DepOpts.OutputFile.empty())
Ben Langmuircb69b572014-03-07 06:40:32 +0000418 TheDependencyFileGenerator.reset(
419 DependencyFileGenerator::CreateAndAttachToPreprocessor(*PP, DepOpts));
Douglas Gregor2e129652012-02-02 23:45:13 +0000420 if (!DepOpts.DOTOutputFile.empty())
421 AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
Douglas Gregor83d46be2012-02-02 00:54:52 +0000422 getHeaderSearchOpts().Sysroot);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000423
Justin Bogner86d12592014-06-19 19:36:03 +0000424 // If we don't have a collector, but we are collecting module dependencies,
425 // then we're the top level compiler instance and need to create one.
Bruno Cardoso Lopesb1631d92016-03-29 23:47:40 +0000426 if (!ModuleDepCollector && !DepOpts.ModuleDependencyOutputDir.empty()) {
Justin Bogner86d12592014-06-19 19:36:03 +0000427 ModuleDepCollector = std::make_shared<ModuleDependencyCollector>(
428 DepOpts.ModuleDependencyOutputDir);
Bruno Cardoso Lopesb1631d92016-03-29 23:47:40 +0000429 }
430
Bruno Cardoso Lopes181225b2016-12-11 04:27:28 +0000431 // If there is a module dep collector, register with other dep collectors
432 // and also (a) collect header maps and (b) TODO: input vfs overlay files.
433 if (ModuleDepCollector) {
Bruno Cardoso Lopesb1631d92016-03-29 23:47:40 +0000434 addDependencyCollector(ModuleDepCollector);
Bruno Cardoso Lopes181225b2016-12-11 04:27:28 +0000435 collectHeaderMaps(PP->getHeaderSearchInfo(), ModuleDepCollector);
Bruno Cardoso Lopes7aff2bb2016-12-12 19:28:25 +0000436 collectIncludePCH(*this, ModuleDepCollector);
Bruno Cardoso Lopes82ec4fde2016-12-22 07:06:03 +0000437 collectVFSEntries(*this, ModuleDepCollector);
Bruno Cardoso Lopes181225b2016-12-11 04:27:28 +0000438 }
Bruno Cardoso Lopesb1631d92016-03-29 23:47:40 +0000439
440 for (auto &Listener : DependencyCollectors)
441 Listener->attachToPreprocessor(*PP);
Hans Wennborg0fd62072013-08-09 00:32:23 +0000442
Daniel Dunbar27734fd2011-02-02 15:41:17 +0000443 // Handle generating header include information, if requested.
444 if (DepOpts.ShowHeaderIncludes)
Nico Weberf54146c2016-03-23 18:46:57 +0000445 AttachHeaderIncludeGen(*PP, DepOpts);
Daniel Dunbar1af1d27512011-02-02 21:11:31 +0000446 if (!DepOpts.HeaderIncludeOutputFile.empty()) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000447 StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
Daniel Dunbar1af1d27512011-02-02 21:11:31 +0000448 if (OutputPath == "-")
449 OutputPath = "";
Nico Weberf54146c2016-03-23 18:46:57 +0000450 AttachHeaderIncludeGen(*PP, DepOpts,
Ivan Krasin1193f2c2015-08-13 04:04:37 +0000451 /*ShowAllHeaders=*/true, OutputPath,
Daniel Dunbarfe908a82011-03-21 19:37:38 +0000452 /*ShowDepth=*/false);
Daniel Dunbar1af1d27512011-02-02 21:11:31 +0000453 }
Hans Wennborg0fd62072013-08-09 00:32:23 +0000454
455 if (DepOpts.PrintShowIncludes) {
Nico Weberf54146c2016-03-23 18:46:57 +0000456 AttachHeaderIncludeGen(*PP, DepOpts,
Nico Weber149d95222016-03-23 18:00:22 +0000457 /*ShowAllHeaders=*/true, /*OutputPath=*/"",
Hans Wennborg0fd62072013-08-09 00:32:23 +0000458 /*ShowDepth=*/true, /*MSStyle=*/true);
459 }
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000460}
Daniel Dunbardf3e30c2009-11-13 08:20:47 +0000461
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000462std::string CompilerInstance::getSpecificModuleCachePath() {
463 // Set up the module path, including the hash for the
464 // module-creation options.
Richard Smithd520a252015-07-21 18:07:47 +0000465 SmallString<256> SpecificModuleCache(getHeaderSearchOpts().ModuleCachePath);
466 if (!SpecificModuleCache.empty() && !getHeaderSearchOpts().DisableModuleHash)
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000467 llvm::sys::path::append(SpecificModuleCache,
468 getInvocation().getModuleHash());
469 return SpecificModuleCache.str();
470}
471
Daniel Dunbardf3e30c2009-11-13 08:20:47 +0000472// ASTContext
473
474void CompilerInstance::createASTContext() {
475 Preprocessor &PP = getPreprocessor();
Richard Smith293534b2015-08-18 20:39:29 +0000476 auto *Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
477 PP.getIdentifierTable(), PP.getSelectorTable(),
478 PP.getBuiltinInfo());
Artem Belevichb5bc9232015-09-22 17:23:22 +0000479 Context->InitBuiltinTypes(getTarget(), getAuxTarget());
Richard Smith293534b2015-08-18 20:39:29 +0000480 setASTContext(Context);
Daniel Dunbardf3e30c2009-11-13 08:20:47 +0000481}
Daniel Dunbar599313e2009-11-13 08:21:10 +0000482
483// ExternalASTSource
484
Nico Weber824285e2014-05-08 04:26:47 +0000485void CompilerInstance::createPCHExternalASTSource(
486 StringRef Path, bool DisablePCHValidation, bool AllowPCHWithCompilerErrors,
487 void *DeserializationListener, bool OwnDeserializationListener) {
Sebastian Redl009e7f22010-10-05 16:15:19 +0000488 bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
Richard Smith4eca9b92015-02-04 23:37:59 +0000489 ModuleManager = createPCHExternalASTSource(
Nico Weber824285e2014-05-08 04:26:47 +0000490 Path, getHeaderSearchOpts().Sysroot, DisablePCHValidation,
491 AllowPCHWithCompilerErrors, getPreprocessor(), getASTContext(),
Douglas Gregor6623e1f2015-11-03 18:33:07 +0000492 getPCHContainerReader(),
493 getFrontendOpts().ModuleFileExtensions,
494 DeserializationListener,
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000495 OwnDeserializationListener, Preamble,
Nico Weber824285e2014-05-08 04:26:47 +0000496 getFrontendOpts().UseGlobalModuleIndex);
Daniel Dunbar599313e2009-11-13 08:21:10 +0000497}
498
Richard Smith4eca9b92015-02-04 23:37:59 +0000499IntrusiveRefCntPtr<ASTReader> CompilerInstance::createPCHExternalASTSource(
Yaron Keren5b816062015-07-06 08:47:15 +0000500 StringRef Path, StringRef Sysroot, bool DisablePCHValidation,
Nico Weber824285e2014-05-08 04:26:47 +0000501 bool AllowPCHWithCompilerErrors, Preprocessor &PP, ASTContext &Context,
Adrian Prantlfb2398d2015-07-17 01:19:54 +0000502 const PCHContainerReader &PCHContainerRdr,
David Blaikie61137e12017-01-05 18:23:18 +0000503 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
Nico Weber824285e2014-05-08 04:26:47 +0000504 void *DeserializationListener, bool OwnDeserializationListener,
505 bool Preamble, bool UseGlobalModuleIndex) {
Ben Langmuirdcf73862014-03-12 00:06:17 +0000506 HeaderSearchOptions &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
507
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000508 IntrusiveRefCntPtr<ASTReader> Reader(new ASTReader(
Douglas Gregor6623e1f2015-11-03 18:33:07 +0000509 PP, Context, PCHContainerRdr, Extensions,
510 Sysroot.empty() ? "" : Sysroot.data(), DisablePCHValidation,
511 AllowPCHWithCompilerErrors, /*AllowConfigurationMismatch*/ false,
512 HSOpts.ModulesValidateSystemHeaders, UseGlobalModuleIndex));
Richard Smith4eca9b92015-02-04 23:37:59 +0000513
514 // We need the external source to be set up before we read the AST, because
515 // eagerly-deserialized declarations may use it.
516 Context.setExternalSource(Reader.get());
Daniel Dunbar599313e2009-11-13 08:21:10 +0000517
Sebastian Redl07a89a82010-07-30 00:29:29 +0000518 Reader->setDeserializationListener(
Nico Weber824285e2014-05-08 04:26:47 +0000519 static_cast<ASTDeserializationListener *>(DeserializationListener),
520 /*TakeOwnership=*/OwnDeserializationListener);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000521 switch (Reader->ReadAST(Path,
522 Preamble ? serialization::MK_Preamble
Douglas Gregor4b29c162012-10-22 23:51:00 +0000523 : serialization::MK_PCH,
Argyrios Kyrtzidis2ec29362012-11-15 18:57:22 +0000524 SourceLocation(),
Ben Langmuir3d4417c2014-02-07 17:31:11 +0000525 ASTReader::ARR_None)) {
Sebastian Redl2c499f62010-08-18 23:56:43 +0000526 case ASTReader::Success:
Daniel Dunbar599313e2009-11-13 08:21:10 +0000527 // Set the predefines buffer as suggested by the PCH reader. Typically, the
528 // predefines buffer will be empty.
529 PP.setPredefines(Reader->getSuggestedPredefines());
Richard Smith4eca9b92015-02-04 23:37:59 +0000530 return Reader;
Daniel Dunbar599313e2009-11-13 08:21:10 +0000531
Sebastian Redl2c499f62010-08-18 23:56:43 +0000532 case ASTReader::Failure:
Daniel Dunbar599313e2009-11-13 08:21:10 +0000533 // Unrecoverable failure: don't even try to process the input file.
534 break;
535
Douglas Gregor7029ce12013-03-19 00:28:20 +0000536 case ASTReader::Missing:
Douglas Gregorc9ad5fb2012-10-22 22:50:17 +0000537 case ASTReader::OutOfDate:
538 case ASTReader::VersionMismatch:
539 case ASTReader::ConfigurationMismatch:
540 case ASTReader::HadErrors:
Daniel Dunbar599313e2009-11-13 08:21:10 +0000541 // No suitable PCH file could be found. Return an error.
542 break;
543 }
544
Richard Smith4eca9b92015-02-04 23:37:59 +0000545 Context.setExternalSource(nullptr);
Craig Topper49a27902014-05-22 04:46:25 +0000546 return nullptr;
Daniel Dunbar599313e2009-11-13 08:21:10 +0000547}
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000548
549// Code Completion
550
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000551static bool EnableCodeCompletion(Preprocessor &PP,
Benjamin Kramer0772c422016-02-13 13:42:54 +0000552 StringRef Filename,
Douglas Gregor8e984da2010-08-04 16:47:14 +0000553 unsigned Line,
554 unsigned Column) {
555 // Tell the source manager to chop off the given file at a specific
556 // line and column.
Chris Lattner5159f612010-11-23 08:35:12 +0000557 const FileEntry *Entry = PP.getFileManager().getFile(Filename);
Douglas Gregor8e984da2010-08-04 16:47:14 +0000558 if (!Entry) {
559 PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
560 << Filename;
561 return true;
562 }
563
564 // Truncate the named file at the given line/column.
565 PP.SetCodeCompletionPoint(Entry, Line, Column);
566 return false;
567}
568
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000569void CompilerInstance::createCodeCompletionConsumer() {
570 const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
Douglas Gregor8e984da2010-08-04 16:47:14 +0000571 if (!CompletionConsumer) {
Erik Verbruggen2fca3c22012-04-12 10:31:12 +0000572 setCodeCompletionConsumer(
Douglas Gregor8e984da2010-08-04 16:47:14 +0000573 createCodeCompletionConsumer(getPreprocessor(),
574 Loc.FileName, Loc.Line, Loc.Column,
Dmitri Gribenko3292d062012-07-02 17:35:10 +0000575 getFrontendOpts().CodeCompleteOpts,
Douglas Gregor8e984da2010-08-04 16:47:14 +0000576 llvm::outs()));
577 if (!CompletionConsumer)
578 return;
579 } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
580 Loc.Line, Loc.Column)) {
Craig Topper49a27902014-05-22 04:46:25 +0000581 setCodeCompletionConsumer(nullptr);
Douglas Gregor00a0cf72010-03-16 06:04:47 +0000582 return;
Douglas Gregor8e984da2010-08-04 16:47:14 +0000583 }
Douglas Gregorf09935f2009-12-01 05:55:20 +0000584
585 if (CompletionConsumer->isOutputBinary() &&
Rafael Espindolaa3346d82013-06-12 20:44:26 +0000586 llvm::sys::ChangeStdoutToBinary()) {
Douglas Gregorf09935f2009-12-01 05:55:20 +0000587 getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
Craig Topper49a27902014-05-22 04:46:25 +0000588 setCodeCompletionConsumer(nullptr);
Douglas Gregorf09935f2009-12-01 05:55:20 +0000589 }
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000590}
591
Kovarththanan Rajaratnam5505dff2009-11-29 09:57:35 +0000592void CompilerInstance::createFrontendTimer() {
Matthias Braunae032b62016-11-18 19:43:25 +0000593 FrontendTimerGroup.reset(
594 new llvm::TimerGroup("frontend", "Clang front-end time report"));
Richard Smithce18a182015-07-14 00:26:00 +0000595 FrontendTimer.reset(
Matthias Braunae032b62016-11-18 19:43:25 +0000596 new llvm::Timer("frontend", "Clang front-end timer",
597 *FrontendTimerGroup));
Kovarththanan Rajaratnam5505dff2009-11-29 09:57:35 +0000598}
599
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000600CodeCompleteConsumer *
601CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
Yaron Keren5b816062015-07-06 08:47:15 +0000602 StringRef Filename,
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000603 unsigned Line,
604 unsigned Column,
Dmitri Gribenko3292d062012-07-02 17:35:10 +0000605 const CodeCompleteOptions &Opts,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000606 raw_ostream &OS) {
Douglas Gregor8e984da2010-08-04 16:47:14 +0000607 if (EnableCodeCompletion(PP, Filename, Line, Column))
Craig Topper49a27902014-05-22 04:46:25 +0000608 return nullptr;
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000609
610 // Set up the creation routine for code-completion.
Dmitri Gribenko3292d062012-07-02 17:35:10 +0000611 return new PrintingCodeCompleteConsumer(Opts, OS);
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000612}
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000613
Douglas Gregor69f74f82011-08-25 22:30:56 +0000614void CompilerInstance::createSema(TranslationUnitKind TUKind,
Douglas Gregor0e93f012010-08-12 23:31:19 +0000615 CodeCompleteConsumer *CompletionConsumer) {
616 TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
Douglas Gregor69f74f82011-08-25 22:30:56 +0000617 TUKind, CompletionConsumer));
Benjamin Kramer7de99692016-11-16 18:15:26 +0000618 // Attach the external sema source if there is any.
619 if (ExternalSemaSrc) {
620 TheSema->addExternalSource(ExternalSemaSrc.get());
621 ExternalSemaSrc->InitializeSema(*TheSema);
622 }
Douglas Gregor0e93f012010-08-12 23:31:19 +0000623}
624
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000625// Output Files
626
Rafael Espindola269ec0f2015-04-10 14:11:52 +0000627void CompilerInstance::addOutputFile(OutputFile &&OutFile) {
Rafael Espindola269ec0f2015-04-10 14:11:52 +0000628 OutputFiles.push_back(std::move(OutFile));
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000629}
630
Kovarththanan Rajaratnam1c558cd2010-03-06 12:07:48 +0000631void CompilerInstance::clearOutputFiles(bool EraseFiles) {
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000632 for (OutputFile &OF : OutputFiles) {
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000633 if (!OF.TempFilename.empty()) {
Anders Carlssonb5c356a2011-03-06 22:25:35 +0000634 if (EraseFiles) {
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000635 llvm::sys::fs::remove(OF.TempFilename);
Anders Carlssonb5c356a2011-03-06 22:25:35 +0000636 } else {
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000637 SmallString<128> NewOutFile(OF.Filename);
Anders Carlssonb5c356a2011-03-06 22:25:35 +0000638
Argyrios Kyrtzidis71731d62010-11-03 22:45:23 +0000639 // If '-working-directory' was passed, the output filename should be
640 // relative to that.
Anders Carlsson9ba8fb12011-03-14 01:13:54 +0000641 FileMgr->FixupRelativePath(NewOutFile);
Rafael Espindolac0809172014-06-12 14:02:15 +0000642 if (std::error_code ec =
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000643 llvm::sys::fs::rename(OF.TempFilename, NewOutFile)) {
Manuel Klimek3ef9c442012-05-16 20:55:58 +0000644 getDiagnostics().Report(diag::err_unable_to_rename_temp)
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000645 << OF.TempFilename << OF.Filename << ec.message();
Anders Carlssonb5c356a2011-03-06 22:25:35 +0000646
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000647 llvm::sys::fs::remove(OF.TempFilename);
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000648 }
649 }
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000650 } else if (!OF.Filename.empty() && EraseFiles)
651 llvm::sys::fs::remove(OF.Filename);
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000652 }
653 OutputFiles.clear();
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000654 NonSeekStream.reset();
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000655}
656
Peter Collingbourne03f89072016-07-15 00:55:40 +0000657std::unique_ptr<raw_pwrite_stream>
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000658CompilerInstance::createDefaultOutputFile(bool Binary, StringRef InFile,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000659 StringRef Extension) {
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000660 return createOutputFile(getFrontendOpts().OutputFile, Binary,
Daniel Dunbarae77b3d2012-03-03 00:36:06 +0000661 /*RemoveFileOnSignal=*/true, InFile, Extension,
662 /*UseTemporary=*/true);
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000663}
664
Peter Collingbourne03f89072016-07-15 00:55:40 +0000665std::unique_ptr<raw_pwrite_stream> CompilerInstance::createNullOutputFile() {
666 return llvm::make_unique<llvm::raw_null_ostream>();
Alp Tokerea046722014-06-03 17:23:34 +0000667}
668
Peter Collingbourne03f89072016-07-15 00:55:40 +0000669std::unique_ptr<raw_pwrite_stream>
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000670CompilerInstance::createOutputFile(StringRef OutputPath, bool Binary,
671 bool RemoveFileOnSignal, StringRef InFile,
672 StringRef Extension, bool UseTemporary,
Daniel Dunbarb9c62c02012-03-03 00:36:02 +0000673 bool CreateMissingDirectories) {
Rafael Espindoladae941a2014-08-25 18:17:04 +0000674 std::string OutputPathName, TempPathName;
675 std::error_code EC;
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000676 std::unique_ptr<raw_pwrite_stream> OS = createOutputFile(
Rafael Espindoladae941a2014-08-25 18:17:04 +0000677 OutputPath, EC, Binary, RemoveFileOnSignal, InFile, Extension,
Rafael Espindolac80a4062015-04-10 14:30:43 +0000678 UseTemporary, CreateMissingDirectories, &OutputPathName, &TempPathName);
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000679 if (!OS) {
Rafael Espindoladae941a2014-08-25 18:17:04 +0000680 getDiagnostics().Report(diag::err_fe_unable_to_open_output) << OutputPath
681 << EC.message();
Craig Topper49a27902014-05-22 04:46:25 +0000682 return nullptr;
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000683 }
684
685 // Add the output file -- but don't try to remove "-", since this means we are
686 // using stdin.
Peter Collingbourne03f89072016-07-15 00:55:40 +0000687 addOutputFile(
688 OutputFile((OutputPathName != "-") ? OutputPathName : "", TempPathName));
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000689
Peter Collingbourne03f89072016-07-15 00:55:40 +0000690 return OS;
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000691}
692
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000693std::unique_ptr<llvm::raw_pwrite_stream> CompilerInstance::createOutputFile(
Rafael Espindoladae941a2014-08-25 18:17:04 +0000694 StringRef OutputPath, std::error_code &Error, bool Binary,
695 bool RemoveFileOnSignal, StringRef InFile, StringRef Extension,
696 bool UseTemporary, bool CreateMissingDirectories,
697 std::string *ResultPathName, std::string *TempPathName) {
Daniel Dunbarb9c62c02012-03-03 00:36:02 +0000698 assert((!CreateMissingDirectories || UseTemporary) &&
699 "CreateMissingDirectories is only allowed when using temporary files");
700
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000701 std::string OutFile, TempFile;
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000702 if (!OutputPath.empty()) {
703 OutFile = OutputPath;
704 } else if (InFile == "-") {
705 OutFile = "-";
706 } else if (!Extension.empty()) {
Rafael Espindola399ab332013-06-26 04:32:59 +0000707 SmallString<128> Path(InFile);
708 llvm::sys::path::replace_extension(Path, Extension);
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000709 OutFile = Path.str();
710 } else {
711 OutFile = "-";
712 }
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000713
Ahmed Charlesb8984322014-03-07 20:03:18 +0000714 std::unique_ptr<llvm::raw_fd_ostream> OS;
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000715 std::string OSFile;
716
Rafael Espindola73c23a72013-06-27 18:26:26 +0000717 if (UseTemporary) {
718 if (OutFile == "-")
719 UseTemporary = false;
720 else {
721 llvm::sys::fs::file_status Status;
722 llvm::sys::fs::status(OutputPath, Status);
723 if (llvm::sys::fs::exists(Status)) {
724 // Fail early if we can't write to the final destination.
Douglas Katzman8bfac2c2015-09-17 16:45:12 +0000725 if (!llvm::sys::fs::can_write(OutputPath)) {
Rafael Espindolaee4e08b2015-10-05 11:49:35 +0000726 Error = make_error_code(llvm::errc::operation_not_permitted);
Craig Topper49a27902014-05-22 04:46:25 +0000727 return nullptr;
Douglas Katzman8bfac2c2015-09-17 16:45:12 +0000728 }
Rafael Espindola73c23a72013-06-27 18:26:26 +0000729
730 // Don't use a temporary if the output is a special file. This handles
731 // things like '-o /dev/null'
732 if (!llvm::sys::fs::is_regular_file(Status))
733 UseTemporary = false;
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000734 }
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000735 }
736 }
737
Rafael Espindola73c23a72013-06-27 18:26:26 +0000738 if (UseTemporary) {
Rafael Espindola73c23a72013-06-27 18:26:26 +0000739 // Create a temporary file.
740 SmallString<128> TempPath;
741 TempPath = OutFile;
742 TempPath += "-%%%%%%%%";
743 int fd;
Rafael Espindolac0809172014-06-12 14:02:15 +0000744 std::error_code EC =
Yaron Keren92e1b622015-03-18 10:17:07 +0000745 llvm::sys::fs::createUniqueFile(TempPath, fd, TempPath);
Rafael Espindola157f34b2013-06-28 03:49:04 +0000746
747 if (CreateMissingDirectories &&
Rafael Espindola71de0b62014-06-13 17:20:50 +0000748 EC == llvm::errc::no_such_file_or_directory) {
Rafael Espindola157f34b2013-06-28 03:49:04 +0000749 StringRef Parent = llvm::sys::path::parent_path(OutputPath);
750 EC = llvm::sys::fs::create_directories(Parent);
751 if (!EC) {
Yaron Keren92e1b622015-03-18 10:17:07 +0000752 EC = llvm::sys::fs::createUniqueFile(TempPath, fd, TempPath);
Rafael Espindola157f34b2013-06-28 03:49:04 +0000753 }
754 }
755
756 if (!EC) {
NAKAMURA Takumi69f35282014-08-11 06:53:11 +0000757 OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
Rafael Espindola73c23a72013-06-27 18:26:26 +0000758 OSFile = TempFile = TempPath.str();
759 }
760 // If we failed to create the temporary, fallback to writing to the file
761 // directly. This handles the corner case where we cannot write to the
762 // directory, but can write to the file.
763 }
764
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000765 if (!OS) {
766 OSFile = OutFile;
NAKAMURA Takumi69f35282014-08-11 06:53:11 +0000767 OS.reset(new llvm::raw_fd_ostream(
Rafael Espindoladae941a2014-08-25 18:17:04 +0000768 OSFile, Error,
NAKAMURA Takumi69f35282014-08-11 06:53:11 +0000769 (Binary ? llvm::sys::fs::F_None : llvm::sys::fs::F_Text)));
Rafael Espindoladae941a2014-08-25 18:17:04 +0000770 if (Error)
Craig Topper49a27902014-05-22 04:46:25 +0000771 return nullptr;
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000772 }
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000773
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000774 // Make sure the out stream file gets removed if we crash.
Daniel Dunbare326f9b2011-01-31 22:00:42 +0000775 if (RemoveFileOnSignal)
Rafael Espindola18556de2013-06-13 21:02:40 +0000776 llvm::sys::RemoveFileOnSignal(OSFile);
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000777
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000778 if (ResultPathName)
779 *ResultPathName = OutFile;
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000780 if (TempPathName)
781 *TempPathName = TempFile;
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000782
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000783 if (!Binary || OS->supportsSeeking())
784 return std::move(OS);
785
786 auto B = llvm::make_unique<llvm::buffer_ostream>(*OS);
787 assert(!NonSeekStream);
788 NonSeekStream = std::move(OS);
789 return std::move(B);
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000790}
Daniel Dunbar409e8902009-11-14 07:53:04 +0000791
792// Initialization Utilities
793
Argyrios Kyrtzidis1b3240b2012-11-09 19:40:33 +0000794bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
Nico Weber2ca4be92016-03-01 23:16:44 +0000795 return InitializeSourceManager(
796 Input, getDiagnostics(), getFileManager(), getSourceManager(),
797 hasPreprocessor() ? &getPreprocessor().getHeaderSearchInfo() : nullptr,
Nico Weber4b5aede2016-03-13 02:44:13 +0000798 getDependencyOutputOpts(), getFrontendOpts());
Daniel Dunbar409e8902009-11-14 07:53:04 +0000799}
800
Nico Weber2ca4be92016-03-01 23:16:44 +0000801// static
Nico Weber4b5aede2016-03-13 02:44:13 +0000802bool CompilerInstance::InitializeSourceManager(
803 const FrontendInputFile &Input, DiagnosticsEngine &Diags,
804 FileManager &FileMgr, SourceManager &SourceMgr, HeaderSearch *HS,
805 DependencyOutputOptions &DepOpts, const FrontendOptions &Opts) {
Argyrios Kyrtzidis1b3240b2012-11-09 19:40:33 +0000806 SrcMgr::CharacteristicKind
Argyrios Kyrtzidis873c8582012-11-09 19:40:39 +0000807 Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
Argyrios Kyrtzidis1b3240b2012-11-09 19:40:33 +0000808
Argyrios Kyrtzidis6566e232012-11-09 19:40:45 +0000809 if (Input.isBuffer()) {
David Blaikie50a5f972014-08-29 07:59:55 +0000810 SourceMgr.setMainFileID(SourceMgr.createFileID(
811 std::unique_ptr<llvm::MemoryBuffer>(Input.getBuffer()), Kind));
Yaron Keren8b563662015-10-03 10:46:20 +0000812 assert(SourceMgr.getMainFileID().isValid() &&
Argyrios Kyrtzidis6566e232012-11-09 19:40:45 +0000813 "Couldn't establish MainFileID!");
814 return true;
815 }
816
817 StringRef InputFile = Input.getFile();
818
Argyrios Kyrtzidis7c06d862011-09-19 20:40:35 +0000819 // Figure out where to get and map in the main file.
820 if (InputFile != "-") {
Nico Weber2ca4be92016-03-01 23:16:44 +0000821 const FileEntry *File;
822 if (Opts.FindPchSource.empty()) {
823 File = FileMgr.getFile(InputFile, /*OpenFile=*/true);
824 } else {
825 // When building a pch file in clang-cl mode, the .h file is built as if
826 // it was included by a cc file. Since the driver doesn't know about
827 // all include search directories, the frontend must search the input
828 // file through HeaderSearch here, as if it had been included by the
829 // cc file at Opts.FindPchSource.
830 const FileEntry *FindFile = FileMgr.getFile(Opts.FindPchSource);
831 if (!FindFile) {
832 Diags.Report(diag::err_fe_error_reading) << Opts.FindPchSource;
833 return false;
834 }
835 const DirectoryLookup *UnusedCurDir;
836 SmallVector<std::pair<const FileEntry *, const DirectoryEntry *>, 16>
837 Includers;
838 Includers.push_back(std::make_pair(FindFile, FindFile->getDir()));
839 File = HS->LookupFile(InputFile, SourceLocation(), /*isAngled=*/false,
840 /*FromDir=*/nullptr,
841 /*CurDir=*/UnusedCurDir, Includers,
842 /*SearchPath=*/nullptr,
843 /*RelativePath=*/nullptr,
844 /*RequestingModule=*/nullptr,
845 /*SuggestedModule=*/nullptr, /*SkipCache=*/true);
Nico Weber4b5aede2016-03-13 02:44:13 +0000846 // Also add the header to /showIncludes output.
847 if (File)
Nico Weberf54146c2016-03-23 18:46:57 +0000848 DepOpts.ShowIncludesPretendHeader = File->getName();
Nico Weber2ca4be92016-03-01 23:16:44 +0000849 }
Dan Gohman52765212010-10-26 21:13:51 +0000850 if (!File) {
Daniel Dunbar409e8902009-11-14 07:53:04 +0000851 Diags.Report(diag::err_fe_error_reading) << InputFile;
852 return false;
853 }
Daniel Dunbare2951f42012-11-05 22:53:33 +0000854
855 // The natural SourceManager infrastructure can't currently handle named
856 // pipes, but we would at least like to accept them for the main
Benjamin Kramer3841fa32013-08-12 13:46:52 +0000857 // file. Detect them here, read them with the volatile flag so FileMgr will
858 // pick up the correct size, and simply override their contents as we do for
859 // STDIN.
Daniel Dunbare2951f42012-11-05 22:53:33 +0000860 if (File->isNamedPipe()) {
Benjamin Kramera8857962014-10-26 22:44:13 +0000861 auto MB = FileMgr.getBufferForFile(File, /*isVolatile=*/true);
862 if (MB) {
Benjamin Kramer3841fa32013-08-12 13:46:52 +0000863 // Create a new virtual file that will have the correct size.
Benjamin Kramera8857962014-10-26 22:44:13 +0000864 File = FileMgr.getVirtualFile(InputFile, (*MB)->getBufferSize(), 0);
865 SourceMgr.overrideFileContents(File, std::move(*MB));
Benjamin Kramer3841fa32013-08-12 13:46:52 +0000866 } else {
Benjamin Kramera8857962014-10-26 22:44:13 +0000867 Diags.Report(diag::err_cannot_open_file) << InputFile
868 << MB.getError().message();
Daniel Dunbare2951f42012-11-05 22:53:33 +0000869 return false;
870 }
Daniel Dunbare2951f42012-11-05 22:53:33 +0000871 }
Daniel Dunbardb0745a2012-11-27 00:04:16 +0000872
Alp Tokerb671e342014-05-21 01:12:41 +0000873 SourceMgr.setMainFileID(
874 SourceMgr.createFileID(File, SourceLocation(), Kind));
Daniel Dunbar409e8902009-11-14 07:53:04 +0000875 } else {
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000876 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> SBOrErr =
877 llvm::MemoryBuffer::getSTDIN();
878 if (std::error_code EC = SBOrErr.getError()) {
879 Diags.Report(diag::err_fe_error_reading_stdin) << EC.message();
Daniel Dunbar409e8902009-11-14 07:53:04 +0000880 return false;
881 }
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000882 std::unique_ptr<llvm::MemoryBuffer> SB = std::move(SBOrErr.get());
883
Dan Gohman2f76cd72010-10-26 23:21:25 +0000884 const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
Chris Lattner5159f612010-11-23 08:35:12 +0000885 SB->getBufferSize(), 0);
Alp Tokerb671e342014-05-21 01:12:41 +0000886 SourceMgr.setMainFileID(
887 SourceMgr.createFileID(File, SourceLocation(), Kind));
David Blaikie49cc3182014-08-27 20:54:45 +0000888 SourceMgr.overrideFileContents(File, std::move(SB));
Daniel Dunbar409e8902009-11-14 07:53:04 +0000889 }
890
Yaron Keren8b563662015-10-03 10:46:20 +0000891 assert(SourceMgr.getMainFileID().isValid() &&
Dan Gohman52765212010-10-26 21:13:51 +0000892 "Couldn't establish MainFileID!");
Daniel Dunbar409e8902009-11-14 07:53:04 +0000893 return true;
894}
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000895
896// High-Level Operations
897
898bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
899 assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
900 assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
901 assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
902
903 // FIXME: Take this as an argument, once all the APIs we used have moved to
904 // taking it as an input instead of hard-coding llvm::errs.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000905 raw_ostream &OS = llvm::errs();
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000906
907 // Create the target instance.
Alp Toker80758082014-07-06 05:26:44 +0000908 setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(),
Saleem Abdulrasool10a49722016-04-08 16:52:00 +0000909 getInvocation().TargetOpts));
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000910 if (!hasTarget())
911 return false;
912
Artem Belevichb5bc9232015-09-22 17:23:22 +0000913 // Create TargetInfo for the other side of CUDA compilation.
914 if (getLangOpts().CUDA && !getFrontendOpts().AuxTriple.empty()) {
Justin Lebar76945b22016-04-29 23:05:19 +0000915 auto TO = std::make_shared<TargetOptions>();
Artem Belevichb5bc9232015-09-22 17:23:22 +0000916 TO->Triple = getFrontendOpts().AuxTriple;
Justin Lebar76945b22016-04-29 23:05:19 +0000917 TO->HostTriple = getTarget().getTriple().str();
Saleem Abdulrasool10a49722016-04-08 16:52:00 +0000918 setAuxTarget(TargetInfo::CreateTargetInfo(getDiagnostics(), TO));
Artem Belevichb5bc9232015-09-22 17:23:22 +0000919 }
920
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000921 // Inform the target of the language options.
922 //
923 // FIXME: We shouldn't need to do this, the target should be immutable once
924 // created. This complexity should be lifted elsewhere.
Alp Toker74437972014-07-06 05:14:24 +0000925 getTarget().adjust(getLangOpts());
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000926
Yaxun Liu2c17e822016-08-09 19:43:38 +0000927 // Adjust target options based on codegen options.
928 getTarget().adjustTargetOptions(getCodeGenOpts(), getTargetOpts());
929
Fariborz Jahanian29898f42012-04-16 21:03:30 +0000930 // rewriter project will change target built-in bool type from its default.
931 if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
932 getTarget().noSignedCharForObjCBool();
933
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000934 // Validate/process some options.
935 if (getHeaderSearchOpts().Verbose)
936 OS << "clang -cc1 version " CLANG_VERSION_STRING
Alp Tokerf988d002014-06-06 10:36:22 +0000937 << " based upon " << BACKEND_PACKAGE_STRING
Sebastian Pop8188c8a2011-11-01 21:33:06 +0000938 << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000939
940 if (getFrontendOpts().ShowTimers)
941 createFrontendTimer();
942
Matthias Braunabb6eea2016-09-26 18:53:34 +0000943 if (getFrontendOpts().ShowStats || !getFrontendOpts().StatsFile.empty())
Matthias Braunec1c5a22016-09-27 19:38:59 +0000944 llvm::EnableStatistics(false);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000945
Vedant Kumar5b60ad62015-11-16 00:59:34 +0000946 for (const FrontendInputFile &FIF : getFrontendOpts().Inputs) {
Ted Kremenekeeccb302014-08-27 15:14:15 +0000947 // Reset the ID tables if we are reusing the SourceManager and parsing
948 // regular files.
949 if (hasSourceManager() && !Act.isModelParsingAction())
Daniel Dunbaraed46fc2010-06-07 23:23:50 +0000950 getSourceManager().clearIDTables();
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000951
Vedant Kumar5b60ad62015-11-16 00:59:34 +0000952 if (Act.BeginSourceFile(*this, FIF)) {
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000953 Act.Execute();
954 Act.EndSourceFile();
955 }
956 }
957
Argyrios Kyrtzidis7910d7b2011-12-07 05:52:12 +0000958 // Notify the diagnostic client that all files were processed.
959 getDiagnostics().getClient()->finish();
960
Chris Lattner198cb4d2010-04-07 18:47:42 +0000961 if (getDiagnosticOpts().ShowCarets) {
Argyrios Kyrtzidisc79346a2010-11-18 20:06:46 +0000962 // We can have multiple diagnostics sharing one diagnostic client.
963 // Get the total number of warnings/errors from the client.
964 unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
965 unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000966
Chris Lattner198cb4d2010-04-07 18:47:42 +0000967 if (NumWarnings)
968 OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
969 if (NumWarnings && NumErrors)
970 OS << " and ";
971 if (NumErrors)
972 OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
973 if (NumWarnings || NumErrors)
974 OS << " generated.\n";
975 }
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000976
Matthias Braunabb6eea2016-09-26 18:53:34 +0000977 if (getFrontendOpts().ShowStats) {
978 if (hasFileManager()) {
979 getFileManager().PrintStats();
980 OS << '\n';
981 }
982 llvm::PrintStatistics(OS);
983 }
984 StringRef StatsFile = getFrontendOpts().StatsFile;
985 if (!StatsFile.empty()) {
986 std::error_code EC;
987 auto StatS = llvm::make_unique<llvm::raw_fd_ostream>(StatsFile, EC,
988 llvm::sys::fs::F_Text);
989 if (EC) {
990 getDiagnostics().Report(diag::warn_fe_unable_to_open_stats_file)
991 << StatsFile << EC.message();
992 } else {
993 llvm::PrintStatisticsJSON(*StatS);
994 }
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000995 }
996
Argyrios Kyrtzidisbc467932010-11-18 21:13:57 +0000997 return !getDiagnostics().getClient()->getNumErrors();
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000998}
999
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001000/// \brief Determine the appropriate source input kind based on language
1001/// options.
1002static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
1003 if (LangOpts.OpenCL)
1004 return IK_OpenCL;
1005 if (LangOpts.CUDA)
1006 return IK_CUDA;
1007 if (LangOpts.ObjC1)
1008 return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
1009 return LangOpts.CPlusPlus? IK_CXX : IK_C;
1010}
1011
Douglas Gregor514b6362011-11-29 19:06:37 +00001012/// \brief Compile a module file for the given module, using the options
Ben Langmuirb797d592014-07-19 16:29:28 +00001013/// provided by the importing compiler instance. Returns true if the module
1014/// was built without errors.
1015static bool compileModuleImpl(CompilerInstance &ImportingInstance,
1016 SourceLocation ImportLoc,
1017 Module *Module,
1018 StringRef ModuleFileName) {
Douglas Gregor514b6362011-11-29 19:06:37 +00001019 ModuleMap &ModMap
1020 = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
1021
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001022 // Construct a compiler invocation for creating this module.
David Blaikieea4395e2017-01-06 19:49:01 +00001023 auto Invocation =
1024 std::make_shared<CompilerInvocation>(ImportingInstance.getInvocation());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +00001025
Douglas Gregorf545f672011-11-29 21:59:16 +00001026 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
1027
Douglas Gregor44bf68d2011-09-15 20:53:28 +00001028 // For any options that aren't intended to affect how a module is built,
1029 // reset them to their default values.
Ted Kremenek8cf47df2011-11-17 23:01:24 +00001030 Invocation->getLangOpts()->resetNonModularOptions();
Douglas Gregorf545f672011-11-29 21:59:16 +00001031 PPOpts.resetNonModularOptions();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +00001032
Douglas Gregor5dc38992013-02-07 00:21:12 +00001033 // Remove any macro definitions that are explicitly ignored by the module.
1034 // They aren't supposed to affect how the module is built anyway.
1035 const HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00001036 PPOpts.Macros.erase(
1037 std::remove_if(PPOpts.Macros.begin(), PPOpts.Macros.end(),
1038 [&HSOpts](const std::pair<std::string, bool> &def) {
1039 StringRef MacroDef = def.first;
Justin Lebar5e83dfe2016-10-21 21:45:01 +00001040 return HSOpts.ModulesIgnoreMacros.count(
1041 llvm::CachedHashString(MacroDef.split('=').first)) > 0;
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00001042 }),
1043 PPOpts.Macros.end());
Douglas Gregor5dc38992013-02-07 00:21:12 +00001044
Douglas Gregor7d106e42011-11-15 19:35:01 +00001045 // Note the name of the module we're building.
Douglas Gregor6dc57922011-11-29 18:31:39 +00001046 Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
Douglas Gregor7d106e42011-11-15 19:35:01 +00001047
Douglas Gregor7a626572012-11-29 23:55:25 +00001048 // Make sure that the failed-module structure has been allocated in
1049 // the importing instance, and propagate the pointer to the newly-created
1050 // instance.
1051 PreprocessorOptions &ImportingPPOpts
1052 = ImportingInstance.getInvocation().getPreprocessorOpts();
1053 if (!ImportingPPOpts.FailedModules)
David Blaikief95113d2017-01-05 19:11:31 +00001054 ImportingPPOpts.FailedModules =
1055 std::make_shared<PreprocessorOptions::FailedModulesSet>();
Douglas Gregor7a626572012-11-29 23:55:25 +00001056 PPOpts.FailedModules = ImportingPPOpts.FailedModules;
1057
Douglas Gregorf545f672011-11-29 21:59:16 +00001058 // If there is a module map file, build the module using the module map.
Douglas Gregor44bf68d2011-09-15 20:53:28 +00001059 // Set up the inputs/outputs so that we build the module from its umbrella
1060 // header.
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001061 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
Douglas Gregor1735f4e2011-09-13 23:15:45 +00001062 FrontendOpts.OutputFile = ModuleFileName.str();
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001063 FrontendOpts.DisableFree = false;
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001064 FrontendOpts.GenerateGlobalModuleIndex = false;
Richard Smithe75ee0f2015-08-17 07:13:32 +00001065 FrontendOpts.BuildingImplicitModule = true;
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001066 FrontendOpts.Inputs.clear();
Douglas Gregorf545f672011-11-29 21:59:16 +00001067 InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +00001068
Douglas Gregorf545f672011-11-29 21:59:16 +00001069 // Don't free the remapped file buffers; they are owned by our caller.
1070 PPOpts.RetainRemappedFileBuffers = true;
1071
Douglas Gregor2b9b4642011-09-13 01:26:44 +00001072 Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
Douglas Gregor3728ea72011-09-13 23:20:27 +00001073 assert(ImportingInstance.getInvocation().getModuleHash() ==
Douglas Gregorf545f672011-11-29 21:59:16 +00001074 Invocation->getModuleHash() && "Module hash mismatch!");
1075
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001076 // Construct a compiler instance that will be used to actually create the
1077 // module.
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001078 CompilerInstance Instance(ImportingInstance.getPCHContainerOperations(),
1079 /*BuildingModule=*/true);
David Blaikieea4395e2017-01-06 19:49:01 +00001080 auto &Inv = *Invocation;
1081 Instance.setInvocation(std::move(Invocation));
Douglas Gregor6b930962013-05-03 22:58:43 +00001082
1083 Instance.createDiagnostics(new ForwardingDiagnosticConsumer(
1084 ImportingInstance.getDiagnosticClient()),
Douglas Gregor30071cea2013-05-03 23:07:45 +00001085 /*ShouldOwnClient=*/true);
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001086
Ben Langmuirc8130a72014-02-20 21:59:23 +00001087 Instance.setVirtualFileSystem(&ImportingInstance.getVirtualFileSystem());
1088
Douglas Gregor63365432012-11-30 22:11:57 +00001089 // Note that this module is part of the module build stack, so that we
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001090 // can detect cycles in the module graph.
Ben Langmuird066d4c2014-02-28 21:16:07 +00001091 Instance.setFileManager(&ImportingInstance.getFileManager());
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001092 Instance.createSourceManager(Instance.getFileManager());
1093 SourceManager &SourceMgr = Instance.getSourceManager();
Douglas Gregor63365432012-11-30 22:11:57 +00001094 SourceMgr.setModuleBuildStack(
1095 ImportingInstance.getSourceManager().getModuleBuildStack());
1096 SourceMgr.pushModuleBuildStack(Module->getTopLevelModuleName(),
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001097 FullSourceLoc(ImportLoc, ImportingInstance.getSourceManager()));
1098
Justin Bogner86d12592014-06-19 19:36:03 +00001099 // If we're collecting module dependencies, we need to share a collector
Richard Smith38c1e6d2015-08-09 06:03:55 +00001100 // between all of the module CompilerInstances. Other than that, we don't
1101 // want to produce any dependency output from the module build.
Justin Bogner86d12592014-06-19 19:36:03 +00001102 Instance.setModuleDepCollector(ImportingInstance.getModuleDepCollector());
David Blaikieea4395e2017-01-06 19:49:01 +00001103 Inv.getDependencyOutputOpts() = DependencyOutputOptions();
Justin Bogner86d12592014-06-19 19:36:03 +00001104
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001105 // Get or create the module map that we'll use to build this module.
1106 std::string InferredModuleMapContent;
1107 if (const FileEntry *ModuleMapFile =
1108 ModMap.getContainingModuleMapFile(Module)) {
1109 // Use the module map where this module resides.
Benjamin Kramer3204b152015-05-29 19:42:19 +00001110 FrontendOpts.Inputs.emplace_back(ModuleMapFile->getName(), IK);
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001111 } else {
Richard Smith2b63d152015-05-16 02:28:53 +00001112 SmallString<128> FakeModuleMapFile(Module->Directory->getName());
1113 llvm::sys::path::append(FakeModuleMapFile, "__inferred_module.map");
Benjamin Kramer3204b152015-05-29 19:42:19 +00001114 FrontendOpts.Inputs.emplace_back(FakeModuleMapFile, IK);
Richard Smith2b63d152015-05-16 02:28:53 +00001115
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001116 llvm::raw_string_ostream OS(InferredModuleMapContent);
1117 Module->print(OS);
1118 OS.flush();
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001119
Rafael Espindolad87f8d72014-08-27 20:03:29 +00001120 std::unique_ptr<llvm::MemoryBuffer> ModuleMapBuffer =
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001121 llvm::MemoryBuffer::getMemBuffer(InferredModuleMapContent);
1122 ModuleMapFile = Instance.getFileManager().getVirtualFile(
Richard Smith2b63d152015-05-16 02:28:53 +00001123 FakeModuleMapFile, InferredModuleMapContent.size(), 0);
David Blaikie49cc3182014-08-27 20:54:45 +00001124 SourceMgr.overrideFileContents(ModuleMapFile, std::move(ModuleMapBuffer));
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001125 }
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001126
Ben Langmuir9d6448b2014-08-09 00:57:23 +00001127 // Construct a module-generating action. Passing through the module map is
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001128 // safe because the FileManager is shared between the compiler instances.
Richard Smithbbcc9f02016-08-26 00:14:38 +00001129 GenerateModuleFromModuleMapAction CreateModuleAction(
Ben Langmuir9d6448b2014-08-09 00:57:23 +00001130 ModMap.getModuleMapFileForUniquing(Module), Module->IsSystem);
Richard Smith99891da2014-10-14 02:08:30 +00001131
1132 ImportingInstance.getDiagnostics().Report(ImportLoc,
1133 diag::remark_module_build)
1134 << Module->Name << ModuleFileName;
1135
Douglas Gregor51e0b542011-10-04 00:21:21 +00001136 // Execute the action to actually build the module in-place. Use a separate
1137 // thread so that we get a stack large enough.
1138 const unsigned ThreadStackSize = 8 << 20;
1139 llvm::CrashRecoveryContext CRC;
Richard Smith841f1c72014-03-04 21:50:01 +00001140 CRC.RunSafelyOnThread([&]() { Instance.ExecuteAction(CreateModuleAction); },
1141 ThreadStackSize);
Douglas Gregor6b930962013-05-03 22:58:43 +00001142
Richard Smith99891da2014-10-14 02:08:30 +00001143 ImportingInstance.getDiagnostics().Report(ImportLoc,
1144 diag::remark_module_build_done)
1145 << Module->Name;
1146
Douglas Gregorf545f672011-11-29 21:59:16 +00001147 // Delete the temporary module map file.
1148 // FIXME: Even though we're executing under crash protection, it would still
1149 // be nice to do this with RemoveFileOnSignal when we can. However, that
1150 // doesn't make sense for all clients, so clean this up manually.
Benjamin Kramer13afbf42012-10-14 19:50:53 +00001151 Instance.clearOutputFiles(/*EraseFiles=*/true);
Douglas Gregor5e306b12013-01-23 22:38:11 +00001152
1153 // We've rebuilt a module. If we're allowed to generate or update the global
1154 // module index, record that fact in the importing compiler instance.
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001155 if (ImportingInstance.getFrontendOpts().GenerateGlobalModuleIndex) {
Douglas Gregor5e306b12013-01-23 22:38:11 +00001156 ImportingInstance.setBuildGlobalModuleIndex(true);
1157 }
Ben Langmuirb797d592014-07-19 16:29:28 +00001158
1159 return !Instance.getDiagnostics().hasErrorOccurred();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +00001160}
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001161
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001162static bool compileAndLoadModule(CompilerInstance &ImportingInstance,
1163 SourceLocation ImportLoc,
Ben Langmuirb797d592014-07-19 16:29:28 +00001164 SourceLocation ModuleNameLoc, Module *Module,
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001165 StringRef ModuleFileName) {
Ben Langmuird213aab2014-09-26 22:42:23 +00001166 DiagnosticsEngine &Diags = ImportingInstance.getDiagnostics();
1167
Ben Langmuirb797d592014-07-19 16:29:28 +00001168 auto diagnoseBuildFailure = [&] {
Ben Langmuird213aab2014-09-26 22:42:23 +00001169 Diags.Report(ModuleNameLoc, diag::err_module_not_built)
Ben Langmuirb797d592014-07-19 16:29:28 +00001170 << Module->Name << SourceRange(ImportLoc, ModuleNameLoc);
1171 };
1172
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001173 // FIXME: have LockFileManager return an error_code so that we can
1174 // avoid the mkdir when the directory already exists.
1175 StringRef Dir = llvm::sys::path::parent_path(ModuleFileName);
1176 llvm::sys::fs::create_directories(Dir);
1177
1178 while (1) {
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001179 unsigned ModuleLoadCapabilities = ASTReader::ARR_Missing;
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001180 llvm::LockFileManager Locked(ModuleFileName);
1181 switch (Locked) {
1182 case llvm::LockFileManager::LFS_Error:
Ben Langmuird213aab2014-09-26 22:42:23 +00001183 Diags.Report(ModuleNameLoc, diag::err_module_lock_failure)
Bruno Cardoso Lopes4a522222016-06-04 01:13:22 +00001184 << Module->Name << Locked.getErrorMessage();
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001185 return false;
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001186
1187 case llvm::LockFileManager::LFS_Owned:
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001188 // We're responsible for building the module ourselves.
Ben Langmuirb797d592014-07-19 16:29:28 +00001189 if (!compileModuleImpl(ImportingInstance, ModuleNameLoc, Module,
1190 ModuleFileName)) {
1191 diagnoseBuildFailure();
1192 return false;
1193 }
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001194 break;
1195
1196 case llvm::LockFileManager::LFS_Shared:
1197 // Someone else is responsible for building the module. Wait for them to
1198 // finish.
Ben Langmuir1daf4802015-02-09 20:35:13 +00001199 switch (Locked.waitForUnlock()) {
1200 case llvm::LockFileManager::Res_Success:
1201 ModuleLoadCapabilities |= ASTReader::ARR_OutOfDate;
1202 break;
1203 case llvm::LockFileManager::Res_OwnerDied:
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001204 continue; // try again to get the lock.
Ben Langmuir1daf4802015-02-09 20:35:13 +00001205 case llvm::LockFileManager::Res_Timeout:
1206 Diags.Report(ModuleNameLoc, diag::err_module_lock_timeout)
1207 << Module->Name;
1208 // Clear the lock file so that future invokations can make progress.
1209 Locked.unsafeRemoveLockFile();
1210 return false;
1211 }
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001212 break;
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001213 }
1214
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001215 // Try to read the module file, now that we've compiled it.
1216 ASTReader::ASTReadResult ReadResult =
1217 ImportingInstance.getModuleManager()->ReadAST(
Richard Smithe842a472014-10-22 02:05:46 +00001218 ModuleFileName, serialization::MK_ImplicitModule, ImportLoc,
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001219 ModuleLoadCapabilities);
1220
1221 if (ReadResult == ASTReader::OutOfDate &&
1222 Locked == llvm::LockFileManager::LFS_Shared) {
1223 // The module may be out of date in the presence of file system races,
1224 // or if one of its imports depends on header search paths that are not
1225 // consistent with this ImportingInstance. Try again...
1226 continue;
1227 } else if (ReadResult == ASTReader::Missing) {
Ben Langmuirb797d592014-07-19 16:29:28 +00001228 diagnoseBuildFailure();
Ben Langmuird213aab2014-09-26 22:42:23 +00001229 } else if (ReadResult != ASTReader::Success &&
1230 !Diags.hasErrorOccurred()) {
1231 // The ASTReader didn't diagnose the error, so conservatively report it.
1232 diagnoseBuildFailure();
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001233 }
1234 return ReadResult == ASTReader::Success;
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001235 }
1236}
1237
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001238/// \brief Diagnose differences between the current definition of the given
1239/// configuration macro and the definition provided on the command line.
1240static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
1241 Module *Mod, SourceLocation ImportLoc) {
1242 IdentifierInfo *Id = PP.getIdentifierInfo(ConfigMacro);
1243 SourceManager &SourceMgr = PP.getSourceManager();
1244
1245 // If this identifier has never had a macro definition, then it could
1246 // not have changed.
1247 if (!Id->hadMacroDefinition())
1248 return;
Richard Smith20e883e2015-04-29 23:20:19 +00001249 auto *LatestLocalMD = PP.getLocalMacroDirectiveHistory(Id);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001250
Richard Smith20e883e2015-04-29 23:20:19 +00001251 // Find the macro definition from the command line.
1252 MacroInfo *CmdLineDefinition = nullptr;
1253 for (auto *MD = LatestLocalMD; MD; MD = MD->getPrevious()) {
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001254 // We only care about the predefines buffer.
Richard Smith20e883e2015-04-29 23:20:19 +00001255 FileID FID = SourceMgr.getFileID(MD->getLocation());
1256 if (FID.isInvalid() || FID != PP.getPredefinesFileID())
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001257 continue;
Richard Smith20e883e2015-04-29 23:20:19 +00001258 if (auto *DMD = dyn_cast<DefMacroDirective>(MD))
1259 CmdLineDefinition = DMD->getMacroInfo();
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001260 break;
1261 }
1262
Richard Smith20e883e2015-04-29 23:20:19 +00001263 auto *CurrentDefinition = PP.getMacroInfo(Id);
1264 if (CurrentDefinition == CmdLineDefinition) {
1265 // Macro matches. Nothing to do.
1266 } else if (!CurrentDefinition) {
1267 // This macro was defined on the command line, then #undef'd later.
1268 // Complain.
1269 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1270 << true << ConfigMacro << Mod->getFullModuleName();
1271 auto LatestDef = LatestLocalMD->getDefinition();
1272 assert(LatestDef.isUndefined() &&
1273 "predefined macro went away with no #undef?");
1274 PP.Diag(LatestDef.getUndefLocation(), diag::note_module_def_undef_here)
1275 << true;
1276 return;
1277 } else if (!CmdLineDefinition) {
1278 // There was no definition for this macro in the predefines buffer,
1279 // but there was a local definition. Complain.
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001280 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1281 << false << ConfigMacro << Mod->getFullModuleName();
Richard Smith20e883e2015-04-29 23:20:19 +00001282 PP.Diag(CurrentDefinition->getDefinitionLoc(),
1283 diag::note_module_def_undef_here)
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001284 << false;
Richard Smith20e883e2015-04-29 23:20:19 +00001285 } else if (!CurrentDefinition->isIdenticalTo(*CmdLineDefinition, PP,
1286 /*Syntactically=*/true)) {
1287 // The macro definitions differ.
1288 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1289 << false << ConfigMacro << Mod->getFullModuleName();
1290 PP.Diag(CurrentDefinition->getDefinitionLoc(),
1291 diag::note_module_def_undef_here)
1292 << false;
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001293 }
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001294}
1295
Douglas Gregor527b1c92013-03-25 21:19:16 +00001296/// \brief Write a new timestamp file with the given path.
1297static void writeTimestampFile(StringRef TimestampFile) {
Rafael Espindoladae941a2014-08-25 18:17:04 +00001298 std::error_code EC;
1299 llvm::raw_fd_ostream Out(TimestampFile.str(), EC, llvm::sys::fs::F_None);
Douglas Gregor527b1c92013-03-25 21:19:16 +00001300}
1301
1302/// \brief Prune the module cache of modules that haven't been accessed in
1303/// a long time.
1304static void pruneModuleCache(const HeaderSearchOptions &HSOpts) {
1305 struct stat StatBuf;
1306 llvm::SmallString<128> TimestampFile;
1307 TimestampFile = HSOpts.ModuleCachePath;
Richard Smith3938f0c2015-08-15 00:34:15 +00001308 assert(!TimestampFile.empty());
Douglas Gregor527b1c92013-03-25 21:19:16 +00001309 llvm::sys::path::append(TimestampFile, "modules.timestamp");
1310
1311 // Try to stat() the timestamp file.
1312 if (::stat(TimestampFile.c_str(), &StatBuf)) {
1313 // If the timestamp file wasn't there, create one now.
1314 if (errno == ENOENT) {
1315 writeTimestampFile(TimestampFile);
1316 }
1317 return;
1318 }
1319
1320 // Check whether the time stamp is older than our pruning interval.
1321 // If not, do nothing.
1322 time_t TimeStampModTime = StatBuf.st_mtime;
Craig Topper49a27902014-05-22 04:46:25 +00001323 time_t CurrentTime = time(nullptr);
Benjamin Kramerdbcf5032013-03-29 17:39:43 +00001324 if (CurrentTime - TimeStampModTime <= time_t(HSOpts.ModuleCachePruneInterval))
Douglas Gregor527b1c92013-03-25 21:19:16 +00001325 return;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001326
1327 // Write a new timestamp file so that nobody else attempts to prune.
1328 // There is a benign race condition here, if two Clang instances happen to
1329 // notice at the same time that the timestamp is out-of-date.
1330 writeTimestampFile(TimestampFile);
1331
1332 // Walk the entire module cache, looking for unused module files and module
1333 // indices.
Rafael Espindolac0809172014-06-12 14:02:15 +00001334 std::error_code EC;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001335 SmallString<128> ModuleCachePathNative;
1336 llvm::sys::path::native(HSOpts.ModuleCachePath, ModuleCachePathNative);
Yaron Keren92e1b622015-03-18 10:17:07 +00001337 for (llvm::sys::fs::directory_iterator Dir(ModuleCachePathNative, EC), DirEnd;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001338 Dir != DirEnd && !EC; Dir.increment(EC)) {
1339 // If we don't have a directory, there's nothing to look into.
Rafael Espindolaa07f7202013-07-17 04:23:07 +00001340 if (!llvm::sys::fs::is_directory(Dir->path()))
Douglas Gregor527b1c92013-03-25 21:19:16 +00001341 continue;
1342
1343 // Walk all of the files within this directory.
Douglas Gregor527b1c92013-03-25 21:19:16 +00001344 for (llvm::sys::fs::directory_iterator File(Dir->path(), EC), FileEnd;
1345 File != FileEnd && !EC; File.increment(EC)) {
1346 // We only care about module and global module index files.
Dmitri Gribenkof430da42014-02-12 10:33:14 +00001347 StringRef Extension = llvm::sys::path::extension(File->path());
1348 if (Extension != ".pcm" && Extension != ".timestamp" &&
1349 llvm::sys::path::filename(File->path()) != "modules.idx")
Douglas Gregor527b1c92013-03-25 21:19:16 +00001350 continue;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001351
1352 // Look at this file. If we can't stat it, there's nothing interesting
1353 // there.
Dmitri Gribenkof430da42014-02-12 10:33:14 +00001354 if (::stat(File->path().c_str(), &StatBuf))
Douglas Gregor527b1c92013-03-25 21:19:16 +00001355 continue;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001356
1357 // If the file has been used recently enough, leave it there.
1358 time_t FileAccessTime = StatBuf.st_atime;
Benjamin Kramerdbcf5032013-03-29 17:39:43 +00001359 if (CurrentTime - FileAccessTime <=
1360 time_t(HSOpts.ModuleCachePruneAfter)) {
Douglas Gregor527b1c92013-03-25 21:19:16 +00001361 continue;
1362 }
1363
1364 // Remove the file.
Dmitri Gribenkof430da42014-02-12 10:33:14 +00001365 llvm::sys::fs::remove(File->path());
1366
1367 // Remove the timestamp file.
1368 std::string TimpestampFilename = File->path() + ".timestamp";
1369 llvm::sys::fs::remove(TimpestampFilename);
Douglas Gregor527b1c92013-03-25 21:19:16 +00001370 }
1371
1372 // If we removed all of the files in the directory, remove the directory
1373 // itself.
Dmitri Gribenkof430da42014-02-12 10:33:14 +00001374 if (llvm::sys::fs::directory_iterator(Dir->path(), EC) ==
1375 llvm::sys::fs::directory_iterator() && !EC)
Rafael Espindola2a008782014-01-10 21:32:14 +00001376 llvm::sys::fs::remove(Dir->path());
Douglas Gregor527b1c92013-03-25 21:19:16 +00001377 }
1378}
1379
John Thompson2255f2c2014-04-23 12:57:01 +00001380void CompilerInstance::createModuleManager() {
1381 if (!ModuleManager) {
1382 if (!hasASTContext())
1383 createASTContext();
1384
Chandler Carruth580dd292015-03-24 21:44:25 +00001385 // If we're implicitly building modules but not currently recursively
1386 // building a module, check whether we need to prune the module cache.
Richard Smith3938f0c2015-08-15 00:34:15 +00001387 if (getSourceManager().getModuleBuildStack().empty() &&
1388 !getPreprocessor().getHeaderSearchInfo().getModuleCachePath().empty() &&
John Thompson2255f2c2014-04-23 12:57:01 +00001389 getHeaderSearchOpts().ModuleCachePruneInterval > 0 &&
1390 getHeaderSearchOpts().ModuleCachePruneAfter > 0) {
1391 pruneModuleCache(getHeaderSearchOpts());
1392 }
1393
1394 HeaderSearchOptions &HSOpts = getHeaderSearchOpts();
1395 std::string Sysroot = HSOpts.Sysroot;
1396 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
Richard Smithce18a182015-07-14 00:26:00 +00001397 std::unique_ptr<llvm::Timer> ReadTimer;
1398 if (FrontendTimerGroup)
Matthias Braunae032b62016-11-18 19:43:25 +00001399 ReadTimer = llvm::make_unique<llvm::Timer>("reading_modules",
1400 "Reading modules",
Richard Smithce18a182015-07-14 00:26:00 +00001401 *FrontendTimerGroup);
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001402 ModuleManager = new ASTReader(
Richard Smith293534b2015-08-18 20:39:29 +00001403 getPreprocessor(), getASTContext(), getPCHContainerReader(),
Douglas Gregor6623e1f2015-11-03 18:33:07 +00001404 getFrontendOpts().ModuleFileExtensions,
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001405 Sysroot.empty() ? "" : Sysroot.c_str(), PPOpts.DisablePCHValidation,
1406 /*AllowASTWithCompilerErrors=*/false,
1407 /*AllowConfigurationMismatch=*/false,
1408 HSOpts.ModulesValidateSystemHeaders,
Richard Smithce18a182015-07-14 00:26:00 +00001409 getFrontendOpts().UseGlobalModuleIndex,
1410 std::move(ReadTimer));
John Thompson2255f2c2014-04-23 12:57:01 +00001411 if (hasASTConsumer()) {
1412 ModuleManager->setDeserializationListener(
1413 getASTConsumer().GetASTDeserializationListener());
1414 getASTContext().setASTMutationListener(
1415 getASTConsumer().GetASTMutationListener());
1416 }
1417 getASTContext().setExternalSource(ModuleManager);
1418 if (hasSema())
1419 ModuleManager->InitializeSema(getSema());
Richard Smith293534b2015-08-18 20:39:29 +00001420 if (hasASTConsumer())
John Thompson2255f2c2014-04-23 12:57:01 +00001421 ModuleManager->StartTranslationUnit(&getASTConsumer());
Richard Smith03f7e612015-08-09 02:28:42 +00001422
1423 if (TheDependencyFileGenerator)
1424 TheDependencyFileGenerator->AttachToASTReader(*ModuleManager);
Richard Smith03f7e612015-08-09 02:28:42 +00001425 for (auto &Listener : DependencyCollectors)
1426 Listener->attachToASTReader(*ModuleManager);
John Thompson2255f2c2014-04-23 12:57:01 +00001427 }
1428}
1429
Richard Smithd4b230b2014-10-27 23:01:16 +00001430bool CompilerInstance::loadModuleFile(StringRef FileName) {
Richard Smithce18a182015-07-14 00:26:00 +00001431 llvm::Timer Timer;
1432 if (FrontendTimerGroup)
Matthias Braunae032b62016-11-18 19:43:25 +00001433 Timer.init("preloading." + FileName.str(), "Preloading " + FileName.str(),
1434 *FrontendTimerGroup);
Richard Smithce18a182015-07-14 00:26:00 +00001435 llvm::TimeRegion TimeLoading(FrontendTimerGroup ? &Timer : nullptr);
1436
Richard Smithd4b230b2014-10-27 23:01:16 +00001437 // Helper to recursively read the module names for all modules we're adding.
1438 // We mark these as known and redirect any attempt to load that module to
1439 // the files we were handed.
1440 struct ReadModuleNames : ASTReaderListener {
1441 CompilerInstance &CI;
Richard Smith0f99d6a2015-08-09 08:48:41 +00001442 llvm::SmallVector<IdentifierInfo*, 8> LoadedModules;
Richard Smithe842a472014-10-22 02:05:46 +00001443
Richard Smith0f99d6a2015-08-09 08:48:41 +00001444 ReadModuleNames(CompilerInstance &CI) : CI(CI) {}
Richard Smithe842a472014-10-22 02:05:46 +00001445
Richard Smithd4b230b2014-10-27 23:01:16 +00001446 void ReadModuleName(StringRef ModuleName) override {
Richard Smith0f99d6a2015-08-09 08:48:41 +00001447 LoadedModules.push_back(
1448 CI.getPreprocessor().getIdentifierInfo(ModuleName));
Richard Smithd4b230b2014-10-27 23:01:16 +00001449 }
Richard Smith0f99d6a2015-08-09 08:48:41 +00001450
1451 void registerAll() {
1452 for (auto *II : LoadedModules) {
1453 CI.KnownModules[II] = CI.getPreprocessor()
1454 .getHeaderSearchInfo()
1455 .getModuleMap()
1456 .findModule(II->getName());
1457 }
1458 LoadedModules.clear();
1459 }
Richard Smith8a308ec2015-11-05 00:54:55 +00001460
1461 void markAllUnavailable() {
1462 for (auto *II : LoadedModules) {
1463 if (Module *M = CI.getPreprocessor()
1464 .getHeaderSearchInfo()
1465 .getModuleMap()
Richard Smitha114c462016-12-06 00:40:17 +00001466 .findModule(II->getName())) {
Richard Smith8a308ec2015-11-05 00:54:55 +00001467 M->HasIncompatibleModuleFile = true;
Richard Smitha114c462016-12-06 00:40:17 +00001468
1469 // Mark module as available if the only reason it was unavailable
1470 // was missing headers.
1471 SmallVector<Module *, 2> Stack;
1472 Stack.push_back(M);
1473 while (!Stack.empty()) {
1474 Module *Current = Stack.pop_back_val();
1475 if (Current->IsMissingRequirement) continue;
1476 Current->IsAvailable = true;
1477 Stack.insert(Stack.end(),
1478 Current->submodule_begin(), Current->submodule_end());
1479 }
1480 }
Richard Smith8a308ec2015-11-05 00:54:55 +00001481 }
1482 LoadedModules.clear();
1483 }
Richard Smith0f99d6a2015-08-09 08:48:41 +00001484 };
Richard Smithd4b230b2014-10-27 23:01:16 +00001485
Richard Smith7f330cd2015-03-18 01:42:29 +00001486 // If we don't already have an ASTReader, create one now.
1487 if (!ModuleManager)
1488 createModuleManager();
1489
Richard Smith0f99d6a2015-08-09 08:48:41 +00001490 auto Listener = llvm::make_unique<ReadModuleNames>(*this);
1491 auto &ListenerRef = *Listener;
1492 ASTReader::ListenerScope ReadModuleNamesListener(*ModuleManager,
1493 std::move(Listener));
Richard Smith7f330cd2015-03-18 01:42:29 +00001494
Richard Smith0f99d6a2015-08-09 08:48:41 +00001495 // Try to load the module file.
Richard Smith95dc57a2015-10-16 23:20:19 +00001496 switch (ModuleManager->ReadAST(FileName, serialization::MK_ExplicitModule,
1497 SourceLocation(),
1498 ASTReader::ARR_ConfigurationMismatch)) {
1499 case ASTReader::Success:
Richard Smith8a308ec2015-11-05 00:54:55 +00001500 // We successfully loaded the module file; remember the set of provided
1501 // modules so that we don't try to load implicit modules for them.
1502 ListenerRef.registerAll();
1503 return true;
Richard Smith95dc57a2015-10-16 23:20:19 +00001504
1505 case ASTReader::ConfigurationMismatch:
1506 // Ignore unusable module files.
1507 getDiagnostics().Report(SourceLocation(), diag::warn_module_config_mismatch)
1508 << FileName;
Richard Smith8a308ec2015-11-05 00:54:55 +00001509 // All modules provided by any files we tried and failed to load are now
1510 // unavailable; includes of those modules should now be handled textually.
1511 ListenerRef.markAllUnavailable();
Richard Smith95dc57a2015-10-16 23:20:19 +00001512 return true;
1513
1514 default:
1515 return false;
1516 }
Richard Smithe842a472014-10-22 02:05:46 +00001517}
1518
1519ModuleLoadResult
Douglas Gregor7a626572012-11-29 23:55:25 +00001520CompilerInstance::loadModule(SourceLocation ImportLoc,
1521 ModuleIdPath Path,
1522 Module::NameVisibilityKind Visibility,
1523 bool IsInclusionDirective) {
Richard Smith92304e02013-10-18 22:48:20 +00001524 // Determine what file we're searching from.
1525 StringRef ModuleName = Path[0].first->getName();
1526 SourceLocation ModuleNameLoc = Path[0].second;
1527
Douglas Gregor1805b8a2011-11-30 04:26:53 +00001528 // If we've already handled this import, just return the cached result.
1529 // This one-element cache is important to eliminate redundant diagnostics
1530 // when both the preprocessor and parser see the same import declaration.
Yaron Keren8b563662015-10-03 10:46:20 +00001531 if (ImportLoc.isValid() && LastModuleImportLoc == ImportLoc) {
Douglas Gregorff2be532011-12-01 17:11:21 +00001532 // Make the named module visible.
Richard Smith7e82e012016-02-19 22:25:36 +00001533 if (LastModuleImportResult && ModuleName != getLangOpts().CurrentModule)
Argyrios Kyrtzidis125df052013-02-01 16:36:12 +00001534 ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility,
Richard Smitha7e2cc62015-05-01 01:53:09 +00001535 ImportLoc);
Douglas Gregor69021972011-11-30 17:33:56 +00001536 return LastModuleImportResult;
Douglas Gregorff2be532011-12-01 17:11:21 +00001537 }
Douglas Gregor5196bc62011-11-30 04:03:44 +00001538
Craig Topper49a27902014-05-22 04:46:25 +00001539 clang::Module *Module = nullptr;
Richard Smith92304e02013-10-18 22:48:20 +00001540
Douglas Gregor5196bc62011-11-30 04:03:44 +00001541 // If we don't already have information on this module, load the module now.
Douglas Gregorde3ef502011-11-30 23:21:26 +00001542 llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
Douglas Gregor69021972011-11-30 17:33:56 +00001543 = KnownModules.find(Path[0].first);
Douglas Gregor2537a362011-12-08 17:01:29 +00001544 if (Known != KnownModules.end()) {
1545 // Retrieve the cached top-level module.
1546 Module = Known->second;
Richard Smith7e82e012016-02-19 22:25:36 +00001547 } else if (ModuleName == getLangOpts().CurrentModule) {
Douglas Gregor2537a362011-12-08 17:01:29 +00001548 // This is the module we're building.
Ben Langmuir527040e2014-05-05 05:31:33 +00001549 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
Douglas Gregor2537a362011-12-08 17:01:29 +00001550 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1551 } else {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001552 // Search for a module with the given name.
Douglas Gregor279a6c32012-01-29 17:08:11 +00001553 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
Manman Ren11f2a472016-08-18 17:42:15 +00001554 HeaderSearchOptions &HSOpts =
1555 PP->getHeaderSearchInfo().getHeaderSearchOpts();
1556
1557 std::string ModuleFileName;
1558 bool LoadFromPrebuiltModulePath = false;
1559 // We try to load the module from the prebuilt module paths. If not
1560 // successful, we then try to find it in the module cache.
1561 if (!HSOpts.PrebuiltModulePaths.empty()) {
1562 // Load the module from the prebuilt module path.
1563 ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(
1564 ModuleName, "", /*UsePrebuiltPath*/ true);
1565 if (!ModuleFileName.empty())
1566 LoadFromPrebuiltModulePath = true;
1567 }
1568 if (!LoadFromPrebuiltModulePath && Module) {
1569 // Load the module from the module cache.
1570 ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(Module);
1571 } else if (!LoadFromPrebuiltModulePath) {
1572 // We can't find a module, error out here.
Ben Langmuir9eb229b2014-01-22 23:19:39 +00001573 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1574 << ModuleName
1575 << SourceRange(ImportLoc, ModuleNameLoc);
1576 ModuleBuildFailed = true;
1577 return ModuleLoadResult();
1578 }
1579
Richard Smithd520a252015-07-21 18:07:47 +00001580 if (ModuleFileName.empty()) {
Manman Ren11f2a472016-08-18 17:42:15 +00001581 if (Module && Module->HasIncompatibleModuleFile) {
Richard Smith8a308ec2015-11-05 00:54:55 +00001582 // We tried and failed to load a module file for this module. Fall
1583 // back to textual inclusion for its headers.
Richard Smitha114c462016-12-06 00:40:17 +00001584 return ModuleLoadResult::ConfigMismatch;
Richard Smith8a308ec2015-11-05 00:54:55 +00001585 }
1586
Manuel Klimekd2e8b042015-02-20 11:44:41 +00001587 getDiagnostics().Report(ModuleNameLoc, diag::err_module_build_disabled)
1588 << ModuleName;
1589 ModuleBuildFailed = true;
1590 return ModuleLoadResult();
1591 }
Richard Smithd4b230b2014-10-27 23:01:16 +00001592
Douglas Gregor5196bc62011-11-30 04:03:44 +00001593 // If we don't already have an ASTReader, create one now.
John Thompson2255f2c2014-04-23 12:57:01 +00001594 if (!ModuleManager)
1595 createModuleManager();
Douglas Gregor5196bc62011-11-30 04:03:44 +00001596
Richard Smithce18a182015-07-14 00:26:00 +00001597 llvm::Timer Timer;
1598 if (FrontendTimerGroup)
Matthias Braunae032b62016-11-18 19:43:25 +00001599 Timer.init("loading." + ModuleFileName, "Loading " + ModuleFileName,
1600 *FrontendTimerGroup);
Richard Smithce18a182015-07-14 00:26:00 +00001601 llvm::TimeRegion TimeLoading(FrontendTimerGroup ? &Timer : nullptr);
1602
Manman Ren11f2a472016-08-18 17:42:15 +00001603 // Try to load the module file. If we are trying to load from the prebuilt
1604 // module path, we don't have the module map files and don't know how to
1605 // rebuild modules.
1606 unsigned ARRFlags = LoadFromPrebuiltModulePath ?
1607 ASTReader::ARR_ConfigurationMismatch :
1608 ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing;
Richard Smithe842a472014-10-22 02:05:46 +00001609 switch (ModuleManager->ReadAST(ModuleFileName,
Manman Ren11f2a472016-08-18 17:42:15 +00001610 LoadFromPrebuiltModulePath ?
1611 serialization::MK_PrebuiltModule :
Richard Smith86cc8292015-08-09 08:58:36 +00001612 serialization::MK_ImplicitModule,
Manman Ren11f2a472016-08-18 17:42:15 +00001613 ImportLoc,
1614 ARRFlags)) {
1615 case ASTReader::Success: {
1616 if (LoadFromPrebuiltModulePath && !Module) {
1617 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1618 if (!Module || !Module->getASTFile() ||
1619 FileMgr->getFile(ModuleFileName) != Module->getASTFile()) {
1620 // Error out if Module does not refer to the file in the prebuilt
1621 // module path.
1622 getDiagnostics().Report(ModuleNameLoc, diag::err_module_prebuilt)
1623 << ModuleName;
1624 ModuleBuildFailed = true;
1625 KnownModules[Path[0].first] = nullptr;
1626 return ModuleLoadResult();
1627 }
1628 }
Douglas Gregor5196bc62011-11-30 04:03:44 +00001629 break;
Manman Ren11f2a472016-08-18 17:42:15 +00001630 }
Douglas Gregor5196bc62011-11-30 04:03:44 +00001631
Eli Friedman963ff2c2013-09-17 00:51:29 +00001632 case ASTReader::OutOfDate:
Douglas Gregor7029ce12013-03-19 00:28:20 +00001633 case ASTReader::Missing: {
Manman Ren11f2a472016-08-18 17:42:15 +00001634 if (LoadFromPrebuiltModulePath) {
1635 // We can't rebuild the module without a module map. Since ReadAST
1636 // already produces diagnostics for these two cases, we simply
1637 // error out here.
1638 ModuleBuildFailed = true;
1639 KnownModules[Path[0].first] = nullptr;
1640 return ModuleLoadResult();
1641 }
1642
Eli Friedman963ff2c2013-09-17 00:51:29 +00001643 // The module file is missing or out-of-date. Build it.
Ben Langmuir9eb229b2014-01-22 23:19:39 +00001644 assert(Module && "missing module file");
Douglas Gregor7029ce12013-03-19 00:28:20 +00001645 // Check whether there is a cycle in the module graph.
1646 ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
1647 ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1648 for (; Pos != PosEnd; ++Pos) {
1649 if (Pos->first == ModuleName)
1650 break;
1651 }
1652
1653 if (Pos != PosEnd) {
1654 SmallString<256> CyclePath;
1655 for (; Pos != PosEnd; ++Pos) {
1656 CyclePath += Pos->first;
1657 CyclePath += " -> ";
1658 }
1659 CyclePath += ModuleName;
1660
1661 getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
1662 << ModuleName << CyclePath;
1663 return ModuleLoadResult();
1664 }
Douglas Gregor7a626572012-11-29 23:55:25 +00001665
1666 // Check whether we have already attempted to build this module (but
1667 // failed).
1668 if (getPreprocessorOpts().FailedModules &&
1669 getPreprocessorOpts().FailedModules->hasAlreadyFailed(ModuleName)) {
1670 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_built)
1671 << ModuleName
1672 << SourceRange(ImportLoc, ModuleNameLoc);
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001673 ModuleBuildFailed = true;
Douglas Gregor7a626572012-11-29 23:55:25 +00001674 return ModuleLoadResult();
1675 }
1676
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001677 // Try to compile and then load the module.
1678 if (!compileAndLoadModule(*this, ImportLoc, ModuleNameLoc, Module,
1679 ModuleFileName)) {
Ben Langmuird213aab2014-09-26 22:42:23 +00001680 assert(getDiagnostics().hasErrorOccurred() &&
1681 "undiagnosed error in compileAndLoadModule");
Douglas Gregor0f2b4632013-01-10 02:04:18 +00001682 if (getPreprocessorOpts().FailedModules)
1683 getPreprocessorOpts().FailedModules->addFailed(ModuleName);
Craig Topper49a27902014-05-22 04:46:25 +00001684 KnownModules[Path[0].first] = nullptr;
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001685 ModuleBuildFailed = true;
Douglas Gregor7a626572012-11-29 23:55:25 +00001686 return ModuleLoadResult();
Douglas Gregor188dbef2012-11-07 17:46:15 +00001687 }
1688
1689 // Okay, we've rebuilt and now loaded the module.
1690 break;
1691 }
1692
Douglas Gregorc9ad5fb2012-10-22 22:50:17 +00001693 case ASTReader::ConfigurationMismatch:
Manman Ren11f2a472016-08-18 17:42:15 +00001694 if (LoadFromPrebuiltModulePath)
1695 getDiagnostics().Report(SourceLocation(),
1696 diag::warn_module_config_mismatch)
1697 << ModuleFileName;
1698 // Fall through to error out.
1699 case ASTReader::VersionMismatch:
Douglas Gregorc9ad5fb2012-10-22 22:50:17 +00001700 case ASTReader::HadErrors:
Argyrios Kyrtzidisdc9fdaf2013-05-24 05:44:08 +00001701 ModuleLoader::HadFatalFailure = true;
Richard Smith0f99d6a2015-08-09 08:48:41 +00001702 // FIXME: The ASTReader will already have complained, but can we shoehorn
Douglas Gregor5196bc62011-11-30 04:03:44 +00001703 // that diagnostic information into a more useful form?
Craig Topper49a27902014-05-22 04:46:25 +00001704 KnownModules[Path[0].first] = nullptr;
Douglas Gregor7a626572012-11-29 23:55:25 +00001705 return ModuleLoadResult();
Douglas Gregor5196bc62011-11-30 04:03:44 +00001706
1707 case ASTReader::Failure:
Argyrios Kyrtzidisdc9fdaf2013-05-24 05:44:08 +00001708 ModuleLoader::HadFatalFailure = true;
Douglas Gregor69021972011-11-30 17:33:56 +00001709 // Already complained, but note now that we failed.
Craig Topper49a27902014-05-22 04:46:25 +00001710 KnownModules[Path[0].first] = nullptr;
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001711 ModuleBuildFailed = true;
Douglas Gregor7a626572012-11-29 23:55:25 +00001712 return ModuleLoadResult();
Douglas Gregor5196bc62011-11-30 04:03:44 +00001713 }
Argyrios Kyrtzidis43af5132012-09-29 01:06:04 +00001714
Douglas Gregor69021972011-11-30 17:33:56 +00001715 // Cache the result of this top-level module lookup for later.
1716 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
Douglas Gregor08142532011-08-26 23:56:07 +00001717 }
Douglas Gregor5196bc62011-11-30 04:03:44 +00001718
Douglas Gregor69021972011-11-30 17:33:56 +00001719 // If we never found the module, fail.
1720 if (!Module)
Douglas Gregor7a626572012-11-29 23:55:25 +00001721 return ModuleLoadResult();
Douglas Gregor69021972011-11-30 17:33:56 +00001722
Douglas Gregor5196bc62011-11-30 04:03:44 +00001723 // Verify that the rest of the module path actually corresponds to
1724 // a submodule.
Douglas Gregor69021972011-11-30 17:33:56 +00001725 if (Path.size() > 1) {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001726 for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1727 StringRef Name = Path[I].first->getName();
Douglas Gregoreb90e832012-01-04 23:32:19 +00001728 clang::Module *Sub = Module->findSubmodule(Name);
Douglas Gregor5196bc62011-11-30 04:03:44 +00001729
Douglas Gregoreb90e832012-01-04 23:32:19 +00001730 if (!Sub) {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001731 // Attempt to perform typo correction to find a module name that works.
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001732 SmallVector<StringRef, 2> Best;
Douglas Gregor5196bc62011-11-30 04:03:44 +00001733 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1734
Douglas Gregoreb90e832012-01-04 23:32:19 +00001735 for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1736 JEnd = Module->submodule_end();
Matt Beaumont-Gayeb44eda2011-11-30 19:41:21 +00001737 J != JEnd; ++J) {
Douglas Gregoreb90e832012-01-04 23:32:19 +00001738 unsigned ED = Name.edit_distance((*J)->Name,
Douglas Gregor5196bc62011-11-30 04:03:44 +00001739 /*AllowReplacements=*/true,
1740 BestEditDistance);
1741 if (ED <= BestEditDistance) {
Douglas Gregoreb90e832012-01-04 23:32:19 +00001742 if (ED < BestEditDistance) {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001743 Best.clear();
Douglas Gregoreb90e832012-01-04 23:32:19 +00001744 BestEditDistance = ED;
1745 }
1746
1747 Best.push_back((*J)->Name);
Douglas Gregor5196bc62011-11-30 04:03:44 +00001748 }
1749 }
1750
1751 // If there was a clear winner, user it.
1752 if (Best.size() == 1) {
1753 getDiagnostics().Report(Path[I].second,
1754 diag::err_no_submodule_suggest)
Douglas Gregor69021972011-11-30 17:33:56 +00001755 << Path[I].first << Module->getFullModuleName() << Best[0]
Douglas Gregor5196bc62011-11-30 04:03:44 +00001756 << SourceRange(Path[0].second, Path[I-1].second)
1757 << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1758 Best[0]);
Douglas Gregoreb90e832012-01-04 23:32:19 +00001759
1760 Sub = Module->findSubmodule(Best[0]);
Douglas Gregor5196bc62011-11-30 04:03:44 +00001761 }
1762 }
1763
Douglas Gregoreb90e832012-01-04 23:32:19 +00001764 if (!Sub) {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001765 // No submodule by this name. Complain, and don't look for further
1766 // submodules.
1767 getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
Douglas Gregor69021972011-11-30 17:33:56 +00001768 << Path[I].first << Module->getFullModuleName()
Douglas Gregor5196bc62011-11-30 04:03:44 +00001769 << SourceRange(Path[0].second, Path[I-1].second);
1770 break;
1771 }
1772
Douglas Gregoreb90e832012-01-04 23:32:19 +00001773 Module = Sub;
Douglas Gregor5196bc62011-11-30 04:03:44 +00001774 }
Douglas Gregor08142532011-08-26 23:56:07 +00001775 }
Ben Langmuirb537a3a2014-07-23 15:30:23 +00001776
Douglas Gregor2537a362011-12-08 17:01:29 +00001777 // Make the named module visible, if it's not already part of the module
1778 // we are parsing.
Douglas Gregor98a52db2011-12-20 00:28:52 +00001779 if (ModuleName != getLangOpts().CurrentModule) {
1780 if (!Module->IsFromModuleFile) {
1781 // We have an umbrella header or directory that doesn't actually include
1782 // all of the headers within the directory it covers. Complain about
1783 // this missing submodule and recover by forgetting that we ever saw
1784 // this submodule.
1785 // FIXME: Should we detect this at module load time? It seems fairly
1786 // expensive (and rare).
1787 getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1788 << Module->getFullModuleName()
1789 << SourceRange(Path.front().second, Path.back().second);
Craig Topper49a27902014-05-22 04:46:25 +00001790
Richard Smitha114c462016-12-06 00:40:17 +00001791 return ModuleLoadResult::MissingExpected;
Douglas Gregor98a52db2011-12-20 00:28:52 +00001792 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00001793
1794 // Check whether this module is available.
Richard Smitha3feee22013-10-28 22:18:19 +00001795 clang::Module::Requirement Requirement;
Richard Smith3c1a41a2014-12-02 00:08:08 +00001796 clang::Module::UnresolvedHeaderDirective MissingHeader;
Daniel Jasper0761a8a2013-12-17 10:31:37 +00001797 if (!Module->isAvailable(getLangOpts(), getTarget(), Requirement,
1798 MissingHeader)) {
1799 if (MissingHeader.FileNameLoc.isValid()) {
1800 getDiagnostics().Report(MissingHeader.FileNameLoc,
1801 diag::err_module_header_missing)
1802 << MissingHeader.IsUmbrella << MissingHeader.FileName;
1803 } else {
1804 getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1805 << Module->getFullModuleName()
1806 << Requirement.second << Requirement.first
1807 << SourceRange(Path.front().second, Path.back().second);
1808 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00001809 LastModuleImportLoc = ImportLoc;
Douglas Gregor7a626572012-11-29 23:55:25 +00001810 LastModuleImportResult = ModuleLoadResult();
1811 return ModuleLoadResult();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00001812 }
1813
Richard Smitha7e2cc62015-05-01 01:53:09 +00001814 ModuleManager->makeModuleVisible(Module, Visibility, ImportLoc);
Douglas Gregor98a52db2011-12-20 00:28:52 +00001815 }
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001816
1817 // Check for any configuration macros that have changed.
1818 clang::Module *TopModule = Module->getTopLevelModule();
1819 for (unsigned I = 0, N = TopModule->ConfigMacros.size(); I != N; ++I) {
1820 checkConfigMacro(getPreprocessor(), TopModule->ConfigMacros[I],
1821 Module, ImportLoc);
1822 }
1823
Douglas Gregor1805b8a2011-11-30 04:26:53 +00001824 LastModuleImportLoc = ImportLoc;
Richard Smitha114c462016-12-06 00:40:17 +00001825 LastModuleImportResult = ModuleLoadResult(Module);
Douglas Gregor7a626572012-11-29 23:55:25 +00001826 return LastModuleImportResult;
Douglas Gregor08142532011-08-26 23:56:07 +00001827}
Douglas Gregorc147b0b2013-01-12 01:29:50 +00001828
1829void CompilerInstance::makeModuleVisible(Module *Mod,
Argyrios Kyrtzidis125df052013-02-01 16:36:12 +00001830 Module::NameVisibilityKind Visibility,
Richard Smitha7e2cc62015-05-01 01:53:09 +00001831 SourceLocation ImportLoc) {
Richard Smith42413142015-05-15 20:05:43 +00001832 if (!ModuleManager)
1833 createModuleManager();
1834 if (!ModuleManager)
1835 return;
1836
Richard Smitha7e2cc62015-05-01 01:53:09 +00001837 ModuleManager->makeModuleVisible(Mod, Visibility, ImportLoc);
Douglas Gregorc147b0b2013-01-12 01:29:50 +00001838}
1839
John Thompson2255f2c2014-04-23 12:57:01 +00001840GlobalModuleIndex *CompilerInstance::loadGlobalModuleIndex(
1841 SourceLocation TriggerLoc) {
Richard Smith3938f0c2015-08-15 00:34:15 +00001842 if (getPreprocessor().getHeaderSearchInfo().getModuleCachePath().empty())
1843 return nullptr;
John Thompson2255f2c2014-04-23 12:57:01 +00001844 if (!ModuleManager)
1845 createModuleManager();
1846 // Can't do anything if we don't have the module manager.
1847 if (!ModuleManager)
Craig Topper49a27902014-05-22 04:46:25 +00001848 return nullptr;
John Thompson2255f2c2014-04-23 12:57:01 +00001849 // Get an existing global index. This loads it if not already
1850 // loaded.
1851 ModuleManager->loadGlobalIndex();
1852 GlobalModuleIndex *GlobalIndex = ModuleManager->getGlobalIndex();
1853 // If the global index doesn't exist, create it.
1854 if (!GlobalIndex && shouldBuildGlobalModuleIndex() && hasFileManager() &&
1855 hasPreprocessor()) {
1856 llvm::sys::fs::create_directories(
1857 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1858 GlobalModuleIndex::writeIndex(
Adrian Prantlfb2398d2015-07-17 01:19:54 +00001859 getFileManager(), getPCHContainerReader(),
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001860 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
John Thompson2255f2c2014-04-23 12:57:01 +00001861 ModuleManager->resetForReload();
1862 ModuleManager->loadGlobalIndex();
1863 GlobalIndex = ModuleManager->getGlobalIndex();
1864 }
1865 // For finding modules needing to be imported for fixit messages,
1866 // we need to make the global index cover all modules, so we do that here.
1867 if (!HaveFullGlobalModuleIndex && GlobalIndex && !buildingModule()) {
1868 ModuleMap &MMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
1869 bool RecreateIndex = false;
1870 for (ModuleMap::module_iterator I = MMap.module_begin(),
1871 E = MMap.module_end(); I != E; ++I) {
1872 Module *TheModule = I->second;
1873 const FileEntry *Entry = TheModule->getASTFile();
1874 if (!Entry) {
1875 SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
1876 Path.push_back(std::make_pair(
Richard Smith629d8e62015-08-11 00:03:28 +00001877 getPreprocessor().getIdentifierInfo(TheModule->Name), TriggerLoc));
John Thompson2255f2c2014-04-23 12:57:01 +00001878 std::reverse(Path.begin(), Path.end());
Richard Smith629d8e62015-08-11 00:03:28 +00001879 // Load a module as hidden. This also adds it to the global index.
1880 loadModule(TheModule->DefinitionLoc, Path, Module::Hidden, false);
John Thompson2255f2c2014-04-23 12:57:01 +00001881 RecreateIndex = true;
1882 }
1883 }
1884 if (RecreateIndex) {
1885 GlobalModuleIndex::writeIndex(
Adrian Prantlfb2398d2015-07-17 01:19:54 +00001886 getFileManager(), getPCHContainerReader(),
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001887 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
John Thompson2255f2c2014-04-23 12:57:01 +00001888 ModuleManager->resetForReload();
1889 ModuleManager->loadGlobalIndex();
1890 GlobalIndex = ModuleManager->getGlobalIndex();
1891 }
1892 HaveFullGlobalModuleIndex = true;
1893 }
1894 return GlobalIndex;
1895}
John Thompson2d94bbb2014-04-23 19:04:32 +00001896
1897// Check global module index for missing imports.
1898bool
1899CompilerInstance::lookupMissingImports(StringRef Name,
1900 SourceLocation TriggerLoc) {
1901 // Look for the symbol in non-imported modules, but only if an error
1902 // actually occurred.
1903 if (!buildingModule()) {
1904 // Load global module index, or retrieve a previously loaded one.
1905 GlobalModuleIndex *GlobalIndex = loadGlobalModuleIndex(
1906 TriggerLoc);
1907
1908 // Only if we have a global index.
1909 if (GlobalIndex) {
1910 GlobalModuleIndex::HitSet FoundModules;
1911
1912 // Find the modules that reference the identifier.
1913 // Note that this only finds top-level modules.
1914 // We'll let diagnoseTypo find the actual declaration module.
1915 if (GlobalIndex->lookupIdentifier(Name, FoundModules))
1916 return true;
1917 }
1918 }
1919
1920 return false;
1921}
David Blaikiea97eaa12014-08-29 16:53:14 +00001922void CompilerInstance::resetAndLeakSema() { BuryPointer(takeSema()); }
Benjamin Kramer7de99692016-11-16 18:15:26 +00001923
1924void CompilerInstance::setExternalSemaSource(
1925 IntrusiveRefCntPtr<ExternalSemaSource> ESS) {
1926 ExternalSemaSrc = std::move(ESS);
1927}