blob: 7cea9e4efc031bc1f27f4d9aa365976b9be3c3c9 [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
Daniel Dunbar12ce6942009-11-14 02:47:17 +0000104void CompilerInstance::setASTConsumer(ASTConsumer *Value) {
105 Consumer.reset(Value);
106}
107
Daniel Dunbar8a9f5692009-11-14 01:20:40 +0000108void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
109 CompletionConsumer.reset(Value);
110}
Stephen Hines651f13c2014-04-23 16:59:28 -0700111
112IntrusiveRefCntPtr<ASTReader> CompilerInstance::getModuleManager() const {
113 return ModuleManager;
114}
115void CompilerInstance::setModuleManager(IntrusiveRefCntPtr<ASTReader> Reader) {
116 ModuleManager = Reader;
117}
Daniel Dunbar8a9f5692009-11-14 01:20:40 +0000118
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700119std::shared_ptr<ModuleDependencyCollector>
120CompilerInstance::getModuleDepCollector() const {
121 return ModuleDepCollector;
122}
123
124void CompilerInstance::setModuleDepCollector(
125 std::shared_ptr<ModuleDependencyCollector> Collector) {
126 ModuleDepCollector = Collector;
127}
128
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000129// Diagnostics
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000130static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts,
Daniel Dunbarb6534bb2011-04-07 18:59:02 +0000131 const CodeGenOptions *CodeGenOpts,
David Blaikied6471f72011-09-25 23:23:43 +0000132 DiagnosticsEngine &Diags) {
Daniel Dunbar9df23492011-04-07 18:31:10 +0000133 std::string ErrorInfo;
134 bool OwnsStream = false;
Chris Lattner5f9e2722011-07-23 10:55:15 +0000135 raw_ostream *OS = &llvm::errs();
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000136 if (DiagOpts->DiagnosticLogFile != "-") {
Daniel Dunbar9df23492011-04-07 18:31:10 +0000137 // Create the output stream.
Stephen Hines651f13c2014-04-23 16:59:28 -0700138 llvm::raw_fd_ostream *FileOS(new llvm::raw_fd_ostream(
139 DiagOpts->DiagnosticLogFile.c_str(), ErrorInfo,
140 llvm::sys::fs::F_Append | llvm::sys::fs::F_Text));
Daniel Dunbar9df23492011-04-07 18:31:10 +0000141 if (!ErrorInfo.empty()) {
142 Diags.Report(diag::warn_fe_cc_log_diagnostics_failure)
Sean Silvad2ff76b2013-01-20 01:58:26 +0000143 << DiagOpts->DiagnosticLogFile << ErrorInfo;
Daniel Dunbar9df23492011-04-07 18:31:10 +0000144 } else {
145 FileOS->SetUnbuffered();
146 FileOS->SetUseAtomicWrites(true);
147 OS = FileOS;
148 OwnsStream = true;
149 }
150 }
151
152 // Chain in the diagnostic client which will log the diagnostics.
Daniel Dunbarb6534bb2011-04-07 18:59:02 +0000153 LogDiagnosticPrinter *Logger = new LogDiagnosticPrinter(*OS, DiagOpts,
154 OwnsStream);
155 if (CodeGenOpts)
156 Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
David Blaikie4e85b8a2011-09-26 00:21:47 +0000157 Diags.setClient(new ChainedDiagnosticConsumer(Diags.takeClient(), Logger));
Daniel Dunbar9df23492011-04-07 18:31:10 +0000158}
159
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000160static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts,
Ted Kremenek78002122011-10-29 00:12:39 +0000161 DiagnosticsEngine &Diags,
162 StringRef OutputFile) {
163 std::string ErrorInfo;
Stephen Hines651f13c2014-04-23 16:59:28 -0700164 std::unique_ptr<llvm::raw_fd_ostream> OS;
Ted Kremenek78002122011-10-29 00:12:39 +0000165 OS.reset(new llvm::raw_fd_ostream(OutputFile.str().c_str(), ErrorInfo,
Stephen Hines651f13c2014-04-23 16:59:28 -0700166 llvm::sys::fs::F_None));
Rafael Espindolad965f952013-07-16 19:44:23 +0000167
Ted Kremenek78002122011-10-29 00:12:39 +0000168 if (!ErrorInfo.empty()) {
169 Diags.Report(diag::warn_fe_serialized_diag_failure)
170 << OutputFile << ErrorInfo;
171 return;
172 }
Ted Kremenek78002122011-10-29 00:12:39 +0000173
Stephen Hines651f13c2014-04-23 16:59:28 -0700174 DiagnosticConsumer *SerializedConsumer =
175 clang::serialized_diags::create(OS.release(), DiagOpts);
176
Ted Kremenek78002122011-10-29 00:12:39 +0000177 Diags.setClient(new ChainedDiagnosticConsumer(Diags.takeClient(),
178 SerializedConsumer));
179}
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
Douglas Gregor6e975c42011-09-13 23:15:45 +0000332 // Set up the module path, including the hash for the
333 // module-creation options.
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +0000334 SmallString<256> SpecificModuleCache(
Douglas Gregor6e975c42011-09-13 23:15:45 +0000335 getHeaderSearchOpts().ModuleCachePath);
336 if (!getHeaderSearchOpts().DisableModuleHash)
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000337 llvm::sys::path::append(SpecificModuleCache,
Douglas Gregor6e975c42011-09-13 23:15:45 +0000338 getInvocation().getModuleHash());
Douglas Gregor5e3f9222011-12-08 17:01:29 +0000339 PP->getHeaderSearchInfo().setModuleCachePath(SpecificModuleCache);
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000340
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000341 // Handle generating dependencies, if requested.
Douglas Gregor6aa52ec2011-08-26 23:56:07 +0000342 const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000343 if (!DepOpts.OutputFile.empty())
Stephen Hines651f13c2014-04-23 16:59:28 -0700344 TheDependencyFileGenerator.reset(
345 DependencyFileGenerator::CreateAndAttachToPreprocessor(*PP, DepOpts));
Douglas Gregor773303a2012-02-02 23:45:13 +0000346 if (!DepOpts.DOTOutputFile.empty())
347 AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
Douglas Gregorc69a1812012-02-02 00:54:52 +0000348 getHeaderSearchOpts().Sysroot);
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000349
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700350 for (auto &Listener : DependencyCollectors)
351 Listener->attachToPreprocessor(*PP);
352
353 // If we don't have a collector, but we are collecting module dependencies,
354 // then we're the top level compiler instance and need to create one.
355 if (!ModuleDepCollector && !DepOpts.ModuleDependencyOutputDir.empty())
356 ModuleDepCollector = std::make_shared<ModuleDependencyCollector>(
357 DepOpts.ModuleDependencyOutputDir);
Hans Wennborg708002e2013-08-09 00:32:23 +0000358
Daniel Dunbareef63e02011-02-02 15:41:17 +0000359 // Handle generating header include information, if requested.
360 if (DepOpts.ShowHeaderIncludes)
361 AttachHeaderIncludeGen(*PP);
Daniel Dunbarb34d69b2011-02-02 21:11:31 +0000362 if (!DepOpts.HeaderIncludeOutputFile.empty()) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000363 StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
Daniel Dunbarb34d69b2011-02-02 21:11:31 +0000364 if (OutputPath == "-")
365 OutputPath = "";
Daniel Dunbarda608852011-03-21 19:37:38 +0000366 AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/true, OutputPath,
367 /*ShowDepth=*/false);
Daniel Dunbarb34d69b2011-02-02 21:11:31 +0000368 }
Hans Wennborg708002e2013-08-09 00:32:23 +0000369
370 if (DepOpts.PrintShowIncludes) {
371 AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/false, /*OutputPath=*/"",
372 /*ShowDepth=*/true, /*MSStyle=*/true);
373 }
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000374}
Daniel Dunbar5eb81002009-11-13 08:20:47 +0000375
376// ASTContext
377
378void CompilerInstance::createASTContext() {
379 Preprocessor &PP = getPreprocessor();
Ted Kremenek4f327862011-03-21 18:40:17 +0000380 Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700381 PP.getIdentifierTable(), PP.getSelectorTable(),
382 PP.getBuiltinInfo());
383 Context->InitBuiltinTypes(getTarget());
Daniel Dunbar5eb81002009-11-13 08:20:47 +0000384}
Daniel Dunbar0f800392009-11-13 08:21:10 +0000385
386// ExternalASTSource
387
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700388void CompilerInstance::createPCHExternalASTSource(
389 StringRef Path, bool DisablePCHValidation, bool AllowPCHWithCompilerErrors,
390 void *DeserializationListener, bool OwnDeserializationListener) {
Stephen Hines651f13c2014-04-23 16:59:28 -0700391 IntrusiveRefCntPtr<ExternalASTSource> Source;
Sebastian Redl1d9f1fe2010-10-05 16:15:19 +0000392 bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700393 Source = createPCHExternalASTSource(
394 Path, getHeaderSearchOpts().Sysroot, DisablePCHValidation,
395 AllowPCHWithCompilerErrors, getPreprocessor(), getASTContext(),
396 DeserializationListener, OwnDeserializationListener, Preamble,
397 getFrontendOpts().UseGlobalModuleIndex);
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700398 ModuleManager = static_cast<ASTReader*>(Source.get());
Daniel Dunbar0f800392009-11-13 08:21:10 +0000399 getASTContext().setExternalSource(Source);
400}
401
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700402ExternalASTSource *CompilerInstance::createPCHExternalASTSource(
403 StringRef Path, const std::string &Sysroot, bool DisablePCHValidation,
404 bool AllowPCHWithCompilerErrors, Preprocessor &PP, ASTContext &Context,
405 void *DeserializationListener, bool OwnDeserializationListener,
406 bool Preamble, bool UseGlobalModuleIndex) {
Stephen Hines651f13c2014-04-23 16:59:28 -0700407 HeaderSearchOptions &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
408
409 std::unique_ptr<ASTReader> Reader;
Douglas Gregorf8a1e512011-09-02 00:26:20 +0000410 Reader.reset(new ASTReader(PP, Context,
Douglas Gregor832d6202011-07-22 16:35:34 +0000411 Sysroot.empty() ? "" : Sysroot.c_str(),
Argyrios Kyrtzidis4182ed62012-10-31 20:59:50 +0000412 DisablePCHValidation,
Douglas Gregorf575d6e2013-01-25 00:45:27 +0000413 AllowPCHWithCompilerErrors,
Stephen Hines651f13c2014-04-23 16:59:28 -0700414 /*AllowConfigurationMismatch*/false,
415 HSOpts.ModulesValidateSystemHeaders,
Douglas Gregorf575d6e2013-01-25 00:45:27 +0000416 UseGlobalModuleIndex));
Daniel Dunbar0f800392009-11-13 08:21:10 +0000417
Sebastian Redlffaab3e2010-07-30 00:29:29 +0000418 Reader->setDeserializationListener(
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700419 static_cast<ASTDeserializationListener *>(DeserializationListener),
420 /*TakeOwnership=*/OwnDeserializationListener);
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000421 switch (Reader->ReadAST(Path,
422 Preamble ? serialization::MK_Preamble
Douglas Gregor38295be2012-10-22 23:51:00 +0000423 : serialization::MK_PCH,
Argyrios Kyrtzidis958bcaf2012-11-15 18:57:22 +0000424 SourceLocation(),
Douglas Gregor38295be2012-10-22 23:51:00 +0000425 ASTReader::ARR_None)) {
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000426 case ASTReader::Success:
Daniel Dunbar0f800392009-11-13 08:21:10 +0000427 // Set the predefines buffer as suggested by the PCH reader. Typically, the
428 // predefines buffer will be empty.
429 PP.setPredefines(Reader->getSuggestedPredefines());
Stephen Hines651f13c2014-04-23 16:59:28 -0700430 return Reader.release();
Daniel Dunbar0f800392009-11-13 08:21:10 +0000431
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000432 case ASTReader::Failure:
Daniel Dunbar0f800392009-11-13 08:21:10 +0000433 // Unrecoverable failure: don't even try to process the input file.
434 break;
435
Douglas Gregor677e15f2013-03-19 00:28:20 +0000436 case ASTReader::Missing:
Douglas Gregor4825fd72012-10-22 22:50:17 +0000437 case ASTReader::OutOfDate:
438 case ASTReader::VersionMismatch:
439 case ASTReader::ConfigurationMismatch:
440 case ASTReader::HadErrors:
Daniel Dunbar0f800392009-11-13 08:21:10 +0000441 // No suitable PCH file could be found. Return an error.
442 break;
443 }
444
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700445 return nullptr;
Daniel Dunbar0f800392009-11-13 08:21:10 +0000446}
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000447
448// Code Completion
449
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000450static bool EnableCodeCompletion(Preprocessor &PP,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000451 const std::string &Filename,
452 unsigned Line,
453 unsigned Column) {
454 // Tell the source manager to chop off the given file at a specific
455 // line and column.
Chris Lattner39b49bc2010-11-23 08:35:12 +0000456 const FileEntry *Entry = PP.getFileManager().getFile(Filename);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000457 if (!Entry) {
458 PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
459 << Filename;
460 return true;
461 }
462
463 // Truncate the named file at the given line/column.
464 PP.SetCodeCompletionPoint(Entry, Line, Column);
465 return false;
466}
467
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000468void CompilerInstance::createCodeCompletionConsumer() {
469 const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000470 if (!CompletionConsumer) {
Erik Verbruggen9bc0c292012-04-12 10:31:12 +0000471 setCodeCompletionConsumer(
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000472 createCodeCompletionConsumer(getPreprocessor(),
473 Loc.FileName, Loc.Line, Loc.Column,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000474 getFrontendOpts().CodeCompleteOpts,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000475 llvm::outs()));
476 if (!CompletionConsumer)
477 return;
478 } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
479 Loc.Line, Loc.Column)) {
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700480 setCodeCompletionConsumer(nullptr);
Douglas Gregorc3d43b72010-03-16 06:04:47 +0000481 return;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000482 }
Douglas Gregor2b4074f2009-12-01 05:55:20 +0000483
484 if (CompletionConsumer->isOutputBinary() &&
Rafael Espindolaa6035692013-06-12 20:44:26 +0000485 llvm::sys::ChangeStdoutToBinary()) {
Douglas Gregor2b4074f2009-12-01 05:55:20 +0000486 getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700487 setCodeCompletionConsumer(nullptr);
Douglas Gregor2b4074f2009-12-01 05:55:20 +0000488 }
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000489}
490
Kovarththanan Rajaratnamf79bafa2009-11-29 09:57:35 +0000491void CompilerInstance::createFrontendTimer() {
492 FrontendTimer.reset(new llvm::Timer("Clang front-end timer"));
493}
494
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000495CodeCompleteConsumer *
496CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
497 const std::string &Filename,
498 unsigned Line,
499 unsigned Column,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000500 const CodeCompleteOptions &Opts,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000501 raw_ostream &OS) {
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000502 if (EnableCodeCompletion(PP, Filename, Line, Column))
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700503 return nullptr;
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000504
505 // Set up the creation routine for code-completion.
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000506 return new PrintingCodeCompleteConsumer(Opts, OS);
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000507}
Daniel Dunbara9204832009-11-13 10:37:48 +0000508
Douglas Gregor467dc882011-08-25 22:30:56 +0000509void CompilerInstance::createSema(TranslationUnitKind TUKind,
Douglas Gregorf18d0d82010-08-12 23:31:19 +0000510 CodeCompleteConsumer *CompletionConsumer) {
511 TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
Douglas Gregor467dc882011-08-25 22:30:56 +0000512 TUKind, CompletionConsumer));
Douglas Gregorf18d0d82010-08-12 23:31:19 +0000513}
514
Daniel Dunbara9204832009-11-13 10:37:48 +0000515// Output Files
516
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000517void CompilerInstance::addOutputFile(const OutputFile &OutFile) {
518 assert(OutFile.OS && "Attempt to add empty stream to output list!");
519 OutputFiles.push_back(OutFile);
Daniel Dunbara9204832009-11-13 10:37:48 +0000520}
521
Kovarththanan Rajaratname51dd7b2010-03-06 12:07:48 +0000522void CompilerInstance::clearOutputFiles(bool EraseFiles) {
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000523 for (std::list<OutputFile>::iterator
Daniel Dunbara9204832009-11-13 10:37:48 +0000524 it = OutputFiles.begin(), ie = OutputFiles.end(); it != ie; ++it) {
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000525 delete it->OS;
526 if (!it->TempFilename.empty()) {
Anders Carlssonaf036a62011-03-06 22:25:35 +0000527 if (EraseFiles) {
Stephen Hines651f13c2014-04-23 16:59:28 -0700528 llvm::sys::fs::remove(it->TempFilename);
Anders Carlssonaf036a62011-03-06 22:25:35 +0000529 } else {
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +0000530 SmallString<128> NewOutFile(it->Filename);
Anders Carlssonaf036a62011-03-06 22:25:35 +0000531
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000532 // If '-working-directory' was passed, the output filename should be
533 // relative to that.
Anders Carlsson2e2468e2011-03-14 01:13:54 +0000534 FileMgr->FixupRelativePath(NewOutFile);
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700535 if (std::error_code ec =
536 llvm::sys::fs::rename(it->TempFilename, NewOutFile.str())) {
Manuel Klimek832a2aa2012-05-16 20:55:58 +0000537 getDiagnostics().Report(diag::err_unable_to_rename_temp)
Anders Carlssonaf036a62011-03-06 22:25:35 +0000538 << it->TempFilename << it->Filename << ec.message();
539
Stephen Hines651f13c2014-04-23 16:59:28 -0700540 llvm::sys::fs::remove(it->TempFilename);
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000541 }
542 }
543 } else if (!it->Filename.empty() && EraseFiles)
Rafael Espindola48955f82013-06-26 04:32:59 +0000544 llvm::sys::fs::remove(it->Filename);
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000545
Daniel Dunbara9204832009-11-13 10:37:48 +0000546 }
547 OutputFiles.clear();
548}
549
Daniel Dunbarf482d592009-11-13 18:32:08 +0000550llvm::raw_fd_ostream *
551CompilerInstance::createDefaultOutputFile(bool Binary,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000552 StringRef InFile,
553 StringRef Extension) {
Daniel Dunbarf482d592009-11-13 18:32:08 +0000554 return createOutputFile(getFrontendOpts().OutputFile, Binary,
Daniel Dunbare21dd282012-03-03 00:36:06 +0000555 /*RemoveFileOnSignal=*/true, InFile, Extension,
556 /*UseTemporary=*/true);
Daniel Dunbarf482d592009-11-13 18:32:08 +0000557}
558
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700559llvm::raw_null_ostream *CompilerInstance::createNullOutputFile() {
560 llvm::raw_null_ostream *OS = new llvm::raw_null_ostream();
561 addOutputFile(OutputFile("", "", OS));
562 return OS;
563}
564
Daniel Dunbarf482d592009-11-13 18:32:08 +0000565llvm::raw_fd_ostream *
Chris Lattner5f9e2722011-07-23 10:55:15 +0000566CompilerInstance::createOutputFile(StringRef OutputPath,
Daniel Dunbarff9cd962011-01-31 22:00:42 +0000567 bool Binary, bool RemoveFileOnSignal,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000568 StringRef InFile,
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000569 StringRef Extension,
Daniel Dunbar12f28ab2012-03-03 00:36:02 +0000570 bool UseTemporary,
571 bool CreateMissingDirectories) {
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000572 std::string Error, OutputPathName, TempPathName;
Daniel Dunbarf482d592009-11-13 18:32:08 +0000573 llvm::raw_fd_ostream *OS = createOutputFile(OutputPath, Error, Binary,
Daniel Dunbarff9cd962011-01-31 22:00:42 +0000574 RemoveFileOnSignal,
Daniel Dunbarf482d592009-11-13 18:32:08 +0000575 InFile, Extension,
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000576 UseTemporary,
Daniel Dunbar12f28ab2012-03-03 00:36:02 +0000577 CreateMissingDirectories,
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000578 &OutputPathName,
579 &TempPathName);
Daniel Dunbarf482d592009-11-13 18:32:08 +0000580 if (!OS) {
Daniel Dunbar36043592009-12-03 09:13:30 +0000581 getDiagnostics().Report(diag::err_fe_unable_to_open_output)
582 << OutputPath << Error;
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
594llvm::raw_fd_ostream *
Chris Lattner5f9e2722011-07-23 10:55:15 +0000595CompilerInstance::createOutputFile(StringRef OutputPath,
Daniel Dunbarf482d592009-11-13 18:32:08 +0000596 std::string &Error,
597 bool Binary,
Daniel Dunbarff9cd962011-01-31 22:00:42 +0000598 bool RemoveFileOnSignal,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000599 StringRef InFile,
600 StringRef Extension,
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000601 bool UseTemporary,
Daniel Dunbar12f28ab2012-03-03 00:36:02 +0000602 bool CreateMissingDirectories,
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000603 std::string *ResultPathName,
604 std::string *TempPathName) {
Daniel Dunbar12f28ab2012-03-03 00:36:02 +0000605 assert((!CreateMissingDirectories || UseTemporary) &&
606 "CreateMissingDirectories is only allowed when using temporary files");
607
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000608 std::string OutFile, TempFile;
Daniel Dunbarf482d592009-11-13 18:32:08 +0000609 if (!OutputPath.empty()) {
610 OutFile = OutputPath;
611 } else if (InFile == "-") {
612 OutFile = "-";
613 } else if (!Extension.empty()) {
Rafael Espindola48955f82013-06-26 04:32:59 +0000614 SmallString<128> Path(InFile);
615 llvm::sys::path::replace_extension(Path, Extension);
Daniel Dunbarf482d592009-11-13 18:32:08 +0000616 OutFile = Path.str();
617 } else {
618 OutFile = "-";
619 }
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000620
Stephen Hines651f13c2014-04-23 16:59:28 -0700621 std::unique_ptr<llvm::raw_fd_ostream> OS;
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000622 std::string OSFile;
623
Rafael Espindola375a4f52013-06-27 18:26:26 +0000624 if (UseTemporary) {
625 if (OutFile == "-")
626 UseTemporary = false;
627 else {
628 llvm::sys::fs::file_status Status;
629 llvm::sys::fs::status(OutputPath, Status);
630 if (llvm::sys::fs::exists(Status)) {
631 // Fail early if we can't write to the final destination.
632 if (!llvm::sys::fs::can_write(OutputPath))
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700633 return nullptr;
Rafael Espindola375a4f52013-06-27 18:26:26 +0000634
635 // Don't use a temporary if the output is a special file. This handles
636 // things like '-o /dev/null'
637 if (!llvm::sys::fs::is_regular_file(Status))
638 UseTemporary = false;
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000639 }
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000640 }
641 }
642
Rafael Espindola375a4f52013-06-27 18:26:26 +0000643 if (UseTemporary) {
Rafael Espindola375a4f52013-06-27 18:26:26 +0000644 // Create a temporary file.
645 SmallString<128> TempPath;
646 TempPath = OutFile;
647 TempPath += "-%%%%%%%%";
648 int fd;
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700649 std::error_code EC =
Rafael Espindola70e7aec2013-07-05 21:13:58 +0000650 llvm::sys::fs::createUniqueFile(TempPath.str(), fd, TempPath);
Rafael Espindola8ffd0a42013-06-28 03:49:04 +0000651
652 if (CreateMissingDirectories &&
Rafael Espindolaabab1832013-07-05 14:15:24 +0000653 EC == llvm::errc::no_such_file_or_directory) {
Rafael Espindola8ffd0a42013-06-28 03:49:04 +0000654 StringRef Parent = llvm::sys::path::parent_path(OutputPath);
655 EC = llvm::sys::fs::create_directories(Parent);
656 if (!EC) {
Rafael Espindola70e7aec2013-07-05 21:13:58 +0000657 EC = llvm::sys::fs::createUniqueFile(TempPath.str(), fd, TempPath);
Rafael Espindola8ffd0a42013-06-28 03:49:04 +0000658 }
659 }
660
661 if (!EC) {
Rafael Espindola375a4f52013-06-27 18:26:26 +0000662 OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
663 OSFile = TempFile = TempPath.str();
664 }
665 // If we failed to create the temporary, fallback to writing to the file
666 // directly. This handles the corner case where we cannot write to the
667 // directory, but can write to the file.
668 }
669
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000670 if (!OS) {
671 OSFile = OutFile;
Rafael Espindolad965f952013-07-16 19:44:23 +0000672 OS.reset(new llvm::raw_fd_ostream(
673 OSFile.c_str(), Error,
Stephen Hines651f13c2014-04-23 16:59:28 -0700674 (Binary ? llvm::sys::fs::F_None : llvm::sys::fs::F_Text)));
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000675 if (!Error.empty())
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700676 return nullptr;
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000677 }
Daniel Dunbarf482d592009-11-13 18:32:08 +0000678
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000679 // Make sure the out stream file gets removed if we crash.
Daniel Dunbarff9cd962011-01-31 22:00:42 +0000680 if (RemoveFileOnSignal)
Rafael Espindola6f2e23b2013-06-13 21:02:40 +0000681 llvm::sys::RemoveFileOnSignal(OSFile);
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000682
Daniel Dunbarf482d592009-11-13 18:32:08 +0000683 if (ResultPathName)
684 *ResultPathName = OutFile;
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000685 if (TempPathName)
686 *TempPathName = TempFile;
Daniel Dunbarf482d592009-11-13 18:32:08 +0000687
Stephen Hines651f13c2014-04-23 16:59:28 -0700688 return OS.release();
Daniel Dunbarf482d592009-11-13 18:32:08 +0000689}
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000690
691// Initialization Utilities
692
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000693bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
694 return InitializeSourceManager(Input, getDiagnostics(),
Douglas Gregora1f1fad2012-01-27 19:52:33 +0000695 getFileManager(), getSourceManager(),
696 getFrontendOpts());
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000697}
698
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000699bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input,
David Blaikied6471f72011-09-25 23:23:43 +0000700 DiagnosticsEngine &Diags,
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000701 FileManager &FileMgr,
702 SourceManager &SourceMgr,
703 const FrontendOptions &Opts) {
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000704 SrcMgr::CharacteristicKind
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +0000705 Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000706
Argyrios Kyrtzidisecd27bf2012-11-09 19:40:45 +0000707 if (Input.isBuffer()) {
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700708 SourceMgr.setMainFileID(SourceMgr.createFileID(Input.getBuffer(), Kind));
Argyrios Kyrtzidisecd27bf2012-11-09 19:40:45 +0000709 assert(!SourceMgr.getMainFileID().isInvalid() &&
710 "Couldn't establish MainFileID!");
711 return true;
712 }
713
714 StringRef InputFile = Input.getFile();
715
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +0000716 // Figure out where to get and map in the main file.
717 if (InputFile != "-") {
Benjamin Kramera3bf8972013-08-12 13:46:52 +0000718 const FileEntry *File = FileMgr.getFile(InputFile, /*OpenFile=*/true);
Dan Gohman694137c2010-10-26 21:13:51 +0000719 if (!File) {
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000720 Diags.Report(diag::err_fe_error_reading) << InputFile;
721 return false;
722 }
Daniel Dunbarce36ecd2012-11-05 22:53:33 +0000723
724 // The natural SourceManager infrastructure can't currently handle named
725 // pipes, but we would at least like to accept them for the main
Benjamin Kramera3bf8972013-08-12 13:46:52 +0000726 // file. Detect them here, read them with the volatile flag so FileMgr will
727 // pick up the correct size, and simply override their contents as we do for
728 // STDIN.
Daniel Dunbarce36ecd2012-11-05 22:53:33 +0000729 if (File->isNamedPipe()) {
Benjamin Kramera3bf8972013-08-12 13:46:52 +0000730 std::string ErrorStr;
731 if (llvm::MemoryBuffer *MB =
732 FileMgr.getBufferForFile(File, &ErrorStr, /*isVolatile=*/true)) {
733 // Create a new virtual file that will have the correct size.
734 File = FileMgr.getVirtualFile(InputFile, MB->getBufferSize(), 0);
735 SourceMgr.overrideFileContents(File, MB);
736 } else {
737 Diags.Report(diag::err_cannot_open_file) << InputFile << ErrorStr;
Daniel Dunbarce36ecd2012-11-05 22:53:33 +0000738 return false;
739 }
Daniel Dunbarce36ecd2012-11-05 22:53:33 +0000740 }
Daniel Dunbaracf36122012-11-27 00:04:16 +0000741
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700742 SourceMgr.setMainFileID(
743 SourceMgr.createFileID(File, SourceLocation(), Kind));
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000744 } else {
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700745 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> SBOrErr =
746 llvm::MemoryBuffer::getSTDIN();
747 if (std::error_code EC = SBOrErr.getError()) {
748 Diags.Report(diag::err_fe_error_reading_stdin) << EC.message();
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000749 return false;
750 }
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700751 std::unique_ptr<llvm::MemoryBuffer> SB = std::move(SBOrErr.get());
752
Dan Gohman90d90812010-10-26 23:21:25 +0000753 const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
Chris Lattner39b49bc2010-11-23 08:35:12 +0000754 SB->getBufferSize(), 0);
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700755 SourceMgr.setMainFileID(
756 SourceMgr.createFileID(File, SourceLocation(), Kind));
Stephen Hines651f13c2014-04-23 16:59:28 -0700757 SourceMgr.overrideFileContents(File, SB.release());
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000758 }
759
Dan Gohman694137c2010-10-26 21:13:51 +0000760 assert(!SourceMgr.getMainFileID().isInvalid() &&
761 "Couldn't establish MainFileID!");
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000762 return true;
763}
Daniel Dunbar0397af22010-01-13 00:48:06 +0000764
765// High-Level Operations
766
767bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
768 assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
769 assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
770 assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
771
772 // FIXME: Take this as an argument, once all the APIs we used have moved to
773 // taking it as an input instead of hard-coding llvm::errs.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000774 raw_ostream &OS = llvm::errs();
Daniel Dunbar0397af22010-01-13 00:48:06 +0000775
776 // Create the target instance.
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700777 setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(),
778 getInvocation().TargetOpts));
Daniel Dunbar0397af22010-01-13 00:48:06 +0000779 if (!hasTarget())
780 return false;
781
782 // Inform the target of the language options.
783 //
784 // FIXME: We shouldn't need to do this, the target should be immutable once
785 // created. This complexity should be lifted elsewhere.
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700786 getTarget().adjust(getLangOpts());
Daniel Dunbar0397af22010-01-13 00:48:06 +0000787
Fariborz Jahanian93a49942012-04-16 21:03:30 +0000788 // rewriter project will change target built-in bool type from its default.
789 if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
790 getTarget().noSignedCharForObjCBool();
791
Daniel Dunbar0397af22010-01-13 00:48:06 +0000792 // Validate/process some options.
793 if (getHeaderSearchOpts().Verbose)
794 OS << "clang -cc1 version " CLANG_VERSION_STRING
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700795 << " based upon " << BACKEND_PACKAGE_STRING
Sebastian Pop5d8b9542011-11-01 21:33:06 +0000796 << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
Daniel Dunbar0397af22010-01-13 00:48:06 +0000797
798 if (getFrontendOpts().ShowTimers)
799 createFrontendTimer();
800
Douglas Gregor95dd5582010-03-30 17:33:59 +0000801 if (getFrontendOpts().ShowStats)
802 llvm::EnableStatistics();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000803
Daniel Dunbar0397af22010-01-13 00:48:06 +0000804 for (unsigned i = 0, e = getFrontendOpts().Inputs.size(); i != e; ++i) {
Daniel Dunbar20560482010-06-07 23:23:50 +0000805 // Reset the ID tables if we are reusing the SourceManager.
806 if (hasSourceManager())
807 getSourceManager().clearIDTables();
Daniel Dunbar0397af22010-01-13 00:48:06 +0000808
Douglas Gregor1f6b2b52012-01-20 16:28:04 +0000809 if (Act.BeginSourceFile(*this, getFrontendOpts().Inputs[i])) {
Daniel Dunbar0397af22010-01-13 00:48:06 +0000810 Act.Execute();
811 Act.EndSourceFile();
812 }
813 }
814
Argyrios Kyrtzidis29f27872011-12-07 05:52:12 +0000815 // Notify the diagnostic client that all files were processed.
816 getDiagnostics().getClient()->finish();
817
Chris Lattner53eee7b2010-04-07 18:47:42 +0000818 if (getDiagnosticOpts().ShowCarets) {
Argyrios Kyrtzidisf2224d82010-11-18 20:06:46 +0000819 // We can have multiple diagnostics sharing one diagnostic client.
820 // Get the total number of warnings/errors from the client.
821 unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
822 unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000823
Chris Lattner53eee7b2010-04-07 18:47:42 +0000824 if (NumWarnings)
825 OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
826 if (NumWarnings && NumErrors)
827 OS << " and ";
828 if (NumErrors)
829 OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
830 if (NumWarnings || NumErrors)
831 OS << " generated.\n";
832 }
Daniel Dunbar0397af22010-01-13 00:48:06 +0000833
Daniel Dunbar20560482010-06-07 23:23:50 +0000834 if (getFrontendOpts().ShowStats && hasFileManager()) {
Daniel Dunbar0397af22010-01-13 00:48:06 +0000835 getFileManager().PrintStats();
836 OS << "\n";
837 }
838
Argyrios Kyrtzidisab41b972010-11-18 21:13:57 +0000839 return !getDiagnostics().getClient()->getNumErrors();
Daniel Dunbar0397af22010-01-13 00:48:06 +0000840}
841
Douglas Gregor21cae202011-09-12 23:31:24 +0000842/// \brief Determine the appropriate source input kind based on language
843/// options.
844static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
845 if (LangOpts.OpenCL)
846 return IK_OpenCL;
847 if (LangOpts.CUDA)
848 return IK_CUDA;
849 if (LangOpts.ObjC1)
850 return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
851 return LangOpts.CPlusPlus? IK_CXX : IK_C;
852}
853
Douglas Gregorf9e357d2011-11-29 19:06:37 +0000854/// \brief Compile a module file for the given module, using the options
855/// provided by the importing compiler instance.
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700856static void compileModuleImpl(CompilerInstance &ImportingInstance,
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000857 SourceLocation ImportLoc,
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000858 Module *Module,
Douglas Gregor933e7a62011-11-29 18:31:39 +0000859 StringRef ModuleFileName) {
Douglas Gregorf9e357d2011-11-29 19:06:37 +0000860 ModuleMap &ModMap
861 = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
862
Douglas Gregor21cae202011-09-12 23:31:24 +0000863 // Construct a compiler invocation for creating this module.
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000864 IntrusiveRefCntPtr<CompilerInvocation> Invocation
Douglas Gregor21cae202011-09-12 23:31:24 +0000865 (new CompilerInvocation(ImportingInstance.getInvocation()));
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000866
Douglas Gregor18ee5472011-11-29 21:59:16 +0000867 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
868
Douglas Gregorb2d39c22011-09-15 20:53:28 +0000869 // For any options that aren't intended to affect how a module is built,
870 // reset them to their default values.
Ted Kremenekd3b74d92011-11-17 23:01:24 +0000871 Invocation->getLangOpts()->resetNonModularOptions();
Douglas Gregor18ee5472011-11-29 21:59:16 +0000872 PPOpts.resetNonModularOptions();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000873
Douglas Gregor2a060852013-02-07 00:21:12 +0000874 // Remove any macro definitions that are explicitly ignored by the module.
875 // They aren't supposed to affect how the module is built anyway.
876 const HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
Stephen Hines651f13c2014-04-23 16:59:28 -0700877 PPOpts.Macros.erase(
878 std::remove_if(PPOpts.Macros.begin(), PPOpts.Macros.end(),
879 [&HSOpts](const std::pair<std::string, bool> &def) {
880 StringRef MacroDef = def.first;
881 return HSOpts.ModulesIgnoreMacros.count(MacroDef.split('=').first) > 0;
882 }),
883 PPOpts.Macros.end());
Douglas Gregor2a060852013-02-07 00:21:12 +0000884
Douglas Gregorb86b8dc2011-11-15 19:35:01 +0000885 // Note the name of the module we're building.
Douglas Gregor933e7a62011-11-29 18:31:39 +0000886 Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
Douglas Gregorb86b8dc2011-11-15 19:35:01 +0000887
Douglas Gregor463d9092012-11-29 23:55:25 +0000888 // Make sure that the failed-module structure has been allocated in
889 // the importing instance, and propagate the pointer to the newly-created
890 // instance.
891 PreprocessorOptions &ImportingPPOpts
892 = ImportingInstance.getInvocation().getPreprocessorOpts();
893 if (!ImportingPPOpts.FailedModules)
894 ImportingPPOpts.FailedModules = new PreprocessorOptions::FailedModulesSet;
895 PPOpts.FailedModules = ImportingPPOpts.FailedModules;
896
Douglas Gregor18ee5472011-11-29 21:59:16 +0000897 // If there is a module map file, build the module using the module map.
Douglas Gregorb2d39c22011-09-15 20:53:28 +0000898 // Set up the inputs/outputs so that we build the module from its umbrella
899 // header.
Douglas Gregor21cae202011-09-12 23:31:24 +0000900 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
Douglas Gregor6e975c42011-09-13 23:15:45 +0000901 FrontendOpts.OutputFile = ModuleFileName.str();
Douglas Gregor21cae202011-09-12 23:31:24 +0000902 FrontendOpts.DisableFree = false;
Douglas Gregorf575d6e2013-01-25 00:45:27 +0000903 FrontendOpts.GenerateGlobalModuleIndex = false;
Douglas Gregor21cae202011-09-12 23:31:24 +0000904 FrontendOpts.Inputs.clear();
Douglas Gregor18ee5472011-11-29 21:59:16 +0000905 InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000906
Douglas Gregor18ee5472011-11-29 21:59:16 +0000907 // Don't free the remapped file buffers; they are owned by our caller.
908 PPOpts.RetainRemappedFileBuffers = true;
909
Douglas Gregor78243652011-09-13 01:26:44 +0000910 Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
Douglas Gregor76d991e2011-09-13 23:20:27 +0000911 assert(ImportingInstance.getInvocation().getModuleHash() ==
Douglas Gregor18ee5472011-11-29 21:59:16 +0000912 Invocation->getModuleHash() && "Module hash mismatch!");
913
Douglas Gregor21cae202011-09-12 23:31:24 +0000914 // Construct a compiler instance that will be used to actually create the
915 // module.
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700916 CompilerInstance Instance(/*BuildingModule=*/true);
Douglas Gregor21cae202011-09-12 23:31:24 +0000917 Instance.setInvocation(&*Invocation);
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000918
919 Instance.createDiagnostics(new ForwardingDiagnosticConsumer(
920 ImportingInstance.getDiagnosticClient()),
Douglas Gregorcc2b6532013-05-03 23:07:45 +0000921 /*ShouldOwnClient=*/true);
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000922
Stephen Hines651f13c2014-04-23 16:59:28 -0700923 Instance.setVirtualFileSystem(&ImportingInstance.getVirtualFileSystem());
924
Douglas Gregor4565e482012-11-30 22:11:57 +0000925 // Note that this module is part of the module build stack, so that we
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000926 // can detect cycles in the module graph.
Stephen Hines651f13c2014-04-23 16:59:28 -0700927 Instance.setFileManager(&ImportingInstance.getFileManager());
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000928 Instance.createSourceManager(Instance.getFileManager());
929 SourceManager &SourceMgr = Instance.getSourceManager();
Douglas Gregor4565e482012-11-30 22:11:57 +0000930 SourceMgr.setModuleBuildStack(
931 ImportingInstance.getSourceManager().getModuleBuildStack());
932 SourceMgr.pushModuleBuildStack(Module->getTopLevelModuleName(),
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000933 FullSourceLoc(ImportLoc, ImportingInstance.getSourceManager()));
934
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700935 // If we're collecting module dependencies, we need to share a collector
936 // between all of the module CompilerInstances.
937 Instance.setModuleDepCollector(ImportingInstance.getModuleDepCollector());
938
Manuel Klimekee0cd372013-10-24 07:51:24 +0000939 // Get or create the module map that we'll use to build this module.
940 std::string InferredModuleMapContent;
941 if (const FileEntry *ModuleMapFile =
942 ModMap.getContainingModuleMapFile(Module)) {
943 // Use the module map where this module resides.
944 FrontendOpts.Inputs.push_back(
945 FrontendInputFile(ModuleMapFile->getName(), IK));
946 } else {
947 llvm::raw_string_ostream OS(InferredModuleMapContent);
948 Module->print(OS);
949 OS.flush();
950 FrontendOpts.Inputs.push_back(
951 FrontendInputFile("__inferred_module.map", IK));
952
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700953 llvm::MemoryBuffer *ModuleMapBuffer =
Manuel Klimekee0cd372013-10-24 07:51:24 +0000954 llvm::MemoryBuffer::getMemBuffer(InferredModuleMapContent);
955 ModuleMapFile = Instance.getFileManager().getVirtualFile(
956 "__inferred_module.map", InferredModuleMapContent.size(), 0);
957 SourceMgr.overrideFileContents(ModuleMapFile, ModuleMapBuffer);
958 }
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000959
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700960 // Construct a module-generating action. Passing through Module->ModuleMap is
961 // safe because the FileManager is shared between the compiler instances.
962 GenerateModuleAction CreateModuleAction(Module->ModuleMap, Module->IsSystem);
Douglas Gregor18ee5472011-11-29 21:59:16 +0000963
Douglas Gregor0ced7992011-10-04 00:21:21 +0000964 // Execute the action to actually build the module in-place. Use a separate
965 // thread so that we get a stack large enough.
966 const unsigned ThreadStackSize = 8 << 20;
967 llvm::CrashRecoveryContext CRC;
Stephen Hines651f13c2014-04-23 16:59:28 -0700968 CRC.RunSafelyOnThread([&]() { Instance.ExecuteAction(CreateModuleAction); },
969 ThreadStackSize);
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000970
Douglas Gregor18ee5472011-11-29 21:59:16 +0000971 // Delete the temporary module map file.
972 // FIXME: Even though we're executing under crash protection, it would still
973 // be nice to do this with RemoveFileOnSignal when we can. However, that
974 // doesn't make sense for all clients, so clean this up manually.
Benjamin Kramera2e94892012-10-14 19:50:53 +0000975 Instance.clearOutputFiles(/*EraseFiles=*/true);
Douglas Gregora6b00fc2013-01-23 22:38:11 +0000976
977 // We've rebuilt a module. If we're allowed to generate or update the global
978 // module index, record that fact in the importing compiler instance.
Douglas Gregorf575d6e2013-01-25 00:45:27 +0000979 if (ImportingInstance.getFrontendOpts().GenerateGlobalModuleIndex) {
Douglas Gregora6b00fc2013-01-23 22:38:11 +0000980 ImportingInstance.setBuildGlobalModuleIndex(true);
981 }
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000982}
Douglas Gregor21cae202011-09-12 23:31:24 +0000983
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700984static bool compileAndLoadModule(CompilerInstance &ImportingInstance,
985 SourceLocation ImportLoc,
986 SourceLocation ModuleNameLoc,
987 Module *Module,
988 StringRef ModuleFileName) {
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700989 // FIXME: have LockFileManager return an error_code so that we can
990 // avoid the mkdir when the directory already exists.
991 StringRef Dir = llvm::sys::path::parent_path(ModuleFileName);
992 llvm::sys::fs::create_directories(Dir);
993
994 while (1) {
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700995 unsigned ModuleLoadCapabilities = ASTReader::ARR_Missing;
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700996 llvm::LockFileManager Locked(ModuleFileName);
997 switch (Locked) {
998 case llvm::LockFileManager::LFS_Error:
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700999 return false;
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001000
1001 case llvm::LockFileManager::LFS_Owned:
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001002 // We're responsible for building the module ourselves.
1003 // FIXME: if there are errors, don't attempt to load the module.
1004 compileModuleImpl(ImportingInstance, ModuleNameLoc, Module,
1005 ModuleFileName);
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001006 break;
1007
1008 case llvm::LockFileManager::LFS_Shared:
1009 // Someone else is responsible for building the module. Wait for them to
1010 // finish.
1011 if (Locked.waitForUnlock() == llvm::LockFileManager::Res_OwnerDied)
1012 continue; // try again to get the lock.
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001013 ModuleLoadCapabilities |= ASTReader::ARR_OutOfDate;
1014 break;
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001015 }
1016
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001017 // Try to read the module file, now that we've compiled it.
1018 ASTReader::ASTReadResult ReadResult =
1019 ImportingInstance.getModuleManager()->ReadAST(
1020 ModuleFileName, serialization::MK_Module, ImportLoc,
1021 ModuleLoadCapabilities);
1022
1023 if (ReadResult == ASTReader::OutOfDate &&
1024 Locked == llvm::LockFileManager::LFS_Shared) {
1025 // The module may be out of date in the presence of file system races,
1026 // or if one of its imports depends on header search paths that are not
1027 // consistent with this ImportingInstance. Try again...
1028 continue;
1029 } else if (ReadResult == ASTReader::Missing) {
1030 ImportingInstance.getDiagnostics().Report(ModuleNameLoc,
1031 diag::err_module_not_built)
1032 << Module->Name << SourceRange(ImportLoc, ModuleNameLoc);
1033 }
1034 return ReadResult == ASTReader::Success;
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001035 }
1036}
1037
Douglas Gregor63a72682013-03-20 00:22:05 +00001038/// \brief Diagnose differences between the current definition of the given
1039/// configuration macro and the definition provided on the command line.
1040static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
1041 Module *Mod, SourceLocation ImportLoc) {
1042 IdentifierInfo *Id = PP.getIdentifierInfo(ConfigMacro);
1043 SourceManager &SourceMgr = PP.getSourceManager();
1044
1045 // If this identifier has never had a macro definition, then it could
1046 // not have changed.
1047 if (!Id->hadMacroDefinition())
1048 return;
1049
1050 // If this identifier does not currently have a macro definition,
1051 // check whether it had one on the command line.
1052 if (!Id->hasMacroDefinition()) {
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001053 MacroDirective::DefInfo LatestDef =
1054 PP.getMacroDirectiveHistory(Id)->getDefinition();
1055 for (MacroDirective::DefInfo Def = LatestDef; Def;
1056 Def = Def.getPreviousDefinition()) {
1057 FileID FID = SourceMgr.getFileID(Def.getLocation());
Douglas Gregor63a72682013-03-20 00:22:05 +00001058 if (FID.isInvalid())
1059 continue;
1060
Douglas Gregor63a72682013-03-20 00:22:05 +00001061 // We only care about the predefines buffer.
Douglas Gregor670b2e62013-04-03 03:16:36 +00001062 if (FID != PP.getPredefinesFileID())
Douglas Gregor63a72682013-03-20 00:22:05 +00001063 continue;
1064
1065 // This macro was defined on the command line, then #undef'd later.
1066 // Complain.
1067 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1068 << true << ConfigMacro << Mod->getFullModuleName();
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001069 if (LatestDef.isUndefined())
1070 PP.Diag(LatestDef.getUndefLocation(), diag::note_module_def_undef_here)
Douglas Gregor63a72682013-03-20 00:22:05 +00001071 << true;
1072 return;
1073 }
1074
1075 // Okay: no definition in the predefines buffer.
1076 return;
1077 }
1078
1079 // This identifier has a macro definition. Check whether we had a definition
1080 // on the command line.
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001081 MacroDirective::DefInfo LatestDef =
1082 PP.getMacroDirectiveHistory(Id)->getDefinition();
1083 MacroDirective::DefInfo PredefinedDef;
1084 for (MacroDirective::DefInfo Def = LatestDef; Def;
1085 Def = Def.getPreviousDefinition()) {
1086 FileID FID = SourceMgr.getFileID(Def.getLocation());
Douglas Gregor63a72682013-03-20 00:22:05 +00001087 if (FID.isInvalid())
1088 continue;
1089
Douglas Gregor63a72682013-03-20 00:22:05 +00001090 // We only care about the predefines buffer.
Douglas Gregor670b2e62013-04-03 03:16:36 +00001091 if (FID != PP.getPredefinesFileID())
Douglas Gregor63a72682013-03-20 00:22:05 +00001092 continue;
1093
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001094 PredefinedDef = Def;
Douglas Gregor63a72682013-03-20 00:22:05 +00001095 break;
1096 }
1097
1098 // If there was no definition for this macro in the predefines buffer,
1099 // complain.
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001100 if (!PredefinedDef ||
1101 (!PredefinedDef.getLocation().isValid() &&
1102 PredefinedDef.getUndefLocation().isValid())) {
Douglas Gregor63a72682013-03-20 00:22:05 +00001103 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1104 << false << ConfigMacro << Mod->getFullModuleName();
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001105 PP.Diag(LatestDef.getLocation(), diag::note_module_def_undef_here)
Douglas Gregor63a72682013-03-20 00:22:05 +00001106 << false;
1107 return;
1108 }
1109
1110 // If the current macro definition is the same as the predefined macro
1111 // definition, it's okay.
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001112 if (LatestDef.getMacroInfo() == PredefinedDef.getMacroInfo() ||
Argyrios Kyrtzidisbd25ff82013-04-03 17:39:30 +00001113 LatestDef.getMacroInfo()->isIdenticalTo(*PredefinedDef.getMacroInfo(),PP,
1114 /*Syntactically=*/true))
Douglas Gregor63a72682013-03-20 00:22:05 +00001115 return;
1116
1117 // The macro definitions differ.
1118 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1119 << false << ConfigMacro << Mod->getFullModuleName();
Argyrios Kyrtzidisc56fff72013-03-26 17:17:01 +00001120 PP.Diag(LatestDef.getLocation(), diag::note_module_def_undef_here)
Douglas Gregor63a72682013-03-20 00:22:05 +00001121 << false;
1122}
1123
Douglas Gregord44d2872013-03-25 21:19:16 +00001124/// \brief Write a new timestamp file with the given path.
1125static void writeTimestampFile(StringRef TimestampFile) {
1126 std::string ErrorInfo;
1127 llvm::raw_fd_ostream Out(TimestampFile.str().c_str(), ErrorInfo,
Stephen Hines651f13c2014-04-23 16:59:28 -07001128 llvm::sys::fs::F_None);
Douglas Gregord44d2872013-03-25 21:19:16 +00001129}
1130
1131/// \brief Prune the module cache of modules that haven't been accessed in
1132/// a long time.
1133static void pruneModuleCache(const HeaderSearchOptions &HSOpts) {
1134 struct stat StatBuf;
1135 llvm::SmallString<128> TimestampFile;
1136 TimestampFile = HSOpts.ModuleCachePath;
1137 llvm::sys::path::append(TimestampFile, "modules.timestamp");
1138
1139 // Try to stat() the timestamp file.
1140 if (::stat(TimestampFile.c_str(), &StatBuf)) {
1141 // If the timestamp file wasn't there, create one now.
1142 if (errno == ENOENT) {
1143 writeTimestampFile(TimestampFile);
1144 }
1145 return;
1146 }
1147
1148 // Check whether the time stamp is older than our pruning interval.
1149 // If not, do nothing.
1150 time_t TimeStampModTime = StatBuf.st_mtime;
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001151 time_t CurrentTime = time(nullptr);
Benjamin Kramer93ce7d52013-03-29 17:39:43 +00001152 if (CurrentTime - TimeStampModTime <= time_t(HSOpts.ModuleCachePruneInterval))
Douglas Gregord44d2872013-03-25 21:19:16 +00001153 return;
Douglas Gregord44d2872013-03-25 21:19:16 +00001154
1155 // Write a new timestamp file so that nobody else attempts to prune.
1156 // There is a benign race condition here, if two Clang instances happen to
1157 // notice at the same time that the timestamp is out-of-date.
1158 writeTimestampFile(TimestampFile);
1159
1160 // Walk the entire module cache, looking for unused module files and module
1161 // indices.
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001162 std::error_code EC;
Douglas Gregord44d2872013-03-25 21:19:16 +00001163 SmallString<128> ModuleCachePathNative;
1164 llvm::sys::path::native(HSOpts.ModuleCachePath, ModuleCachePathNative);
1165 for (llvm::sys::fs::directory_iterator
1166 Dir(ModuleCachePathNative.str(), EC), DirEnd;
1167 Dir != DirEnd && !EC; Dir.increment(EC)) {
1168 // If we don't have a directory, there's nothing to look into.
Rafael Espindolab470d1a2013-07-17 04:23:07 +00001169 if (!llvm::sys::fs::is_directory(Dir->path()))
Douglas Gregord44d2872013-03-25 21:19:16 +00001170 continue;
1171
1172 // Walk all of the files within this directory.
Douglas Gregord44d2872013-03-25 21:19:16 +00001173 for (llvm::sys::fs::directory_iterator File(Dir->path(), EC), FileEnd;
1174 File != FileEnd && !EC; File.increment(EC)) {
1175 // We only care about module and global module index files.
Stephen Hines651f13c2014-04-23 16:59:28 -07001176 StringRef Extension = llvm::sys::path::extension(File->path());
1177 if (Extension != ".pcm" && Extension != ".timestamp" &&
1178 llvm::sys::path::filename(File->path()) != "modules.idx")
Douglas Gregord44d2872013-03-25 21:19:16 +00001179 continue;
Douglas Gregord44d2872013-03-25 21:19:16 +00001180
1181 // Look at this file. If we can't stat it, there's nothing interesting
1182 // there.
Stephen Hines651f13c2014-04-23 16:59:28 -07001183 if (::stat(File->path().c_str(), &StatBuf))
Douglas Gregord44d2872013-03-25 21:19:16 +00001184 continue;
Douglas Gregord44d2872013-03-25 21:19:16 +00001185
1186 // If the file has been used recently enough, leave it there.
1187 time_t FileAccessTime = StatBuf.st_atime;
Benjamin Kramer93ce7d52013-03-29 17:39:43 +00001188 if (CurrentTime - FileAccessTime <=
1189 time_t(HSOpts.ModuleCachePruneAfter)) {
Douglas Gregord44d2872013-03-25 21:19:16 +00001190 continue;
1191 }
1192
1193 // Remove the file.
Stephen Hines651f13c2014-04-23 16:59:28 -07001194 llvm::sys::fs::remove(File->path());
1195
1196 // Remove the timestamp file.
1197 std::string TimpestampFilename = File->path() + ".timestamp";
1198 llvm::sys::fs::remove(TimpestampFilename);
Douglas Gregord44d2872013-03-25 21:19:16 +00001199 }
1200
1201 // If we removed all of the files in the directory, remove the directory
1202 // itself.
Stephen Hines651f13c2014-04-23 16:59:28 -07001203 if (llvm::sys::fs::directory_iterator(Dir->path(), EC) ==
1204 llvm::sys::fs::directory_iterator() && !EC)
1205 llvm::sys::fs::remove(Dir->path());
Douglas Gregord44d2872013-03-25 21:19:16 +00001206 }
1207}
1208
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001209void CompilerInstance::createModuleManager() {
1210 if (!ModuleManager) {
1211 if (!hasASTContext())
1212 createASTContext();
1213
1214 // If we're not recursively building a module, check whether we
1215 // need to prune the module cache.
1216 if (getSourceManager().getModuleBuildStack().empty() &&
1217 getHeaderSearchOpts().ModuleCachePruneInterval > 0 &&
1218 getHeaderSearchOpts().ModuleCachePruneAfter > 0) {
1219 pruneModuleCache(getHeaderSearchOpts());
1220 }
1221
1222 HeaderSearchOptions &HSOpts = getHeaderSearchOpts();
1223 std::string Sysroot = HSOpts.Sysroot;
1224 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
1225 ModuleManager = new ASTReader(getPreprocessor(), *Context,
1226 Sysroot.empty() ? "" : Sysroot.c_str(),
1227 PPOpts.DisablePCHValidation,
1228 /*AllowASTWithCompilerErrors=*/false,
1229 /*AllowConfigurationMismatch=*/false,
1230 HSOpts.ModulesValidateSystemHeaders,
1231 getFrontendOpts().UseGlobalModuleIndex);
1232 if (hasASTConsumer()) {
1233 ModuleManager->setDeserializationListener(
1234 getASTConsumer().GetASTDeserializationListener());
1235 getASTContext().setASTMutationListener(
1236 getASTConsumer().GetASTMutationListener());
1237 }
1238 getASTContext().setExternalSource(ModuleManager);
1239 if (hasSema())
1240 ModuleManager->InitializeSema(getSema());
1241 if (hasASTConsumer())
1242 ModuleManager->StartTranslationUnit(&getASTConsumer());
1243 }
1244}
1245
Douglas Gregor463d9092012-11-29 23:55:25 +00001246ModuleLoadResult
1247CompilerInstance::loadModule(SourceLocation ImportLoc,
1248 ModuleIdPath Path,
1249 Module::NameVisibilityKind Visibility,
1250 bool IsInclusionDirective) {
Richard Smithb934d242013-10-18 22:48:20 +00001251 // Determine what file we're searching from.
1252 StringRef ModuleName = Path[0].first->getName();
1253 SourceLocation ModuleNameLoc = Path[0].second;
1254
Douglas Gregorb514c792011-11-30 04:26:53 +00001255 // If we've already handled this import, just return the cached result.
1256 // This one-element cache is important to eliminate redundant diagnostics
1257 // when both the preprocessor and parser see the same import declaration.
Douglas Gregor5e356932011-12-01 17:11:21 +00001258 if (!ImportLoc.isInvalid() && LastModuleImportLoc == ImportLoc) {
1259 // Make the named module visible.
Richard Smithb934d242013-10-18 22:48:20 +00001260 if (LastModuleImportResult && ModuleName != getLangOpts().CurrentModule)
Argyrios Kyrtzidis5ebcb202013-02-01 16:36:12 +00001261 ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility,
Douglas Gregor906d66a2013-03-20 21:10:35 +00001262 ImportLoc, /*Complain=*/false);
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001263 return LastModuleImportResult;
Douglas Gregor5e356932011-12-01 17:11:21 +00001264 }
Douglas Gregor49009ec2011-11-30 04:03:44 +00001265
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001266 clang::Module *Module = nullptr;
Richard Smithb934d242013-10-18 22:48:20 +00001267
Douglas Gregor49009ec2011-11-30 04:03:44 +00001268 // If we don't already have information on this module, load the module now.
Douglas Gregor1a4761e2011-11-30 23:21:26 +00001269 llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001270 = KnownModules.find(Path[0].first);
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001271 if (Known != KnownModules.end()) {
1272 // Retrieve the cached top-level module.
1273 Module = Known->second;
1274 } else if (ModuleName == getLangOpts().CurrentModule) {
1275 // This is the module we're building.
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001276 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001277 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1278 } else {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001279 // Search for a module with the given name.
Douglas Gregore434ec72012-01-29 17:08:11 +00001280 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
Stephen Hines651f13c2014-04-23 16:59:28 -07001281 if (!Module) {
1282 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1283 << ModuleName
1284 << SourceRange(ImportLoc, ModuleNameLoc);
1285 ModuleBuildFailed = true;
1286 return ModuleLoadResult();
1287 }
1288
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001289 std::string ModuleFileName =
1290 PP->getHeaderSearchInfo().getModuleFileName(Module);
Douglas Gregor463d9092012-11-29 23:55:25 +00001291
Douglas Gregor49009ec2011-11-30 04:03:44 +00001292 // If we don't already have an ASTReader, create one now.
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001293 if (!ModuleManager)
1294 createModuleManager();
Douglas Gregor49009ec2011-11-30 04:03:44 +00001295
Stephen Hines651f13c2014-04-23 16:59:28 -07001296 if (TheDependencyFileGenerator)
1297 TheDependencyFileGenerator->AttachToASTReader(*ModuleManager);
1298
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001299 if (ModuleDepCollector)
1300 ModuleDepCollector->attachToASTReader(*ModuleManager);
1301
1302 for (auto &Listener : DependencyCollectors)
1303 Listener->attachToASTReader(*ModuleManager);
1304
Douglas Gregor677e15f2013-03-19 00:28:20 +00001305 // Try to load the module file.
1306 unsigned ARRFlags = ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing;
1307 switch (ModuleManager->ReadAST(ModuleFileName, serialization::MK_Module,
1308 ImportLoc, ARRFlags)) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001309 case ASTReader::Success:
1310 break;
1311
Eli Friedman0295c232013-09-17 00:51:29 +00001312 case ASTReader::OutOfDate:
Douglas Gregor677e15f2013-03-19 00:28:20 +00001313 case ASTReader::Missing: {
Eli Friedman0295c232013-09-17 00:51:29 +00001314 // The module file is missing or out-of-date. Build it.
Stephen Hines651f13c2014-04-23 16:59:28 -07001315 assert(Module && "missing module file");
Douglas Gregor677e15f2013-03-19 00:28:20 +00001316 // Check whether there is a cycle in the module graph.
1317 ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
1318 ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1319 for (; Pos != PosEnd; ++Pos) {
1320 if (Pos->first == ModuleName)
1321 break;
1322 }
1323
1324 if (Pos != PosEnd) {
1325 SmallString<256> CyclePath;
1326 for (; Pos != PosEnd; ++Pos) {
1327 CyclePath += Pos->first;
1328 CyclePath += " -> ";
1329 }
1330 CyclePath += ModuleName;
1331
1332 getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
1333 << ModuleName << CyclePath;
1334 return ModuleLoadResult();
1335 }
Douglas Gregor463d9092012-11-29 23:55:25 +00001336
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001337 getDiagnostics().Report(ImportLoc, diag::remark_module_build)
1338 << ModuleName << ModuleFileName;
1339
Douglas Gregor463d9092012-11-29 23:55:25 +00001340 // Check whether we have already attempted to build this module (but
1341 // failed).
1342 if (getPreprocessorOpts().FailedModules &&
1343 getPreprocessorOpts().FailedModules->hasAlreadyFailed(ModuleName)) {
1344 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_built)
1345 << ModuleName
1346 << SourceRange(ImportLoc, ModuleNameLoc);
Douglas Gregorf575d6e2013-01-25 00:45:27 +00001347 ModuleBuildFailed = true;
Douglas Gregor463d9092012-11-29 23:55:25 +00001348 return ModuleLoadResult();
1349 }
1350
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001351 // Try to compile and then load the module.
1352 if (!compileAndLoadModule(*this, ImportLoc, ModuleNameLoc, Module,
1353 ModuleFileName)) {
Douglas Gregorb8a8be12013-01-10 02:04:18 +00001354 if (getPreprocessorOpts().FailedModules)
1355 getPreprocessorOpts().FailedModules->addFailed(ModuleName);
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001356 KnownModules[Path[0].first] = nullptr;
Douglas Gregorf575d6e2013-01-25 00:45:27 +00001357 ModuleBuildFailed = true;
Douglas Gregor463d9092012-11-29 23:55:25 +00001358 return ModuleLoadResult();
Douglas Gregor7cdd2812012-11-07 17:46:15 +00001359 }
1360
1361 // Okay, we've rebuilt and now loaded the module.
1362 break;
1363 }
1364
Douglas Gregor4825fd72012-10-22 22:50:17 +00001365 case ASTReader::VersionMismatch:
1366 case ASTReader::ConfigurationMismatch:
1367 case ASTReader::HadErrors:
Argyrios Kyrtzidis3b7deda2013-05-24 05:44:08 +00001368 ModuleLoader::HadFatalFailure = true;
Douglas Gregor49009ec2011-11-30 04:03:44 +00001369 // FIXME: The ASTReader will already have complained, but can we showhorn
1370 // that diagnostic information into a more useful form?
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001371 KnownModules[Path[0].first] = nullptr;
Douglas Gregor463d9092012-11-29 23:55:25 +00001372 return ModuleLoadResult();
Douglas Gregor49009ec2011-11-30 04:03:44 +00001373
1374 case ASTReader::Failure:
Argyrios Kyrtzidis3b7deda2013-05-24 05:44:08 +00001375 ModuleLoader::HadFatalFailure = true;
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001376 // Already complained, but note now that we failed.
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001377 KnownModules[Path[0].first] = nullptr;
Douglas Gregorf575d6e2013-01-25 00:45:27 +00001378 ModuleBuildFailed = true;
Douglas Gregor463d9092012-11-29 23:55:25 +00001379 return ModuleLoadResult();
Douglas Gregor49009ec2011-11-30 04:03:44 +00001380 }
Argyrios Kyrtzidise2ac16b2012-09-29 01:06:04 +00001381
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001382 // Cache the result of this top-level module lookup for later.
1383 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
Douglas Gregor6aa52ec2011-08-26 23:56:07 +00001384 }
Douglas Gregor49009ec2011-11-30 04:03:44 +00001385
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001386 // If we never found the module, fail.
1387 if (!Module)
Douglas Gregor463d9092012-11-29 23:55:25 +00001388 return ModuleLoadResult();
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001389
Douglas Gregor49009ec2011-11-30 04:03:44 +00001390 // Verify that the rest of the module path actually corresponds to
1391 // a submodule.
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001392 if (Path.size() > 1) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001393 for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1394 StringRef Name = Path[I].first->getName();
Douglas Gregorb7a78192012-01-04 23:32:19 +00001395 clang::Module *Sub = Module->findSubmodule(Name);
Douglas Gregor49009ec2011-11-30 04:03:44 +00001396
Douglas Gregorb7a78192012-01-04 23:32:19 +00001397 if (!Sub) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001398 // Attempt to perform typo correction to find a module name that works.
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00001399 SmallVector<StringRef, 2> Best;
Douglas Gregor49009ec2011-11-30 04:03:44 +00001400 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1401
Douglas Gregorb7a78192012-01-04 23:32:19 +00001402 for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1403 JEnd = Module->submodule_end();
Matt Beaumont-Gaye25633f2011-11-30 19:41:21 +00001404 J != JEnd; ++J) {
Douglas Gregorb7a78192012-01-04 23:32:19 +00001405 unsigned ED = Name.edit_distance((*J)->Name,
Douglas Gregor49009ec2011-11-30 04:03:44 +00001406 /*AllowReplacements=*/true,
1407 BestEditDistance);
1408 if (ED <= BestEditDistance) {
Douglas Gregorb7a78192012-01-04 23:32:19 +00001409 if (ED < BestEditDistance) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001410 Best.clear();
Douglas Gregorb7a78192012-01-04 23:32:19 +00001411 BestEditDistance = ED;
1412 }
1413
1414 Best.push_back((*J)->Name);
Douglas Gregor49009ec2011-11-30 04:03:44 +00001415 }
1416 }
1417
1418 // If there was a clear winner, user it.
1419 if (Best.size() == 1) {
1420 getDiagnostics().Report(Path[I].second,
1421 diag::err_no_submodule_suggest)
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001422 << Path[I].first << Module->getFullModuleName() << Best[0]
Douglas Gregor49009ec2011-11-30 04:03:44 +00001423 << SourceRange(Path[0].second, Path[I-1].second)
1424 << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1425 Best[0]);
Douglas Gregorb7a78192012-01-04 23:32:19 +00001426
1427 Sub = Module->findSubmodule(Best[0]);
Douglas Gregor49009ec2011-11-30 04:03:44 +00001428 }
1429 }
1430
Douglas Gregorb7a78192012-01-04 23:32:19 +00001431 if (!Sub) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001432 // No submodule by this name. Complain, and don't look for further
1433 // submodules.
1434 getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001435 << Path[I].first << Module->getFullModuleName()
Douglas Gregor49009ec2011-11-30 04:03:44 +00001436 << SourceRange(Path[0].second, Path[I-1].second);
1437 break;
1438 }
1439
Douglas Gregorb7a78192012-01-04 23:32:19 +00001440 Module = Sub;
Douglas Gregor49009ec2011-11-30 04:03:44 +00001441 }
Douglas Gregor6aa52ec2011-08-26 23:56:07 +00001442 }
Douglas Gregor49009ec2011-11-30 04:03:44 +00001443
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001444 // Make the named module visible, if it's not already part of the module
1445 // we are parsing.
Douglas Gregor305dc3e2011-12-20 00:28:52 +00001446 if (ModuleName != getLangOpts().CurrentModule) {
1447 if (!Module->IsFromModuleFile) {
1448 // We have an umbrella header or directory that doesn't actually include
1449 // all of the headers within the directory it covers. Complain about
1450 // this missing submodule and recover by forgetting that we ever saw
1451 // this submodule.
1452 // FIXME: Should we detect this at module load time? It seems fairly
1453 // expensive (and rare).
1454 getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1455 << Module->getFullModuleName()
1456 << SourceRange(Path.front().second, Path.back().second);
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001457
1458 return ModuleLoadResult(nullptr, true);
Douglas Gregor305dc3e2011-12-20 00:28:52 +00001459 }
Douglas Gregor51f564f2011-12-31 04:05:44 +00001460
1461 // Check whether this module is available.
Richard Smith5794b532013-10-28 22:18:19 +00001462 clang::Module::Requirement Requirement;
Stephen Hines651f13c2014-04-23 16:59:28 -07001463 clang::Module::HeaderDirective MissingHeader;
1464 if (!Module->isAvailable(getLangOpts(), getTarget(), Requirement,
1465 MissingHeader)) {
1466 if (MissingHeader.FileNameLoc.isValid()) {
1467 getDiagnostics().Report(MissingHeader.FileNameLoc,
1468 diag::err_module_header_missing)
1469 << MissingHeader.IsUmbrella << MissingHeader.FileName;
1470 } else {
1471 getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1472 << Module->getFullModuleName()
1473 << Requirement.second << Requirement.first
1474 << SourceRange(Path.front().second, Path.back().second);
1475 }
Douglas Gregor51f564f2011-12-31 04:05:44 +00001476 LastModuleImportLoc = ImportLoc;
Douglas Gregor463d9092012-11-29 23:55:25 +00001477 LastModuleImportResult = ModuleLoadResult();
1478 return ModuleLoadResult();
Douglas Gregor51f564f2011-12-31 04:05:44 +00001479 }
1480
Douglas Gregor906d66a2013-03-20 21:10:35 +00001481 ModuleManager->makeModuleVisible(Module, Visibility, ImportLoc,
1482 /*Complain=*/true);
Douglas Gregor305dc3e2011-12-20 00:28:52 +00001483 }
Douglas Gregor63a72682013-03-20 00:22:05 +00001484
1485 // Check for any configuration macros that have changed.
1486 clang::Module *TopModule = Module->getTopLevelModule();
1487 for (unsigned I = 0, N = TopModule->ConfigMacros.size(); I != N; ++I) {
1488 checkConfigMacro(getPreprocessor(), TopModule->ConfigMacros[I],
1489 Module, ImportLoc);
1490 }
1491
Douglas Gregor93ebfa62011-12-02 23:42:12 +00001492 // If this module import was due to an inclusion directive, create an
1493 // implicit import declaration to capture it in the AST.
1494 if (IsInclusionDirective && hasASTContext()) {
1495 TranslationUnitDecl *TU = getASTContext().getTranslationUnitDecl();
Argyrios Kyrtzidisd3d98162012-10-03 01:58:37 +00001496 ImportDecl *ImportD = ImportDecl::CreateImplicit(getASTContext(), TU,
1497 ImportLoc, Module,
1498 Path.back().second);
1499 TU->addDecl(ImportD);
1500 if (Consumer)
1501 Consumer->HandleImplicitImportDecl(ImportD);
Douglas Gregor93ebfa62011-12-02 23:42:12 +00001502 }
Douglas Gregor49009ec2011-11-30 04:03:44 +00001503
Douglas Gregorb514c792011-11-30 04:26:53 +00001504 LastModuleImportLoc = ImportLoc;
Douglas Gregor463d9092012-11-29 23:55:25 +00001505 LastModuleImportResult = ModuleLoadResult(Module, false);
1506 return LastModuleImportResult;
Douglas Gregor6aa52ec2011-08-26 23:56:07 +00001507}
Douglas Gregorca2ab452013-01-12 01:29:50 +00001508
1509void CompilerInstance::makeModuleVisible(Module *Mod,
Argyrios Kyrtzidis5ebcb202013-02-01 16:36:12 +00001510 Module::NameVisibilityKind Visibility,
Douglas Gregor906d66a2013-03-20 21:10:35 +00001511 SourceLocation ImportLoc,
1512 bool Complain){
1513 ModuleManager->makeModuleVisible(Mod, Visibility, ImportLoc, Complain);
Douglas Gregorca2ab452013-01-12 01:29:50 +00001514}
1515
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001516GlobalModuleIndex *CompilerInstance::loadGlobalModuleIndex(
1517 SourceLocation TriggerLoc) {
1518 if (!ModuleManager)
1519 createModuleManager();
1520 // Can't do anything if we don't have the module manager.
1521 if (!ModuleManager)
1522 return nullptr;
1523 // Get an existing global index. This loads it if not already
1524 // loaded.
1525 ModuleManager->loadGlobalIndex();
1526 GlobalModuleIndex *GlobalIndex = ModuleManager->getGlobalIndex();
1527 // If the global index doesn't exist, create it.
1528 if (!GlobalIndex && shouldBuildGlobalModuleIndex() && hasFileManager() &&
1529 hasPreprocessor()) {
1530 llvm::sys::fs::create_directories(
1531 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1532 GlobalModuleIndex::writeIndex(
1533 getFileManager(),
1534 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1535 ModuleManager->resetForReload();
1536 ModuleManager->loadGlobalIndex();
1537 GlobalIndex = ModuleManager->getGlobalIndex();
1538 }
1539 // For finding modules needing to be imported for fixit messages,
1540 // we need to make the global index cover all modules, so we do that here.
1541 if (!HaveFullGlobalModuleIndex && GlobalIndex && !buildingModule()) {
1542 ModuleMap &MMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
1543 bool RecreateIndex = false;
1544 for (ModuleMap::module_iterator I = MMap.module_begin(),
1545 E = MMap.module_end(); I != E; ++I) {
1546 Module *TheModule = I->second;
1547 const FileEntry *Entry = TheModule->getASTFile();
1548 if (!Entry) {
1549 SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
1550 Path.push_back(std::make_pair(
1551 getPreprocessor().getIdentifierInfo(TheModule->Name), TriggerLoc));
1552 std::reverse(Path.begin(), Path.end());
1553 // Load a module as hidden. This also adds it to the global index.
1554 loadModule(TheModule->DefinitionLoc, Path,
1555 Module::Hidden, false);
1556 RecreateIndex = true;
1557 }
1558 }
1559 if (RecreateIndex) {
1560 GlobalModuleIndex::writeIndex(
1561 getFileManager(),
1562 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1563 ModuleManager->resetForReload();
1564 ModuleManager->loadGlobalIndex();
1565 GlobalIndex = ModuleManager->getGlobalIndex();
1566 }
1567 HaveFullGlobalModuleIndex = true;
1568 }
1569 return GlobalIndex;
1570}
1571
1572// Check global module index for missing imports.
1573bool
1574CompilerInstance::lookupMissingImports(StringRef Name,
1575 SourceLocation TriggerLoc) {
1576 // Look for the symbol in non-imported modules, but only if an error
1577 // actually occurred.
1578 if (!buildingModule()) {
1579 // Load global module index, or retrieve a previously loaded one.
1580 GlobalModuleIndex *GlobalIndex = loadGlobalModuleIndex(
1581 TriggerLoc);
1582
1583 // Only if we have a global index.
1584 if (GlobalIndex) {
1585 GlobalModuleIndex::HitSet FoundModules;
1586
1587 // Find the modules that reference the identifier.
1588 // Note that this only finds top-level modules.
1589 // We'll let diagnoseTypo find the actual declaration module.
1590 if (GlobalIndex->lookupIdentifier(Name, FoundModules))
1591 return true;
1592 }
1593 }
1594
1595 return false;
1596}