blob: 07812bdc83916768bc472c6bdc6663bfae1c8891 [file] [log] [blame]
Daniel Dunbar2a79e162009-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 Dunbar12ce6942009-11-14 02:47:17 +000011#include "clang/AST/ASTConsumer.h"
Daniel Dunbar5eb81002009-11-13 08:20:47 +000012#include "clang/AST/ASTContext.h"
Douglas Gregor93ebfa62011-12-02 23:42:12 +000013#include "clang/AST/Decl.h"
Daniel Dunbar2a79e162009-11-13 03:51:44 +000014#include "clang/Basic/Diagnostic.h"
Daniel Dunbar16b74492009-11-13 04:12:06 +000015#include "clang/Basic/FileManager.h"
16#include "clang/Basic/SourceManager.h"
Daniel Dunbar2a79e162009-11-13 03:51:44 +000017#include "clang/Basic/TargetInfo.h"
Daniel Dunbar0397af22010-01-13 00:48:06 +000018#include "clang/Basic/Version.h"
Stephen Hinesc568f1e2014-07-21 00:47:37 -070019#include "clang/Config/config.h"
David Blaikie4e85b8a2011-09-26 00:21:47 +000020#include "clang/Frontend/ChainedDiagnosticConsumer.h"
Daniel Dunbar0397af22010-01-13 00:48:06 +000021#include "clang/Frontend/FrontendAction.h"
Douglas Gregor21cae202011-09-12 23:31:24 +000022#include "clang/Frontend/FrontendActions.h"
Daniel Dunbarc2f484f2009-11-13 09:36:05 +000023#include "clang/Frontend/FrontendDiagnostic.h"
Daniel Dunbar9df23492011-04-07 18:31:10 +000024#include "clang/Frontend/LogDiagnosticPrinter.h"
Ted Kremenek78002122011-10-29 00:12:39 +000025#include "clang/Frontend/SerializedDiagnosticPrinter.h"
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +000026#include "clang/Frontend/TextDiagnosticPrinter.h"
Daniel Dunbar22dacfa2009-11-13 05:52:11 +000027#include "clang/Frontend/Utils.h"
Chandler Carruth55fc8732012-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"
Daniel Dunbarc2f484f2009-11-13 09:36:05 +000032#include "clang/Sema/CodeCompleteConsumer.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000033#include "clang/Sema/Sema.h"
34#include "clang/Serialization/ASTReader.h"
Stephen Hines6bcf27b2014-05-29 04:14:42 -070035#include "clang/Serialization/GlobalModuleIndex.h"
Douglas Gregor95dd5582010-03-30 17:33:59 +000036#include "llvm/ADT/Statistic.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000037#include "llvm/Support/CrashRecoveryContext.h"
Stephen Hinesc568f1e2014-07-21 00:47:37 -070038#include "llvm/Support/Errc.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000039#include "llvm/Support/FileSystem.h"
Michael J. Spencer03013fa2010-11-29 18:12:39 +000040#include "llvm/Support/Host.h"
Douglas Gregor52f12722012-01-29 20:15:24 +000041#include "llvm/Support/LockFileManager.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000042#include "llvm/Support/MemoryBuffer.h"
Michael J. Spencer03013fa2010-11-29 18:12:39 +000043#include "llvm/Support/Path.h"
44#include "llvm/Support/Program.h"
45#include "llvm/Support/Signals.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000046#include "llvm/Support/Timer.h"
47#include "llvm/Support/raw_ostream.h"
Douglas Gregord44d2872013-03-25 21:19:16 +000048#include <sys/stat.h>
Stephen Hinesc568f1e2014-07-21 00:47:37 -070049#include <system_error>
Douglas Gregor87ab0662013-03-25 21:51:16 +000050#include <time.h>
Douglas Gregor2bc75072011-10-05 14:53:30 +000051
Daniel Dunbar2a79e162009-11-13 03:51:44 +000052using namespace clang;
53
Stephen Hines6bcf27b2014-05-29 04:14:42 -070054CompilerInstance::CompilerInstance(bool BuildingModule)
55 : ModuleLoader(BuildingModule),
56 Invocation(new CompilerInvocation()), ModuleManager(nullptr),
57 BuildGlobalModuleIndex(false), HaveFullGlobalModuleIndex(false),
58 ModuleBuildFailed(false) {
Daniel Dunbar6228ca02010-01-30 21:47:07 +000059}
Daniel Dunbar2a79e162009-11-13 03:51:44 +000060
61CompilerInstance::~CompilerInstance() {
Benjamin Kramerac447fc2012-10-14 19:21:21 +000062 assert(OutputFiles.empty() && "Still output files in flight?");
Daniel Dunbar42e9f8e42010-02-16 01:54:47 +000063}
64
Daniel Dunbar6228ca02010-01-30 21:47:07 +000065void CompilerInstance::setInvocation(CompilerInvocation *Value) {
Ted Kremenek4f327862011-03-21 18:40:17 +000066 Invocation = Value;
Daniel Dunbar6228ca02010-01-30 21:47:07 +000067}
68
Douglas Gregorf575d6e2013-01-25 00:45:27 +000069bool CompilerInstance::shouldBuildGlobalModuleIndex() const {
Douglas Gregor1a49d972013-01-25 01:03:03 +000070 return (BuildGlobalModuleIndex ||
Douglas Gregored2fc2a2013-03-22 21:26:48 +000071 (ModuleManager && ModuleManager->isGlobalIndexUnavailable() &&
72 getFrontendOpts().GenerateGlobalModuleIndex)) &&
Douglas Gregor1a49d972013-01-25 01:03:03 +000073 !ModuleBuildFailed;
Douglas Gregorf575d6e2013-01-25 00:45:27 +000074}
75
David Blaikied6471f72011-09-25 23:23:43 +000076void CompilerInstance::setDiagnostics(DiagnosticsEngine *Value) {
Douglas Gregor28019772010-04-05 23:52:57 +000077 Diagnostics = Value;
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000078}
79
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000080void CompilerInstance::setTarget(TargetInfo *Value) {
Ted Kremenek4f327862011-03-21 18:40:17 +000081 Target = Value;
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000082}
83
84void CompilerInstance::setFileManager(FileManager *Value) {
Ted Kremenek4f327862011-03-21 18:40:17 +000085 FileMgr = Value;
Stephen Hines651f13c2014-04-23 16:59:28 -070086 if (Value)
87 VirtualFileSystem = Value->getVirtualFileSystem();
88 else
89 VirtualFileSystem.reset();
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000090}
91
NAKAMURA Takumia789ca92011-10-08 11:31:46 +000092void CompilerInstance::setSourceManager(SourceManager *Value) {
Ted Kremenek4f327862011-03-21 18:40:17 +000093 SourceMgr = Value;
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000094}
95
Ted Kremenek4f327862011-03-21 18:40:17 +000096void CompilerInstance::setPreprocessor(Preprocessor *Value) { PP = Value; }
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000097
Ted Kremenek4f327862011-03-21 18:40:17 +000098void CompilerInstance::setASTContext(ASTContext *Value) { Context = Value; }
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000099
Douglas Gregorf18d0d82010-08-12 23:31:19 +0000100void CompilerInstance::setSema(Sema *S) {
101 TheSema.reset(S);
102}
103
Stephen Hines176edba2014-12-01 14:53:08 -0800104void CompilerInstance::setASTConsumer(std::unique_ptr<ASTConsumer> Value) {
105 Consumer = std::move(Value);
Daniel Dunbar12ce6942009-11-14 02:47:17 +0000106}
107
Daniel Dunbar8a9f5692009-11-14 01:20:40 +0000108void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
109 CompletionConsumer.reset(Value);
110}
Stephen Hines176edba2014-12-01 14:53:08 -0800111
112std::unique_ptr<Sema> CompilerInstance::takeSema() {
113 return std::move(TheSema);
114}
115
Stephen Hines651f13c2014-04-23 16:59:28 -0700116IntrusiveRefCntPtr<ASTReader> CompilerInstance::getModuleManager() const {
117 return ModuleManager;
118}
119void CompilerInstance::setModuleManager(IntrusiveRefCntPtr<ASTReader> Reader) {
120 ModuleManager = Reader;
121}
Daniel Dunbar8a9f5692009-11-14 01:20:40 +0000122
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700123std::shared_ptr<ModuleDependencyCollector>
124CompilerInstance::getModuleDepCollector() const {
125 return ModuleDepCollector;
126}
127
128void CompilerInstance::setModuleDepCollector(
129 std::shared_ptr<ModuleDependencyCollector> Collector) {
130 ModuleDepCollector = Collector;
131}
132
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000133// Diagnostics
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000134static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts,
Daniel Dunbarb6534bb2011-04-07 18:59:02 +0000135 const CodeGenOptions *CodeGenOpts,
David Blaikied6471f72011-09-25 23:23:43 +0000136 DiagnosticsEngine &Diags) {
Stephen Hines176edba2014-12-01 14:53:08 -0800137 std::error_code EC;
138 std::unique_ptr<raw_ostream> StreamOwner;
Chris Lattner5f9e2722011-07-23 10:55:15 +0000139 raw_ostream *OS = &llvm::errs();
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000140 if (DiagOpts->DiagnosticLogFile != "-") {
Daniel Dunbar9df23492011-04-07 18:31:10 +0000141 // Create the output stream.
Stephen Hines176edba2014-12-01 14:53:08 -0800142 auto FileOS = llvm::make_unique<llvm::raw_fd_ostream>(
143 DiagOpts->DiagnosticLogFile, EC,
144 llvm::sys::fs::F_Append | llvm::sys::fs::F_Text);
145 if (EC) {
Daniel Dunbar9df23492011-04-07 18:31:10 +0000146 Diags.Report(diag::warn_fe_cc_log_diagnostics_failure)
Stephen Hines176edba2014-12-01 14:53:08 -0800147 << DiagOpts->DiagnosticLogFile << EC.message();
Daniel Dunbar9df23492011-04-07 18:31:10 +0000148 } else {
149 FileOS->SetUnbuffered();
150 FileOS->SetUseAtomicWrites(true);
Stephen Hines176edba2014-12-01 14:53:08 -0800151 OS = FileOS.get();
152 StreamOwner = std::move(FileOS);
Daniel Dunbar9df23492011-04-07 18:31:10 +0000153 }
154 }
155
156 // Chain in the diagnostic client which will log the diagnostics.
Stephen Hines176edba2014-12-01 14:53:08 -0800157 auto Logger = llvm::make_unique<LogDiagnosticPrinter>(*OS, DiagOpts,
158 std::move(StreamOwner));
Daniel Dunbarb6534bb2011-04-07 18:59:02 +0000159 if (CodeGenOpts)
160 Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
Stephen Hines176edba2014-12-01 14:53:08 -0800161 assert(Diags.ownsClient());
162 Diags.setClient(
163 new ChainedDiagnosticConsumer(Diags.takeClient(), std::move(Logger)));
Daniel Dunbar9df23492011-04-07 18:31:10 +0000164}
165
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000166static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts,
Ted Kremenek78002122011-10-29 00:12:39 +0000167 DiagnosticsEngine &Diags,
168 StringRef OutputFile) {
Stephen Hines176edba2014-12-01 14:53:08 -0800169 auto SerializedConsumer =
170 clang::serialized_diags::create(OutputFile, DiagOpts);
Rafael Espindolad965f952013-07-16 19:44:23 +0000171
Stephen Hines176edba2014-12-01 14:53:08 -0800172 if (Diags.ownsClient()) {
173 Diags.setClient(new ChainedDiagnosticConsumer(
174 Diags.takeClient(), std::move(SerializedConsumer)));
175 } else {
176 Diags.setClient(new ChainedDiagnosticConsumer(
177 Diags.getClient(), std::move(SerializedConsumer)));
Ted Kremenek78002122011-10-29 00:12:39 +0000178 }
Ted Kremenek78002122011-10-29 00:12:39 +0000179}
180
Sean Silvad47afb92013-01-20 01:58:28 +0000181void CompilerInstance::createDiagnostics(DiagnosticConsumer *Client,
Douglas Gregorcc2b6532013-05-03 23:07:45 +0000182 bool ShouldOwnClient) {
Sean Silvad47afb92013-01-20 01:58:28 +0000183 Diagnostics = createDiagnostics(&getDiagnosticOpts(), Client,
Douglas Gregorcc2b6532013-05-03 23:07:45 +0000184 ShouldOwnClient, &getCodeGenOpts());
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000185}
186
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000187IntrusiveRefCntPtr<DiagnosticsEngine>
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000188CompilerInstance::createDiagnostics(DiagnosticOptions *Opts,
David Blaikie78ad0b92011-09-25 23:39:51 +0000189 DiagnosticConsumer *Client,
Douglas Gregor78243652011-09-13 01:26:44 +0000190 bool ShouldOwnClient,
Daniel Dunbarb6534bb2011-04-07 18:59:02 +0000191 const CodeGenOptions *CodeGenOpts) {
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000192 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
193 IntrusiveRefCntPtr<DiagnosticsEngine>
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000194 Diags(new DiagnosticsEngine(DiagID, Opts));
Daniel Dunbar221c7212009-11-14 07:53:24 +0000195
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000196 // Create the diagnostic client for reporting errors or for
197 // implementing -verify.
Douglas Gregoraee526e2011-09-29 00:38:00 +0000198 if (Client) {
Douglas Gregorcc2b6532013-05-03 23:07:45 +0000199 Diags->setClient(Client, ShouldOwnClient);
Douglas Gregoraee526e2011-09-29 00:38:00 +0000200 } else
Douglas Gregore47be3e2010-11-11 00:39:14 +0000201 Diags->setClient(new TextDiagnosticPrinter(llvm::errs(), Opts));
Daniel Dunbarf79dced2009-11-14 03:24:39 +0000202
203 // Chain in -verify checker, if requested.
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000204 if (Opts->VerifyDiagnostics)
David Blaikie621bc692011-09-26 00:38:03 +0000205 Diags->setClient(new VerifyDiagnosticConsumer(*Diags));
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000206
Daniel Dunbar9df23492011-04-07 18:31:10 +0000207 // Chain in -diagnostic-log-file dumper, if requested.
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000208 if (!Opts->DiagnosticLogFile.empty())
Daniel Dunbarb6534bb2011-04-07 18:59:02 +0000209 SetUpDiagnosticLog(Opts, CodeGenOpts, *Diags);
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000210
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000211 if (!Opts->DiagnosticSerializationFile.empty())
Ted Kremenek78002122011-10-29 00:12:39 +0000212 SetupSerializedDiagnostics(Opts, *Diags,
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000213 Opts->DiagnosticSerializationFile);
Ted Kremenek78002122011-10-29 00:12:39 +0000214
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000215 // Configure our handling of diagnostics.
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000216 ProcessWarningOptions(*Diags, *Opts);
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000217
Douglas Gregor28019772010-04-05 23:52:57 +0000218 return Diags;
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000219}
220
221// File Manager
222
Daniel Dunbar16b74492009-11-13 04:12:06 +0000223void CompilerInstance::createFileManager() {
Stephen Hines651f13c2014-04-23 16:59:28 -0700224 if (!hasVirtualFileSystem()) {
225 // TODO: choose the virtual file system based on the CompilerInvocation.
226 setVirtualFileSystem(vfs::getRealFileSystem());
227 }
228 FileMgr = new FileManager(getFileSystemOpts(), VirtualFileSystem);
Daniel Dunbar16b74492009-11-13 04:12:06 +0000229}
230
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000231// Source Manager
232
Chris Lattner39b49bc2010-11-23 08:35:12 +0000233void CompilerInstance::createSourceManager(FileManager &FileMgr) {
Ted Kremenek4f327862011-03-21 18:40:17 +0000234 SourceMgr = new SourceManager(getDiagnostics(), FileMgr);
Daniel Dunbar16b74492009-11-13 04:12:06 +0000235}
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000236
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700237// Initialize the remapping of files to alternative contents, e.g.,
238// those specified through other files.
239static void InitializeFileRemapping(DiagnosticsEngine &Diags,
240 SourceManager &SourceMgr,
241 FileManager &FileMgr,
242 const PreprocessorOptions &InitOpts) {
243 // Remap files in the source manager (with buffers).
244 for (const auto &RB : InitOpts.RemappedFileBuffers) {
245 // Create the file entry for the file that we're mapping from.
246 const FileEntry *FromFile =
247 FileMgr.getVirtualFile(RB.first, RB.second->getBufferSize(), 0);
248 if (!FromFile) {
249 Diags.Report(diag::err_fe_remap_missing_from_file) << RB.first;
250 if (!InitOpts.RetainRemappedFileBuffers)
251 delete RB.second;
252 continue;
253 }
254
255 // Override the contents of the "from" file with the contents of
256 // the "to" file.
257 SourceMgr.overrideFileContents(FromFile, RB.second,
258 InitOpts.RetainRemappedFileBuffers);
259 }
260
261 // Remap files in the source manager (with other files).
262 for (const auto &RF : InitOpts.RemappedFiles) {
263 // Find the file that we're mapping to.
264 const FileEntry *ToFile = FileMgr.getFile(RF.second);
265 if (!ToFile) {
266 Diags.Report(diag::err_fe_remap_missing_to_file) << RF.first << RF.second;
267 continue;
268 }
269
270 // Create the file entry for the file that we're mapping from.
271 const FileEntry *FromFile =
272 FileMgr.getVirtualFile(RF.first, ToFile->getSize(), 0);
273 if (!FromFile) {
274 Diags.Report(diag::err_fe_remap_missing_from_file) << RF.first;
275 continue;
276 }
277
278 // Override the contents of the "from" file with the contents of
279 // the "to" file.
280 SourceMgr.overrideFileContents(FromFile, ToFile);
281 }
282
283 SourceMgr.setOverridenFilesKeepOriginalName(
284 InitOpts.RemappedFilesKeepOriginalName);
285}
286
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000287// Preprocessor
288
Stephen Hines651f13c2014-04-23 16:59:28 -0700289void CompilerInstance::createPreprocessor(TranslationUnitKind TUKind) {
Douglas Gregor6aa52ec2011-08-26 23:56:07 +0000290 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000291
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000292 // Create a PTH manager if we are using some form of a token cache.
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700293 PTHManager *PTHMgr = nullptr;
Daniel Dunbar049d3a02009-11-17 05:52:41 +0000294 if (!PPOpts.TokenCache.empty())
Douglas Gregor6aa52ec2011-08-26 23:56:07 +0000295 PTHMgr = PTHManager::Create(PPOpts.TokenCache, getDiagnostics());
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000296
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000297 // Create the Preprocessor.
Douglas Gregorc042edd2012-10-24 16:19:39 +0000298 HeaderSearch *HeaderInfo = new HeaderSearch(&getHeaderSearchOpts(),
Manuel Klimekee0cd372013-10-24 07:51:24 +0000299 getSourceManager(),
Douglas Gregor51f564f2011-12-31 04:05:44 +0000300 getDiagnostics(),
Douglas Gregordc58aa72012-01-30 06:01:29 +0000301 getLangOpts(),
302 &getTarget());
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700303 PP = new Preprocessor(&getPreprocessorOpts(), getDiagnostics(), getLangOpts(),
Douglas Gregor6aa52ec2011-08-26 23:56:07 +0000304 getSourceManager(), *HeaderInfo, *this, PTHMgr,
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700305 /*OwnsHeaderSearch=*/true, TUKind);
306 PP->Initialize(getTarget());
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000307
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000308 // Note that this is different then passing PTHMgr to Preprocessor's ctor.
309 // That argument is used as the IdentifierInfoLookup argument to
310 // IdentifierTable's ctor.
311 if (PTHMgr) {
Douglas Gregor6aa52ec2011-08-26 23:56:07 +0000312 PTHMgr->setPreprocessor(&*PP);
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000313 PP->setPTHManager(PTHMgr);
314 }
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000315
Douglas Gregor94dc8f62010-03-19 16:15:56 +0000316 if (PPOpts.DetailedRecord)
Argyrios Kyrtzidis37ed1272012-12-04 07:27:05 +0000317 PP->createPreprocessingRecord();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000318
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700319 // Apply remappings to the source manager.
320 InitializeFileRemapping(PP->getDiagnostics(), PP->getSourceManager(),
321 PP->getFileManager(), PPOpts);
322
323 // Predefine macros and configure the preprocessor.
324 InitializePreprocessor(*PP, PPOpts, getFrontendOpts());
325
326 // Initialize the header search object.
327 ApplyHeaderSearchOptions(PP->getHeaderSearchInfo(), getHeaderSearchOpts(),
328 PP->getLangOpts(), PP->getTargetInfo().getTriple());
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000329
Jordan Rose74c24982013-01-30 01:52:57 +0000330 PP->setPreprocessedOutput(getPreprocessorOutputOpts().ShowCPP);
331
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700332 PP->getHeaderSearchInfo().setModuleCachePath(getSpecificModuleCachePath());
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000333
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000334 // Handle generating dependencies, if requested.
Douglas Gregor6aa52ec2011-08-26 23:56:07 +0000335 const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000336 if (!DepOpts.OutputFile.empty())
Stephen Hines651f13c2014-04-23 16:59:28 -0700337 TheDependencyFileGenerator.reset(
338 DependencyFileGenerator::CreateAndAttachToPreprocessor(*PP, DepOpts));
Douglas Gregor773303a2012-02-02 23:45:13 +0000339 if (!DepOpts.DOTOutputFile.empty())
340 AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
Douglas Gregorc69a1812012-02-02 00:54:52 +0000341 getHeaderSearchOpts().Sysroot);
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000342
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700343 for (auto &Listener : DependencyCollectors)
344 Listener->attachToPreprocessor(*PP);
345
346 // If we don't have a collector, but we are collecting module dependencies,
347 // then we're the top level compiler instance and need to create one.
348 if (!ModuleDepCollector && !DepOpts.ModuleDependencyOutputDir.empty())
349 ModuleDepCollector = std::make_shared<ModuleDependencyCollector>(
350 DepOpts.ModuleDependencyOutputDir);
Hans Wennborg708002e2013-08-09 00:32:23 +0000351
Daniel Dunbareef63e02011-02-02 15:41:17 +0000352 // Handle generating header include information, if requested.
353 if (DepOpts.ShowHeaderIncludes)
354 AttachHeaderIncludeGen(*PP);
Daniel Dunbarb34d69b2011-02-02 21:11:31 +0000355 if (!DepOpts.HeaderIncludeOutputFile.empty()) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000356 StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
Daniel Dunbarb34d69b2011-02-02 21:11:31 +0000357 if (OutputPath == "-")
358 OutputPath = "";
Daniel Dunbarda608852011-03-21 19:37:38 +0000359 AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/true, OutputPath,
360 /*ShowDepth=*/false);
Daniel Dunbarb34d69b2011-02-02 21:11:31 +0000361 }
Hans Wennborg708002e2013-08-09 00:32:23 +0000362
363 if (DepOpts.PrintShowIncludes) {
364 AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/false, /*OutputPath=*/"",
365 /*ShowDepth=*/true, /*MSStyle=*/true);
366 }
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000367}
Daniel Dunbar5eb81002009-11-13 08:20:47 +0000368
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700369std::string CompilerInstance::getSpecificModuleCachePath() {
370 // Set up the module path, including the hash for the
371 // module-creation options.
372 SmallString<256> SpecificModuleCache(
373 getHeaderSearchOpts().ModuleCachePath);
374 if (!getHeaderSearchOpts().DisableModuleHash)
375 llvm::sys::path::append(SpecificModuleCache,
376 getInvocation().getModuleHash());
377 return SpecificModuleCache.str();
378}
379
Daniel Dunbar5eb81002009-11-13 08:20:47 +0000380// ASTContext
381
382void CompilerInstance::createASTContext() {
383 Preprocessor &PP = getPreprocessor();
Ted Kremenek4f327862011-03-21 18:40:17 +0000384 Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700385 PP.getIdentifierTable(), PP.getSelectorTable(),
386 PP.getBuiltinInfo());
387 Context->InitBuiltinTypes(getTarget());
Daniel Dunbar5eb81002009-11-13 08:20:47 +0000388}
Daniel Dunbar0f800392009-11-13 08:21:10 +0000389
390// ExternalASTSource
391
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700392void CompilerInstance::createPCHExternalASTSource(
393 StringRef Path, bool DisablePCHValidation, bool AllowPCHWithCompilerErrors,
394 void *DeserializationListener, bool OwnDeserializationListener) {
Sebastian Redl1d9f1fe2010-10-05 16:15:19 +0000395 bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700396 ModuleManager = createPCHExternalASTSource(
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700397 Path, getHeaderSearchOpts().Sysroot, DisablePCHValidation,
398 AllowPCHWithCompilerErrors, getPreprocessor(), getASTContext(),
399 DeserializationListener, OwnDeserializationListener, Preamble,
400 getFrontendOpts().UseGlobalModuleIndex);
Daniel Dunbar0f800392009-11-13 08:21:10 +0000401}
402
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700403IntrusiveRefCntPtr<ASTReader> CompilerInstance::createPCHExternalASTSource(
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700404 StringRef Path, const std::string &Sysroot, bool DisablePCHValidation,
405 bool AllowPCHWithCompilerErrors, Preprocessor &PP, ASTContext &Context,
406 void *DeserializationListener, bool OwnDeserializationListener,
407 bool Preamble, bool UseGlobalModuleIndex) {
Stephen Hines651f13c2014-04-23 16:59:28 -0700408 HeaderSearchOptions &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
409
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700410 IntrusiveRefCntPtr<ASTReader> Reader(
411 new ASTReader(PP, Context, Sysroot.empty() ? "" : Sysroot.c_str(),
412 DisablePCHValidation, AllowPCHWithCompilerErrors,
413 /*AllowConfigurationMismatch*/ false,
414 HSOpts.ModulesValidateSystemHeaders, UseGlobalModuleIndex));
415
416 // We need the external source to be set up before we read the AST, because
417 // eagerly-deserialized declarations may use it.
418 Context.setExternalSource(Reader.get());
Daniel Dunbar0f800392009-11-13 08:21:10 +0000419
Sebastian Redlffaab3e2010-07-30 00:29:29 +0000420 Reader->setDeserializationListener(
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700421 static_cast<ASTDeserializationListener *>(DeserializationListener),
422 /*TakeOwnership=*/OwnDeserializationListener);
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000423 switch (Reader->ReadAST(Path,
424 Preamble ? serialization::MK_Preamble
Douglas Gregor38295be2012-10-22 23:51:00 +0000425 : serialization::MK_PCH,
Argyrios Kyrtzidis958bcaf2012-11-15 18:57:22 +0000426 SourceLocation(),
Douglas Gregor38295be2012-10-22 23:51:00 +0000427 ASTReader::ARR_None)) {
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000428 case ASTReader::Success:
Daniel Dunbar0f800392009-11-13 08:21:10 +0000429 // Set the predefines buffer as suggested by the PCH reader. Typically, the
430 // predefines buffer will be empty.
431 PP.setPredefines(Reader->getSuggestedPredefines());
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700432 return Reader;
Daniel Dunbar0f800392009-11-13 08:21:10 +0000433
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000434 case ASTReader::Failure:
Daniel Dunbar0f800392009-11-13 08:21:10 +0000435 // Unrecoverable failure: don't even try to process the input file.
436 break;
437
Douglas Gregor677e15f2013-03-19 00:28:20 +0000438 case ASTReader::Missing:
Douglas Gregor4825fd72012-10-22 22:50:17 +0000439 case ASTReader::OutOfDate:
440 case ASTReader::VersionMismatch:
441 case ASTReader::ConfigurationMismatch:
442 case ASTReader::HadErrors:
Daniel Dunbar0f800392009-11-13 08:21:10 +0000443 // No suitable PCH file could be found. Return an error.
444 break;
445 }
446
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700447 Context.setExternalSource(nullptr);
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700448 return nullptr;
Daniel Dunbar0f800392009-11-13 08:21:10 +0000449}
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000450
451// Code Completion
452
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000453static bool EnableCodeCompletion(Preprocessor &PP,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000454 const std::string &Filename,
455 unsigned Line,
456 unsigned Column) {
457 // Tell the source manager to chop off the given file at a specific
458 // line and column.
Chris Lattner39b49bc2010-11-23 08:35:12 +0000459 const FileEntry *Entry = PP.getFileManager().getFile(Filename);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000460 if (!Entry) {
461 PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
462 << Filename;
463 return true;
464 }
465
466 // Truncate the named file at the given line/column.
467 PP.SetCodeCompletionPoint(Entry, Line, Column);
468 return false;
469}
470
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000471void CompilerInstance::createCodeCompletionConsumer() {
472 const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000473 if (!CompletionConsumer) {
Erik Verbruggen9bc0c292012-04-12 10:31:12 +0000474 setCodeCompletionConsumer(
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000475 createCodeCompletionConsumer(getPreprocessor(),
476 Loc.FileName, Loc.Line, Loc.Column,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000477 getFrontendOpts().CodeCompleteOpts,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000478 llvm::outs()));
479 if (!CompletionConsumer)
480 return;
481 } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
482 Loc.Line, Loc.Column)) {
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700483 setCodeCompletionConsumer(nullptr);
Douglas Gregorc3d43b72010-03-16 06:04:47 +0000484 return;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000485 }
Douglas Gregor2b4074f2009-12-01 05:55:20 +0000486
487 if (CompletionConsumer->isOutputBinary() &&
Rafael Espindolaa6035692013-06-12 20:44:26 +0000488 llvm::sys::ChangeStdoutToBinary()) {
Douglas Gregor2b4074f2009-12-01 05:55:20 +0000489 getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700490 setCodeCompletionConsumer(nullptr);
Douglas Gregor2b4074f2009-12-01 05:55:20 +0000491 }
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000492}
493
Kovarththanan Rajaratnamf79bafa2009-11-29 09:57:35 +0000494void CompilerInstance::createFrontendTimer() {
495 FrontendTimer.reset(new llvm::Timer("Clang front-end timer"));
496}
497
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000498CodeCompleteConsumer *
499CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
500 const std::string &Filename,
501 unsigned Line,
502 unsigned Column,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000503 const CodeCompleteOptions &Opts,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000504 raw_ostream &OS) {
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000505 if (EnableCodeCompletion(PP, Filename, Line, Column))
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700506 return nullptr;
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000507
508 // Set up the creation routine for code-completion.
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000509 return new PrintingCodeCompleteConsumer(Opts, OS);
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000510}
Daniel Dunbara9204832009-11-13 10:37:48 +0000511
Douglas Gregor467dc882011-08-25 22:30:56 +0000512void CompilerInstance::createSema(TranslationUnitKind TUKind,
Douglas Gregorf18d0d82010-08-12 23:31:19 +0000513 CodeCompleteConsumer *CompletionConsumer) {
514 TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
Douglas Gregor467dc882011-08-25 22:30:56 +0000515 TUKind, CompletionConsumer));
Douglas Gregorf18d0d82010-08-12 23:31:19 +0000516}
517
Daniel Dunbara9204832009-11-13 10:37:48 +0000518// Output Files
519
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000520void CompilerInstance::addOutputFile(const OutputFile &OutFile) {
521 assert(OutFile.OS && "Attempt to add empty stream to output list!");
522 OutputFiles.push_back(OutFile);
Daniel Dunbara9204832009-11-13 10:37:48 +0000523}
524
Kovarththanan Rajaratname51dd7b2010-03-06 12:07:48 +0000525void CompilerInstance::clearOutputFiles(bool EraseFiles) {
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000526 for (std::list<OutputFile>::iterator
Daniel Dunbara9204832009-11-13 10:37:48 +0000527 it = OutputFiles.begin(), ie = OutputFiles.end(); it != ie; ++it) {
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000528 delete it->OS;
529 if (!it->TempFilename.empty()) {
Anders Carlssonaf036a62011-03-06 22:25:35 +0000530 if (EraseFiles) {
Stephen Hines651f13c2014-04-23 16:59:28 -0700531 llvm::sys::fs::remove(it->TempFilename);
Anders Carlssonaf036a62011-03-06 22:25:35 +0000532 } else {
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +0000533 SmallString<128> NewOutFile(it->Filename);
Anders Carlssonaf036a62011-03-06 22:25:35 +0000534
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000535 // If '-working-directory' was passed, the output filename should be
536 // relative to that.
Anders Carlsson2e2468e2011-03-14 01:13:54 +0000537 FileMgr->FixupRelativePath(NewOutFile);
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700538 if (std::error_code ec =
539 llvm::sys::fs::rename(it->TempFilename, NewOutFile.str())) {
Manuel Klimek832a2aa2012-05-16 20:55:58 +0000540 getDiagnostics().Report(diag::err_unable_to_rename_temp)
Anders Carlssonaf036a62011-03-06 22:25:35 +0000541 << it->TempFilename << it->Filename << ec.message();
542
Stephen Hines651f13c2014-04-23 16:59:28 -0700543 llvm::sys::fs::remove(it->TempFilename);
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000544 }
545 }
546 } else if (!it->Filename.empty() && EraseFiles)
Rafael Espindola48955f82013-06-26 04:32:59 +0000547 llvm::sys::fs::remove(it->Filename);
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000548
Daniel Dunbara9204832009-11-13 10:37:48 +0000549 }
550 OutputFiles.clear();
551}
552
Daniel Dunbarf482d592009-11-13 18:32:08 +0000553llvm::raw_fd_ostream *
554CompilerInstance::createDefaultOutputFile(bool Binary,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000555 StringRef InFile,
556 StringRef Extension) {
Daniel Dunbarf482d592009-11-13 18:32:08 +0000557 return createOutputFile(getFrontendOpts().OutputFile, Binary,
Daniel Dunbare21dd282012-03-03 00:36:06 +0000558 /*RemoveFileOnSignal=*/true, InFile, Extension,
559 /*UseTemporary=*/true);
Daniel Dunbarf482d592009-11-13 18:32:08 +0000560}
561
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700562llvm::raw_null_ostream *CompilerInstance::createNullOutputFile() {
563 llvm::raw_null_ostream *OS = new llvm::raw_null_ostream();
564 addOutputFile(OutputFile("", "", OS));
565 return OS;
566}
567
Daniel Dunbarf482d592009-11-13 18:32:08 +0000568llvm::raw_fd_ostream *
Chris Lattner5f9e2722011-07-23 10:55:15 +0000569CompilerInstance::createOutputFile(StringRef OutputPath,
Daniel Dunbarff9cd962011-01-31 22:00:42 +0000570 bool Binary, bool RemoveFileOnSignal,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000571 StringRef InFile,
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000572 StringRef Extension,
Daniel Dunbar12f28ab2012-03-03 00:36:02 +0000573 bool UseTemporary,
574 bool CreateMissingDirectories) {
Stephen Hines176edba2014-12-01 14:53:08 -0800575 std::string OutputPathName, TempPathName;
576 std::error_code EC;
577 llvm::raw_fd_ostream *OS = createOutputFile(
578 OutputPath, EC, Binary, RemoveFileOnSignal, InFile, Extension,
579 UseTemporary, CreateMissingDirectories, &OutputPathName, &TempPathName);
Daniel Dunbarf482d592009-11-13 18:32:08 +0000580 if (!OS) {
Stephen Hines176edba2014-12-01 14:53:08 -0800581 getDiagnostics().Report(diag::err_fe_unable_to_open_output) << OutputPath
582 << EC.message();
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700583 return nullptr;
Daniel Dunbarf482d592009-11-13 18:32:08 +0000584 }
585
586 // Add the output file -- but don't try to remove "-", since this means we are
587 // using stdin.
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000588 addOutputFile(OutputFile((OutputPathName != "-") ? OutputPathName : "",
589 TempPathName, OS));
Daniel Dunbarf482d592009-11-13 18:32:08 +0000590
591 return OS;
592}
593
Stephen Hines176edba2014-12-01 14:53:08 -0800594llvm::raw_fd_ostream *CompilerInstance::createOutputFile(
595 StringRef OutputPath, std::error_code &Error, bool Binary,
596 bool RemoveFileOnSignal, StringRef InFile, StringRef Extension,
597 bool UseTemporary, bool CreateMissingDirectories,
598 std::string *ResultPathName, std::string *TempPathName) {
Daniel Dunbar12f28ab2012-03-03 00:36:02 +0000599 assert((!CreateMissingDirectories || UseTemporary) &&
600 "CreateMissingDirectories is only allowed when using temporary files");
601
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000602 std::string OutFile, TempFile;
Daniel Dunbarf482d592009-11-13 18:32:08 +0000603 if (!OutputPath.empty()) {
604 OutFile = OutputPath;
605 } else if (InFile == "-") {
606 OutFile = "-";
607 } else if (!Extension.empty()) {
Rafael Espindola48955f82013-06-26 04:32:59 +0000608 SmallString<128> Path(InFile);
609 llvm::sys::path::replace_extension(Path, Extension);
Daniel Dunbarf482d592009-11-13 18:32:08 +0000610 OutFile = Path.str();
611 } else {
612 OutFile = "-";
613 }
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000614
Stephen Hines651f13c2014-04-23 16:59:28 -0700615 std::unique_ptr<llvm::raw_fd_ostream> OS;
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000616 std::string OSFile;
617
Rafael Espindola375a4f52013-06-27 18:26:26 +0000618 if (UseTemporary) {
619 if (OutFile == "-")
620 UseTemporary = false;
621 else {
622 llvm::sys::fs::file_status Status;
623 llvm::sys::fs::status(OutputPath, Status);
624 if (llvm::sys::fs::exists(Status)) {
625 // Fail early if we can't write to the final destination.
626 if (!llvm::sys::fs::can_write(OutputPath))
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700627 return nullptr;
Rafael Espindola375a4f52013-06-27 18:26:26 +0000628
629 // Don't use a temporary if the output is a special file. This handles
630 // things like '-o /dev/null'
631 if (!llvm::sys::fs::is_regular_file(Status))
632 UseTemporary = false;
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000633 }
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000634 }
635 }
636
Rafael Espindola375a4f52013-06-27 18:26:26 +0000637 if (UseTemporary) {
Rafael Espindola375a4f52013-06-27 18:26:26 +0000638 // Create a temporary file.
639 SmallString<128> TempPath;
640 TempPath = OutFile;
641 TempPath += "-%%%%%%%%";
642 int fd;
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700643 std::error_code EC =
Rafael Espindola70e7aec2013-07-05 21:13:58 +0000644 llvm::sys::fs::createUniqueFile(TempPath.str(), fd, TempPath);
Rafael Espindola8ffd0a42013-06-28 03:49:04 +0000645
646 if (CreateMissingDirectories &&
Rafael Espindolaabab1832013-07-05 14:15:24 +0000647 EC == llvm::errc::no_such_file_or_directory) {
Rafael Espindola8ffd0a42013-06-28 03:49:04 +0000648 StringRef Parent = llvm::sys::path::parent_path(OutputPath);
649 EC = llvm::sys::fs::create_directories(Parent);
650 if (!EC) {
Rafael Espindola70e7aec2013-07-05 21:13:58 +0000651 EC = llvm::sys::fs::createUniqueFile(TempPath.str(), fd, TempPath);
Rafael Espindola8ffd0a42013-06-28 03:49:04 +0000652 }
653 }
654
655 if (!EC) {
Rafael Espindola375a4f52013-06-27 18:26:26 +0000656 OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
657 OSFile = TempFile = TempPath.str();
658 }
659 // If we failed to create the temporary, fallback to writing to the file
660 // directly. This handles the corner case where we cannot write to the
661 // directory, but can write to the file.
662 }
663
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000664 if (!OS) {
665 OSFile = OutFile;
Rafael Espindolad965f952013-07-16 19:44:23 +0000666 OS.reset(new llvm::raw_fd_ostream(
Stephen Hines176edba2014-12-01 14:53:08 -0800667 OSFile, Error,
Stephen Hines651f13c2014-04-23 16:59:28 -0700668 (Binary ? llvm::sys::fs::F_None : llvm::sys::fs::F_Text)));
Stephen Hines176edba2014-12-01 14:53:08 -0800669 if (Error)
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700670 return nullptr;
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000671 }
Daniel Dunbarf482d592009-11-13 18:32:08 +0000672
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000673 // Make sure the out stream file gets removed if we crash.
Daniel Dunbarff9cd962011-01-31 22:00:42 +0000674 if (RemoveFileOnSignal)
Rafael Espindola6f2e23b2013-06-13 21:02:40 +0000675 llvm::sys::RemoveFileOnSignal(OSFile);
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000676
Daniel Dunbarf482d592009-11-13 18:32:08 +0000677 if (ResultPathName)
678 *ResultPathName = OutFile;
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000679 if (TempPathName)
680 *TempPathName = TempFile;
Daniel Dunbarf482d592009-11-13 18:32:08 +0000681
Stephen Hines651f13c2014-04-23 16:59:28 -0700682 return OS.release();
Daniel Dunbarf482d592009-11-13 18:32:08 +0000683}
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000684
685// Initialization Utilities
686
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000687bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
688 return InitializeSourceManager(Input, getDiagnostics(),
Douglas Gregora1f1fad2012-01-27 19:52:33 +0000689 getFileManager(), getSourceManager(),
690 getFrontendOpts());
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000691}
692
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000693bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input,
David Blaikied6471f72011-09-25 23:23:43 +0000694 DiagnosticsEngine &Diags,
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000695 FileManager &FileMgr,
696 SourceManager &SourceMgr,
697 const FrontendOptions &Opts) {
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000698 SrcMgr::CharacteristicKind
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +0000699 Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000700
Argyrios Kyrtzidisecd27bf2012-11-09 19:40:45 +0000701 if (Input.isBuffer()) {
Stephen Hines176edba2014-12-01 14:53:08 -0800702 SourceMgr.setMainFileID(SourceMgr.createFileID(
703 std::unique_ptr<llvm::MemoryBuffer>(Input.getBuffer()), Kind));
Argyrios Kyrtzidisecd27bf2012-11-09 19:40:45 +0000704 assert(!SourceMgr.getMainFileID().isInvalid() &&
705 "Couldn't establish MainFileID!");
706 return true;
707 }
708
709 StringRef InputFile = Input.getFile();
710
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +0000711 // Figure out where to get and map in the main file.
712 if (InputFile != "-") {
Benjamin Kramera3bf8972013-08-12 13:46:52 +0000713 const FileEntry *File = FileMgr.getFile(InputFile, /*OpenFile=*/true);
Dan Gohman694137c2010-10-26 21:13:51 +0000714 if (!File) {
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000715 Diags.Report(diag::err_fe_error_reading) << InputFile;
716 return false;
717 }
Daniel Dunbarce36ecd2012-11-05 22:53:33 +0000718
719 // The natural SourceManager infrastructure can't currently handle named
720 // pipes, but we would at least like to accept them for the main
Benjamin Kramera3bf8972013-08-12 13:46:52 +0000721 // file. Detect them here, read them with the volatile flag so FileMgr will
722 // pick up the correct size, and simply override their contents as we do for
723 // STDIN.
Daniel Dunbarce36ecd2012-11-05 22:53:33 +0000724 if (File->isNamedPipe()) {
Stephen Hines176edba2014-12-01 14:53:08 -0800725 auto MB = FileMgr.getBufferForFile(File, /*isVolatile=*/true);
726 if (MB) {
Benjamin Kramera3bf8972013-08-12 13:46:52 +0000727 // Create a new virtual file that will have the correct size.
Stephen Hines176edba2014-12-01 14:53:08 -0800728 File = FileMgr.getVirtualFile(InputFile, (*MB)->getBufferSize(), 0);
729 SourceMgr.overrideFileContents(File, std::move(*MB));
Benjamin Kramera3bf8972013-08-12 13:46:52 +0000730 } else {
Stephen Hines176edba2014-12-01 14:53:08 -0800731 Diags.Report(diag::err_cannot_open_file) << InputFile
732 << MB.getError().message();
Daniel Dunbarce36ecd2012-11-05 22:53:33 +0000733 return false;
734 }
Daniel Dunbarce36ecd2012-11-05 22:53:33 +0000735 }
Daniel Dunbaracf36122012-11-27 00:04:16 +0000736
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700737 SourceMgr.setMainFileID(
738 SourceMgr.createFileID(File, SourceLocation(), Kind));
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000739 } else {
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700740 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> SBOrErr =
741 llvm::MemoryBuffer::getSTDIN();
742 if (std::error_code EC = SBOrErr.getError()) {
743 Diags.Report(diag::err_fe_error_reading_stdin) << EC.message();
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000744 return false;
745 }
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700746 std::unique_ptr<llvm::MemoryBuffer> SB = std::move(SBOrErr.get());
747
Dan Gohman90d90812010-10-26 23:21:25 +0000748 const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
Chris Lattner39b49bc2010-11-23 08:35:12 +0000749 SB->getBufferSize(), 0);
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700750 SourceMgr.setMainFileID(
751 SourceMgr.createFileID(File, SourceLocation(), Kind));
Stephen Hines176edba2014-12-01 14:53:08 -0800752 SourceMgr.overrideFileContents(File, std::move(SB));
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000753 }
754
Dan Gohman694137c2010-10-26 21:13:51 +0000755 assert(!SourceMgr.getMainFileID().isInvalid() &&
756 "Couldn't establish MainFileID!");
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000757 return true;
758}
Daniel Dunbar0397af22010-01-13 00:48:06 +0000759
760// High-Level Operations
761
762bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
763 assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
764 assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
765 assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
766
767 // FIXME: Take this as an argument, once all the APIs we used have moved to
768 // taking it as an input instead of hard-coding llvm::errs.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000769 raw_ostream &OS = llvm::errs();
Daniel Dunbar0397af22010-01-13 00:48:06 +0000770
771 // Create the target instance.
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700772 setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(),
773 getInvocation().TargetOpts));
Daniel Dunbar0397af22010-01-13 00:48:06 +0000774 if (!hasTarget())
775 return false;
776
777 // Inform the target of the language options.
778 //
779 // FIXME: We shouldn't need to do this, the target should be immutable once
780 // created. This complexity should be lifted elsewhere.
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700781 getTarget().adjust(getLangOpts());
Daniel Dunbar0397af22010-01-13 00:48:06 +0000782
Fariborz Jahanian93a49942012-04-16 21:03:30 +0000783 // rewriter project will change target built-in bool type from its default.
784 if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
785 getTarget().noSignedCharForObjCBool();
786
Daniel Dunbar0397af22010-01-13 00:48:06 +0000787 // Validate/process some options.
788 if (getHeaderSearchOpts().Verbose)
789 OS << "clang -cc1 version " CLANG_VERSION_STRING
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700790 << " based upon " << BACKEND_PACKAGE_STRING
Sebastian Pop5d8b9542011-11-01 21:33:06 +0000791 << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
Daniel Dunbar0397af22010-01-13 00:48:06 +0000792
793 if (getFrontendOpts().ShowTimers)
794 createFrontendTimer();
795
Douglas Gregor95dd5582010-03-30 17:33:59 +0000796 if (getFrontendOpts().ShowStats)
797 llvm::EnableStatistics();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000798
Daniel Dunbar0397af22010-01-13 00:48:06 +0000799 for (unsigned i = 0, e = getFrontendOpts().Inputs.size(); i != e; ++i) {
Stephen Hines176edba2014-12-01 14:53:08 -0800800 // Reset the ID tables if we are reusing the SourceManager and parsing
801 // regular files.
802 if (hasSourceManager() && !Act.isModelParsingAction())
Daniel Dunbar20560482010-06-07 23:23:50 +0000803 getSourceManager().clearIDTables();
Daniel Dunbar0397af22010-01-13 00:48:06 +0000804
Douglas Gregor1f6b2b52012-01-20 16:28:04 +0000805 if (Act.BeginSourceFile(*this, getFrontendOpts().Inputs[i])) {
Daniel Dunbar0397af22010-01-13 00:48:06 +0000806 Act.Execute();
807 Act.EndSourceFile();
808 }
809 }
810
Argyrios Kyrtzidis29f27872011-12-07 05:52:12 +0000811 // Notify the diagnostic client that all files were processed.
812 getDiagnostics().getClient()->finish();
813
Chris Lattner53eee7b2010-04-07 18:47:42 +0000814 if (getDiagnosticOpts().ShowCarets) {
Argyrios Kyrtzidisf2224d82010-11-18 20:06:46 +0000815 // We can have multiple diagnostics sharing one diagnostic client.
816 // Get the total number of warnings/errors from the client.
817 unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
818 unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000819
Chris Lattner53eee7b2010-04-07 18:47:42 +0000820 if (NumWarnings)
821 OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
822 if (NumWarnings && NumErrors)
823 OS << " and ";
824 if (NumErrors)
825 OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
826 if (NumWarnings || NumErrors)
827 OS << " generated.\n";
828 }
Daniel Dunbar0397af22010-01-13 00:48:06 +0000829
Daniel Dunbar20560482010-06-07 23:23:50 +0000830 if (getFrontendOpts().ShowStats && hasFileManager()) {
Daniel Dunbar0397af22010-01-13 00:48:06 +0000831 getFileManager().PrintStats();
832 OS << "\n";
833 }
834
Argyrios Kyrtzidisab41b972010-11-18 21:13:57 +0000835 return !getDiagnostics().getClient()->getNumErrors();
Daniel Dunbar0397af22010-01-13 00:48:06 +0000836}
837
Douglas Gregor21cae202011-09-12 23:31:24 +0000838/// \brief Determine the appropriate source input kind based on language
839/// options.
840static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
841 if (LangOpts.OpenCL)
842 return IK_OpenCL;
843 if (LangOpts.CUDA)
844 return IK_CUDA;
845 if (LangOpts.ObjC1)
846 return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
847 return LangOpts.CPlusPlus? IK_CXX : IK_C;
848}
849
Douglas Gregorf9e357d2011-11-29 19:06:37 +0000850/// \brief Compile a module file for the given module, using the options
Stephen Hines176edba2014-12-01 14:53:08 -0800851/// provided by the importing compiler instance. Returns true if the module
852/// was built without errors.
853static bool compileModuleImpl(CompilerInstance &ImportingInstance,
854 SourceLocation ImportLoc,
855 Module *Module,
856 StringRef ModuleFileName) {
Douglas Gregorf9e357d2011-11-29 19:06:37 +0000857 ModuleMap &ModMap
858 = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
859
Douglas Gregor21cae202011-09-12 23:31:24 +0000860 // Construct a compiler invocation for creating this module.
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000861 IntrusiveRefCntPtr<CompilerInvocation> Invocation
Douglas Gregor21cae202011-09-12 23:31:24 +0000862 (new CompilerInvocation(ImportingInstance.getInvocation()));
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000863
Douglas Gregor18ee5472011-11-29 21:59:16 +0000864 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
865
Douglas Gregorb2d39c22011-09-15 20:53:28 +0000866 // For any options that aren't intended to affect how a module is built,
867 // reset them to their default values.
Ted Kremenekd3b74d92011-11-17 23:01:24 +0000868 Invocation->getLangOpts()->resetNonModularOptions();
Douglas Gregor18ee5472011-11-29 21:59:16 +0000869 PPOpts.resetNonModularOptions();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000870
Douglas Gregor2a060852013-02-07 00:21:12 +0000871 // Remove any macro definitions that are explicitly ignored by the module.
872 // They aren't supposed to affect how the module is built anyway.
873 const HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
Stephen Hines651f13c2014-04-23 16:59:28 -0700874 PPOpts.Macros.erase(
875 std::remove_if(PPOpts.Macros.begin(), PPOpts.Macros.end(),
876 [&HSOpts](const std::pair<std::string, bool> &def) {
877 StringRef MacroDef = def.first;
878 return HSOpts.ModulesIgnoreMacros.count(MacroDef.split('=').first) > 0;
879 }),
880 PPOpts.Macros.end());
Douglas Gregor2a060852013-02-07 00:21:12 +0000881
Douglas Gregorb86b8dc2011-11-15 19:35:01 +0000882 // Note the name of the module we're building.
Douglas Gregor933e7a62011-11-29 18:31:39 +0000883 Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
Douglas Gregorb86b8dc2011-11-15 19:35:01 +0000884
Douglas Gregor463d9092012-11-29 23:55:25 +0000885 // Make sure that the failed-module structure has been allocated in
886 // the importing instance, and propagate the pointer to the newly-created
887 // instance.
888 PreprocessorOptions &ImportingPPOpts
889 = ImportingInstance.getInvocation().getPreprocessorOpts();
890 if (!ImportingPPOpts.FailedModules)
891 ImportingPPOpts.FailedModules = new PreprocessorOptions::FailedModulesSet;
892 PPOpts.FailedModules = ImportingPPOpts.FailedModules;
893
Douglas Gregor18ee5472011-11-29 21:59:16 +0000894 // If there is a module map file, build the module using the module map.
Douglas Gregorb2d39c22011-09-15 20:53:28 +0000895 // Set up the inputs/outputs so that we build the module from its umbrella
896 // header.
Douglas Gregor21cae202011-09-12 23:31:24 +0000897 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
Douglas Gregor6e975c42011-09-13 23:15:45 +0000898 FrontendOpts.OutputFile = ModuleFileName.str();
Douglas Gregor21cae202011-09-12 23:31:24 +0000899 FrontendOpts.DisableFree = false;
Douglas Gregorf575d6e2013-01-25 00:45:27 +0000900 FrontendOpts.GenerateGlobalModuleIndex = false;
Douglas Gregor21cae202011-09-12 23:31:24 +0000901 FrontendOpts.Inputs.clear();
Douglas Gregor18ee5472011-11-29 21:59:16 +0000902 InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000903
Douglas Gregor18ee5472011-11-29 21:59:16 +0000904 // Don't free the remapped file buffers; they are owned by our caller.
905 PPOpts.RetainRemappedFileBuffers = true;
906
Douglas Gregor78243652011-09-13 01:26:44 +0000907 Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
Douglas Gregor76d991e2011-09-13 23:20:27 +0000908 assert(ImportingInstance.getInvocation().getModuleHash() ==
Douglas Gregor18ee5472011-11-29 21:59:16 +0000909 Invocation->getModuleHash() && "Module hash mismatch!");
910
Douglas Gregor21cae202011-09-12 23:31:24 +0000911 // Construct a compiler instance that will be used to actually create the
912 // module.
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700913 CompilerInstance Instance(/*BuildingModule=*/true);
Douglas Gregor21cae202011-09-12 23:31:24 +0000914 Instance.setInvocation(&*Invocation);
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000915
916 Instance.createDiagnostics(new ForwardingDiagnosticConsumer(
917 ImportingInstance.getDiagnosticClient()),
Douglas Gregorcc2b6532013-05-03 23:07:45 +0000918 /*ShouldOwnClient=*/true);
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000919
Stephen Hines651f13c2014-04-23 16:59:28 -0700920 Instance.setVirtualFileSystem(&ImportingInstance.getVirtualFileSystem());
921
Douglas Gregor4565e482012-11-30 22:11:57 +0000922 // Note that this module is part of the module build stack, so that we
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000923 // can detect cycles in the module graph.
Stephen Hines651f13c2014-04-23 16:59:28 -0700924 Instance.setFileManager(&ImportingInstance.getFileManager());
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000925 Instance.createSourceManager(Instance.getFileManager());
926 SourceManager &SourceMgr = Instance.getSourceManager();
Douglas Gregor4565e482012-11-30 22:11:57 +0000927 SourceMgr.setModuleBuildStack(
928 ImportingInstance.getSourceManager().getModuleBuildStack());
929 SourceMgr.pushModuleBuildStack(Module->getTopLevelModuleName(),
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000930 FullSourceLoc(ImportLoc, ImportingInstance.getSourceManager()));
931
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700932 // If we're collecting module dependencies, we need to share a collector
933 // between all of the module CompilerInstances.
934 Instance.setModuleDepCollector(ImportingInstance.getModuleDepCollector());
935
Manuel Klimekee0cd372013-10-24 07:51:24 +0000936 // Get or create the module map that we'll use to build this module.
937 std::string InferredModuleMapContent;
938 if (const FileEntry *ModuleMapFile =
939 ModMap.getContainingModuleMapFile(Module)) {
940 // Use the module map where this module resides.
941 FrontendOpts.Inputs.push_back(
942 FrontendInputFile(ModuleMapFile->getName(), IK));
943 } else {
944 llvm::raw_string_ostream OS(InferredModuleMapContent);
945 Module->print(OS);
946 OS.flush();
947 FrontendOpts.Inputs.push_back(
948 FrontendInputFile("__inferred_module.map", IK));
949
Stephen Hines176edba2014-12-01 14:53:08 -0800950 std::unique_ptr<llvm::MemoryBuffer> ModuleMapBuffer =
Manuel Klimekee0cd372013-10-24 07:51:24 +0000951 llvm::MemoryBuffer::getMemBuffer(InferredModuleMapContent);
952 ModuleMapFile = Instance.getFileManager().getVirtualFile(
953 "__inferred_module.map", InferredModuleMapContent.size(), 0);
Stephen Hines176edba2014-12-01 14:53:08 -0800954 SourceMgr.overrideFileContents(ModuleMapFile, std::move(ModuleMapBuffer));
Manuel Klimekee0cd372013-10-24 07:51:24 +0000955 }
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000956
Stephen Hines176edba2014-12-01 14:53:08 -0800957 // Construct a module-generating action. Passing through the module map is
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700958 // safe because the FileManager is shared between the compiler instances.
Stephen Hines176edba2014-12-01 14:53:08 -0800959 GenerateModuleAction CreateModuleAction(
960 ModMap.getModuleMapFileForUniquing(Module), Module->IsSystem);
961
962 ImportingInstance.getDiagnostics().Report(ImportLoc,
963 diag::remark_module_build)
964 << Module->Name << ModuleFileName;
965
Douglas Gregor0ced7992011-10-04 00:21:21 +0000966 // Execute the action to actually build the module in-place. Use a separate
967 // thread so that we get a stack large enough.
968 const unsigned ThreadStackSize = 8 << 20;
969 llvm::CrashRecoveryContext CRC;
Stephen Hines651f13c2014-04-23 16:59:28 -0700970 CRC.RunSafelyOnThread([&]() { Instance.ExecuteAction(CreateModuleAction); },
971 ThreadStackSize);
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000972
Stephen Hines176edba2014-12-01 14:53:08 -0800973 ImportingInstance.getDiagnostics().Report(ImportLoc,
974 diag::remark_module_build_done)
975 << Module->Name;
976
Douglas Gregor18ee5472011-11-29 21:59:16 +0000977 // Delete the temporary module map file.
978 // FIXME: Even though we're executing under crash protection, it would still
979 // be nice to do this with RemoveFileOnSignal when we can. However, that
980 // doesn't make sense for all clients, so clean this up manually.
Benjamin Kramera2e94892012-10-14 19:50:53 +0000981 Instance.clearOutputFiles(/*EraseFiles=*/true);
Douglas Gregora6b00fc2013-01-23 22:38:11 +0000982
983 // We've rebuilt a module. If we're allowed to generate or update the global
984 // module index, record that fact in the importing compiler instance.
Douglas Gregorf575d6e2013-01-25 00:45:27 +0000985 if (ImportingInstance.getFrontendOpts().GenerateGlobalModuleIndex) {
Douglas Gregora6b00fc2013-01-23 22:38:11 +0000986 ImportingInstance.setBuildGlobalModuleIndex(true);
987 }
Stephen Hines176edba2014-12-01 14:53:08 -0800988
989 return !Instance.getDiagnostics().hasErrorOccurred();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000990}
Douglas Gregor21cae202011-09-12 23:31:24 +0000991
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700992static bool compileAndLoadModule(CompilerInstance &ImportingInstance,
993 SourceLocation ImportLoc,
Stephen Hines176edba2014-12-01 14:53:08 -0800994 SourceLocation ModuleNameLoc, Module *Module,
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700995 StringRef ModuleFileName) {
Stephen Hines176edba2014-12-01 14:53:08 -0800996 DiagnosticsEngine &Diags = ImportingInstance.getDiagnostics();
997
998 auto diagnoseBuildFailure = [&] {
999 Diags.Report(ModuleNameLoc, diag::err_module_not_built)
1000 << Module->Name << SourceRange(ImportLoc, ModuleNameLoc);
1001 };
1002
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001003 // FIXME: have LockFileManager return an error_code so that we can
1004 // avoid the mkdir when the directory already exists.
1005 StringRef Dir = llvm::sys::path::parent_path(ModuleFileName);
1006 llvm::sys::fs::create_directories(Dir);
1007
1008 while (1) {
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001009 unsigned ModuleLoadCapabilities = ASTReader::ARR_Missing;
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001010 llvm::LockFileManager Locked(ModuleFileName);
1011 switch (Locked) {
1012 case llvm::LockFileManager::LFS_Error:
Stephen Hines176edba2014-12-01 14:53:08 -08001013 Diags.Report(ModuleNameLoc, diag::err_module_lock_failure)
1014 << Module->Name;
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001015 return false;
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001016
1017 case llvm::LockFileManager::LFS_Owned:
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001018 // We're responsible for building the module ourselves.
Stephen Hines176edba2014-12-01 14:53:08 -08001019 if (!compileModuleImpl(ImportingInstance, ModuleNameLoc, Module,
1020 ModuleFileName)) {
1021 diagnoseBuildFailure();
1022 return false;
1023 }
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001024 break;
1025
1026 case llvm::LockFileManager::LFS_Shared:
1027 // Someone else is responsible for building the module. Wait for them to
1028 // finish.
Stephen Hines0e2c34f2015-03-23 12:09:02 -07001029 switch (Locked.waitForUnlock()) {
1030 case llvm::LockFileManager::Res_Success:
1031 ModuleLoadCapabilities |= ASTReader::ARR_OutOfDate;
1032 break;
1033 case llvm::LockFileManager::Res_OwnerDied:
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001034 continue; // try again to get the lock.
Stephen Hines0e2c34f2015-03-23 12:09:02 -07001035 case llvm::LockFileManager::Res_Timeout:
1036 Diags.Report(ModuleNameLoc, diag::err_module_lock_timeout)
1037 << Module->Name;
1038 // Clear the lock file so that future invokations can make progress.
1039 Locked.unsafeRemoveLockFile();
1040 return false;
1041 }
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001042 break;
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001043 }
1044
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001045 // Try to read the module file, now that we've compiled it.
1046 ASTReader::ASTReadResult ReadResult =
1047 ImportingInstance.getModuleManager()->ReadAST(
Stephen Hines176edba2014-12-01 14:53:08 -08001048 ModuleFileName, serialization::MK_ImplicitModule, ImportLoc,
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001049 ModuleLoadCapabilities);
1050
1051 if (ReadResult == ASTReader::OutOfDate &&
1052 Locked == llvm::LockFileManager::LFS_Shared) {
1053 // The module may be out of date in the presence of file system races,
1054 // or if one of its imports depends on header search paths that are not
1055 // consistent with this ImportingInstance. Try again...
1056 continue;
1057 } else if (ReadResult == ASTReader::Missing) {
Stephen Hines176edba2014-12-01 14:53:08 -08001058 diagnoseBuildFailure();
1059 } else if (ReadResult != ASTReader::Success &&
1060 !Diags.hasErrorOccurred()) {
1061 // The ASTReader didn't diagnose the error, so conservatively report it.
1062 diagnoseBuildFailure();
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001063 }
1064 return ReadResult == ASTReader::Success;
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001065 }
1066}
1067
Douglas Gregor63a72682013-03-20 00:22:05 +00001068/// \brief Diagnose differences between the current definition of the given
1069/// configuration macro and the definition provided on the command line.
1070static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
1071 Module *Mod, SourceLocation ImportLoc) {
1072 IdentifierInfo *Id = PP.getIdentifierInfo(ConfigMacro);
1073 SourceManager &SourceMgr = PP.getSourceManager();
1074
1075 // If this identifier has never had a macro definition, then it could
1076 // not have changed.
1077 if (!Id->hadMacroDefinition())
1078 return;
1079
1080 // If this identifier does not currently have a macro definition,
1081 // check whether it had one on the command line.
1082 if (!Id->hasMacroDefinition()) {
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001083 MacroDirective::DefInfo LatestDef =
1084 PP.getMacroDirectiveHistory(Id)->getDefinition();
1085 for (MacroDirective::DefInfo Def = LatestDef; Def;
1086 Def = Def.getPreviousDefinition()) {
1087 FileID FID = SourceMgr.getFileID(Def.getLocation());
Douglas Gregor63a72682013-03-20 00:22:05 +00001088 if (FID.isInvalid())
1089 continue;
1090
Douglas Gregor63a72682013-03-20 00:22:05 +00001091 // We only care about the predefines buffer.
Douglas Gregor670b2e62013-04-03 03:16:36 +00001092 if (FID != PP.getPredefinesFileID())
Douglas Gregor63a72682013-03-20 00:22:05 +00001093 continue;
1094
1095 // This macro was defined on the command line, then #undef'd later.
1096 // Complain.
1097 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1098 << true << ConfigMacro << Mod->getFullModuleName();
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001099 if (LatestDef.isUndefined())
1100 PP.Diag(LatestDef.getUndefLocation(), diag::note_module_def_undef_here)
Douglas Gregor63a72682013-03-20 00:22:05 +00001101 << true;
1102 return;
1103 }
1104
1105 // Okay: no definition in the predefines buffer.
1106 return;
1107 }
1108
1109 // This identifier has a macro definition. Check whether we had a definition
1110 // on the command line.
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001111 MacroDirective::DefInfo LatestDef =
1112 PP.getMacroDirectiveHistory(Id)->getDefinition();
1113 MacroDirective::DefInfo PredefinedDef;
1114 for (MacroDirective::DefInfo Def = LatestDef; Def;
1115 Def = Def.getPreviousDefinition()) {
1116 FileID FID = SourceMgr.getFileID(Def.getLocation());
Douglas Gregor63a72682013-03-20 00:22:05 +00001117 if (FID.isInvalid())
1118 continue;
1119
Douglas Gregor63a72682013-03-20 00:22:05 +00001120 // We only care about the predefines buffer.
Douglas Gregor670b2e62013-04-03 03:16:36 +00001121 if (FID != PP.getPredefinesFileID())
Douglas Gregor63a72682013-03-20 00:22:05 +00001122 continue;
1123
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001124 PredefinedDef = Def;
Douglas Gregor63a72682013-03-20 00:22:05 +00001125 break;
1126 }
1127
1128 // If there was no definition for this macro in the predefines buffer,
1129 // complain.
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001130 if (!PredefinedDef ||
1131 (!PredefinedDef.getLocation().isValid() &&
1132 PredefinedDef.getUndefLocation().isValid())) {
Douglas Gregor63a72682013-03-20 00:22:05 +00001133 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1134 << false << ConfigMacro << Mod->getFullModuleName();
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001135 PP.Diag(LatestDef.getLocation(), diag::note_module_def_undef_here)
Douglas Gregor63a72682013-03-20 00:22:05 +00001136 << false;
1137 return;
1138 }
1139
1140 // If the current macro definition is the same as the predefined macro
1141 // definition, it's okay.
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001142 if (LatestDef.getMacroInfo() == PredefinedDef.getMacroInfo() ||
Argyrios Kyrtzidisbd25ff82013-04-03 17:39:30 +00001143 LatestDef.getMacroInfo()->isIdenticalTo(*PredefinedDef.getMacroInfo(),PP,
1144 /*Syntactically=*/true))
Douglas Gregor63a72682013-03-20 00:22:05 +00001145 return;
1146
1147 // The macro definitions differ.
1148 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1149 << false << ConfigMacro << Mod->getFullModuleName();
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001150 PP.Diag(LatestDef.getLocation(), diag::note_module_def_undef_here)
Douglas Gregor63a72682013-03-20 00:22:05 +00001151 << false;
1152}
1153
Douglas Gregord44d2872013-03-25 21:19:16 +00001154/// \brief Write a new timestamp file with the given path.
1155static void writeTimestampFile(StringRef TimestampFile) {
Stephen Hines176edba2014-12-01 14:53:08 -08001156 std::error_code EC;
1157 llvm::raw_fd_ostream Out(TimestampFile.str(), EC, llvm::sys::fs::F_None);
Douglas Gregord44d2872013-03-25 21:19:16 +00001158}
1159
1160/// \brief Prune the module cache of modules that haven't been accessed in
1161/// a long time.
1162static void pruneModuleCache(const HeaderSearchOptions &HSOpts) {
1163 struct stat StatBuf;
1164 llvm::SmallString<128> TimestampFile;
1165 TimestampFile = HSOpts.ModuleCachePath;
1166 llvm::sys::path::append(TimestampFile, "modules.timestamp");
1167
1168 // Try to stat() the timestamp file.
1169 if (::stat(TimestampFile.c_str(), &StatBuf)) {
1170 // If the timestamp file wasn't there, create one now.
1171 if (errno == ENOENT) {
1172 writeTimestampFile(TimestampFile);
1173 }
1174 return;
1175 }
1176
1177 // Check whether the time stamp is older than our pruning interval.
1178 // If not, do nothing.
1179 time_t TimeStampModTime = StatBuf.st_mtime;
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001180 time_t CurrentTime = time(nullptr);
Benjamin Kramer93ce7d52013-03-29 17:39:43 +00001181 if (CurrentTime - TimeStampModTime <= time_t(HSOpts.ModuleCachePruneInterval))
Douglas Gregord44d2872013-03-25 21:19:16 +00001182 return;
Douglas Gregord44d2872013-03-25 21:19:16 +00001183
1184 // Write a new timestamp file so that nobody else attempts to prune.
1185 // There is a benign race condition here, if two Clang instances happen to
1186 // notice at the same time that the timestamp is out-of-date.
1187 writeTimestampFile(TimestampFile);
1188
1189 // Walk the entire module cache, looking for unused module files and module
1190 // indices.
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001191 std::error_code EC;
Douglas Gregord44d2872013-03-25 21:19:16 +00001192 SmallString<128> ModuleCachePathNative;
1193 llvm::sys::path::native(HSOpts.ModuleCachePath, ModuleCachePathNative);
1194 for (llvm::sys::fs::directory_iterator
1195 Dir(ModuleCachePathNative.str(), EC), DirEnd;
1196 Dir != DirEnd && !EC; Dir.increment(EC)) {
1197 // If we don't have a directory, there's nothing to look into.
Rafael Espindolab470d1a2013-07-17 04:23:07 +00001198 if (!llvm::sys::fs::is_directory(Dir->path()))
Douglas Gregord44d2872013-03-25 21:19:16 +00001199 continue;
1200
1201 // Walk all of the files within this directory.
Douglas Gregord44d2872013-03-25 21:19:16 +00001202 for (llvm::sys::fs::directory_iterator File(Dir->path(), EC), FileEnd;
1203 File != FileEnd && !EC; File.increment(EC)) {
1204 // We only care about module and global module index files.
Stephen Hines651f13c2014-04-23 16:59:28 -07001205 StringRef Extension = llvm::sys::path::extension(File->path());
1206 if (Extension != ".pcm" && Extension != ".timestamp" &&
1207 llvm::sys::path::filename(File->path()) != "modules.idx")
Douglas Gregord44d2872013-03-25 21:19:16 +00001208 continue;
Douglas Gregord44d2872013-03-25 21:19:16 +00001209
1210 // Look at this file. If we can't stat it, there's nothing interesting
1211 // there.
Stephen Hines651f13c2014-04-23 16:59:28 -07001212 if (::stat(File->path().c_str(), &StatBuf))
Douglas Gregord44d2872013-03-25 21:19:16 +00001213 continue;
Douglas Gregord44d2872013-03-25 21:19:16 +00001214
1215 // If the file has been used recently enough, leave it there.
1216 time_t FileAccessTime = StatBuf.st_atime;
Benjamin Kramer93ce7d52013-03-29 17:39:43 +00001217 if (CurrentTime - FileAccessTime <=
1218 time_t(HSOpts.ModuleCachePruneAfter)) {
Douglas Gregord44d2872013-03-25 21:19:16 +00001219 continue;
1220 }
1221
1222 // Remove the file.
Stephen Hines651f13c2014-04-23 16:59:28 -07001223 llvm::sys::fs::remove(File->path());
1224
1225 // Remove the timestamp file.
1226 std::string TimpestampFilename = File->path() + ".timestamp";
1227 llvm::sys::fs::remove(TimpestampFilename);
Douglas Gregord44d2872013-03-25 21:19:16 +00001228 }
1229
1230 // If we removed all of the files in the directory, remove the directory
1231 // itself.
Stephen Hines651f13c2014-04-23 16:59:28 -07001232 if (llvm::sys::fs::directory_iterator(Dir->path(), EC) ==
1233 llvm::sys::fs::directory_iterator() && !EC)
1234 llvm::sys::fs::remove(Dir->path());
Douglas Gregord44d2872013-03-25 21:19:16 +00001235 }
1236}
1237
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001238void CompilerInstance::createModuleManager() {
1239 if (!ModuleManager) {
1240 if (!hasASTContext())
1241 createASTContext();
1242
1243 // If we're not recursively building a module, check whether we
1244 // need to prune the module cache.
1245 if (getSourceManager().getModuleBuildStack().empty() &&
1246 getHeaderSearchOpts().ModuleCachePruneInterval > 0 &&
1247 getHeaderSearchOpts().ModuleCachePruneAfter > 0) {
1248 pruneModuleCache(getHeaderSearchOpts());
1249 }
1250
1251 HeaderSearchOptions &HSOpts = getHeaderSearchOpts();
1252 std::string Sysroot = HSOpts.Sysroot;
1253 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
1254 ModuleManager = new ASTReader(getPreprocessor(), *Context,
1255 Sysroot.empty() ? "" : Sysroot.c_str(),
1256 PPOpts.DisablePCHValidation,
1257 /*AllowASTWithCompilerErrors=*/false,
1258 /*AllowConfigurationMismatch=*/false,
1259 HSOpts.ModulesValidateSystemHeaders,
1260 getFrontendOpts().UseGlobalModuleIndex);
1261 if (hasASTConsumer()) {
1262 ModuleManager->setDeserializationListener(
1263 getASTConsumer().GetASTDeserializationListener());
1264 getASTContext().setASTMutationListener(
1265 getASTConsumer().GetASTMutationListener());
1266 }
1267 getASTContext().setExternalSource(ModuleManager);
1268 if (hasSema())
1269 ModuleManager->InitializeSema(getSema());
1270 if (hasASTConsumer())
1271 ModuleManager->StartTranslationUnit(&getASTConsumer());
1272 }
1273}
1274
Stephen Hines176edba2014-12-01 14:53:08 -08001275bool CompilerInstance::loadModuleFile(StringRef FileName) {
1276 // Helper to recursively read the module names for all modules we're adding.
1277 // We mark these as known and redirect any attempt to load that module to
1278 // the files we were handed.
1279 struct ReadModuleNames : ASTReaderListener {
1280 CompilerInstance &CI;
1281 std::vector<StringRef> ModuleFileStack;
1282 bool Failed;
1283 bool TopFileIsModule;
1284
1285 ReadModuleNames(CompilerInstance &CI)
1286 : CI(CI), Failed(false), TopFileIsModule(false) {}
1287
1288 bool needsImportVisitation() const override { return true; }
1289
1290 void visitImport(StringRef FileName) override {
Stephen Hines0e2c34f2015-03-23 12:09:02 -07001291 if (!CI.ExplicitlyLoadedModuleFiles.insert(FileName).second) {
1292 if (ModuleFileStack.size() == 0)
1293 TopFileIsModule = true;
1294 return;
1295 }
1296
Stephen Hines176edba2014-12-01 14:53:08 -08001297 ModuleFileStack.push_back(FileName);
1298 if (ASTReader::readASTFileControlBlock(FileName, CI.getFileManager(),
1299 *this)) {
1300 CI.getDiagnostics().Report(SourceLocation(),
1301 diag::err_module_file_not_found)
1302 << FileName;
1303 // FIXME: Produce a note stack explaining how we got here.
1304 Failed = true;
1305 }
1306 ModuleFileStack.pop_back();
1307 }
1308
1309 void ReadModuleName(StringRef ModuleName) override {
1310 if (ModuleFileStack.size() == 1)
1311 TopFileIsModule = true;
1312
1313 auto &ModuleFile = CI.ModuleFileOverrides[ModuleName];
Stephen Hines0e2c34f2015-03-23 12:09:02 -07001314 if (!ModuleFile.empty() &&
1315 CI.getFileManager().getFile(ModuleFile) !=
1316 CI.getFileManager().getFile(ModuleFileStack.back()))
Stephen Hines176edba2014-12-01 14:53:08 -08001317 CI.getDiagnostics().Report(SourceLocation(),
1318 diag::err_conflicting_module_files)
1319 << ModuleName << ModuleFile << ModuleFileStack.back();
1320 ModuleFile = ModuleFileStack.back();
1321 }
1322 } RMN(*this);
1323
1324 RMN.visitImport(FileName);
1325
1326 if (RMN.Failed)
1327 return false;
1328
1329 // If we never found a module name for the top file, then it's not a module,
1330 // it's a PCH or preamble or something.
1331 if (!RMN.TopFileIsModule) {
1332 getDiagnostics().Report(SourceLocation(), diag::err_module_file_not_module)
1333 << FileName;
1334 return false;
1335 }
1336
1337 return true;
1338}
1339
Douglas Gregor463d9092012-11-29 23:55:25 +00001340ModuleLoadResult
1341CompilerInstance::loadModule(SourceLocation ImportLoc,
1342 ModuleIdPath Path,
1343 Module::NameVisibilityKind Visibility,
1344 bool IsInclusionDirective) {
Richard Smithb934d242013-10-18 22:48:20 +00001345 // Determine what file we're searching from.
1346 StringRef ModuleName = Path[0].first->getName();
1347 SourceLocation ModuleNameLoc = Path[0].second;
1348
Douglas Gregorb514c792011-11-30 04:26:53 +00001349 // If we've already handled this import, just return the cached result.
1350 // This one-element cache is important to eliminate redundant diagnostics
1351 // when both the preprocessor and parser see the same import declaration.
Douglas Gregor5e356932011-12-01 17:11:21 +00001352 if (!ImportLoc.isInvalid() && LastModuleImportLoc == ImportLoc) {
1353 // Make the named module visible.
Stephen Hines176edba2014-12-01 14:53:08 -08001354 if (LastModuleImportResult && ModuleName != getLangOpts().CurrentModule &&
1355 ModuleName != getLangOpts().ImplementationOfModule)
Argyrios Kyrtzidis5ebcb202013-02-01 16:36:12 +00001356 ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility,
Douglas Gregor906d66a2013-03-20 21:10:35 +00001357 ImportLoc, /*Complain=*/false);
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001358 return LastModuleImportResult;
Douglas Gregor5e356932011-12-01 17:11:21 +00001359 }
Douglas Gregor49009ec2011-11-30 04:03:44 +00001360
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001361 clang::Module *Module = nullptr;
Richard Smithb934d242013-10-18 22:48:20 +00001362
Douglas Gregor49009ec2011-11-30 04:03:44 +00001363 // If we don't already have information on this module, load the module now.
Douglas Gregor1a4761e2011-11-30 23:21:26 +00001364 llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001365 = KnownModules.find(Path[0].first);
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001366 if (Known != KnownModules.end()) {
1367 // Retrieve the cached top-level module.
1368 Module = Known->second;
Stephen Hines176edba2014-12-01 14:53:08 -08001369 } else if (ModuleName == getLangOpts().CurrentModule ||
1370 ModuleName == getLangOpts().ImplementationOfModule) {
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001371 // This is the module we're building.
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001372 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001373 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1374 } else {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001375 // Search for a module with the given name.
Douglas Gregore434ec72012-01-29 17:08:11 +00001376 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
Stephen Hines651f13c2014-04-23 16:59:28 -07001377 if (!Module) {
1378 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1379 << ModuleName
1380 << SourceRange(ImportLoc, ModuleNameLoc);
1381 ModuleBuildFailed = true;
1382 return ModuleLoadResult();
1383 }
1384
Stephen Hines176edba2014-12-01 14:53:08 -08001385 auto Override = ModuleFileOverrides.find(ModuleName);
1386 bool Explicit = Override != ModuleFileOverrides.end();
Stephen Hines0e2c34f2015-03-23 12:09:02 -07001387 if (!Explicit && !getLangOpts().ImplicitModules) {
1388 getDiagnostics().Report(ModuleNameLoc, diag::err_module_build_disabled)
1389 << ModuleName;
1390 ModuleBuildFailed = true;
1391 return ModuleLoadResult();
1392 }
Stephen Hines176edba2014-12-01 14:53:08 -08001393
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001394 std::string ModuleFileName =
Stephen Hines176edba2014-12-01 14:53:08 -08001395 Explicit ? Override->second
1396 : PP->getHeaderSearchInfo().getModuleFileName(Module);
Douglas Gregor463d9092012-11-29 23:55:25 +00001397
Douglas Gregor49009ec2011-11-30 04:03:44 +00001398 // If we don't already have an ASTReader, create one now.
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001399 if (!ModuleManager)
1400 createModuleManager();
Douglas Gregor49009ec2011-11-30 04:03:44 +00001401
Stephen Hines651f13c2014-04-23 16:59:28 -07001402 if (TheDependencyFileGenerator)
1403 TheDependencyFileGenerator->AttachToASTReader(*ModuleManager);
1404
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001405 if (ModuleDepCollector)
1406 ModuleDepCollector->attachToASTReader(*ModuleManager);
1407
1408 for (auto &Listener : DependencyCollectors)
1409 Listener->attachToASTReader(*ModuleManager);
1410
Douglas Gregor677e15f2013-03-19 00:28:20 +00001411 // Try to load the module file.
Stephen Hines176edba2014-12-01 14:53:08 -08001412 unsigned ARRFlags =
1413 Explicit ? 0 : ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing;
1414 switch (ModuleManager->ReadAST(ModuleFileName,
1415 Explicit ? serialization::MK_ExplicitModule
1416 : serialization::MK_ImplicitModule,
Douglas Gregor677e15f2013-03-19 00:28:20 +00001417 ImportLoc, ARRFlags)) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001418 case ASTReader::Success:
1419 break;
1420
Eli Friedman0295c232013-09-17 00:51:29 +00001421 case ASTReader::OutOfDate:
Douglas Gregor677e15f2013-03-19 00:28:20 +00001422 case ASTReader::Missing: {
Stephen Hines176edba2014-12-01 14:53:08 -08001423 if (Explicit) {
1424 // ReadAST has already complained for us.
1425 ModuleLoader::HadFatalFailure = true;
1426 KnownModules[Path[0].first] = nullptr;
1427 return ModuleLoadResult();
1428 }
1429
Eli Friedman0295c232013-09-17 00:51:29 +00001430 // The module file is missing or out-of-date. Build it.
Stephen Hines651f13c2014-04-23 16:59:28 -07001431 assert(Module && "missing module file");
Douglas Gregor677e15f2013-03-19 00:28:20 +00001432 // Check whether there is a cycle in the module graph.
1433 ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
1434 ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1435 for (; Pos != PosEnd; ++Pos) {
1436 if (Pos->first == ModuleName)
1437 break;
1438 }
1439
1440 if (Pos != PosEnd) {
1441 SmallString<256> CyclePath;
1442 for (; Pos != PosEnd; ++Pos) {
1443 CyclePath += Pos->first;
1444 CyclePath += " -> ";
1445 }
1446 CyclePath += ModuleName;
1447
1448 getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
1449 << ModuleName << CyclePath;
1450 return ModuleLoadResult();
1451 }
Douglas Gregor463d9092012-11-29 23:55:25 +00001452
1453 // Check whether we have already attempted to build this module (but
1454 // failed).
1455 if (getPreprocessorOpts().FailedModules &&
1456 getPreprocessorOpts().FailedModules->hasAlreadyFailed(ModuleName)) {
1457 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_built)
1458 << ModuleName
1459 << SourceRange(ImportLoc, ModuleNameLoc);
Douglas Gregorf575d6e2013-01-25 00:45:27 +00001460 ModuleBuildFailed = true;
Douglas Gregor463d9092012-11-29 23:55:25 +00001461 return ModuleLoadResult();
1462 }
1463
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001464 // Try to compile and then load the module.
1465 if (!compileAndLoadModule(*this, ImportLoc, ModuleNameLoc, Module,
1466 ModuleFileName)) {
Stephen Hines176edba2014-12-01 14:53:08 -08001467 assert(getDiagnostics().hasErrorOccurred() &&
1468 "undiagnosed error in compileAndLoadModule");
Douglas Gregorb8a8be12013-01-10 02:04:18 +00001469 if (getPreprocessorOpts().FailedModules)
1470 getPreprocessorOpts().FailedModules->addFailed(ModuleName);
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001471 KnownModules[Path[0].first] = nullptr;
Douglas Gregorf575d6e2013-01-25 00:45:27 +00001472 ModuleBuildFailed = true;
Douglas Gregor463d9092012-11-29 23:55:25 +00001473 return ModuleLoadResult();
Douglas Gregor7cdd2812012-11-07 17:46:15 +00001474 }
1475
1476 // Okay, we've rebuilt and now loaded the module.
1477 break;
1478 }
1479
Douglas Gregor4825fd72012-10-22 22:50:17 +00001480 case ASTReader::VersionMismatch:
1481 case ASTReader::ConfigurationMismatch:
1482 case ASTReader::HadErrors:
Argyrios Kyrtzidis3b7deda2013-05-24 05:44:08 +00001483 ModuleLoader::HadFatalFailure = true;
Douglas Gregor49009ec2011-11-30 04:03:44 +00001484 // FIXME: The ASTReader will already have complained, but can we showhorn
1485 // that diagnostic information into a more useful form?
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001486 KnownModules[Path[0].first] = nullptr;
Douglas Gregor463d9092012-11-29 23:55:25 +00001487 return ModuleLoadResult();
Douglas Gregor49009ec2011-11-30 04:03:44 +00001488
1489 case ASTReader::Failure:
Argyrios Kyrtzidis3b7deda2013-05-24 05:44:08 +00001490 ModuleLoader::HadFatalFailure = true;
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001491 // Already complained, but note now that we failed.
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001492 KnownModules[Path[0].first] = nullptr;
Douglas Gregorf575d6e2013-01-25 00:45:27 +00001493 ModuleBuildFailed = true;
Douglas Gregor463d9092012-11-29 23:55:25 +00001494 return ModuleLoadResult();
Douglas Gregor49009ec2011-11-30 04:03:44 +00001495 }
Argyrios Kyrtzidise2ac16b2012-09-29 01:06:04 +00001496
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001497 // Cache the result of this top-level module lookup for later.
1498 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
Douglas Gregor6aa52ec2011-08-26 23:56:07 +00001499 }
Douglas Gregor49009ec2011-11-30 04:03:44 +00001500
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001501 // If we never found the module, fail.
1502 if (!Module)
Douglas Gregor463d9092012-11-29 23:55:25 +00001503 return ModuleLoadResult();
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001504
Douglas Gregor49009ec2011-11-30 04:03:44 +00001505 // Verify that the rest of the module path actually corresponds to
1506 // a submodule.
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001507 if (Path.size() > 1) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001508 for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1509 StringRef Name = Path[I].first->getName();
Douglas Gregorb7a78192012-01-04 23:32:19 +00001510 clang::Module *Sub = Module->findSubmodule(Name);
Douglas Gregor49009ec2011-11-30 04:03:44 +00001511
Douglas Gregorb7a78192012-01-04 23:32:19 +00001512 if (!Sub) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001513 // Attempt to perform typo correction to find a module name that works.
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00001514 SmallVector<StringRef, 2> Best;
Douglas Gregor49009ec2011-11-30 04:03:44 +00001515 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1516
Douglas Gregorb7a78192012-01-04 23:32:19 +00001517 for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1518 JEnd = Module->submodule_end();
Matt Beaumont-Gaye25633f2011-11-30 19:41:21 +00001519 J != JEnd; ++J) {
Douglas Gregorb7a78192012-01-04 23:32:19 +00001520 unsigned ED = Name.edit_distance((*J)->Name,
Douglas Gregor49009ec2011-11-30 04:03:44 +00001521 /*AllowReplacements=*/true,
1522 BestEditDistance);
1523 if (ED <= BestEditDistance) {
Douglas Gregorb7a78192012-01-04 23:32:19 +00001524 if (ED < BestEditDistance) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001525 Best.clear();
Douglas Gregorb7a78192012-01-04 23:32:19 +00001526 BestEditDistance = ED;
1527 }
1528
1529 Best.push_back((*J)->Name);
Douglas Gregor49009ec2011-11-30 04:03:44 +00001530 }
1531 }
1532
1533 // If there was a clear winner, user it.
1534 if (Best.size() == 1) {
1535 getDiagnostics().Report(Path[I].second,
1536 diag::err_no_submodule_suggest)
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001537 << Path[I].first << Module->getFullModuleName() << Best[0]
Douglas Gregor49009ec2011-11-30 04:03:44 +00001538 << SourceRange(Path[0].second, Path[I-1].second)
1539 << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1540 Best[0]);
Douglas Gregorb7a78192012-01-04 23:32:19 +00001541
1542 Sub = Module->findSubmodule(Best[0]);
Douglas Gregor49009ec2011-11-30 04:03:44 +00001543 }
1544 }
1545
Douglas Gregorb7a78192012-01-04 23:32:19 +00001546 if (!Sub) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001547 // No submodule by this name. Complain, and don't look for further
1548 // submodules.
1549 getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001550 << Path[I].first << Module->getFullModuleName()
Douglas Gregor49009ec2011-11-30 04:03:44 +00001551 << SourceRange(Path[0].second, Path[I-1].second);
1552 break;
1553 }
1554
Douglas Gregorb7a78192012-01-04 23:32:19 +00001555 Module = Sub;
Douglas Gregor49009ec2011-11-30 04:03:44 +00001556 }
Douglas Gregor6aa52ec2011-08-26 23:56:07 +00001557 }
Stephen Hines176edba2014-12-01 14:53:08 -08001558
1559 // Don't make the module visible if we are in the implementation.
1560 if (ModuleName == getLangOpts().ImplementationOfModule)
1561 return ModuleLoadResult(Module, false);
Douglas Gregor49009ec2011-11-30 04:03:44 +00001562
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001563 // Make the named module visible, if it's not already part of the module
1564 // we are parsing.
Douglas Gregor305dc3e2011-12-20 00:28:52 +00001565 if (ModuleName != getLangOpts().CurrentModule) {
1566 if (!Module->IsFromModuleFile) {
1567 // We have an umbrella header or directory that doesn't actually include
1568 // all of the headers within the directory it covers. Complain about
1569 // this missing submodule and recover by forgetting that we ever saw
1570 // this submodule.
1571 // FIXME: Should we detect this at module load time? It seems fairly
1572 // expensive (and rare).
1573 getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1574 << Module->getFullModuleName()
1575 << SourceRange(Path.front().second, Path.back().second);
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001576
1577 return ModuleLoadResult(nullptr, true);
Douglas Gregor305dc3e2011-12-20 00:28:52 +00001578 }
Douglas Gregor51f564f2011-12-31 04:05:44 +00001579
1580 // Check whether this module is available.
Richard Smith5794b532013-10-28 22:18:19 +00001581 clang::Module::Requirement Requirement;
Stephen Hines0e2c34f2015-03-23 12:09:02 -07001582 clang::Module::UnresolvedHeaderDirective MissingHeader;
Stephen Hines651f13c2014-04-23 16:59:28 -07001583 if (!Module->isAvailable(getLangOpts(), getTarget(), Requirement,
1584 MissingHeader)) {
1585 if (MissingHeader.FileNameLoc.isValid()) {
1586 getDiagnostics().Report(MissingHeader.FileNameLoc,
1587 diag::err_module_header_missing)
1588 << MissingHeader.IsUmbrella << MissingHeader.FileName;
1589 } else {
1590 getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1591 << Module->getFullModuleName()
1592 << Requirement.second << Requirement.first
1593 << SourceRange(Path.front().second, Path.back().second);
1594 }
Douglas Gregor51f564f2011-12-31 04:05:44 +00001595 LastModuleImportLoc = ImportLoc;
Douglas Gregor463d9092012-11-29 23:55:25 +00001596 LastModuleImportResult = ModuleLoadResult();
1597 return ModuleLoadResult();
Douglas Gregor51f564f2011-12-31 04:05:44 +00001598 }
1599
Douglas Gregor906d66a2013-03-20 21:10:35 +00001600 ModuleManager->makeModuleVisible(Module, Visibility, ImportLoc,
1601 /*Complain=*/true);
Douglas Gregor305dc3e2011-12-20 00:28:52 +00001602 }
Douglas Gregor63a72682013-03-20 00:22:05 +00001603
1604 // Check for any configuration macros that have changed.
1605 clang::Module *TopModule = Module->getTopLevelModule();
1606 for (unsigned I = 0, N = TopModule->ConfigMacros.size(); I != N; ++I) {
1607 checkConfigMacro(getPreprocessor(), TopModule->ConfigMacros[I],
1608 Module, ImportLoc);
1609 }
1610
Stephen Hines0e2c34f2015-03-23 12:09:02 -07001611 // Determine whether we're in the #include buffer for a module. The #includes
1612 // in that buffer do not qualify as module imports; they're just an
1613 // implementation detail of us building the module.
1614 bool IsInModuleIncludes = !getLangOpts().CurrentModule.empty() &&
1615 getSourceManager().getFileID(ImportLoc) ==
1616 getSourceManager().getMainFileID();
1617
Douglas Gregor93ebfa62011-12-02 23:42:12 +00001618 // If this module import was due to an inclusion directive, create an
1619 // implicit import declaration to capture it in the AST.
Stephen Hines0e2c34f2015-03-23 12:09:02 -07001620 if (IsInclusionDirective && hasASTContext() && !IsInModuleIncludes) {
Douglas Gregor93ebfa62011-12-02 23:42:12 +00001621 TranslationUnitDecl *TU = getASTContext().getTranslationUnitDecl();
Argyrios Kyrtzidisd3d98162012-10-03 01:58:37 +00001622 ImportDecl *ImportD = ImportDecl::CreateImplicit(getASTContext(), TU,
1623 ImportLoc, Module,
1624 Path.back().second);
1625 TU->addDecl(ImportD);
1626 if (Consumer)
1627 Consumer->HandleImplicitImportDecl(ImportD);
Douglas Gregor93ebfa62011-12-02 23:42:12 +00001628 }
Douglas Gregor49009ec2011-11-30 04:03:44 +00001629
Douglas Gregorb514c792011-11-30 04:26:53 +00001630 LastModuleImportLoc = ImportLoc;
Douglas Gregor463d9092012-11-29 23:55:25 +00001631 LastModuleImportResult = ModuleLoadResult(Module, false);
1632 return LastModuleImportResult;
Douglas Gregor6aa52ec2011-08-26 23:56:07 +00001633}
Douglas Gregorca2ab452013-01-12 01:29:50 +00001634
1635void CompilerInstance::makeModuleVisible(Module *Mod,
Argyrios Kyrtzidis5ebcb202013-02-01 16:36:12 +00001636 Module::NameVisibilityKind Visibility,
Douglas Gregor906d66a2013-03-20 21:10:35 +00001637 SourceLocation ImportLoc,
1638 bool Complain){
1639 ModuleManager->makeModuleVisible(Mod, Visibility, ImportLoc, Complain);
Douglas Gregorca2ab452013-01-12 01:29:50 +00001640}
1641
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001642GlobalModuleIndex *CompilerInstance::loadGlobalModuleIndex(
1643 SourceLocation TriggerLoc) {
1644 if (!ModuleManager)
1645 createModuleManager();
1646 // Can't do anything if we don't have the module manager.
1647 if (!ModuleManager)
1648 return nullptr;
1649 // Get an existing global index. This loads it if not already
1650 // loaded.
1651 ModuleManager->loadGlobalIndex();
1652 GlobalModuleIndex *GlobalIndex = ModuleManager->getGlobalIndex();
1653 // If the global index doesn't exist, create it.
1654 if (!GlobalIndex && shouldBuildGlobalModuleIndex() && hasFileManager() &&
1655 hasPreprocessor()) {
1656 llvm::sys::fs::create_directories(
1657 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1658 GlobalModuleIndex::writeIndex(
1659 getFileManager(),
1660 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1661 ModuleManager->resetForReload();
1662 ModuleManager->loadGlobalIndex();
1663 GlobalIndex = ModuleManager->getGlobalIndex();
1664 }
1665 // For finding modules needing to be imported for fixit messages,
1666 // we need to make the global index cover all modules, so we do that here.
1667 if (!HaveFullGlobalModuleIndex && GlobalIndex && !buildingModule()) {
1668 ModuleMap &MMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
1669 bool RecreateIndex = false;
1670 for (ModuleMap::module_iterator I = MMap.module_begin(),
1671 E = MMap.module_end(); I != E; ++I) {
1672 Module *TheModule = I->second;
1673 const FileEntry *Entry = TheModule->getASTFile();
1674 if (!Entry) {
1675 SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
1676 Path.push_back(std::make_pair(
1677 getPreprocessor().getIdentifierInfo(TheModule->Name), TriggerLoc));
1678 std::reverse(Path.begin(), Path.end());
1679 // Load a module as hidden. This also adds it to the global index.
1680 loadModule(TheModule->DefinitionLoc, Path,
1681 Module::Hidden, false);
1682 RecreateIndex = true;
1683 }
1684 }
1685 if (RecreateIndex) {
1686 GlobalModuleIndex::writeIndex(
1687 getFileManager(),
1688 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1689 ModuleManager->resetForReload();
1690 ModuleManager->loadGlobalIndex();
1691 GlobalIndex = ModuleManager->getGlobalIndex();
1692 }
1693 HaveFullGlobalModuleIndex = true;
1694 }
1695 return GlobalIndex;
1696}
1697
1698// Check global module index for missing imports.
1699bool
1700CompilerInstance::lookupMissingImports(StringRef Name,
1701 SourceLocation TriggerLoc) {
1702 // Look for the symbol in non-imported modules, but only if an error
1703 // actually occurred.
1704 if (!buildingModule()) {
1705 // Load global module index, or retrieve a previously loaded one.
1706 GlobalModuleIndex *GlobalIndex = loadGlobalModuleIndex(
1707 TriggerLoc);
1708
1709 // Only if we have a global index.
1710 if (GlobalIndex) {
1711 GlobalModuleIndex::HitSet FoundModules;
1712
1713 // Find the modules that reference the identifier.
1714 // Note that this only finds top-level modules.
1715 // We'll let diagnoseTypo find the actual declaration module.
1716 if (GlobalIndex->lookupIdentifier(Name, FoundModules))
1717 return true;
1718 }
1719 }
1720
1721 return false;
1722}
Stephen Hines176edba2014-12-01 14:53:08 -08001723void CompilerInstance::resetAndLeakSema() { BuryPointer(takeSema()); }