blob: a0e81f01f9be44afaee5c25cf06f83b765d0b734 [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()),
Duncan P. N. Exon Smith1116d692017-02-02 05:09:51 +000060 ThePCHContainerOperations(std::move(PCHContainerOps)) {}
Daniel Dunbar636404a2009-11-13 03:51:44 +000061
62CompilerInstance::~CompilerInstance() {
Benjamin Kramer3c717b42012-10-14 19:21:21 +000063 assert(OutputFiles.empty() && "Still output files in flight?");
Daniel Dunbare922d9b2010-02-16 01:54:47 +000064}
65
David Blaikieea4395e2017-01-06 19:49:01 +000066void CompilerInstance::setInvocation(
67 std::shared_ptr<CompilerInvocation> Value) {
68 Invocation = std::move(Value);
Daniel Dunbar68242252010-01-30 21:47:07 +000069}
70
Douglas Gregorc1bbec82013-01-25 00:45:27 +000071bool CompilerInstance::shouldBuildGlobalModuleIndex() const {
Douglas Gregore060e572013-01-25 01:03:03 +000072 return (BuildGlobalModuleIndex ||
Douglas Gregor11ef0b72013-03-22 21:26:48 +000073 (ModuleManager && ModuleManager->isGlobalIndexUnavailable() &&
74 getFrontendOpts().GenerateGlobalModuleIndex)) &&
Douglas Gregore060e572013-01-25 01:03:03 +000075 !ModuleBuildFailed;
Douglas Gregorc1bbec82013-01-25 00:45:27 +000076}
77
David Blaikie9c902b52011-09-25 23:23:43 +000078void CompilerInstance::setDiagnostics(DiagnosticsEngine *Value) {
Douglas Gregor7f95d262010-04-05 23:52:57 +000079 Diagnostics = Value;
Daniel Dunbare01dc862009-11-14 01:20:40 +000080}
81
Artem Belevichb5bc9232015-09-22 17:23:22 +000082void CompilerInstance::setTarget(TargetInfo *Value) { Target = Value; }
83void CompilerInstance::setAuxTarget(TargetInfo *Value) { AuxTarget = Value; }
Daniel Dunbare01dc862009-11-14 01:20:40 +000084
85void CompilerInstance::setFileManager(FileManager *Value) {
Ted Kremenek5e14d392011-03-21 18:40:17 +000086 FileMgr = Value;
Ben Langmuirc8130a72014-02-20 21:59:23 +000087 if (Value)
88 VirtualFileSystem = Value->getVirtualFileSystem();
89 else
90 VirtualFileSystem.reset();
Daniel Dunbare01dc862009-11-14 01:20:40 +000091}
92
NAKAMURA Takumi82a35112011-10-08 11:31:46 +000093void CompilerInstance::setSourceManager(SourceManager *Value) {
Ted Kremenek5e14d392011-03-21 18:40:17 +000094 SourceMgr = Value;
Daniel Dunbare01dc862009-11-14 01:20:40 +000095}
96
David Blaikie41565462017-01-05 19:48:07 +000097void CompilerInstance::setPreprocessor(std::shared_ptr<Preprocessor> Value) {
98 PP = std::move(Value);
99}
Daniel Dunbare01dc862009-11-14 01:20:40 +0000100
Richard Smith293534b2015-08-18 20:39:29 +0000101void CompilerInstance::setASTContext(ASTContext *Value) {
102 Context = Value;
103
104 if (Context && Consumer)
105 getASTConsumer().Initialize(getASTContext());
106}
Daniel Dunbare01dc862009-11-14 01:20:40 +0000107
Douglas Gregor0e93f012010-08-12 23:31:19 +0000108void CompilerInstance::setSema(Sema *S) {
109 TheSema.reset(S);
110}
111
David Blaikie6beb6aa2014-08-10 19:56:51 +0000112void CompilerInstance::setASTConsumer(std::unique_ptr<ASTConsumer> Value) {
113 Consumer = std::move(Value);
Richard Smith293534b2015-08-18 20:39:29 +0000114
115 if (Context && Consumer)
116 getASTConsumer().Initialize(getASTContext());
Daniel Dunbar56d9c292009-11-14 02:47:17 +0000117}
118
Daniel Dunbare01dc862009-11-14 01:20:40 +0000119void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
120 CompletionConsumer.reset(Value);
121}
David Blaikie61535812014-08-10 20:12:39 +0000122
123std::unique_ptr<Sema> CompilerInstance::takeSema() {
124 return std::move(TheSema);
125}
126
Argyrios Kyrtzidis1b7ed912014-02-27 04:11:59 +0000127IntrusiveRefCntPtr<ASTReader> CompilerInstance::getModuleManager() const {
128 return ModuleManager;
129}
130void CompilerInstance::setModuleManager(IntrusiveRefCntPtr<ASTReader> Reader) {
Benjamin Kramerd6da1a02016-06-12 20:05:23 +0000131 ModuleManager = std::move(Reader);
Argyrios Kyrtzidis1b7ed912014-02-27 04:11:59 +0000132}
Daniel Dunbare01dc862009-11-14 01:20:40 +0000133
Justin Bogner86d12592014-06-19 19:36:03 +0000134std::shared_ptr<ModuleDependencyCollector>
135CompilerInstance::getModuleDepCollector() const {
136 return ModuleDepCollector;
137}
138
139void CompilerInstance::setModuleDepCollector(
140 std::shared_ptr<ModuleDependencyCollector> Collector) {
Benjamin Kramerd6da1a02016-06-12 20:05:23 +0000141 ModuleDepCollector = std::move(Collector);
Justin Bogner86d12592014-06-19 19:36:03 +0000142}
143
Bruno Cardoso Lopes181225b2016-12-11 04:27:28 +0000144static void collectHeaderMaps(const HeaderSearch &HS,
145 std::shared_ptr<ModuleDependencyCollector> MDC) {
146 SmallVector<std::string, 4> HeaderMapFileNames;
147 HS.getHeaderMapFileNames(HeaderMapFileNames);
148 for (auto &Name : HeaderMapFileNames)
149 MDC->addFile(Name);
150}
151
Bruno Cardoso Lopes7aff2bb2016-12-12 19:28:25 +0000152static void collectIncludePCH(CompilerInstance &CI,
153 std::shared_ptr<ModuleDependencyCollector> MDC) {
154 const PreprocessorOptions &PPOpts = CI.getPreprocessorOpts();
155 if (PPOpts.ImplicitPCHInclude.empty())
156 return;
157
158 StringRef PCHInclude = PPOpts.ImplicitPCHInclude;
159 FileManager &FileMgr = CI.getFileManager();
160 const DirectoryEntry *PCHDir = FileMgr.getDirectory(PCHInclude);
161 if (!PCHDir) {
162 MDC->addFile(PCHInclude);
163 return;
164 }
165
166 std::error_code EC;
167 SmallString<128> DirNative;
168 llvm::sys::path::native(PCHDir->getName(), DirNative);
169 vfs::FileSystem &FS = *FileMgr.getVirtualFileSystem();
170 SimpleASTReaderListener Validator(CI.getPreprocessor());
171 for (vfs::directory_iterator Dir = FS.dir_begin(DirNative, EC), DirEnd;
172 Dir != DirEnd && !EC; Dir.increment(EC)) {
173 // Check whether this is an AST file. ASTReader::isAcceptableASTFile is not
174 // used here since we're not interested in validating the PCH at this time,
175 // but only to check whether this is a file containing an AST.
176 if (!ASTReader::readASTFileControlBlock(
177 Dir->getName(), FileMgr, CI.getPCHContainerReader(),
178 /*FindModuleFileExtensions=*/false, Validator,
179 /*ValidateDiagnosticOptions=*/false))
180 MDC->addFile(Dir->getName());
181 }
182}
183
Bruno Cardoso Lopes82ec4fde2016-12-22 07:06:03 +0000184static void collectVFSEntries(CompilerInstance &CI,
185 std::shared_ptr<ModuleDependencyCollector> MDC) {
186 if (CI.getHeaderSearchOpts().VFSOverlayFiles.empty())
187 return;
188
189 // Collect all VFS found.
190 SmallVector<vfs::YAMLVFSEntry, 16> VFSEntries;
191 for (const std::string &VFSFile : CI.getHeaderSearchOpts().VFSOverlayFiles) {
192 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Buffer =
193 llvm::MemoryBuffer::getFile(VFSFile);
194 if (!Buffer)
195 return;
196 vfs::collectVFSFromYAML(std::move(Buffer.get()), /*DiagHandler*/ nullptr,
197 VFSFile, VFSEntries);
198 }
199
200 for (auto &E : VFSEntries)
201 MDC->addFile(E.VPath, E.RPath);
202}
203
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000204// Diagnostics
Douglas Gregor811db4e2012-10-23 22:26:28 +0000205static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts,
Daniel Dunbar7b833062011-04-07 18:59:02 +0000206 const CodeGenOptions *CodeGenOpts,
David Blaikie9c902b52011-09-25 23:23:43 +0000207 DiagnosticsEngine &Diags) {
Rafael Espindoladae941a2014-08-25 18:17:04 +0000208 std::error_code EC;
David Blaikie11f8a942014-09-15 17:30:56 +0000209 std::unique_ptr<raw_ostream> StreamOwner;
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000210 raw_ostream *OS = &llvm::errs();
Douglas Gregor811db4e2012-10-23 22:26:28 +0000211 if (DiagOpts->DiagnosticLogFile != "-") {
Daniel Dunbar2083c322011-04-07 18:31:10 +0000212 // Create the output stream.
David Blaikie11f8a942014-09-15 17:30:56 +0000213 auto FileOS = llvm::make_unique<llvm::raw_fd_ostream>(
Rafael Espindoladae941a2014-08-25 18:17:04 +0000214 DiagOpts->DiagnosticLogFile, EC,
David Blaikie11f8a942014-09-15 17:30:56 +0000215 llvm::sys::fs::F_Append | llvm::sys::fs::F_Text);
Rafael Espindoladae941a2014-08-25 18:17:04 +0000216 if (EC) {
Daniel Dunbar2083c322011-04-07 18:31:10 +0000217 Diags.Report(diag::warn_fe_cc_log_diagnostics_failure)
Rafael Espindoladae941a2014-08-25 18:17:04 +0000218 << DiagOpts->DiagnosticLogFile << EC.message();
Daniel Dunbar2083c322011-04-07 18:31:10 +0000219 } else {
220 FileOS->SetUnbuffered();
David Blaikie11f8a942014-09-15 17:30:56 +0000221 OS = FileOS.get();
222 StreamOwner = std::move(FileOS);
Daniel Dunbar2083c322011-04-07 18:31:10 +0000223 }
224 }
225
226 // Chain in the diagnostic client which will log the diagnostics.
David Blaikie7ee25502014-09-15 17:50:10 +0000227 auto Logger = llvm::make_unique<LogDiagnosticPrinter>(*OS, DiagOpts,
228 std::move(StreamOwner));
Daniel Dunbar7b833062011-04-07 18:59:02 +0000229 if (CodeGenOpts)
230 Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
David Blaikie7ee25502014-09-15 17:50:10 +0000231 assert(Diags.ownsClient());
Alexander Kornienko41c247a2014-11-17 23:46:02 +0000232 Diags.setClient(
233 new ChainedDiagnosticConsumer(Diags.takeClient(), std::move(Logger)));
Daniel Dunbar2083c322011-04-07 18:31:10 +0000234}
235
Douglas Gregor811db4e2012-10-23 22:26:28 +0000236static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts,
Ted Kremenek4610ea22011-10-29 00:12:39 +0000237 DiagnosticsEngine &Diags,
238 StringRef OutputFile) {
David Blaikie7ee25502014-09-15 17:50:10 +0000239 auto SerializedConsumer =
Justin Bogner5a6a2fc2014-10-23 22:20:11 +0000240 clang::serialized_diags::create(OutputFile, DiagOpts);
Ahmed Charles9a16beb2014-03-07 19:33:25 +0000241
Alexander Kornienko254b7db2014-11-13 13:08:27 +0000242 if (Diags.ownsClient()) {
243 Diags.setClient(new ChainedDiagnosticConsumer(
Alexander Kornienko41c247a2014-11-17 23:46:02 +0000244 Diags.takeClient(), std::move(SerializedConsumer)));
Alexander Kornienko254b7db2014-11-13 13:08:27 +0000245 } else {
246 Diags.setClient(new ChainedDiagnosticConsumer(
Alexander Kornienko4c0ef3792014-11-17 14:46:28 +0000247 Diags.getClient(), std::move(SerializedConsumer)));
Alexander Kornienko254b7db2014-11-13 13:08:27 +0000248 }
Ted Kremenek4610ea22011-10-29 00:12:39 +0000249}
250
Sean Silvaf1b49e22013-01-20 01:58:28 +0000251void CompilerInstance::createDiagnostics(DiagnosticConsumer *Client,
Douglas Gregor30071cea2013-05-03 23:07:45 +0000252 bool ShouldOwnClient) {
Sean Silvaf1b49e22013-01-20 01:58:28 +0000253 Diagnostics = createDiagnostics(&getDiagnosticOpts(), Client,
Douglas Gregor30071cea2013-05-03 23:07:45 +0000254 ShouldOwnClient, &getCodeGenOpts());
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000255}
256
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000257IntrusiveRefCntPtr<DiagnosticsEngine>
Douglas Gregor811db4e2012-10-23 22:26:28 +0000258CompilerInstance::createDiagnostics(DiagnosticOptions *Opts,
David Blaikiee2eefae2011-09-25 23:39:51 +0000259 DiagnosticConsumer *Client,
Douglas Gregor2b9b4642011-09-13 01:26:44 +0000260 bool ShouldOwnClient,
Daniel Dunbar7b833062011-04-07 18:59:02 +0000261 const CodeGenOptions *CodeGenOpts) {
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000262 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
263 IntrusiveRefCntPtr<DiagnosticsEngine>
Douglas Gregor811db4e2012-10-23 22:26:28 +0000264 Diags(new DiagnosticsEngine(DiagID, Opts));
Daniel Dunbar1b39a2e2009-11-14 07:53:24 +0000265
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000266 // Create the diagnostic client for reporting errors or for
267 // implementing -verify.
Douglas Gregord0e9e3a2011-09-29 00:38:00 +0000268 if (Client) {
Douglas Gregor30071cea2013-05-03 23:07:45 +0000269 Diags->setClient(Client, ShouldOwnClient);
Douglas Gregord0e9e3a2011-09-29 00:38:00 +0000270 } else
Douglas Gregor44c6ee72010-11-11 00:39:14 +0000271 Diags->setClient(new TextDiagnosticPrinter(llvm::errs(), Opts));
Daniel Dunbar50ec0da2009-11-14 03:24:39 +0000272
273 // Chain in -verify checker, if requested.
Douglas Gregor811db4e2012-10-23 22:26:28 +0000274 if (Opts->VerifyDiagnostics)
David Blaikie69609dc2011-09-26 00:38:03 +0000275 Diags->setClient(new VerifyDiagnosticConsumer(*Diags));
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000276
Daniel Dunbar2083c322011-04-07 18:31:10 +0000277 // Chain in -diagnostic-log-file dumper, if requested.
Douglas Gregor811db4e2012-10-23 22:26:28 +0000278 if (!Opts->DiagnosticLogFile.empty())
Daniel Dunbar7b833062011-04-07 18:59:02 +0000279 SetUpDiagnosticLog(Opts, CodeGenOpts, *Diags);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000280
Douglas Gregor811db4e2012-10-23 22:26:28 +0000281 if (!Opts->DiagnosticSerializationFile.empty())
Ted Kremenek4610ea22011-10-29 00:12:39 +0000282 SetupSerializedDiagnostics(Opts, *Diags,
Douglas Gregor811db4e2012-10-23 22:26:28 +0000283 Opts->DiagnosticSerializationFile);
Ted Kremenek4610ea22011-10-29 00:12:39 +0000284
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000285 // Configure our handling of diagnostics.
Douglas Gregor811db4e2012-10-23 22:26:28 +0000286 ProcessWarningOptions(*Diags, *Opts);
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000287
Douglas Gregor7f95d262010-04-05 23:52:57 +0000288 return Diags;
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000289}
290
291// File Manager
292
Daniel Dunbar546a6762009-11-13 04:12:06 +0000293void CompilerInstance::createFileManager() {
Ben Langmuirc8130a72014-02-20 21:59:23 +0000294 if (!hasVirtualFileSystem()) {
295 // TODO: choose the virtual file system based on the CompilerInvocation.
296 setVirtualFileSystem(vfs::getRealFileSystem());
297 }
298 FileMgr = new FileManager(getFileSystemOpts(), VirtualFileSystem);
Daniel Dunbar546a6762009-11-13 04:12:06 +0000299}
300
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000301// Source Manager
302
Chris Lattner5159f612010-11-23 08:35:12 +0000303void CompilerInstance::createSourceManager(FileManager &FileMgr) {
Ted Kremenek5e14d392011-03-21 18:40:17 +0000304 SourceMgr = new SourceManager(getDiagnostics(), FileMgr);
Daniel Dunbar546a6762009-11-13 04:12:06 +0000305}
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000306
Alp Tokerc3580002014-07-07 06:05:00 +0000307// Initialize the remapping of files to alternative contents, e.g.,
308// those specified through other files.
309static void InitializeFileRemapping(DiagnosticsEngine &Diags,
310 SourceManager &SourceMgr,
311 FileManager &FileMgr,
312 const PreprocessorOptions &InitOpts) {
313 // Remap files in the source manager (with buffers).
Alp Toker1b070d22014-07-07 07:47:20 +0000314 for (const auto &RB : InitOpts.RemappedFileBuffers) {
Alp Tokerc3580002014-07-07 06:05:00 +0000315 // Create the file entry for the file that we're mapping from.
316 const FileEntry *FromFile =
Alp Toker1b070d22014-07-07 07:47:20 +0000317 FileMgr.getVirtualFile(RB.first, RB.second->getBufferSize(), 0);
Alp Tokerc3580002014-07-07 06:05:00 +0000318 if (!FromFile) {
Alp Toker1b070d22014-07-07 07:47:20 +0000319 Diags.Report(diag::err_fe_remap_missing_from_file) << RB.first;
Alp Tokerc3580002014-07-07 06:05:00 +0000320 if (!InitOpts.RetainRemappedFileBuffers)
Alp Toker1b070d22014-07-07 07:47:20 +0000321 delete RB.second;
Alp Tokerc3580002014-07-07 06:05:00 +0000322 continue;
323 }
324
325 // Override the contents of the "from" file with the contents of
326 // the "to" file.
Alp Toker1b070d22014-07-07 07:47:20 +0000327 SourceMgr.overrideFileContents(FromFile, RB.second,
Alp Tokerc3580002014-07-07 06:05:00 +0000328 InitOpts.RetainRemappedFileBuffers);
329 }
330
331 // Remap files in the source manager (with other files).
Alp Toker1b070d22014-07-07 07:47:20 +0000332 for (const auto &RF : InitOpts.RemappedFiles) {
Alp Tokerc3580002014-07-07 06:05:00 +0000333 // Find the file that we're mapping to.
Alp Toker1b070d22014-07-07 07:47:20 +0000334 const FileEntry *ToFile = FileMgr.getFile(RF.second);
Alp Tokerc3580002014-07-07 06:05:00 +0000335 if (!ToFile) {
Alp Toker1b070d22014-07-07 07:47:20 +0000336 Diags.Report(diag::err_fe_remap_missing_to_file) << RF.first << RF.second;
Alp Tokerc3580002014-07-07 06:05:00 +0000337 continue;
338 }
339
340 // Create the file entry for the file that we're mapping from.
341 const FileEntry *FromFile =
Alp Toker1b070d22014-07-07 07:47:20 +0000342 FileMgr.getVirtualFile(RF.first, ToFile->getSize(), 0);
Alp Tokerc3580002014-07-07 06:05:00 +0000343 if (!FromFile) {
Alp Toker1b070d22014-07-07 07:47:20 +0000344 Diags.Report(diag::err_fe_remap_missing_from_file) << RF.first;
Alp Tokerc3580002014-07-07 06:05:00 +0000345 continue;
346 }
347
348 // Override the contents of the "from" file with the contents of
349 // the "to" file.
350 SourceMgr.overrideFileContents(FromFile, ToFile);
351 }
352
353 SourceMgr.setOverridenFilesKeepOriginalName(
354 InitOpts.RemappedFilesKeepOriginalName);
355}
356
Daniel Dunbar7d75afc2009-11-13 05:52:34 +0000357// Preprocessor
358
Argyrios Kyrtzidise1974dc2014-03-07 07:47:58 +0000359void CompilerInstance::createPreprocessor(TranslationUnitKind TUKind) {
Douglas Gregor08142532011-08-26 23:56:07 +0000360 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000361
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000362 // Create a PTH manager if we are using some form of a token cache.
Craig Topper49a27902014-05-22 04:46:25 +0000363 PTHManager *PTHMgr = nullptr;
Daniel Dunbard6ea9022009-11-17 05:52:41 +0000364 if (!PPOpts.TokenCache.empty())
Douglas Gregor08142532011-08-26 23:56:07 +0000365 PTHMgr = PTHManager::Create(PPOpts.TokenCache, getDiagnostics());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000366
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000367 // Create the Preprocessor.
David Blaikie9c28cb32017-01-06 01:04:46 +0000368 HeaderSearch *HeaderInfo =
369 new HeaderSearch(getHeaderSearchOptsPtr(), getSourceManager(),
370 getDiagnostics(), getLangOpts(), &getTarget());
David Blaikie41565462017-01-05 19:48:07 +0000371 PP = std::make_shared<Preprocessor>(
372 Invocation->getPreprocessorOptsPtr(), getDiagnostics(), getLangOpts(),
373 getSourceManager(), *HeaderInfo, *this, PTHMgr,
374 /*OwnsHeaderSearch=*/true, TUKind);
Artem Belevichb5bc9232015-09-22 17:23:22 +0000375 PP->Initialize(getTarget(), getAuxTarget());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000376
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000377 // Note that this is different then passing PTHMgr to Preprocessor's ctor.
378 // That argument is used as the IdentifierInfoLookup argument to
379 // IdentifierTable's ctor.
380 if (PTHMgr) {
Douglas Gregor08142532011-08-26 23:56:07 +0000381 PTHMgr->setPreprocessor(&*PP);
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000382 PP->setPTHManager(PTHMgr);
383 }
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000384
Douglas Gregor7f6d60d2010-03-19 16:15:56 +0000385 if (PPOpts.DetailedRecord)
Argyrios Kyrtzidisf3d587e2012-12-04 07:27:05 +0000386 PP->createPreprocessingRecord();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000387
Alp Tokerc3580002014-07-07 06:05:00 +0000388 // Apply remappings to the source manager.
389 InitializeFileRemapping(PP->getDiagnostics(), PP->getSourceManager(),
390 PP->getFileManager(), PPOpts);
391
392 // Predefine macros and configure the preprocessor.
Adrian Prantlfb2398d2015-07-17 01:19:54 +0000393 InitializePreprocessor(*PP, PPOpts, getPCHContainerReader(),
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000394 getFrontendOpts());
Alp Tokerc3580002014-07-07 06:05:00 +0000395
Justin Lebarf91086b2016-11-18 00:41:27 +0000396 // Initialize the header search object. In CUDA compilations, we use the aux
397 // triple (the host triple) to initialize our header search, since we need to
398 // find the host headers in order to compile the CUDA code.
399 const llvm::Triple *HeaderSearchTriple = &PP->getTargetInfo().getTriple();
400 if (PP->getTargetInfo().getTriple().getOS() == llvm::Triple::CUDA &&
401 PP->getAuxTargetInfo())
402 HeaderSearchTriple = &PP->getAuxTargetInfo()->getTriple();
403
Alp Tokerc3580002014-07-07 06:05:00 +0000404 ApplyHeaderSearchOptions(PP->getHeaderSearchInfo(), getHeaderSearchOpts(),
Justin Lebarf91086b2016-11-18 00:41:27 +0000405 PP->getLangOpts(), *HeaderSearchTriple);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000406
Jordan Rose17441582013-01-30 01:52:57 +0000407 PP->setPreprocessedOutput(getPreprocessorOutputOpts().ShowCPP);
408
Richard Smith3938f0c2015-08-15 00:34:15 +0000409 if (PP->getLangOpts().Modules && PP->getLangOpts().ImplicitModules)
Chandler Carruthff8d9432015-03-28 01:10:44 +0000410 PP->getHeaderSearchInfo().setModuleCachePath(getSpecificModuleCachePath());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000411
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000412 // Handle generating dependencies, if requested.
Douglas Gregor08142532011-08-26 23:56:07 +0000413 const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000414 if (!DepOpts.OutputFile.empty())
Ben Langmuircb69b572014-03-07 06:40:32 +0000415 TheDependencyFileGenerator.reset(
416 DependencyFileGenerator::CreateAndAttachToPreprocessor(*PP, DepOpts));
Douglas Gregor2e129652012-02-02 23:45:13 +0000417 if (!DepOpts.DOTOutputFile.empty())
418 AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
Douglas Gregor83d46be2012-02-02 00:54:52 +0000419 getHeaderSearchOpts().Sysroot);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000420
Justin Bogner86d12592014-06-19 19:36:03 +0000421 // If we don't have a collector, but we are collecting module dependencies,
422 // then we're the top level compiler instance and need to create one.
Bruno Cardoso Lopesb1631d92016-03-29 23:47:40 +0000423 if (!ModuleDepCollector && !DepOpts.ModuleDependencyOutputDir.empty()) {
Justin Bogner86d12592014-06-19 19:36:03 +0000424 ModuleDepCollector = std::make_shared<ModuleDependencyCollector>(
425 DepOpts.ModuleDependencyOutputDir);
Bruno Cardoso Lopesb1631d92016-03-29 23:47:40 +0000426 }
427
Bruno Cardoso Lopes181225b2016-12-11 04:27:28 +0000428 // If there is a module dep collector, register with other dep collectors
429 // and also (a) collect header maps and (b) TODO: input vfs overlay files.
430 if (ModuleDepCollector) {
Bruno Cardoso Lopesb1631d92016-03-29 23:47:40 +0000431 addDependencyCollector(ModuleDepCollector);
Bruno Cardoso Lopes181225b2016-12-11 04:27:28 +0000432 collectHeaderMaps(PP->getHeaderSearchInfo(), ModuleDepCollector);
Bruno Cardoso Lopes7aff2bb2016-12-12 19:28:25 +0000433 collectIncludePCH(*this, ModuleDepCollector);
Bruno Cardoso Lopes82ec4fde2016-12-22 07:06:03 +0000434 collectVFSEntries(*this, ModuleDepCollector);
Bruno Cardoso Lopes181225b2016-12-11 04:27:28 +0000435 }
Bruno Cardoso Lopesb1631d92016-03-29 23:47:40 +0000436
437 for (auto &Listener : DependencyCollectors)
438 Listener->attachToPreprocessor(*PP);
Hans Wennborg0fd62072013-08-09 00:32:23 +0000439
Daniel Dunbar27734fd2011-02-02 15:41:17 +0000440 // Handle generating header include information, if requested.
441 if (DepOpts.ShowHeaderIncludes)
Nico Weberf54146c2016-03-23 18:46:57 +0000442 AttachHeaderIncludeGen(*PP, DepOpts);
Daniel Dunbar1af1d27512011-02-02 21:11:31 +0000443 if (!DepOpts.HeaderIncludeOutputFile.empty()) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000444 StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
Daniel Dunbar1af1d27512011-02-02 21:11:31 +0000445 if (OutputPath == "-")
446 OutputPath = "";
Nico Weberf54146c2016-03-23 18:46:57 +0000447 AttachHeaderIncludeGen(*PP, DepOpts,
Ivan Krasin1193f2c2015-08-13 04:04:37 +0000448 /*ShowAllHeaders=*/true, OutputPath,
Daniel Dunbarfe908a82011-03-21 19:37:38 +0000449 /*ShowDepth=*/false);
Daniel Dunbar1af1d27512011-02-02 21:11:31 +0000450 }
Hans Wennborg0fd62072013-08-09 00:32:23 +0000451
452 if (DepOpts.PrintShowIncludes) {
Nico Weberf54146c2016-03-23 18:46:57 +0000453 AttachHeaderIncludeGen(*PP, DepOpts,
Nico Weber149d95222016-03-23 18:00:22 +0000454 /*ShowAllHeaders=*/true, /*OutputPath=*/"",
Hans Wennborg0fd62072013-08-09 00:32:23 +0000455 /*ShowDepth=*/true, /*MSStyle=*/true);
456 }
Daniel Dunbaraaa148f2009-11-13 05:52:11 +0000457}
Daniel Dunbardf3e30c2009-11-13 08:20:47 +0000458
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000459std::string CompilerInstance::getSpecificModuleCachePath() {
460 // Set up the module path, including the hash for the
461 // module-creation options.
Richard Smithd520a252015-07-21 18:07:47 +0000462 SmallString<256> SpecificModuleCache(getHeaderSearchOpts().ModuleCachePath);
463 if (!SpecificModuleCache.empty() && !getHeaderSearchOpts().DisableModuleHash)
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000464 llvm::sys::path::append(SpecificModuleCache,
465 getInvocation().getModuleHash());
466 return SpecificModuleCache.str();
467}
468
Daniel Dunbardf3e30c2009-11-13 08:20:47 +0000469// ASTContext
470
471void CompilerInstance::createASTContext() {
472 Preprocessor &PP = getPreprocessor();
Richard Smith293534b2015-08-18 20:39:29 +0000473 auto *Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
474 PP.getIdentifierTable(), PP.getSelectorTable(),
475 PP.getBuiltinInfo());
Artem Belevichb5bc9232015-09-22 17:23:22 +0000476 Context->InitBuiltinTypes(getTarget(), getAuxTarget());
Richard Smith293534b2015-08-18 20:39:29 +0000477 setASTContext(Context);
Daniel Dunbardf3e30c2009-11-13 08:20:47 +0000478}
Daniel Dunbar599313e2009-11-13 08:21:10 +0000479
480// ExternalASTSource
481
Nico Weber824285e2014-05-08 04:26:47 +0000482void CompilerInstance::createPCHExternalASTSource(
483 StringRef Path, bool DisablePCHValidation, bool AllowPCHWithCompilerErrors,
484 void *DeserializationListener, bool OwnDeserializationListener) {
Sebastian Redl009e7f22010-10-05 16:15:19 +0000485 bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
Richard Smith4eca9b92015-02-04 23:37:59 +0000486 ModuleManager = createPCHExternalASTSource(
Nico Weber824285e2014-05-08 04:26:47 +0000487 Path, getHeaderSearchOpts().Sysroot, DisablePCHValidation,
488 AllowPCHWithCompilerErrors, getPreprocessor(), getASTContext(),
Douglas Gregor6623e1f2015-11-03 18:33:07 +0000489 getPCHContainerReader(),
490 getFrontendOpts().ModuleFileExtensions,
491 DeserializationListener,
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000492 OwnDeserializationListener, Preamble,
Nico Weber824285e2014-05-08 04:26:47 +0000493 getFrontendOpts().UseGlobalModuleIndex);
Daniel Dunbar599313e2009-11-13 08:21:10 +0000494}
495
Richard Smith4eca9b92015-02-04 23:37:59 +0000496IntrusiveRefCntPtr<ASTReader> CompilerInstance::createPCHExternalASTSource(
Yaron Keren5b816062015-07-06 08:47:15 +0000497 StringRef Path, StringRef Sysroot, bool DisablePCHValidation,
Nico Weber824285e2014-05-08 04:26:47 +0000498 bool AllowPCHWithCompilerErrors, Preprocessor &PP, ASTContext &Context,
Adrian Prantlfb2398d2015-07-17 01:19:54 +0000499 const PCHContainerReader &PCHContainerRdr,
David Blaikie61137e12017-01-05 18:23:18 +0000500 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
Nico Weber824285e2014-05-08 04:26:47 +0000501 void *DeserializationListener, bool OwnDeserializationListener,
502 bool Preamble, bool UseGlobalModuleIndex) {
Ben Langmuirdcf73862014-03-12 00:06:17 +0000503 HeaderSearchOptions &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
504
Adrian Prantlbb165fb2015-06-20 18:53:08 +0000505 IntrusiveRefCntPtr<ASTReader> Reader(new ASTReader(
Douglas Gregor6623e1f2015-11-03 18:33:07 +0000506 PP, Context, PCHContainerRdr, Extensions,
507 Sysroot.empty() ? "" : Sysroot.data(), DisablePCHValidation,
508 AllowPCHWithCompilerErrors, /*AllowConfigurationMismatch*/ false,
509 HSOpts.ModulesValidateSystemHeaders, UseGlobalModuleIndex));
Richard Smith4eca9b92015-02-04 23:37:59 +0000510
511 // We need the external source to be set up before we read the AST, because
512 // eagerly-deserialized declarations may use it.
513 Context.setExternalSource(Reader.get());
Daniel Dunbar599313e2009-11-13 08:21:10 +0000514
Sebastian Redl07a89a82010-07-30 00:29:29 +0000515 Reader->setDeserializationListener(
Nico Weber824285e2014-05-08 04:26:47 +0000516 static_cast<ASTDeserializationListener *>(DeserializationListener),
517 /*TakeOwnership=*/OwnDeserializationListener);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000518 switch (Reader->ReadAST(Path,
519 Preamble ? serialization::MK_Preamble
Douglas Gregor4b29c162012-10-22 23:51:00 +0000520 : serialization::MK_PCH,
Argyrios Kyrtzidis2ec29362012-11-15 18:57:22 +0000521 SourceLocation(),
Ben Langmuir3d4417c2014-02-07 17:31:11 +0000522 ASTReader::ARR_None)) {
Sebastian Redl2c499f62010-08-18 23:56:43 +0000523 case ASTReader::Success:
Daniel Dunbar599313e2009-11-13 08:21:10 +0000524 // Set the predefines buffer as suggested by the PCH reader. Typically, the
525 // predefines buffer will be empty.
526 PP.setPredefines(Reader->getSuggestedPredefines());
Richard Smith4eca9b92015-02-04 23:37:59 +0000527 return Reader;
Daniel Dunbar599313e2009-11-13 08:21:10 +0000528
Sebastian Redl2c499f62010-08-18 23:56:43 +0000529 case ASTReader::Failure:
Daniel Dunbar599313e2009-11-13 08:21:10 +0000530 // Unrecoverable failure: don't even try to process the input file.
531 break;
532
Douglas Gregor7029ce12013-03-19 00:28:20 +0000533 case ASTReader::Missing:
Douglas Gregorc9ad5fb2012-10-22 22:50:17 +0000534 case ASTReader::OutOfDate:
535 case ASTReader::VersionMismatch:
536 case ASTReader::ConfigurationMismatch:
537 case ASTReader::HadErrors:
Daniel Dunbar599313e2009-11-13 08:21:10 +0000538 // No suitable PCH file could be found. Return an error.
539 break;
540 }
541
Richard Smith4eca9b92015-02-04 23:37:59 +0000542 Context.setExternalSource(nullptr);
Craig Topper49a27902014-05-22 04:46:25 +0000543 return nullptr;
Daniel Dunbar599313e2009-11-13 08:21:10 +0000544}
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000545
546// Code Completion
547
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000548static bool EnableCodeCompletion(Preprocessor &PP,
Benjamin Kramer0772c422016-02-13 13:42:54 +0000549 StringRef Filename,
Douglas Gregor8e984da2010-08-04 16:47:14 +0000550 unsigned Line,
551 unsigned Column) {
552 // Tell the source manager to chop off the given file at a specific
553 // line and column.
Chris Lattner5159f612010-11-23 08:35:12 +0000554 const FileEntry *Entry = PP.getFileManager().getFile(Filename);
Douglas Gregor8e984da2010-08-04 16:47:14 +0000555 if (!Entry) {
556 PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
557 << Filename;
558 return true;
559 }
560
561 // Truncate the named file at the given line/column.
562 PP.SetCodeCompletionPoint(Entry, Line, Column);
563 return false;
564}
565
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000566void CompilerInstance::createCodeCompletionConsumer() {
567 const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
Douglas Gregor8e984da2010-08-04 16:47:14 +0000568 if (!CompletionConsumer) {
Erik Verbruggen2fca3c22012-04-12 10:31:12 +0000569 setCodeCompletionConsumer(
Douglas Gregor8e984da2010-08-04 16:47:14 +0000570 createCodeCompletionConsumer(getPreprocessor(),
571 Loc.FileName, Loc.Line, Loc.Column,
Dmitri Gribenko3292d062012-07-02 17:35:10 +0000572 getFrontendOpts().CodeCompleteOpts,
Douglas Gregor8e984da2010-08-04 16:47:14 +0000573 llvm::outs()));
574 if (!CompletionConsumer)
575 return;
576 } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
577 Loc.Line, Loc.Column)) {
Craig Topper49a27902014-05-22 04:46:25 +0000578 setCodeCompletionConsumer(nullptr);
Douglas Gregor00a0cf72010-03-16 06:04:47 +0000579 return;
Douglas Gregor8e984da2010-08-04 16:47:14 +0000580 }
Douglas Gregorf09935f2009-12-01 05:55:20 +0000581
582 if (CompletionConsumer->isOutputBinary() &&
Rafael Espindolaa3346d82013-06-12 20:44:26 +0000583 llvm::sys::ChangeStdoutToBinary()) {
Douglas Gregorf09935f2009-12-01 05:55:20 +0000584 getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
Craig Topper49a27902014-05-22 04:46:25 +0000585 setCodeCompletionConsumer(nullptr);
Douglas Gregorf09935f2009-12-01 05:55:20 +0000586 }
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000587}
588
Kovarththanan Rajaratnam5505dff2009-11-29 09:57:35 +0000589void CompilerInstance::createFrontendTimer() {
Matthias Braunae032b62016-11-18 19:43:25 +0000590 FrontendTimerGroup.reset(
591 new llvm::TimerGroup("frontend", "Clang front-end time report"));
Richard Smithce18a182015-07-14 00:26:00 +0000592 FrontendTimer.reset(
Matthias Braunae032b62016-11-18 19:43:25 +0000593 new llvm::Timer("frontend", "Clang front-end timer",
594 *FrontendTimerGroup));
Kovarththanan Rajaratnam5505dff2009-11-29 09:57:35 +0000595}
596
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000597CodeCompleteConsumer *
598CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
Yaron Keren5b816062015-07-06 08:47:15 +0000599 StringRef Filename,
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000600 unsigned Line,
601 unsigned Column,
Dmitri Gribenko3292d062012-07-02 17:35:10 +0000602 const CodeCompleteOptions &Opts,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000603 raw_ostream &OS) {
Douglas Gregor8e984da2010-08-04 16:47:14 +0000604 if (EnableCodeCompletion(PP, Filename, Line, Column))
Craig Topper49a27902014-05-22 04:46:25 +0000605 return nullptr;
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000606
607 // Set up the creation routine for code-completion.
Dmitri Gribenko3292d062012-07-02 17:35:10 +0000608 return new PrintingCodeCompleteConsumer(Opts, OS);
Daniel Dunbarf7093b52009-11-13 09:36:05 +0000609}
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000610
Douglas Gregor69f74f82011-08-25 22:30:56 +0000611void CompilerInstance::createSema(TranslationUnitKind TUKind,
Douglas Gregor0e93f012010-08-12 23:31:19 +0000612 CodeCompleteConsumer *CompletionConsumer) {
613 TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
Douglas Gregor69f74f82011-08-25 22:30:56 +0000614 TUKind, CompletionConsumer));
Benjamin Kramer7de99692016-11-16 18:15:26 +0000615 // Attach the external sema source if there is any.
616 if (ExternalSemaSrc) {
617 TheSema->addExternalSource(ExternalSemaSrc.get());
618 ExternalSemaSrc->InitializeSema(*TheSema);
619 }
Douglas Gregor0e93f012010-08-12 23:31:19 +0000620}
621
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000622// Output Files
623
Rafael Espindola269ec0f2015-04-10 14:11:52 +0000624void CompilerInstance::addOutputFile(OutputFile &&OutFile) {
Rafael Espindola269ec0f2015-04-10 14:11:52 +0000625 OutputFiles.push_back(std::move(OutFile));
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000626}
627
Kovarththanan Rajaratnam1c558cd2010-03-06 12:07:48 +0000628void CompilerInstance::clearOutputFiles(bool EraseFiles) {
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000629 for (OutputFile &OF : OutputFiles) {
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000630 if (!OF.TempFilename.empty()) {
Anders Carlssonb5c356a2011-03-06 22:25:35 +0000631 if (EraseFiles) {
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000632 llvm::sys::fs::remove(OF.TempFilename);
Anders Carlssonb5c356a2011-03-06 22:25:35 +0000633 } else {
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000634 SmallString<128> NewOutFile(OF.Filename);
Anders Carlssonb5c356a2011-03-06 22:25:35 +0000635
Argyrios Kyrtzidis71731d62010-11-03 22:45:23 +0000636 // If '-working-directory' was passed, the output filename should be
637 // relative to that.
Anders Carlsson9ba8fb12011-03-14 01:13:54 +0000638 FileMgr->FixupRelativePath(NewOutFile);
Rafael Espindolac0809172014-06-12 14:02:15 +0000639 if (std::error_code ec =
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000640 llvm::sys::fs::rename(OF.TempFilename, NewOutFile)) {
Manuel Klimek3ef9c442012-05-16 20:55:58 +0000641 getDiagnostics().Report(diag::err_unable_to_rename_temp)
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000642 << OF.TempFilename << OF.Filename << ec.message();
Anders Carlssonb5c356a2011-03-06 22:25:35 +0000643
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000644 llvm::sys::fs::remove(OF.TempFilename);
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000645 }
646 }
Reid Kleckner0aa128e2015-04-10 17:27:58 +0000647 } else if (!OF.Filename.empty() && EraseFiles)
648 llvm::sys::fs::remove(OF.Filename);
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000649 }
650 OutputFiles.clear();
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000651 NonSeekStream.reset();
Daniel Dunbar566eeb22009-11-13 10:37:48 +0000652}
653
Peter Collingbourne03f89072016-07-15 00:55:40 +0000654std::unique_ptr<raw_pwrite_stream>
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000655CompilerInstance::createDefaultOutputFile(bool Binary, StringRef InFile,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000656 StringRef Extension) {
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000657 return createOutputFile(getFrontendOpts().OutputFile, Binary,
Daniel Dunbarae77b3d2012-03-03 00:36:06 +0000658 /*RemoveFileOnSignal=*/true, InFile, Extension,
659 /*UseTemporary=*/true);
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000660}
661
Peter Collingbourne03f89072016-07-15 00:55:40 +0000662std::unique_ptr<raw_pwrite_stream> CompilerInstance::createNullOutputFile() {
663 return llvm::make_unique<llvm::raw_null_ostream>();
Alp Tokerea046722014-06-03 17:23:34 +0000664}
665
Peter Collingbourne03f89072016-07-15 00:55:40 +0000666std::unique_ptr<raw_pwrite_stream>
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000667CompilerInstance::createOutputFile(StringRef OutputPath, bool Binary,
668 bool RemoveFileOnSignal, StringRef InFile,
669 StringRef Extension, bool UseTemporary,
Daniel Dunbarb9c62c02012-03-03 00:36:02 +0000670 bool CreateMissingDirectories) {
Rafael Espindoladae941a2014-08-25 18:17:04 +0000671 std::string OutputPathName, TempPathName;
672 std::error_code EC;
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000673 std::unique_ptr<raw_pwrite_stream> OS = createOutputFile(
Rafael Espindoladae941a2014-08-25 18:17:04 +0000674 OutputPath, EC, Binary, RemoveFileOnSignal, InFile, Extension,
Rafael Espindolac80a4062015-04-10 14:30:43 +0000675 UseTemporary, CreateMissingDirectories, &OutputPathName, &TempPathName);
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000676 if (!OS) {
Rafael Espindoladae941a2014-08-25 18:17:04 +0000677 getDiagnostics().Report(diag::err_fe_unable_to_open_output) << OutputPath
678 << EC.message();
Craig Topper49a27902014-05-22 04:46:25 +0000679 return nullptr;
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000680 }
681
682 // Add the output file -- but don't try to remove "-", since this means we are
683 // using stdin.
Peter Collingbourne03f89072016-07-15 00:55:40 +0000684 addOutputFile(
685 OutputFile((OutputPathName != "-") ? OutputPathName : "", TempPathName));
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000686
Peter Collingbourne03f89072016-07-15 00:55:40 +0000687 return OS;
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000688}
689
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000690std::unique_ptr<llvm::raw_pwrite_stream> CompilerInstance::createOutputFile(
Rafael Espindoladae941a2014-08-25 18:17:04 +0000691 StringRef OutputPath, std::error_code &Error, bool Binary,
692 bool RemoveFileOnSignal, StringRef InFile, StringRef Extension,
693 bool UseTemporary, bool CreateMissingDirectories,
694 std::string *ResultPathName, std::string *TempPathName) {
Daniel Dunbarb9c62c02012-03-03 00:36:02 +0000695 assert((!CreateMissingDirectories || UseTemporary) &&
696 "CreateMissingDirectories is only allowed when using temporary files");
697
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000698 std::string OutFile, TempFile;
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000699 if (!OutputPath.empty()) {
700 OutFile = OutputPath;
701 } else if (InFile == "-") {
702 OutFile = "-";
703 } else if (!Extension.empty()) {
Rafael Espindola399ab332013-06-26 04:32:59 +0000704 SmallString<128> Path(InFile);
705 llvm::sys::path::replace_extension(Path, Extension);
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000706 OutFile = Path.str();
707 } else {
708 OutFile = "-";
709 }
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000710
Ahmed Charlesb8984322014-03-07 20:03:18 +0000711 std::unique_ptr<llvm::raw_fd_ostream> OS;
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000712 std::string OSFile;
713
Rafael Espindola73c23a72013-06-27 18:26:26 +0000714 if (UseTemporary) {
715 if (OutFile == "-")
716 UseTemporary = false;
717 else {
718 llvm::sys::fs::file_status Status;
719 llvm::sys::fs::status(OutputPath, Status);
720 if (llvm::sys::fs::exists(Status)) {
721 // Fail early if we can't write to the final destination.
Douglas Katzman8bfac2c2015-09-17 16:45:12 +0000722 if (!llvm::sys::fs::can_write(OutputPath)) {
Rafael Espindolaee4e08b2015-10-05 11:49:35 +0000723 Error = make_error_code(llvm::errc::operation_not_permitted);
Craig Topper49a27902014-05-22 04:46:25 +0000724 return nullptr;
Douglas Katzman8bfac2c2015-09-17 16:45:12 +0000725 }
Rafael Espindola73c23a72013-06-27 18:26:26 +0000726
727 // Don't use a temporary if the output is a special file. This handles
728 // things like '-o /dev/null'
729 if (!llvm::sys::fs::is_regular_file(Status))
730 UseTemporary = false;
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000731 }
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000732 }
733 }
734
Rafael Espindola73c23a72013-06-27 18:26:26 +0000735 if (UseTemporary) {
Rafael Espindola73c23a72013-06-27 18:26:26 +0000736 // Create a temporary file.
737 SmallString<128> TempPath;
738 TempPath = OutFile;
739 TempPath += "-%%%%%%%%";
740 int fd;
Rafael Espindolac0809172014-06-12 14:02:15 +0000741 std::error_code EC =
Yaron Keren92e1b622015-03-18 10:17:07 +0000742 llvm::sys::fs::createUniqueFile(TempPath, fd, TempPath);
Rafael Espindola157f34b2013-06-28 03:49:04 +0000743
744 if (CreateMissingDirectories &&
Rafael Espindola71de0b62014-06-13 17:20:50 +0000745 EC == llvm::errc::no_such_file_or_directory) {
Rafael Espindola157f34b2013-06-28 03:49:04 +0000746 StringRef Parent = llvm::sys::path::parent_path(OutputPath);
747 EC = llvm::sys::fs::create_directories(Parent);
748 if (!EC) {
Yaron Keren92e1b622015-03-18 10:17:07 +0000749 EC = llvm::sys::fs::createUniqueFile(TempPath, fd, TempPath);
Rafael Espindola157f34b2013-06-28 03:49:04 +0000750 }
751 }
752
753 if (!EC) {
NAKAMURA Takumi69f35282014-08-11 06:53:11 +0000754 OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
Rafael Espindola73c23a72013-06-27 18:26:26 +0000755 OSFile = TempFile = TempPath.str();
756 }
757 // If we failed to create the temporary, fallback to writing to the file
758 // directly. This handles the corner case where we cannot write to the
759 // directory, but can write to the file.
760 }
761
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000762 if (!OS) {
763 OSFile = OutFile;
NAKAMURA Takumi69f35282014-08-11 06:53:11 +0000764 OS.reset(new llvm::raw_fd_ostream(
Rafael Espindoladae941a2014-08-25 18:17:04 +0000765 OSFile, Error,
NAKAMURA Takumi69f35282014-08-11 06:53:11 +0000766 (Binary ? llvm::sys::fs::F_None : llvm::sys::fs::F_Text)));
Rafael Espindoladae941a2014-08-25 18:17:04 +0000767 if (Error)
Craig Topper49a27902014-05-22 04:46:25 +0000768 return nullptr;
Argyrios Kyrtzidis08a2bfd2011-07-28 00:45:10 +0000769 }
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000770
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000771 // Make sure the out stream file gets removed if we crash.
Daniel Dunbare326f9b2011-01-31 22:00:42 +0000772 if (RemoveFileOnSignal)
Rafael Espindola18556de2013-06-13 21:02:40 +0000773 llvm::sys::RemoveFileOnSignal(OSFile);
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000774
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000775 if (ResultPathName)
776 *ResultPathName = OutFile;
Argyrios Kyrtzidisd0599972010-09-17 17:38:48 +0000777 if (TempPathName)
778 *TempPathName = TempFile;
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000779
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000780 if (!Binary || OS->supportsSeeking())
781 return std::move(OS);
782
783 auto B = llvm::make_unique<llvm::buffer_ostream>(*OS);
784 assert(!NonSeekStream);
785 NonSeekStream = std::move(OS);
786 return std::move(B);
Daniel Dunbar420b0f12009-11-13 18:32:08 +0000787}
Daniel Dunbar409e8902009-11-14 07:53:04 +0000788
789// Initialization Utilities
790
Argyrios Kyrtzidis1b3240b2012-11-09 19:40:33 +0000791bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
Nico Weber2ca4be92016-03-01 23:16:44 +0000792 return InitializeSourceManager(
793 Input, getDiagnostics(), getFileManager(), getSourceManager(),
794 hasPreprocessor() ? &getPreprocessor().getHeaderSearchInfo() : nullptr,
Nico Weber4b5aede2016-03-13 02:44:13 +0000795 getDependencyOutputOpts(), getFrontendOpts());
Daniel Dunbar409e8902009-11-14 07:53:04 +0000796}
797
Nico Weber2ca4be92016-03-01 23:16:44 +0000798// static
Nico Weber4b5aede2016-03-13 02:44:13 +0000799bool CompilerInstance::InitializeSourceManager(
800 const FrontendInputFile &Input, DiagnosticsEngine &Diags,
801 FileManager &FileMgr, SourceManager &SourceMgr, HeaderSearch *HS,
802 DependencyOutputOptions &DepOpts, const FrontendOptions &Opts) {
Argyrios Kyrtzidis1b3240b2012-11-09 19:40:33 +0000803 SrcMgr::CharacteristicKind
Argyrios Kyrtzidis873c8582012-11-09 19:40:39 +0000804 Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
Argyrios Kyrtzidis1b3240b2012-11-09 19:40:33 +0000805
Argyrios Kyrtzidis6566e232012-11-09 19:40:45 +0000806 if (Input.isBuffer()) {
David Blaikie50a5f972014-08-29 07:59:55 +0000807 SourceMgr.setMainFileID(SourceMgr.createFileID(
808 std::unique_ptr<llvm::MemoryBuffer>(Input.getBuffer()), Kind));
Yaron Keren8b563662015-10-03 10:46:20 +0000809 assert(SourceMgr.getMainFileID().isValid() &&
Argyrios Kyrtzidis6566e232012-11-09 19:40:45 +0000810 "Couldn't establish MainFileID!");
811 return true;
812 }
813
814 StringRef InputFile = Input.getFile();
815
Argyrios Kyrtzidis7c06d862011-09-19 20:40:35 +0000816 // Figure out where to get and map in the main file.
817 if (InputFile != "-") {
Nico Weber2ca4be92016-03-01 23:16:44 +0000818 const FileEntry *File;
819 if (Opts.FindPchSource.empty()) {
820 File = FileMgr.getFile(InputFile, /*OpenFile=*/true);
821 } else {
822 // When building a pch file in clang-cl mode, the .h file is built as if
823 // it was included by a cc file. Since the driver doesn't know about
824 // all include search directories, the frontend must search the input
825 // file through HeaderSearch here, as if it had been included by the
826 // cc file at Opts.FindPchSource.
827 const FileEntry *FindFile = FileMgr.getFile(Opts.FindPchSource);
828 if (!FindFile) {
829 Diags.Report(diag::err_fe_error_reading) << Opts.FindPchSource;
830 return false;
831 }
832 const DirectoryLookup *UnusedCurDir;
833 SmallVector<std::pair<const FileEntry *, const DirectoryEntry *>, 16>
834 Includers;
835 Includers.push_back(std::make_pair(FindFile, FindFile->getDir()));
836 File = HS->LookupFile(InputFile, SourceLocation(), /*isAngled=*/false,
837 /*FromDir=*/nullptr,
838 /*CurDir=*/UnusedCurDir, Includers,
839 /*SearchPath=*/nullptr,
840 /*RelativePath=*/nullptr,
841 /*RequestingModule=*/nullptr,
842 /*SuggestedModule=*/nullptr, /*SkipCache=*/true);
Nico Weber4b5aede2016-03-13 02:44:13 +0000843 // Also add the header to /showIncludes output.
844 if (File)
Nico Weberf54146c2016-03-23 18:46:57 +0000845 DepOpts.ShowIncludesPretendHeader = File->getName();
Nico Weber2ca4be92016-03-01 23:16:44 +0000846 }
Dan Gohman52765212010-10-26 21:13:51 +0000847 if (!File) {
Daniel Dunbar409e8902009-11-14 07:53:04 +0000848 Diags.Report(diag::err_fe_error_reading) << InputFile;
849 return false;
850 }
Daniel Dunbare2951f42012-11-05 22:53:33 +0000851
852 // The natural SourceManager infrastructure can't currently handle named
853 // pipes, but we would at least like to accept them for the main
Benjamin Kramer3841fa32013-08-12 13:46:52 +0000854 // file. Detect them here, read them with the volatile flag so FileMgr will
855 // pick up the correct size, and simply override their contents as we do for
856 // STDIN.
Daniel Dunbare2951f42012-11-05 22:53:33 +0000857 if (File->isNamedPipe()) {
Benjamin Kramera8857962014-10-26 22:44:13 +0000858 auto MB = FileMgr.getBufferForFile(File, /*isVolatile=*/true);
859 if (MB) {
Benjamin Kramer3841fa32013-08-12 13:46:52 +0000860 // Create a new virtual file that will have the correct size.
Benjamin Kramera8857962014-10-26 22:44:13 +0000861 File = FileMgr.getVirtualFile(InputFile, (*MB)->getBufferSize(), 0);
862 SourceMgr.overrideFileContents(File, std::move(*MB));
Benjamin Kramer3841fa32013-08-12 13:46:52 +0000863 } else {
Benjamin Kramera8857962014-10-26 22:44:13 +0000864 Diags.Report(diag::err_cannot_open_file) << InputFile
865 << MB.getError().message();
Daniel Dunbare2951f42012-11-05 22:53:33 +0000866 return false;
867 }
Daniel Dunbare2951f42012-11-05 22:53:33 +0000868 }
Daniel Dunbardb0745a2012-11-27 00:04:16 +0000869
Alp Tokerb671e342014-05-21 01:12:41 +0000870 SourceMgr.setMainFileID(
871 SourceMgr.createFileID(File, SourceLocation(), Kind));
Daniel Dunbar409e8902009-11-14 07:53:04 +0000872 } else {
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000873 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> SBOrErr =
874 llvm::MemoryBuffer::getSTDIN();
875 if (std::error_code EC = SBOrErr.getError()) {
876 Diags.Report(diag::err_fe_error_reading_stdin) << EC.message();
Daniel Dunbar409e8902009-11-14 07:53:04 +0000877 return false;
878 }
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000879 std::unique_ptr<llvm::MemoryBuffer> SB = std::move(SBOrErr.get());
880
Dan Gohman2f76cd72010-10-26 23:21:25 +0000881 const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
Chris Lattner5159f612010-11-23 08:35:12 +0000882 SB->getBufferSize(), 0);
Alp Tokerb671e342014-05-21 01:12:41 +0000883 SourceMgr.setMainFileID(
884 SourceMgr.createFileID(File, SourceLocation(), Kind));
David Blaikie49cc3182014-08-27 20:54:45 +0000885 SourceMgr.overrideFileContents(File, std::move(SB));
Daniel Dunbar409e8902009-11-14 07:53:04 +0000886 }
887
Yaron Keren8b563662015-10-03 10:46:20 +0000888 assert(SourceMgr.getMainFileID().isValid() &&
Dan Gohman52765212010-10-26 21:13:51 +0000889 "Couldn't establish MainFileID!");
Daniel Dunbar409e8902009-11-14 07:53:04 +0000890 return true;
891}
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000892
893// High-Level Operations
894
895bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
896 assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
897 assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
898 assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
899
900 // FIXME: Take this as an argument, once all the APIs we used have moved to
901 // taking it as an input instead of hard-coding llvm::errs.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000902 raw_ostream &OS = llvm::errs();
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000903
904 // Create the target instance.
Alp Toker80758082014-07-06 05:26:44 +0000905 setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(),
Saleem Abdulrasool10a49722016-04-08 16:52:00 +0000906 getInvocation().TargetOpts));
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000907 if (!hasTarget())
908 return false;
909
Artem Belevichb5bc9232015-09-22 17:23:22 +0000910 // Create TargetInfo for the other side of CUDA compilation.
911 if (getLangOpts().CUDA && !getFrontendOpts().AuxTriple.empty()) {
Justin Lebar76945b22016-04-29 23:05:19 +0000912 auto TO = std::make_shared<TargetOptions>();
Artem Belevichb5bc9232015-09-22 17:23:22 +0000913 TO->Triple = getFrontendOpts().AuxTriple;
Justin Lebar76945b22016-04-29 23:05:19 +0000914 TO->HostTriple = getTarget().getTriple().str();
Saleem Abdulrasool10a49722016-04-08 16:52:00 +0000915 setAuxTarget(TargetInfo::CreateTargetInfo(getDiagnostics(), TO));
Artem Belevichb5bc9232015-09-22 17:23:22 +0000916 }
917
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000918 // Inform the target of the language options.
919 //
920 // FIXME: We shouldn't need to do this, the target should be immutable once
921 // created. This complexity should be lifted elsewhere.
Alp Toker74437972014-07-06 05:14:24 +0000922 getTarget().adjust(getLangOpts());
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000923
Yaxun Liu2c17e822016-08-09 19:43:38 +0000924 // Adjust target options based on codegen options.
925 getTarget().adjustTargetOptions(getCodeGenOpts(), getTargetOpts());
926
Fariborz Jahanian29898f42012-04-16 21:03:30 +0000927 // rewriter project will change target built-in bool type from its default.
928 if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
929 getTarget().noSignedCharForObjCBool();
930
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000931 // Validate/process some options.
932 if (getHeaderSearchOpts().Verbose)
933 OS << "clang -cc1 version " CLANG_VERSION_STRING
Alp Tokerf988d002014-06-06 10:36:22 +0000934 << " based upon " << BACKEND_PACKAGE_STRING
Sebastian Pop8188c8a2011-11-01 21:33:06 +0000935 << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000936
937 if (getFrontendOpts().ShowTimers)
938 createFrontendTimer();
939
Matthias Braunabb6eea2016-09-26 18:53:34 +0000940 if (getFrontendOpts().ShowStats || !getFrontendOpts().StatsFile.empty())
Matthias Braunec1c5a22016-09-27 19:38:59 +0000941 llvm::EnableStatistics(false);
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000942
Vedant Kumar5b60ad62015-11-16 00:59:34 +0000943 for (const FrontendInputFile &FIF : getFrontendOpts().Inputs) {
Ted Kremenekeeccb302014-08-27 15:14:15 +0000944 // Reset the ID tables if we are reusing the SourceManager and parsing
945 // regular files.
946 if (hasSourceManager() && !Act.isModelParsingAction())
Daniel Dunbaraed46fc2010-06-07 23:23:50 +0000947 getSourceManager().clearIDTables();
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000948
Vedant Kumar5b60ad62015-11-16 00:59:34 +0000949 if (Act.BeginSourceFile(*this, FIF)) {
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000950 Act.Execute();
951 Act.EndSourceFile();
952 }
953 }
954
Argyrios Kyrtzidis7910d7b2011-12-07 05:52:12 +0000955 // Notify the diagnostic client that all files were processed.
956 getDiagnostics().getClient()->finish();
957
Chris Lattner198cb4d2010-04-07 18:47:42 +0000958 if (getDiagnosticOpts().ShowCarets) {
Argyrios Kyrtzidisc79346a2010-11-18 20:06:46 +0000959 // We can have multiple diagnostics sharing one diagnostic client.
960 // Get the total number of warnings/errors from the client.
961 unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
962 unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +0000963
Chris Lattner198cb4d2010-04-07 18:47:42 +0000964 if (NumWarnings)
965 OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
966 if (NumWarnings && NumErrors)
967 OS << " and ";
968 if (NumErrors)
969 OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
970 if (NumWarnings || NumErrors)
971 OS << " generated.\n";
972 }
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000973
Matthias Braunabb6eea2016-09-26 18:53:34 +0000974 if (getFrontendOpts().ShowStats) {
975 if (hasFileManager()) {
976 getFileManager().PrintStats();
977 OS << '\n';
978 }
979 llvm::PrintStatistics(OS);
980 }
981 StringRef StatsFile = getFrontendOpts().StatsFile;
982 if (!StatsFile.empty()) {
983 std::error_code EC;
984 auto StatS = llvm::make_unique<llvm::raw_fd_ostream>(StatsFile, EC,
985 llvm::sys::fs::F_Text);
986 if (EC) {
987 getDiagnostics().Report(diag::warn_fe_unable_to_open_stats_file)
988 << StatsFile << EC.message();
989 } else {
990 llvm::PrintStatisticsJSON(*StatS);
991 }
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000992 }
993
Argyrios Kyrtzidisbc467932010-11-18 21:13:57 +0000994 return !getDiagnostics().getClient()->getNumErrors();
Daniel Dunbar4f2bc552010-01-13 00:48:06 +0000995}
996
Douglas Gregorfaeb1d42011-09-12 23:31:24 +0000997/// \brief Determine the appropriate source input kind based on language
998/// options.
999static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
1000 if (LangOpts.OpenCL)
1001 return IK_OpenCL;
1002 if (LangOpts.CUDA)
1003 return IK_CUDA;
1004 if (LangOpts.ObjC1)
1005 return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
1006 return LangOpts.CPlusPlus? IK_CXX : IK_C;
1007}
1008
Douglas Gregor514b6362011-11-29 19:06:37 +00001009/// \brief Compile a module file for the given module, using the options
Ben Langmuirb797d592014-07-19 16:29:28 +00001010/// provided by the importing compiler instance. Returns true if the module
1011/// was built without errors.
1012static bool compileModuleImpl(CompilerInstance &ImportingInstance,
1013 SourceLocation ImportLoc,
1014 Module *Module,
1015 StringRef ModuleFileName) {
Douglas Gregor514b6362011-11-29 19:06:37 +00001016 ModuleMap &ModMap
1017 = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
1018
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001019 // Construct a compiler invocation for creating this module.
David Blaikieea4395e2017-01-06 19:49:01 +00001020 auto Invocation =
1021 std::make_shared<CompilerInvocation>(ImportingInstance.getInvocation());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +00001022
Douglas Gregorf545f672011-11-29 21:59:16 +00001023 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
1024
Douglas Gregor44bf68d2011-09-15 20:53:28 +00001025 // For any options that aren't intended to affect how a module is built,
1026 // reset them to their default values.
Ted Kremenek8cf47df2011-11-17 23:01:24 +00001027 Invocation->getLangOpts()->resetNonModularOptions();
Douglas Gregorf545f672011-11-29 21:59:16 +00001028 PPOpts.resetNonModularOptions();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +00001029
Douglas Gregor5dc38992013-02-07 00:21:12 +00001030 // Remove any macro definitions that are explicitly ignored by the module.
1031 // They aren't supposed to affect how the module is built anyway.
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001032 HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00001033 PPOpts.Macros.erase(
1034 std::remove_if(PPOpts.Macros.begin(), PPOpts.Macros.end(),
1035 [&HSOpts](const std::pair<std::string, bool> &def) {
1036 StringRef MacroDef = def.first;
Justin Lebar5e83dfe2016-10-21 21:45:01 +00001037 return HSOpts.ModulesIgnoreMacros.count(
1038 llvm::CachedHashString(MacroDef.split('=').first)) > 0;
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00001039 }),
1040 PPOpts.Macros.end());
Douglas Gregor5dc38992013-02-07 00:21:12 +00001041
Douglas Gregor7d106e42011-11-15 19:35:01 +00001042 // Note the name of the module we're building.
Douglas Gregor6dc57922011-11-29 18:31:39 +00001043 Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
Douglas Gregor7d106e42011-11-15 19:35:01 +00001044
Douglas Gregor7a626572012-11-29 23:55:25 +00001045 // Make sure that the failed-module structure has been allocated in
1046 // the importing instance, and propagate the pointer to the newly-created
1047 // instance.
1048 PreprocessorOptions &ImportingPPOpts
1049 = ImportingInstance.getInvocation().getPreprocessorOpts();
1050 if (!ImportingPPOpts.FailedModules)
David Blaikief95113d2017-01-05 19:11:31 +00001051 ImportingPPOpts.FailedModules =
1052 std::make_shared<PreprocessorOptions::FailedModulesSet>();
Douglas Gregor7a626572012-11-29 23:55:25 +00001053 PPOpts.FailedModules = ImportingPPOpts.FailedModules;
1054
Douglas Gregorf545f672011-11-29 21:59:16 +00001055 // If there is a module map file, build the module using the module map.
Douglas Gregor44bf68d2011-09-15 20:53:28 +00001056 // Set up the inputs/outputs so that we build the module from its umbrella
1057 // header.
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001058 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
Douglas Gregor1735f4e2011-09-13 23:15:45 +00001059 FrontendOpts.OutputFile = ModuleFileName.str();
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001060 FrontendOpts.DisableFree = false;
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001061 FrontendOpts.GenerateGlobalModuleIndex = false;
Richard Smithe75ee0f2015-08-17 07:13:32 +00001062 FrontendOpts.BuildingImplicitModule = true;
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001063 // Force implicitly-built modules to hash the content of the module file.
1064 HSOpts.ModulesHashContent = true;
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001065 FrontendOpts.Inputs.clear();
Douglas Gregorf545f672011-11-29 21:59:16 +00001066 InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
NAKAMURA Takumi82a35112011-10-08 11:31:46 +00001067
Douglas Gregorf545f672011-11-29 21:59:16 +00001068 // Don't free the remapped file buffers; they are owned by our caller.
1069 PPOpts.RetainRemappedFileBuffers = true;
1070
Douglas Gregor2b9b4642011-09-13 01:26:44 +00001071 Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
Douglas Gregor3728ea72011-09-13 23:20:27 +00001072 assert(ImportingInstance.getInvocation().getModuleHash() ==
Douglas Gregorf545f672011-11-29 21:59:16 +00001073 Invocation->getModuleHash() && "Module hash mismatch!");
1074
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001075 // Construct a compiler instance that will be used to actually create the
1076 // module.
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001077 CompilerInstance Instance(ImportingInstance.getPCHContainerOperations(),
1078 /*BuildingModule=*/true);
David Blaikieea4395e2017-01-06 19:49:01 +00001079 auto &Inv = *Invocation;
1080 Instance.setInvocation(std::move(Invocation));
Douglas Gregor6b930962013-05-03 22:58:43 +00001081
1082 Instance.createDiagnostics(new ForwardingDiagnosticConsumer(
1083 ImportingInstance.getDiagnosticClient()),
Douglas Gregor30071cea2013-05-03 23:07:45 +00001084 /*ShouldOwnClient=*/true);
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001085
Ben Langmuirc8130a72014-02-20 21:59:23 +00001086 Instance.setVirtualFileSystem(&ImportingInstance.getVirtualFileSystem());
1087
Douglas Gregor63365432012-11-30 22:11:57 +00001088 // Note that this module is part of the module build stack, so that we
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001089 // can detect cycles in the module graph.
Ben Langmuird066d4c2014-02-28 21:16:07 +00001090 Instance.setFileManager(&ImportingInstance.getFileManager());
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001091 Instance.createSourceManager(Instance.getFileManager());
1092 SourceManager &SourceMgr = Instance.getSourceManager();
Douglas Gregor63365432012-11-30 22:11:57 +00001093 SourceMgr.setModuleBuildStack(
1094 ImportingInstance.getSourceManager().getModuleBuildStack());
1095 SourceMgr.pushModuleBuildStack(Module->getTopLevelModuleName(),
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001096 FullSourceLoc(ImportLoc, ImportingInstance.getSourceManager()));
1097
Justin Bogner86d12592014-06-19 19:36:03 +00001098 // If we're collecting module dependencies, we need to share a collector
Richard Smith38c1e6d2015-08-09 06:03:55 +00001099 // between all of the module CompilerInstances. Other than that, we don't
1100 // want to produce any dependency output from the module build.
Justin Bogner86d12592014-06-19 19:36:03 +00001101 Instance.setModuleDepCollector(ImportingInstance.getModuleDepCollector());
David Blaikieea4395e2017-01-06 19:49:01 +00001102 Inv.getDependencyOutputOpts() = DependencyOutputOptions();
Justin Bogner86d12592014-06-19 19:36:03 +00001103
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001104 // Get or create the module map that we'll use to build this module.
1105 std::string InferredModuleMapContent;
1106 if (const FileEntry *ModuleMapFile =
1107 ModMap.getContainingModuleMapFile(Module)) {
1108 // Use the module map where this module resides.
Benjamin Kramer3204b152015-05-29 19:42:19 +00001109 FrontendOpts.Inputs.emplace_back(ModuleMapFile->getName(), IK);
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001110 } else {
Richard Smith2b63d152015-05-16 02:28:53 +00001111 SmallString<128> FakeModuleMapFile(Module->Directory->getName());
1112 llvm::sys::path::append(FakeModuleMapFile, "__inferred_module.map");
Benjamin Kramer3204b152015-05-29 19:42:19 +00001113 FrontendOpts.Inputs.emplace_back(FakeModuleMapFile, IK);
Richard Smith2b63d152015-05-16 02:28:53 +00001114
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001115 llvm::raw_string_ostream OS(InferredModuleMapContent);
1116 Module->print(OS);
1117 OS.flush();
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001118
Rafael Espindolad87f8d72014-08-27 20:03:29 +00001119 std::unique_ptr<llvm::MemoryBuffer> ModuleMapBuffer =
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001120 llvm::MemoryBuffer::getMemBuffer(InferredModuleMapContent);
1121 ModuleMapFile = Instance.getFileManager().getVirtualFile(
Richard Smith2b63d152015-05-16 02:28:53 +00001122 FakeModuleMapFile, InferredModuleMapContent.size(), 0);
David Blaikie49cc3182014-08-27 20:54:45 +00001123 SourceMgr.overrideFileContents(ModuleMapFile, std::move(ModuleMapBuffer));
Manuel Klimek1f76c4e2013-10-24 07:51:24 +00001124 }
Douglas Gregoraf8f0262012-11-30 18:38:50 +00001125
Ben Langmuir9d6448b2014-08-09 00:57:23 +00001126 // Construct a module-generating action. Passing through the module map is
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001127 // safe because the FileManager is shared between the compiler instances.
Richard Smithbbcc9f02016-08-26 00:14:38 +00001128 GenerateModuleFromModuleMapAction CreateModuleAction(
Ben Langmuir9d6448b2014-08-09 00:57:23 +00001129 ModMap.getModuleMapFileForUniquing(Module), Module->IsSystem);
Richard Smith99891da2014-10-14 02:08:30 +00001130
1131 ImportingInstance.getDiagnostics().Report(ImportLoc,
1132 diag::remark_module_build)
1133 << Module->Name << ModuleFileName;
1134
Douglas Gregor51e0b542011-10-04 00:21:21 +00001135 // Execute the action to actually build the module in-place. Use a separate
1136 // thread so that we get a stack large enough.
1137 const unsigned ThreadStackSize = 8 << 20;
1138 llvm::CrashRecoveryContext CRC;
Richard Smith841f1c72014-03-04 21:50:01 +00001139 CRC.RunSafelyOnThread([&]() { Instance.ExecuteAction(CreateModuleAction); },
1140 ThreadStackSize);
Douglas Gregor6b930962013-05-03 22:58:43 +00001141
Richard Smith99891da2014-10-14 02:08:30 +00001142 ImportingInstance.getDiagnostics().Report(ImportLoc,
1143 diag::remark_module_build_done)
1144 << Module->Name;
1145
Douglas Gregorf545f672011-11-29 21:59:16 +00001146 // Delete the temporary module map file.
1147 // FIXME: Even though we're executing under crash protection, it would still
1148 // be nice to do this with RemoveFileOnSignal when we can. However, that
1149 // doesn't make sense for all clients, so clean this up manually.
Benjamin Kramer13afbf42012-10-14 19:50:53 +00001150 Instance.clearOutputFiles(/*EraseFiles=*/true);
Douglas Gregor5e306b12013-01-23 22:38:11 +00001151
1152 // We've rebuilt a module. If we're allowed to generate or update the global
1153 // module index, record that fact in the importing compiler instance.
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001154 if (ImportingInstance.getFrontendOpts().GenerateGlobalModuleIndex) {
Douglas Gregor5e306b12013-01-23 22:38:11 +00001155 ImportingInstance.setBuildGlobalModuleIndex(true);
1156 }
Ben Langmuirb797d592014-07-19 16:29:28 +00001157
1158 return !Instance.getDiagnostics().hasErrorOccurred();
NAKAMURA Takumi82a35112011-10-08 11:31:46 +00001159}
Douglas Gregorfaeb1d42011-09-12 23:31:24 +00001160
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001161static bool compileAndLoadModule(CompilerInstance &ImportingInstance,
1162 SourceLocation ImportLoc,
Ben Langmuirb797d592014-07-19 16:29:28 +00001163 SourceLocation ModuleNameLoc, Module *Module,
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001164 StringRef ModuleFileName) {
Ben Langmuird213aab2014-09-26 22:42:23 +00001165 DiagnosticsEngine &Diags = ImportingInstance.getDiagnostics();
1166
Ben Langmuirb797d592014-07-19 16:29:28 +00001167 auto diagnoseBuildFailure = [&] {
Ben Langmuird213aab2014-09-26 22:42:23 +00001168 Diags.Report(ModuleNameLoc, diag::err_module_not_built)
Ben Langmuirb797d592014-07-19 16:29:28 +00001169 << Module->Name << SourceRange(ImportLoc, ModuleNameLoc);
1170 };
1171
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001172 // FIXME: have LockFileManager return an error_code so that we can
1173 // avoid the mkdir when the directory already exists.
1174 StringRef Dir = llvm::sys::path::parent_path(ModuleFileName);
1175 llvm::sys::fs::create_directories(Dir);
1176
1177 while (1) {
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001178 unsigned ModuleLoadCapabilities = ASTReader::ARR_Missing;
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001179 llvm::LockFileManager Locked(ModuleFileName);
1180 switch (Locked) {
1181 case llvm::LockFileManager::LFS_Error:
Ben Langmuird213aab2014-09-26 22:42:23 +00001182 Diags.Report(ModuleNameLoc, diag::err_module_lock_failure)
Bruno Cardoso Lopes4a522222016-06-04 01:13:22 +00001183 << Module->Name << Locked.getErrorMessage();
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001184 return false;
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001185
1186 case llvm::LockFileManager::LFS_Owned:
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001187 // We're responsible for building the module ourselves.
Ben Langmuirb797d592014-07-19 16:29:28 +00001188 if (!compileModuleImpl(ImportingInstance, ModuleNameLoc, Module,
1189 ModuleFileName)) {
1190 diagnoseBuildFailure();
1191 return false;
1192 }
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001193 break;
1194
1195 case llvm::LockFileManager::LFS_Shared:
1196 // Someone else is responsible for building the module. Wait for them to
1197 // finish.
Ben Langmuir1daf4802015-02-09 20:35:13 +00001198 switch (Locked.waitForUnlock()) {
1199 case llvm::LockFileManager::Res_Success:
1200 ModuleLoadCapabilities |= ASTReader::ARR_OutOfDate;
1201 break;
1202 case llvm::LockFileManager::Res_OwnerDied:
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001203 continue; // try again to get the lock.
Ben Langmuir1daf4802015-02-09 20:35:13 +00001204 case llvm::LockFileManager::Res_Timeout:
1205 Diags.Report(ModuleNameLoc, diag::err_module_lock_timeout)
1206 << Module->Name;
1207 // Clear the lock file so that future invokations can make progress.
1208 Locked.unsafeRemoveLockFile();
1209 return false;
1210 }
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001211 break;
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001212 }
1213
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001214 // Try to read the module file, now that we've compiled it.
1215 ASTReader::ASTReadResult ReadResult =
1216 ImportingInstance.getModuleManager()->ReadAST(
Richard Smithe842a472014-10-22 02:05:46 +00001217 ModuleFileName, serialization::MK_ImplicitModule, ImportLoc,
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001218 ModuleLoadCapabilities);
1219
1220 if (ReadResult == ASTReader::OutOfDate &&
1221 Locked == llvm::LockFileManager::LFS_Shared) {
1222 // The module may be out of date in the presence of file system races,
1223 // or if one of its imports depends on header search paths that are not
1224 // consistent with this ImportingInstance. Try again...
1225 continue;
1226 } else if (ReadResult == ASTReader::Missing) {
Ben Langmuirb797d592014-07-19 16:29:28 +00001227 diagnoseBuildFailure();
Ben Langmuird213aab2014-09-26 22:42:23 +00001228 } else if (ReadResult != ASTReader::Success &&
1229 !Diags.hasErrorOccurred()) {
1230 // The ASTReader didn't diagnose the error, so conservatively report it.
1231 diagnoseBuildFailure();
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001232 }
1233 return ReadResult == ASTReader::Success;
Argyrios Kyrtzidis4382fe72014-04-06 03:21:44 +00001234 }
1235}
1236
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001237/// \brief Diagnose differences between the current definition of the given
1238/// configuration macro and the definition provided on the command line.
1239static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
1240 Module *Mod, SourceLocation ImportLoc) {
1241 IdentifierInfo *Id = PP.getIdentifierInfo(ConfigMacro);
1242 SourceManager &SourceMgr = PP.getSourceManager();
1243
1244 // If this identifier has never had a macro definition, then it could
1245 // not have changed.
1246 if (!Id->hadMacroDefinition())
1247 return;
Richard Smith20e883e2015-04-29 23:20:19 +00001248 auto *LatestLocalMD = PP.getLocalMacroDirectiveHistory(Id);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001249
Richard Smith20e883e2015-04-29 23:20:19 +00001250 // Find the macro definition from the command line.
1251 MacroInfo *CmdLineDefinition = nullptr;
1252 for (auto *MD = LatestLocalMD; MD; MD = MD->getPrevious()) {
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001253 // We only care about the predefines buffer.
Richard Smith20e883e2015-04-29 23:20:19 +00001254 FileID FID = SourceMgr.getFileID(MD->getLocation());
1255 if (FID.isInvalid() || FID != PP.getPredefinesFileID())
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001256 continue;
Richard Smith20e883e2015-04-29 23:20:19 +00001257 if (auto *DMD = dyn_cast<DefMacroDirective>(MD))
1258 CmdLineDefinition = DMD->getMacroInfo();
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001259 break;
1260 }
1261
Richard Smith20e883e2015-04-29 23:20:19 +00001262 auto *CurrentDefinition = PP.getMacroInfo(Id);
1263 if (CurrentDefinition == CmdLineDefinition) {
1264 // Macro matches. Nothing to do.
1265 } else if (!CurrentDefinition) {
1266 // This macro was defined on the command line, then #undef'd later.
1267 // Complain.
1268 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1269 << true << ConfigMacro << Mod->getFullModuleName();
1270 auto LatestDef = LatestLocalMD->getDefinition();
1271 assert(LatestDef.isUndefined() &&
1272 "predefined macro went away with no #undef?");
1273 PP.Diag(LatestDef.getUndefLocation(), diag::note_module_def_undef_here)
1274 << true;
1275 return;
1276 } else if (!CmdLineDefinition) {
1277 // There was no definition for this macro in the predefines buffer,
1278 // but there was a local definition. Complain.
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001279 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1280 << false << ConfigMacro << Mod->getFullModuleName();
Richard Smith20e883e2015-04-29 23:20:19 +00001281 PP.Diag(CurrentDefinition->getDefinitionLoc(),
1282 diag::note_module_def_undef_here)
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001283 << false;
Richard Smith20e883e2015-04-29 23:20:19 +00001284 } else if (!CurrentDefinition->isIdenticalTo(*CmdLineDefinition, PP,
1285 /*Syntactically=*/true)) {
1286 // The macro definitions differ.
1287 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1288 << false << ConfigMacro << Mod->getFullModuleName();
1289 PP.Diag(CurrentDefinition->getDefinitionLoc(),
1290 diag::note_module_def_undef_here)
1291 << false;
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001292 }
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001293}
1294
Douglas Gregor527b1c92013-03-25 21:19:16 +00001295/// \brief Write a new timestamp file with the given path.
1296static void writeTimestampFile(StringRef TimestampFile) {
Rafael Espindoladae941a2014-08-25 18:17:04 +00001297 std::error_code EC;
1298 llvm::raw_fd_ostream Out(TimestampFile.str(), EC, llvm::sys::fs::F_None);
Douglas Gregor527b1c92013-03-25 21:19:16 +00001299}
1300
1301/// \brief Prune the module cache of modules that haven't been accessed in
1302/// a long time.
1303static void pruneModuleCache(const HeaderSearchOptions &HSOpts) {
1304 struct stat StatBuf;
1305 llvm::SmallString<128> TimestampFile;
1306 TimestampFile = HSOpts.ModuleCachePath;
Richard Smith3938f0c2015-08-15 00:34:15 +00001307 assert(!TimestampFile.empty());
Douglas Gregor527b1c92013-03-25 21:19:16 +00001308 llvm::sys::path::append(TimestampFile, "modules.timestamp");
1309
1310 // Try to stat() the timestamp file.
1311 if (::stat(TimestampFile.c_str(), &StatBuf)) {
1312 // If the timestamp file wasn't there, create one now.
1313 if (errno == ENOENT) {
1314 writeTimestampFile(TimestampFile);
1315 }
1316 return;
1317 }
1318
1319 // Check whether the time stamp is older than our pruning interval.
1320 // If not, do nothing.
1321 time_t TimeStampModTime = StatBuf.st_mtime;
Craig Topper49a27902014-05-22 04:46:25 +00001322 time_t CurrentTime = time(nullptr);
Benjamin Kramerdbcf5032013-03-29 17:39:43 +00001323 if (CurrentTime - TimeStampModTime <= time_t(HSOpts.ModuleCachePruneInterval))
Douglas Gregor527b1c92013-03-25 21:19:16 +00001324 return;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001325
1326 // Write a new timestamp file so that nobody else attempts to prune.
1327 // There is a benign race condition here, if two Clang instances happen to
1328 // notice at the same time that the timestamp is out-of-date.
1329 writeTimestampFile(TimestampFile);
1330
1331 // Walk the entire module cache, looking for unused module files and module
1332 // indices.
Rafael Espindolac0809172014-06-12 14:02:15 +00001333 std::error_code EC;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001334 SmallString<128> ModuleCachePathNative;
1335 llvm::sys::path::native(HSOpts.ModuleCachePath, ModuleCachePathNative);
Yaron Keren92e1b622015-03-18 10:17:07 +00001336 for (llvm::sys::fs::directory_iterator Dir(ModuleCachePathNative, EC), DirEnd;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001337 Dir != DirEnd && !EC; Dir.increment(EC)) {
1338 // If we don't have a directory, there's nothing to look into.
Rafael Espindolaa07f7202013-07-17 04:23:07 +00001339 if (!llvm::sys::fs::is_directory(Dir->path()))
Douglas Gregor527b1c92013-03-25 21:19:16 +00001340 continue;
1341
1342 // Walk all of the files within this directory.
Douglas Gregor527b1c92013-03-25 21:19:16 +00001343 for (llvm::sys::fs::directory_iterator File(Dir->path(), EC), FileEnd;
1344 File != FileEnd && !EC; File.increment(EC)) {
1345 // We only care about module and global module index files.
Dmitri Gribenkof430da42014-02-12 10:33:14 +00001346 StringRef Extension = llvm::sys::path::extension(File->path());
1347 if (Extension != ".pcm" && Extension != ".timestamp" &&
1348 llvm::sys::path::filename(File->path()) != "modules.idx")
Douglas Gregor527b1c92013-03-25 21:19:16 +00001349 continue;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001350
1351 // Look at this file. If we can't stat it, there's nothing interesting
1352 // there.
Dmitri Gribenkof430da42014-02-12 10:33:14 +00001353 if (::stat(File->path().c_str(), &StatBuf))
Douglas Gregor527b1c92013-03-25 21:19:16 +00001354 continue;
Douglas Gregor527b1c92013-03-25 21:19:16 +00001355
1356 // If the file has been used recently enough, leave it there.
1357 time_t FileAccessTime = StatBuf.st_atime;
Benjamin Kramerdbcf5032013-03-29 17:39:43 +00001358 if (CurrentTime - FileAccessTime <=
1359 time_t(HSOpts.ModuleCachePruneAfter)) {
Douglas Gregor527b1c92013-03-25 21:19:16 +00001360 continue;
1361 }
1362
1363 // Remove the file.
Dmitri Gribenkof430da42014-02-12 10:33:14 +00001364 llvm::sys::fs::remove(File->path());
1365
1366 // Remove the timestamp file.
1367 std::string TimpestampFilename = File->path() + ".timestamp";
1368 llvm::sys::fs::remove(TimpestampFilename);
Douglas Gregor527b1c92013-03-25 21:19:16 +00001369 }
1370
1371 // If we removed all of the files in the directory, remove the directory
1372 // itself.
Dmitri Gribenkof430da42014-02-12 10:33:14 +00001373 if (llvm::sys::fs::directory_iterator(Dir->path(), EC) ==
1374 llvm::sys::fs::directory_iterator() && !EC)
Rafael Espindola2a008782014-01-10 21:32:14 +00001375 llvm::sys::fs::remove(Dir->path());
Douglas Gregor527b1c92013-03-25 21:19:16 +00001376 }
1377}
1378
John Thompson2255f2c2014-04-23 12:57:01 +00001379void CompilerInstance::createModuleManager() {
1380 if (!ModuleManager) {
1381 if (!hasASTContext())
1382 createASTContext();
1383
Chandler Carruth580dd292015-03-24 21:44:25 +00001384 // If we're implicitly building modules but not currently recursively
1385 // building a module, check whether we need to prune the module cache.
Richard Smith3938f0c2015-08-15 00:34:15 +00001386 if (getSourceManager().getModuleBuildStack().empty() &&
1387 !getPreprocessor().getHeaderSearchInfo().getModuleCachePath().empty() &&
John Thompson2255f2c2014-04-23 12:57:01 +00001388 getHeaderSearchOpts().ModuleCachePruneInterval > 0 &&
1389 getHeaderSearchOpts().ModuleCachePruneAfter > 0) {
1390 pruneModuleCache(getHeaderSearchOpts());
1391 }
1392
1393 HeaderSearchOptions &HSOpts = getHeaderSearchOpts();
1394 std::string Sysroot = HSOpts.Sysroot;
1395 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
Richard Smithce18a182015-07-14 00:26:00 +00001396 std::unique_ptr<llvm::Timer> ReadTimer;
1397 if (FrontendTimerGroup)
Matthias Braunae032b62016-11-18 19:43:25 +00001398 ReadTimer = llvm::make_unique<llvm::Timer>("reading_modules",
1399 "Reading modules",
Richard Smithce18a182015-07-14 00:26:00 +00001400 *FrontendTimerGroup);
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001401 ModuleManager = new ASTReader(
Richard Smith293534b2015-08-18 20:39:29 +00001402 getPreprocessor(), getASTContext(), getPCHContainerReader(),
Douglas Gregor6623e1f2015-11-03 18:33:07 +00001403 getFrontendOpts().ModuleFileExtensions,
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001404 Sysroot.empty() ? "" : Sysroot.c_str(), PPOpts.DisablePCHValidation,
1405 /*AllowASTWithCompilerErrors=*/false,
1406 /*AllowConfigurationMismatch=*/false,
1407 HSOpts.ModulesValidateSystemHeaders,
Richard Smithce18a182015-07-14 00:26:00 +00001408 getFrontendOpts().UseGlobalModuleIndex,
1409 std::move(ReadTimer));
John Thompson2255f2c2014-04-23 12:57:01 +00001410 if (hasASTConsumer()) {
1411 ModuleManager->setDeserializationListener(
1412 getASTConsumer().GetASTDeserializationListener());
1413 getASTContext().setASTMutationListener(
1414 getASTConsumer().GetASTMutationListener());
1415 }
1416 getASTContext().setExternalSource(ModuleManager);
1417 if (hasSema())
1418 ModuleManager->InitializeSema(getSema());
Richard Smith293534b2015-08-18 20:39:29 +00001419 if (hasASTConsumer())
John Thompson2255f2c2014-04-23 12:57:01 +00001420 ModuleManager->StartTranslationUnit(&getASTConsumer());
Richard Smith03f7e612015-08-09 02:28:42 +00001421
1422 if (TheDependencyFileGenerator)
1423 TheDependencyFileGenerator->AttachToASTReader(*ModuleManager);
Richard Smith03f7e612015-08-09 02:28:42 +00001424 for (auto &Listener : DependencyCollectors)
1425 Listener->attachToASTReader(*ModuleManager);
John Thompson2255f2c2014-04-23 12:57:01 +00001426 }
1427}
1428
Richard Smithd4b230b2014-10-27 23:01:16 +00001429bool CompilerInstance::loadModuleFile(StringRef FileName) {
Richard Smithce18a182015-07-14 00:26:00 +00001430 llvm::Timer Timer;
1431 if (FrontendTimerGroup)
Matthias Braunae032b62016-11-18 19:43:25 +00001432 Timer.init("preloading." + FileName.str(), "Preloading " + FileName.str(),
1433 *FrontendTimerGroup);
Richard Smithce18a182015-07-14 00:26:00 +00001434 llvm::TimeRegion TimeLoading(FrontendTimerGroup ? &Timer : nullptr);
1435
Richard Smithd4b230b2014-10-27 23:01:16 +00001436 // Helper to recursively read the module names for all modules we're adding.
1437 // We mark these as known and redirect any attempt to load that module to
1438 // the files we were handed.
1439 struct ReadModuleNames : ASTReaderListener {
1440 CompilerInstance &CI;
Richard Smith0f99d6a2015-08-09 08:48:41 +00001441 llvm::SmallVector<IdentifierInfo*, 8> LoadedModules;
Richard Smithe842a472014-10-22 02:05:46 +00001442
Richard Smith0f99d6a2015-08-09 08:48:41 +00001443 ReadModuleNames(CompilerInstance &CI) : CI(CI) {}
Richard Smithe842a472014-10-22 02:05:46 +00001444
Richard Smithd4b230b2014-10-27 23:01:16 +00001445 void ReadModuleName(StringRef ModuleName) override {
Richard Smith0f99d6a2015-08-09 08:48:41 +00001446 LoadedModules.push_back(
1447 CI.getPreprocessor().getIdentifierInfo(ModuleName));
Richard Smithd4b230b2014-10-27 23:01:16 +00001448 }
Richard Smith0f99d6a2015-08-09 08:48:41 +00001449
1450 void registerAll() {
1451 for (auto *II : LoadedModules) {
1452 CI.KnownModules[II] = CI.getPreprocessor()
1453 .getHeaderSearchInfo()
1454 .getModuleMap()
1455 .findModule(II->getName());
1456 }
1457 LoadedModules.clear();
1458 }
Richard Smith8a308ec2015-11-05 00:54:55 +00001459
1460 void markAllUnavailable() {
1461 for (auto *II : LoadedModules) {
1462 if (Module *M = CI.getPreprocessor()
1463 .getHeaderSearchInfo()
1464 .getModuleMap()
Richard Smitha114c462016-12-06 00:40:17 +00001465 .findModule(II->getName())) {
Richard Smith8a308ec2015-11-05 00:54:55 +00001466 M->HasIncompatibleModuleFile = true;
Richard Smitha114c462016-12-06 00:40:17 +00001467
1468 // Mark module as available if the only reason it was unavailable
1469 // was missing headers.
1470 SmallVector<Module *, 2> Stack;
1471 Stack.push_back(M);
1472 while (!Stack.empty()) {
1473 Module *Current = Stack.pop_back_val();
1474 if (Current->IsMissingRequirement) continue;
1475 Current->IsAvailable = true;
1476 Stack.insert(Stack.end(),
1477 Current->submodule_begin(), Current->submodule_end());
1478 }
1479 }
Richard Smith8a308ec2015-11-05 00:54:55 +00001480 }
1481 LoadedModules.clear();
1482 }
Richard Smith0f99d6a2015-08-09 08:48:41 +00001483 };
Richard Smithd4b230b2014-10-27 23:01:16 +00001484
Richard Smith7f330cd2015-03-18 01:42:29 +00001485 // If we don't already have an ASTReader, create one now.
1486 if (!ModuleManager)
1487 createModuleManager();
1488
Richard Smith0f99d6a2015-08-09 08:48:41 +00001489 auto Listener = llvm::make_unique<ReadModuleNames>(*this);
1490 auto &ListenerRef = *Listener;
1491 ASTReader::ListenerScope ReadModuleNamesListener(*ModuleManager,
1492 std::move(Listener));
Richard Smith7f330cd2015-03-18 01:42:29 +00001493
Richard Smith0f99d6a2015-08-09 08:48:41 +00001494 // Try to load the module file.
Richard Smith95dc57a2015-10-16 23:20:19 +00001495 switch (ModuleManager->ReadAST(FileName, serialization::MK_ExplicitModule,
1496 SourceLocation(),
1497 ASTReader::ARR_ConfigurationMismatch)) {
1498 case ASTReader::Success:
Richard Smith8a308ec2015-11-05 00:54:55 +00001499 // We successfully loaded the module file; remember the set of provided
1500 // modules so that we don't try to load implicit modules for them.
1501 ListenerRef.registerAll();
1502 return true;
Richard Smith95dc57a2015-10-16 23:20:19 +00001503
1504 case ASTReader::ConfigurationMismatch:
1505 // Ignore unusable module files.
1506 getDiagnostics().Report(SourceLocation(), diag::warn_module_config_mismatch)
1507 << FileName;
Richard Smith8a308ec2015-11-05 00:54:55 +00001508 // All modules provided by any files we tried and failed to load are now
1509 // unavailable; includes of those modules should now be handled textually.
1510 ListenerRef.markAllUnavailable();
Richard Smith95dc57a2015-10-16 23:20:19 +00001511 return true;
1512
1513 default:
1514 return false;
1515 }
Richard Smithe842a472014-10-22 02:05:46 +00001516}
1517
1518ModuleLoadResult
Douglas Gregor7a626572012-11-29 23:55:25 +00001519CompilerInstance::loadModule(SourceLocation ImportLoc,
1520 ModuleIdPath Path,
1521 Module::NameVisibilityKind Visibility,
1522 bool IsInclusionDirective) {
Richard Smith92304e02013-10-18 22:48:20 +00001523 // Determine what file we're searching from.
1524 StringRef ModuleName = Path[0].first->getName();
1525 SourceLocation ModuleNameLoc = Path[0].second;
1526
Douglas Gregor1805b8a2011-11-30 04:26:53 +00001527 // If we've already handled this import, just return the cached result.
1528 // This one-element cache is important to eliminate redundant diagnostics
1529 // when both the preprocessor and parser see the same import declaration.
Yaron Keren8b563662015-10-03 10:46:20 +00001530 if (ImportLoc.isValid() && LastModuleImportLoc == ImportLoc) {
Douglas Gregorff2be532011-12-01 17:11:21 +00001531 // Make the named module visible.
Richard Smith7e82e012016-02-19 22:25:36 +00001532 if (LastModuleImportResult && ModuleName != getLangOpts().CurrentModule)
Argyrios Kyrtzidis125df052013-02-01 16:36:12 +00001533 ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility,
Richard Smitha7e2cc62015-05-01 01:53:09 +00001534 ImportLoc);
Douglas Gregor69021972011-11-30 17:33:56 +00001535 return LastModuleImportResult;
Douglas Gregorff2be532011-12-01 17:11:21 +00001536 }
Douglas Gregor5196bc62011-11-30 04:03:44 +00001537
Craig Topper49a27902014-05-22 04:46:25 +00001538 clang::Module *Module = nullptr;
Richard Smith92304e02013-10-18 22:48:20 +00001539
Douglas Gregor5196bc62011-11-30 04:03:44 +00001540 // If we don't already have information on this module, load the module now.
Douglas Gregorde3ef502011-11-30 23:21:26 +00001541 llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
Douglas Gregor69021972011-11-30 17:33:56 +00001542 = KnownModules.find(Path[0].first);
Douglas Gregor2537a362011-12-08 17:01:29 +00001543 if (Known != KnownModules.end()) {
1544 // Retrieve the cached top-level module.
1545 Module = Known->second;
Richard Smith7e82e012016-02-19 22:25:36 +00001546 } else if (ModuleName == getLangOpts().CurrentModule) {
Douglas Gregor2537a362011-12-08 17:01:29 +00001547 // This is the module we're building.
Ben Langmuir527040e2014-05-05 05:31:33 +00001548 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
Douglas Gregor2537a362011-12-08 17:01:29 +00001549 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1550 } else {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001551 // Search for a module with the given name.
Douglas Gregor279a6c32012-01-29 17:08:11 +00001552 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
Manman Ren11f2a472016-08-18 17:42:15 +00001553 HeaderSearchOptions &HSOpts =
1554 PP->getHeaderSearchInfo().getHeaderSearchOpts();
1555
1556 std::string ModuleFileName;
1557 bool LoadFromPrebuiltModulePath = false;
1558 // We try to load the module from the prebuilt module paths. If not
1559 // successful, we then try to find it in the module cache.
1560 if (!HSOpts.PrebuiltModulePaths.empty()) {
1561 // Load the module from the prebuilt module path.
1562 ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(
1563 ModuleName, "", /*UsePrebuiltPath*/ true);
1564 if (!ModuleFileName.empty())
1565 LoadFromPrebuiltModulePath = true;
1566 }
1567 if (!LoadFromPrebuiltModulePath && Module) {
1568 // Load the module from the module cache.
1569 ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(Module);
1570 } else if (!LoadFromPrebuiltModulePath) {
1571 // We can't find a module, error out here.
Ben Langmuir9eb229b2014-01-22 23:19:39 +00001572 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1573 << ModuleName
1574 << SourceRange(ImportLoc, ModuleNameLoc);
1575 ModuleBuildFailed = true;
1576 return ModuleLoadResult();
1577 }
1578
Richard Smithd520a252015-07-21 18:07:47 +00001579 if (ModuleFileName.empty()) {
Manman Ren11f2a472016-08-18 17:42:15 +00001580 if (Module && Module->HasIncompatibleModuleFile) {
Richard Smith8a308ec2015-11-05 00:54:55 +00001581 // We tried and failed to load a module file for this module. Fall
1582 // back to textual inclusion for its headers.
Richard Smitha114c462016-12-06 00:40:17 +00001583 return ModuleLoadResult::ConfigMismatch;
Richard Smith8a308ec2015-11-05 00:54:55 +00001584 }
1585
Manuel Klimekd2e8b042015-02-20 11:44:41 +00001586 getDiagnostics().Report(ModuleNameLoc, diag::err_module_build_disabled)
1587 << ModuleName;
1588 ModuleBuildFailed = true;
1589 return ModuleLoadResult();
1590 }
Richard Smithd4b230b2014-10-27 23:01:16 +00001591
Douglas Gregor5196bc62011-11-30 04:03:44 +00001592 // If we don't already have an ASTReader, create one now.
John Thompson2255f2c2014-04-23 12:57:01 +00001593 if (!ModuleManager)
1594 createModuleManager();
Douglas Gregor5196bc62011-11-30 04:03:44 +00001595
Richard Smithce18a182015-07-14 00:26:00 +00001596 llvm::Timer Timer;
1597 if (FrontendTimerGroup)
Matthias Braunae032b62016-11-18 19:43:25 +00001598 Timer.init("loading." + ModuleFileName, "Loading " + ModuleFileName,
1599 *FrontendTimerGroup);
Richard Smithce18a182015-07-14 00:26:00 +00001600 llvm::TimeRegion TimeLoading(FrontendTimerGroup ? &Timer : nullptr);
1601
Manman Ren11f2a472016-08-18 17:42:15 +00001602 // Try to load the module file. If we are trying to load from the prebuilt
1603 // module path, we don't have the module map files and don't know how to
1604 // rebuild modules.
1605 unsigned ARRFlags = LoadFromPrebuiltModulePath ?
1606 ASTReader::ARR_ConfigurationMismatch :
1607 ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing;
Richard Smithe842a472014-10-22 02:05:46 +00001608 switch (ModuleManager->ReadAST(ModuleFileName,
Manman Ren11f2a472016-08-18 17:42:15 +00001609 LoadFromPrebuiltModulePath ?
1610 serialization::MK_PrebuiltModule :
Richard Smith86cc8292015-08-09 08:58:36 +00001611 serialization::MK_ImplicitModule,
Manman Ren11f2a472016-08-18 17:42:15 +00001612 ImportLoc,
1613 ARRFlags)) {
1614 case ASTReader::Success: {
1615 if (LoadFromPrebuiltModulePath && !Module) {
1616 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1617 if (!Module || !Module->getASTFile() ||
1618 FileMgr->getFile(ModuleFileName) != Module->getASTFile()) {
1619 // Error out if Module does not refer to the file in the prebuilt
1620 // module path.
1621 getDiagnostics().Report(ModuleNameLoc, diag::err_module_prebuilt)
1622 << ModuleName;
1623 ModuleBuildFailed = true;
1624 KnownModules[Path[0].first] = nullptr;
1625 return ModuleLoadResult();
1626 }
1627 }
Douglas Gregor5196bc62011-11-30 04:03:44 +00001628 break;
Manman Ren11f2a472016-08-18 17:42:15 +00001629 }
Douglas Gregor5196bc62011-11-30 04:03:44 +00001630
Eli Friedman963ff2c2013-09-17 00:51:29 +00001631 case ASTReader::OutOfDate:
Douglas Gregor7029ce12013-03-19 00:28:20 +00001632 case ASTReader::Missing: {
Manman Ren11f2a472016-08-18 17:42:15 +00001633 if (LoadFromPrebuiltModulePath) {
1634 // We can't rebuild the module without a module map. Since ReadAST
1635 // already produces diagnostics for these two cases, we simply
1636 // error out here.
1637 ModuleBuildFailed = true;
1638 KnownModules[Path[0].first] = nullptr;
1639 return ModuleLoadResult();
1640 }
1641
Eli Friedman963ff2c2013-09-17 00:51:29 +00001642 // The module file is missing or out-of-date. Build it.
Ben Langmuir9eb229b2014-01-22 23:19:39 +00001643 assert(Module && "missing module file");
Douglas Gregor7029ce12013-03-19 00:28:20 +00001644 // Check whether there is a cycle in the module graph.
1645 ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
1646 ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1647 for (; Pos != PosEnd; ++Pos) {
1648 if (Pos->first == ModuleName)
1649 break;
1650 }
1651
1652 if (Pos != PosEnd) {
1653 SmallString<256> CyclePath;
1654 for (; Pos != PosEnd; ++Pos) {
1655 CyclePath += Pos->first;
1656 CyclePath += " -> ";
1657 }
1658 CyclePath += ModuleName;
1659
1660 getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
1661 << ModuleName << CyclePath;
1662 return ModuleLoadResult();
1663 }
Douglas Gregor7a626572012-11-29 23:55:25 +00001664
1665 // Check whether we have already attempted to build this module (but
1666 // failed).
1667 if (getPreprocessorOpts().FailedModules &&
1668 getPreprocessorOpts().FailedModules->hasAlreadyFailed(ModuleName)) {
1669 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_built)
1670 << ModuleName
1671 << SourceRange(ImportLoc, ModuleNameLoc);
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001672 ModuleBuildFailed = true;
Douglas Gregor7a626572012-11-29 23:55:25 +00001673 return ModuleLoadResult();
1674 }
1675
Ben Langmuirdbdc0362014-06-17 22:35:27 +00001676 // Try to compile and then load the module.
1677 if (!compileAndLoadModule(*this, ImportLoc, ModuleNameLoc, Module,
1678 ModuleFileName)) {
Ben Langmuird213aab2014-09-26 22:42:23 +00001679 assert(getDiagnostics().hasErrorOccurred() &&
1680 "undiagnosed error in compileAndLoadModule");
Douglas Gregor0f2b4632013-01-10 02:04:18 +00001681 if (getPreprocessorOpts().FailedModules)
1682 getPreprocessorOpts().FailedModules->addFailed(ModuleName);
Craig Topper49a27902014-05-22 04:46:25 +00001683 KnownModules[Path[0].first] = nullptr;
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001684 ModuleBuildFailed = true;
Douglas Gregor7a626572012-11-29 23:55:25 +00001685 return ModuleLoadResult();
Douglas Gregor188dbef2012-11-07 17:46:15 +00001686 }
1687
1688 // Okay, we've rebuilt and now loaded the module.
1689 break;
1690 }
1691
Douglas Gregorc9ad5fb2012-10-22 22:50:17 +00001692 case ASTReader::ConfigurationMismatch:
Manman Ren11f2a472016-08-18 17:42:15 +00001693 if (LoadFromPrebuiltModulePath)
1694 getDiagnostics().Report(SourceLocation(),
1695 diag::warn_module_config_mismatch)
1696 << ModuleFileName;
1697 // Fall through to error out.
1698 case ASTReader::VersionMismatch:
Douglas Gregorc9ad5fb2012-10-22 22:50:17 +00001699 case ASTReader::HadErrors:
Argyrios Kyrtzidisdc9fdaf2013-05-24 05:44:08 +00001700 ModuleLoader::HadFatalFailure = true;
Richard Smith0f99d6a2015-08-09 08:48:41 +00001701 // FIXME: The ASTReader will already have complained, but can we shoehorn
Douglas Gregor5196bc62011-11-30 04:03:44 +00001702 // that diagnostic information into a more useful form?
Craig Topper49a27902014-05-22 04:46:25 +00001703 KnownModules[Path[0].first] = nullptr;
Douglas Gregor7a626572012-11-29 23:55:25 +00001704 return ModuleLoadResult();
Douglas Gregor5196bc62011-11-30 04:03:44 +00001705
1706 case ASTReader::Failure:
Argyrios Kyrtzidisdc9fdaf2013-05-24 05:44:08 +00001707 ModuleLoader::HadFatalFailure = true;
Douglas Gregor69021972011-11-30 17:33:56 +00001708 // Already complained, but note now that we failed.
Craig Topper49a27902014-05-22 04:46:25 +00001709 KnownModules[Path[0].first] = nullptr;
Douglas Gregorc1bbec82013-01-25 00:45:27 +00001710 ModuleBuildFailed = true;
Douglas Gregor7a626572012-11-29 23:55:25 +00001711 return ModuleLoadResult();
Douglas Gregor5196bc62011-11-30 04:03:44 +00001712 }
Argyrios Kyrtzidis43af5132012-09-29 01:06:04 +00001713
Douglas Gregor69021972011-11-30 17:33:56 +00001714 // Cache the result of this top-level module lookup for later.
1715 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
Douglas Gregor08142532011-08-26 23:56:07 +00001716 }
Douglas Gregor5196bc62011-11-30 04:03:44 +00001717
Douglas Gregor69021972011-11-30 17:33:56 +00001718 // If we never found the module, fail.
1719 if (!Module)
Douglas Gregor7a626572012-11-29 23:55:25 +00001720 return ModuleLoadResult();
Douglas Gregor69021972011-11-30 17:33:56 +00001721
Douglas Gregor5196bc62011-11-30 04:03:44 +00001722 // Verify that the rest of the module path actually corresponds to
1723 // a submodule.
Douglas Gregor69021972011-11-30 17:33:56 +00001724 if (Path.size() > 1) {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001725 for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1726 StringRef Name = Path[I].first->getName();
Douglas Gregoreb90e832012-01-04 23:32:19 +00001727 clang::Module *Sub = Module->findSubmodule(Name);
Douglas Gregor5196bc62011-11-30 04:03:44 +00001728
Douglas Gregoreb90e832012-01-04 23:32:19 +00001729 if (!Sub) {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001730 // Attempt to perform typo correction to find a module name that works.
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001731 SmallVector<StringRef, 2> Best;
Douglas Gregor5196bc62011-11-30 04:03:44 +00001732 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1733
Douglas Gregoreb90e832012-01-04 23:32:19 +00001734 for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1735 JEnd = Module->submodule_end();
Matt Beaumont-Gayeb44eda2011-11-30 19:41:21 +00001736 J != JEnd; ++J) {
Douglas Gregoreb90e832012-01-04 23:32:19 +00001737 unsigned ED = Name.edit_distance((*J)->Name,
Douglas Gregor5196bc62011-11-30 04:03:44 +00001738 /*AllowReplacements=*/true,
1739 BestEditDistance);
1740 if (ED <= BestEditDistance) {
Douglas Gregoreb90e832012-01-04 23:32:19 +00001741 if (ED < BestEditDistance) {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001742 Best.clear();
Douglas Gregoreb90e832012-01-04 23:32:19 +00001743 BestEditDistance = ED;
1744 }
1745
1746 Best.push_back((*J)->Name);
Douglas Gregor5196bc62011-11-30 04:03:44 +00001747 }
1748 }
1749
1750 // If there was a clear winner, user it.
1751 if (Best.size() == 1) {
1752 getDiagnostics().Report(Path[I].second,
1753 diag::err_no_submodule_suggest)
Douglas Gregor69021972011-11-30 17:33:56 +00001754 << Path[I].first << Module->getFullModuleName() << Best[0]
Douglas Gregor5196bc62011-11-30 04:03:44 +00001755 << SourceRange(Path[0].second, Path[I-1].second)
1756 << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1757 Best[0]);
Douglas Gregoreb90e832012-01-04 23:32:19 +00001758
1759 Sub = Module->findSubmodule(Best[0]);
Douglas Gregor5196bc62011-11-30 04:03:44 +00001760 }
1761 }
1762
Douglas Gregoreb90e832012-01-04 23:32:19 +00001763 if (!Sub) {
Douglas Gregor5196bc62011-11-30 04:03:44 +00001764 // No submodule by this name. Complain, and don't look for further
1765 // submodules.
1766 getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
Douglas Gregor69021972011-11-30 17:33:56 +00001767 << Path[I].first << Module->getFullModuleName()
Douglas Gregor5196bc62011-11-30 04:03:44 +00001768 << SourceRange(Path[0].second, Path[I-1].second);
1769 break;
1770 }
1771
Douglas Gregoreb90e832012-01-04 23:32:19 +00001772 Module = Sub;
Douglas Gregor5196bc62011-11-30 04:03:44 +00001773 }
Douglas Gregor08142532011-08-26 23:56:07 +00001774 }
Ben Langmuirb537a3a2014-07-23 15:30:23 +00001775
Douglas Gregor2537a362011-12-08 17:01:29 +00001776 // Make the named module visible, if it's not already part of the module
1777 // we are parsing.
Douglas Gregor98a52db2011-12-20 00:28:52 +00001778 if (ModuleName != getLangOpts().CurrentModule) {
1779 if (!Module->IsFromModuleFile) {
1780 // We have an umbrella header or directory that doesn't actually include
1781 // all of the headers within the directory it covers. Complain about
1782 // this missing submodule and recover by forgetting that we ever saw
1783 // this submodule.
1784 // FIXME: Should we detect this at module load time? It seems fairly
1785 // expensive (and rare).
1786 getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1787 << Module->getFullModuleName()
1788 << SourceRange(Path.front().second, Path.back().second);
Craig Topper49a27902014-05-22 04:46:25 +00001789
Richard Smitha114c462016-12-06 00:40:17 +00001790 return ModuleLoadResult::MissingExpected;
Douglas Gregor98a52db2011-12-20 00:28:52 +00001791 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00001792
1793 // Check whether this module is available.
Richard Smitha3feee22013-10-28 22:18:19 +00001794 clang::Module::Requirement Requirement;
Richard Smith3c1a41a2014-12-02 00:08:08 +00001795 clang::Module::UnresolvedHeaderDirective MissingHeader;
Daniel Jasper0761a8a2013-12-17 10:31:37 +00001796 if (!Module->isAvailable(getLangOpts(), getTarget(), Requirement,
1797 MissingHeader)) {
1798 if (MissingHeader.FileNameLoc.isValid()) {
1799 getDiagnostics().Report(MissingHeader.FileNameLoc,
1800 diag::err_module_header_missing)
1801 << MissingHeader.IsUmbrella << MissingHeader.FileName;
1802 } else {
1803 getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1804 << Module->getFullModuleName()
1805 << Requirement.second << Requirement.first
1806 << SourceRange(Path.front().second, Path.back().second);
1807 }
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00001808 LastModuleImportLoc = ImportLoc;
Douglas Gregor7a626572012-11-29 23:55:25 +00001809 LastModuleImportResult = ModuleLoadResult();
1810 return ModuleLoadResult();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00001811 }
1812
Richard Smitha7e2cc62015-05-01 01:53:09 +00001813 ModuleManager->makeModuleVisible(Module, Visibility, ImportLoc);
Douglas Gregor98a52db2011-12-20 00:28:52 +00001814 }
Douglas Gregor35b13ec2013-03-20 00:22:05 +00001815
1816 // Check for any configuration macros that have changed.
1817 clang::Module *TopModule = Module->getTopLevelModule();
1818 for (unsigned I = 0, N = TopModule->ConfigMacros.size(); I != N; ++I) {
1819 checkConfigMacro(getPreprocessor(), TopModule->ConfigMacros[I],
1820 Module, ImportLoc);
1821 }
1822
Douglas Gregor1805b8a2011-11-30 04:26:53 +00001823 LastModuleImportLoc = ImportLoc;
Richard Smitha114c462016-12-06 00:40:17 +00001824 LastModuleImportResult = ModuleLoadResult(Module);
Douglas Gregor7a626572012-11-29 23:55:25 +00001825 return LastModuleImportResult;
Douglas Gregor08142532011-08-26 23:56:07 +00001826}
Douglas Gregorc147b0b2013-01-12 01:29:50 +00001827
1828void CompilerInstance::makeModuleVisible(Module *Mod,
Argyrios Kyrtzidis125df052013-02-01 16:36:12 +00001829 Module::NameVisibilityKind Visibility,
Richard Smitha7e2cc62015-05-01 01:53:09 +00001830 SourceLocation ImportLoc) {
Richard Smith42413142015-05-15 20:05:43 +00001831 if (!ModuleManager)
1832 createModuleManager();
1833 if (!ModuleManager)
1834 return;
1835
Richard Smitha7e2cc62015-05-01 01:53:09 +00001836 ModuleManager->makeModuleVisible(Mod, Visibility, ImportLoc);
Douglas Gregorc147b0b2013-01-12 01:29:50 +00001837}
1838
John Thompson2255f2c2014-04-23 12:57:01 +00001839GlobalModuleIndex *CompilerInstance::loadGlobalModuleIndex(
1840 SourceLocation TriggerLoc) {
Richard Smith3938f0c2015-08-15 00:34:15 +00001841 if (getPreprocessor().getHeaderSearchInfo().getModuleCachePath().empty())
1842 return nullptr;
John Thompson2255f2c2014-04-23 12:57:01 +00001843 if (!ModuleManager)
1844 createModuleManager();
1845 // Can't do anything if we don't have the module manager.
1846 if (!ModuleManager)
Craig Topper49a27902014-05-22 04:46:25 +00001847 return nullptr;
John Thompson2255f2c2014-04-23 12:57:01 +00001848 // Get an existing global index. This loads it if not already
1849 // loaded.
1850 ModuleManager->loadGlobalIndex();
1851 GlobalModuleIndex *GlobalIndex = ModuleManager->getGlobalIndex();
1852 // If the global index doesn't exist, create it.
1853 if (!GlobalIndex && shouldBuildGlobalModuleIndex() && hasFileManager() &&
1854 hasPreprocessor()) {
1855 llvm::sys::fs::create_directories(
1856 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1857 GlobalModuleIndex::writeIndex(
Adrian Prantlfb2398d2015-07-17 01:19:54 +00001858 getFileManager(), getPCHContainerReader(),
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001859 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
John Thompson2255f2c2014-04-23 12:57:01 +00001860 ModuleManager->resetForReload();
1861 ModuleManager->loadGlobalIndex();
1862 GlobalIndex = ModuleManager->getGlobalIndex();
1863 }
1864 // For finding modules needing to be imported for fixit messages,
1865 // we need to make the global index cover all modules, so we do that here.
1866 if (!HaveFullGlobalModuleIndex && GlobalIndex && !buildingModule()) {
1867 ModuleMap &MMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
1868 bool RecreateIndex = false;
1869 for (ModuleMap::module_iterator I = MMap.module_begin(),
1870 E = MMap.module_end(); I != E; ++I) {
1871 Module *TheModule = I->second;
1872 const FileEntry *Entry = TheModule->getASTFile();
1873 if (!Entry) {
1874 SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
1875 Path.push_back(std::make_pair(
Richard Smith629d8e62015-08-11 00:03:28 +00001876 getPreprocessor().getIdentifierInfo(TheModule->Name), TriggerLoc));
John Thompson2255f2c2014-04-23 12:57:01 +00001877 std::reverse(Path.begin(), Path.end());
Richard Smith629d8e62015-08-11 00:03:28 +00001878 // Load a module as hidden. This also adds it to the global index.
1879 loadModule(TheModule->DefinitionLoc, Path, Module::Hidden, false);
John Thompson2255f2c2014-04-23 12:57:01 +00001880 RecreateIndex = true;
1881 }
1882 }
1883 if (RecreateIndex) {
1884 GlobalModuleIndex::writeIndex(
Adrian Prantlfb2398d2015-07-17 01:19:54 +00001885 getFileManager(), getPCHContainerReader(),
Adrian Prantlbb165fb2015-06-20 18:53:08 +00001886 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
John Thompson2255f2c2014-04-23 12:57:01 +00001887 ModuleManager->resetForReload();
1888 ModuleManager->loadGlobalIndex();
1889 GlobalIndex = ModuleManager->getGlobalIndex();
1890 }
1891 HaveFullGlobalModuleIndex = true;
1892 }
1893 return GlobalIndex;
1894}
John Thompson2d94bbb2014-04-23 19:04:32 +00001895
1896// Check global module index for missing imports.
1897bool
1898CompilerInstance::lookupMissingImports(StringRef Name,
1899 SourceLocation TriggerLoc) {
1900 // Look for the symbol in non-imported modules, but only if an error
1901 // actually occurred.
1902 if (!buildingModule()) {
1903 // Load global module index, or retrieve a previously loaded one.
1904 GlobalModuleIndex *GlobalIndex = loadGlobalModuleIndex(
1905 TriggerLoc);
1906
1907 // Only if we have a global index.
1908 if (GlobalIndex) {
1909 GlobalModuleIndex::HitSet FoundModules;
1910
1911 // Find the modules that reference the identifier.
1912 // Note that this only finds top-level modules.
1913 // We'll let diagnoseTypo find the actual declaration module.
1914 if (GlobalIndex->lookupIdentifier(Name, FoundModules))
1915 return true;
1916 }
1917 }
1918
1919 return false;
1920}
David Blaikiea97eaa12014-08-29 16:53:14 +00001921void CompilerInstance::resetAndLeakSema() { BuryPointer(takeSema()); }
Benjamin Kramer7de99692016-11-16 18:15:26 +00001922
1923void CompilerInstance::setExternalSemaSource(
1924 IntrusiveRefCntPtr<ExternalSemaSource> ESS) {
1925 ExternalSemaSrc = std::move(ESS);
1926}