blob: 4c4d6037163d1eb4b9e7e9217765929e99a6b36a [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"
David Blaikie4e85b8a2011-09-26 00:21:47 +000019#include "clang/Frontend/ChainedDiagnosticConsumer.h"
Daniel Dunbar0397af22010-01-13 00:48:06 +000020#include "clang/Frontend/FrontendAction.h"
Douglas Gregor21cae202011-09-12 23:31:24 +000021#include "clang/Frontend/FrontendActions.h"
Daniel Dunbarc2f484f2009-11-13 09:36:05 +000022#include "clang/Frontend/FrontendDiagnostic.h"
Daniel Dunbar9df23492011-04-07 18:31:10 +000023#include "clang/Frontend/LogDiagnosticPrinter.h"
Ted Kremenek78002122011-10-29 00:12:39 +000024#include "clang/Frontend/SerializedDiagnosticPrinter.h"
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +000025#include "clang/Frontend/TextDiagnosticPrinter.h"
Daniel Dunbar22dacfa2009-11-13 05:52:11 +000026#include "clang/Frontend/Utils.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000027#include "clang/Frontend/VerifyDiagnosticConsumer.h"
28#include "clang/Lex/HeaderSearch.h"
29#include "clang/Lex/PTHManager.h"
30#include "clang/Lex/Preprocessor.h"
Daniel Dunbarc2f484f2009-11-13 09:36:05 +000031#include "clang/Sema/CodeCompleteConsumer.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000032#include "clang/Sema/Sema.h"
33#include "clang/Serialization/ASTReader.h"
Douglas Gregor95dd5582010-03-30 17:33:59 +000034#include "llvm/ADT/Statistic.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000035#include "llvm/Config/config.h"
36#include "llvm/Support/CrashRecoveryContext.h"
37#include "llvm/Support/FileSystem.h"
Michael J. Spencer03013fa2010-11-29 18:12:39 +000038#include "llvm/Support/Host.h"
Douglas Gregor52f12722012-01-29 20:15:24 +000039#include "llvm/Support/LockFileManager.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000040#include "llvm/Support/MemoryBuffer.h"
Michael J. Spencer03013fa2010-11-29 18:12:39 +000041#include "llvm/Support/Path.h"
42#include "llvm/Support/Program.h"
43#include "llvm/Support/Signals.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000044#include "llvm/Support/Timer.h"
45#include "llvm/Support/raw_ostream.h"
Michael J. Spencer3a321e22010-12-09 17:36:38 +000046#include "llvm/Support/system_error.h"
Douglas Gregord44d2872013-03-25 21:19:16 +000047#include <sys/stat.h>
Douglas Gregor87ab0662013-03-25 21:51:16 +000048#include <time.h>
Douglas Gregor2bc75072011-10-05 14:53:30 +000049
Daniel Dunbar2a79e162009-11-13 03:51:44 +000050using namespace clang;
51
Daniel Dunbar42e9f8e42010-02-16 01:54:47 +000052CompilerInstance::CompilerInstance()
Douglas Gregora6b00fc2013-01-23 22:38:11 +000053 : Invocation(new CompilerInvocation()), ModuleManager(0),
Douglas Gregorf575d6e2013-01-25 00:45:27 +000054 BuildGlobalModuleIndex(false), ModuleBuildFailed(false) {
Daniel Dunbar6228ca02010-01-30 21:47:07 +000055}
Daniel Dunbar2a79e162009-11-13 03:51:44 +000056
57CompilerInstance::~CompilerInstance() {
Benjamin Kramerac447fc2012-10-14 19:21:21 +000058 assert(OutputFiles.empty() && "Still output files in flight?");
Daniel Dunbar42e9f8e42010-02-16 01:54:47 +000059}
60
Daniel Dunbar6228ca02010-01-30 21:47:07 +000061void CompilerInstance::setInvocation(CompilerInvocation *Value) {
Ted Kremenek4f327862011-03-21 18:40:17 +000062 Invocation = Value;
Daniel Dunbar6228ca02010-01-30 21:47:07 +000063}
64
Douglas Gregorf575d6e2013-01-25 00:45:27 +000065bool CompilerInstance::shouldBuildGlobalModuleIndex() const {
Douglas Gregor1a49d972013-01-25 01:03:03 +000066 return (BuildGlobalModuleIndex ||
Douglas Gregored2fc2a2013-03-22 21:26:48 +000067 (ModuleManager && ModuleManager->isGlobalIndexUnavailable() &&
68 getFrontendOpts().GenerateGlobalModuleIndex)) &&
Douglas Gregor1a49d972013-01-25 01:03:03 +000069 !ModuleBuildFailed;
Douglas Gregorf575d6e2013-01-25 00:45:27 +000070}
71
David Blaikied6471f72011-09-25 23:23:43 +000072void CompilerInstance::setDiagnostics(DiagnosticsEngine *Value) {
Douglas Gregor28019772010-04-05 23:52:57 +000073 Diagnostics = Value;
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000074}
75
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000076void CompilerInstance::setTarget(TargetInfo *Value) {
Ted Kremenek4f327862011-03-21 18:40:17 +000077 Target = Value;
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000078}
79
80void CompilerInstance::setFileManager(FileManager *Value) {
Ted Kremenek4f327862011-03-21 18:40:17 +000081 FileMgr = Value;
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000082}
83
NAKAMURA Takumia789ca92011-10-08 11:31:46 +000084void CompilerInstance::setSourceManager(SourceManager *Value) {
Ted Kremenek4f327862011-03-21 18:40:17 +000085 SourceMgr = Value;
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000086}
87
Ted Kremenek4f327862011-03-21 18:40:17 +000088void CompilerInstance::setPreprocessor(Preprocessor *Value) { PP = Value; }
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000089
Ted Kremenek4f327862011-03-21 18:40:17 +000090void CompilerInstance::setASTContext(ASTContext *Value) { Context = Value; }
Daniel Dunbar8a9f5692009-11-14 01:20:40 +000091
Douglas Gregorf18d0d82010-08-12 23:31:19 +000092void CompilerInstance::setSema(Sema *S) {
93 TheSema.reset(S);
94}
95
Daniel Dunbar12ce6942009-11-14 02:47:17 +000096void CompilerInstance::setASTConsumer(ASTConsumer *Value) {
97 Consumer.reset(Value);
98}
99
Daniel Dunbar8a9f5692009-11-14 01:20:40 +0000100void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
101 CompletionConsumer.reset(Value);
102}
103
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000104// Diagnostics
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000105static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts,
Daniel Dunbarb6534bb2011-04-07 18:59:02 +0000106 const CodeGenOptions *CodeGenOpts,
David Blaikied6471f72011-09-25 23:23:43 +0000107 DiagnosticsEngine &Diags) {
Daniel Dunbar9df23492011-04-07 18:31:10 +0000108 std::string ErrorInfo;
109 bool OwnsStream = false;
Chris Lattner5f9e2722011-07-23 10:55:15 +0000110 raw_ostream *OS = &llvm::errs();
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000111 if (DiagOpts->DiagnosticLogFile != "-") {
Daniel Dunbar9df23492011-04-07 18:31:10 +0000112 // Create the output stream.
113 llvm::raw_fd_ostream *FileOS(
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000114 new llvm::raw_fd_ostream(DiagOpts->DiagnosticLogFile.c_str(),
Daniel Dunbare01eceb2011-04-07 20:19:21 +0000115 ErrorInfo, llvm::raw_fd_ostream::F_Append));
Daniel Dunbar9df23492011-04-07 18:31:10 +0000116 if (!ErrorInfo.empty()) {
117 Diags.Report(diag::warn_fe_cc_log_diagnostics_failure)
Sean Silvad2ff76b2013-01-20 01:58:26 +0000118 << DiagOpts->DiagnosticLogFile << ErrorInfo;
Daniel Dunbar9df23492011-04-07 18:31:10 +0000119 } else {
120 FileOS->SetUnbuffered();
121 FileOS->SetUseAtomicWrites(true);
122 OS = FileOS;
123 OwnsStream = true;
124 }
125 }
126
127 // Chain in the diagnostic client which will log the diagnostics.
Daniel Dunbarb6534bb2011-04-07 18:59:02 +0000128 LogDiagnosticPrinter *Logger = new LogDiagnosticPrinter(*OS, DiagOpts,
129 OwnsStream);
130 if (CodeGenOpts)
131 Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
David Blaikie4e85b8a2011-09-26 00:21:47 +0000132 Diags.setClient(new ChainedDiagnosticConsumer(Diags.takeClient(), Logger));
Daniel Dunbar9df23492011-04-07 18:31:10 +0000133}
134
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000135static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts,
Ted Kremenek78002122011-10-29 00:12:39 +0000136 DiagnosticsEngine &Diags,
137 StringRef OutputFile) {
138 std::string ErrorInfo;
Dylan Noblesmith6f42b622012-02-05 02:12:40 +0000139 OwningPtr<llvm::raw_fd_ostream> OS;
Ted Kremenek78002122011-10-29 00:12:39 +0000140 OS.reset(new llvm::raw_fd_ostream(OutputFile.str().c_str(), ErrorInfo,
141 llvm::raw_fd_ostream::F_Binary));
142
143 if (!ErrorInfo.empty()) {
144 Diags.Report(diag::warn_fe_serialized_diag_failure)
145 << OutputFile << ErrorInfo;
146 return;
147 }
148
149 DiagnosticConsumer *SerializedConsumer =
Ted Kremenek2a764102011-12-17 05:26:11 +0000150 clang::serialized_diags::create(OS.take(), DiagOpts);
Ted Kremenek78002122011-10-29 00:12:39 +0000151
152
153 Diags.setClient(new ChainedDiagnosticConsumer(Diags.takeClient(),
154 SerializedConsumer));
155}
156
Sean Silvad47afb92013-01-20 01:58:28 +0000157void CompilerInstance::createDiagnostics(DiagnosticConsumer *Client,
Douglas Gregoraee526e2011-09-29 00:38:00 +0000158 bool ShouldOwnClient,
159 bool ShouldCloneClient) {
Sean Silvad47afb92013-01-20 01:58:28 +0000160 Diagnostics = createDiagnostics(&getDiagnosticOpts(), Client,
Douglas Gregoraee526e2011-09-29 00:38:00 +0000161 ShouldOwnClient, ShouldCloneClient,
162 &getCodeGenOpts());
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000163}
164
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000165IntrusiveRefCntPtr<DiagnosticsEngine>
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000166CompilerInstance::createDiagnostics(DiagnosticOptions *Opts,
David Blaikie78ad0b92011-09-25 23:39:51 +0000167 DiagnosticConsumer *Client,
Douglas Gregor78243652011-09-13 01:26:44 +0000168 bool ShouldOwnClient,
Douglas Gregoraee526e2011-09-29 00:38:00 +0000169 bool ShouldCloneClient,
Daniel Dunbarb6534bb2011-04-07 18:59:02 +0000170 const CodeGenOptions *CodeGenOpts) {
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000171 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
172 IntrusiveRefCntPtr<DiagnosticsEngine>
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000173 Diags(new DiagnosticsEngine(DiagID, Opts));
Daniel Dunbar221c7212009-11-14 07:53:24 +0000174
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000175 // Create the diagnostic client for reporting errors or for
176 // implementing -verify.
Douglas Gregoraee526e2011-09-29 00:38:00 +0000177 if (Client) {
178 if (ShouldCloneClient)
179 Diags->setClient(Client->clone(*Diags), ShouldOwnClient);
180 else
181 Diags->setClient(Client, ShouldOwnClient);
182 } else
Douglas Gregore47be3e2010-11-11 00:39:14 +0000183 Diags->setClient(new TextDiagnosticPrinter(llvm::errs(), Opts));
Daniel Dunbarf79dced2009-11-14 03:24:39 +0000184
185 // Chain in -verify checker, if requested.
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000186 if (Opts->VerifyDiagnostics)
David Blaikie621bc692011-09-26 00:38:03 +0000187 Diags->setClient(new VerifyDiagnosticConsumer(*Diags));
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000188
Daniel Dunbar9df23492011-04-07 18:31:10 +0000189 // Chain in -diagnostic-log-file dumper, if requested.
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000190 if (!Opts->DiagnosticLogFile.empty())
Daniel Dunbarb6534bb2011-04-07 18:59:02 +0000191 SetUpDiagnosticLog(Opts, CodeGenOpts, *Diags);
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000192
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000193 if (!Opts->DiagnosticSerializationFile.empty())
Ted Kremenek78002122011-10-29 00:12:39 +0000194 SetupSerializedDiagnostics(Opts, *Diags,
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000195 Opts->DiagnosticSerializationFile);
Ted Kremenek78002122011-10-29 00:12:39 +0000196
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000197 // Configure our handling of diagnostics.
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000198 ProcessWarningOptions(*Diags, *Opts);
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000199
Douglas Gregor28019772010-04-05 23:52:57 +0000200 return Diags;
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000201}
202
203// File Manager
204
Daniel Dunbar16b74492009-11-13 04:12:06 +0000205void CompilerInstance::createFileManager() {
Ted Kremenek4f327862011-03-21 18:40:17 +0000206 FileMgr = new FileManager(getFileSystemOpts());
Daniel Dunbar16b74492009-11-13 04:12:06 +0000207}
208
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000209// Source Manager
210
Chris Lattner39b49bc2010-11-23 08:35:12 +0000211void CompilerInstance::createSourceManager(FileManager &FileMgr) {
Ted Kremenek4f327862011-03-21 18:40:17 +0000212 SourceMgr = new SourceManager(getDiagnostics(), FileMgr);
Daniel Dunbar16b74492009-11-13 04:12:06 +0000213}
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000214
Daniel Dunbar0fbb3d92009-11-13 05:52:34 +0000215// Preprocessor
216
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000217void CompilerInstance::createPreprocessor() {
Douglas Gregor6aa52ec2011-08-26 23:56:07 +0000218 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000219
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000220 // Create a PTH manager if we are using some form of a token cache.
221 PTHManager *PTHMgr = 0;
Daniel Dunbar049d3a02009-11-17 05:52:41 +0000222 if (!PPOpts.TokenCache.empty())
Douglas Gregor6aa52ec2011-08-26 23:56:07 +0000223 PTHMgr = PTHManager::Create(PPOpts.TokenCache, getDiagnostics());
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000224
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000225 // Create the Preprocessor.
Douglas Gregorc042edd2012-10-24 16:19:39 +0000226 HeaderSearch *HeaderInfo = new HeaderSearch(&getHeaderSearchOpts(),
227 getFileManager(),
Douglas Gregor51f564f2011-12-31 04:05:44 +0000228 getDiagnostics(),
Douglas Gregordc58aa72012-01-30 06:01:29 +0000229 getLangOpts(),
230 &getTarget());
Douglas Gregor36a16492012-10-24 17:46:57 +0000231 PP = new Preprocessor(&getPreprocessorOpts(),
232 getDiagnostics(), getLangOpts(), &getTarget(),
Douglas Gregor6aa52ec2011-08-26 23:56:07 +0000233 getSourceManager(), *HeaderInfo, *this, PTHMgr,
234 /*OwnsHeaderSearch=*/true);
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000235
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000236 // Note that this is different then passing PTHMgr to Preprocessor's ctor.
237 // That argument is used as the IdentifierInfoLookup argument to
238 // IdentifierTable's ctor.
239 if (PTHMgr) {
Douglas Gregor6aa52ec2011-08-26 23:56:07 +0000240 PTHMgr->setPreprocessor(&*PP);
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000241 PP->setPTHManager(PTHMgr);
242 }
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000243
Douglas Gregor94dc8f62010-03-19 16:15:56 +0000244 if (PPOpts.DetailedRecord)
Argyrios Kyrtzidis37ed1272012-12-04 07:27:05 +0000245 PP->createPreprocessingRecord();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000246
Douglas Gregor6aa52ec2011-08-26 23:56:07 +0000247 InitializePreprocessor(*PP, PPOpts, getHeaderSearchOpts(), getFrontendOpts());
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000248
Jordan Rose74c24982013-01-30 01:52:57 +0000249 PP->setPreprocessedOutput(getPreprocessorOutputOpts().ShowCPP);
250
Douglas Gregor6e975c42011-09-13 23:15:45 +0000251 // Set up the module path, including the hash for the
252 // module-creation options.
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +0000253 SmallString<256> SpecificModuleCache(
Douglas Gregor6e975c42011-09-13 23:15:45 +0000254 getHeaderSearchOpts().ModuleCachePath);
255 if (!getHeaderSearchOpts().DisableModuleHash)
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000256 llvm::sys::path::append(SpecificModuleCache,
Douglas Gregor6e975c42011-09-13 23:15:45 +0000257 getInvocation().getModuleHash());
Douglas Gregor5e3f9222011-12-08 17:01:29 +0000258 PP->getHeaderSearchInfo().setModuleCachePath(SpecificModuleCache);
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000259
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000260 // Handle generating dependencies, if requested.
Douglas Gregor6aa52ec2011-08-26 23:56:07 +0000261 const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000262 if (!DepOpts.OutputFile.empty())
263 AttachDependencyFileGen(*PP, DepOpts);
Douglas Gregor773303a2012-02-02 23:45:13 +0000264 if (!DepOpts.DOTOutputFile.empty())
265 AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
Douglas Gregorc69a1812012-02-02 00:54:52 +0000266 getHeaderSearchOpts().Sysroot);
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000267
Douglas Gregorc69a1812012-02-02 00:54:52 +0000268
Daniel Dunbareef63e02011-02-02 15:41:17 +0000269 // Handle generating header include information, if requested.
270 if (DepOpts.ShowHeaderIncludes)
271 AttachHeaderIncludeGen(*PP);
Daniel Dunbarb34d69b2011-02-02 21:11:31 +0000272 if (!DepOpts.HeaderIncludeOutputFile.empty()) {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000273 StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
Daniel Dunbarb34d69b2011-02-02 21:11:31 +0000274 if (OutputPath == "-")
275 OutputPath = "";
Daniel Dunbarda608852011-03-21 19:37:38 +0000276 AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/true, OutputPath,
277 /*ShowDepth=*/false);
Daniel Dunbarb34d69b2011-02-02 21:11:31 +0000278 }
Daniel Dunbar22dacfa2009-11-13 05:52:11 +0000279}
Daniel Dunbar5eb81002009-11-13 08:20:47 +0000280
281// ASTContext
282
283void CompilerInstance::createASTContext() {
284 Preprocessor &PP = getPreprocessor();
Ted Kremenek4f327862011-03-21 18:40:17 +0000285 Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000286 &getTarget(), PP.getIdentifierTable(),
Ted Kremenek4f327862011-03-21 18:40:17 +0000287 PP.getSelectorTable(), PP.getBuiltinInfo(),
288 /*size_reserve=*/ 0);
Daniel Dunbar5eb81002009-11-13 08:20:47 +0000289}
Daniel Dunbar0f800392009-11-13 08:21:10 +0000290
291// ExternalASTSource
292
Chris Lattner5f9e2722011-07-23 10:55:15 +0000293void CompilerInstance::createPCHExternalASTSource(StringRef Path,
Sebastian Redlffaab3e2010-07-30 00:29:29 +0000294 bool DisablePCHValidation,
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +0000295 bool AllowPCHWithCompilerErrors,
Sebastian Redlffaab3e2010-07-30 00:29:29 +0000296 void *DeserializationListener){
Dylan Noblesmith6f42b622012-02-05 02:12:40 +0000297 OwningPtr<ExternalASTSource> Source;
Sebastian Redl1d9f1fe2010-10-05 16:15:19 +0000298 bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
Daniel Dunbar0f800392009-11-13 08:21:10 +0000299 Source.reset(createPCHExternalASTSource(Path, getHeaderSearchOpts().Sysroot,
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000300 DisablePCHValidation,
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +0000301 AllowPCHWithCompilerErrors,
Sebastian Redlffaab3e2010-07-30 00:29:29 +0000302 getPreprocessor(), getASTContext(),
Sebastian Redl1d9f1fe2010-10-05 16:15:19 +0000303 DeserializationListener,
Douglas Gregorf575d6e2013-01-25 00:45:27 +0000304 Preamble,
305 getFrontendOpts().UseGlobalModuleIndex));
Douglas Gregorf62d43d2011-07-19 16:10:42 +0000306 ModuleManager = static_cast<ASTReader*>(Source.get());
Daniel Dunbar0f800392009-11-13 08:21:10 +0000307 getASTContext().setExternalSource(Source);
308}
309
310ExternalASTSource *
Chris Lattner5f9e2722011-07-23 10:55:15 +0000311CompilerInstance::createPCHExternalASTSource(StringRef Path,
Daniel Dunbar0f800392009-11-13 08:21:10 +0000312 const std::string &Sysroot,
Douglas Gregorfae3b2f2010-07-27 00:27:13 +0000313 bool DisablePCHValidation,
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +0000314 bool AllowPCHWithCompilerErrors,
Daniel Dunbar0f800392009-11-13 08:21:10 +0000315 Preprocessor &PP,
Sebastian Redlffaab3e2010-07-30 00:29:29 +0000316 ASTContext &Context,
Sebastian Redl1d9f1fe2010-10-05 16:15:19 +0000317 void *DeserializationListener,
Douglas Gregorf575d6e2013-01-25 00:45:27 +0000318 bool Preamble,
319 bool UseGlobalModuleIndex) {
Dylan Noblesmith6f42b622012-02-05 02:12:40 +0000320 OwningPtr<ASTReader> Reader;
Douglas Gregorf8a1e512011-09-02 00:26:20 +0000321 Reader.reset(new ASTReader(PP, Context,
Douglas Gregor832d6202011-07-22 16:35:34 +0000322 Sysroot.empty() ? "" : Sysroot.c_str(),
Argyrios Kyrtzidis4182ed62012-10-31 20:59:50 +0000323 DisablePCHValidation,
Douglas Gregorf575d6e2013-01-25 00:45:27 +0000324 AllowPCHWithCompilerErrors,
325 UseGlobalModuleIndex));
Daniel Dunbar0f800392009-11-13 08:21:10 +0000326
Sebastian Redlffaab3e2010-07-30 00:29:29 +0000327 Reader->setDeserializationListener(
Sebastian Redl571db7f2010-08-18 23:56:56 +0000328 static_cast<ASTDeserializationListener *>(DeserializationListener));
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000329 switch (Reader->ReadAST(Path,
330 Preamble ? serialization::MK_Preamble
Douglas Gregor38295be2012-10-22 23:51:00 +0000331 : serialization::MK_PCH,
Argyrios Kyrtzidis958bcaf2012-11-15 18:57:22 +0000332 SourceLocation(),
Douglas Gregor38295be2012-10-22 23:51:00 +0000333 ASTReader::ARR_None)) {
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000334 case ASTReader::Success:
Daniel Dunbar0f800392009-11-13 08:21:10 +0000335 // Set the predefines buffer as suggested by the PCH reader. Typically, the
336 // predefines buffer will be empty.
337 PP.setPredefines(Reader->getSuggestedPredefines());
338 return Reader.take();
339
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000340 case ASTReader::Failure:
Daniel Dunbar0f800392009-11-13 08:21:10 +0000341 // Unrecoverable failure: don't even try to process the input file.
342 break;
343
Douglas Gregor677e15f2013-03-19 00:28:20 +0000344 case ASTReader::Missing:
Douglas Gregor4825fd72012-10-22 22:50:17 +0000345 case ASTReader::OutOfDate:
346 case ASTReader::VersionMismatch:
347 case ASTReader::ConfigurationMismatch:
348 case ASTReader::HadErrors:
Daniel Dunbar0f800392009-11-13 08:21:10 +0000349 // No suitable PCH file could be found. Return an error.
350 break;
351 }
352
353 return 0;
354}
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000355
356// Code Completion
357
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000358static bool EnableCodeCompletion(Preprocessor &PP,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000359 const std::string &Filename,
360 unsigned Line,
361 unsigned Column) {
362 // Tell the source manager to chop off the given file at a specific
363 // line and column.
Chris Lattner39b49bc2010-11-23 08:35:12 +0000364 const FileEntry *Entry = PP.getFileManager().getFile(Filename);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000365 if (!Entry) {
366 PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
367 << Filename;
368 return true;
369 }
370
371 // Truncate the named file at the given line/column.
372 PP.SetCodeCompletionPoint(Entry, Line, Column);
373 return false;
374}
375
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000376void CompilerInstance::createCodeCompletionConsumer() {
377 const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000378 if (!CompletionConsumer) {
Erik Verbruggen9bc0c292012-04-12 10:31:12 +0000379 setCodeCompletionConsumer(
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000380 createCodeCompletionConsumer(getPreprocessor(),
381 Loc.FileName, Loc.Line, Loc.Column,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000382 getFrontendOpts().CodeCompleteOpts,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000383 llvm::outs()));
384 if (!CompletionConsumer)
385 return;
386 } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
387 Loc.Line, Loc.Column)) {
Erik Verbruggen9bc0c292012-04-12 10:31:12 +0000388 setCodeCompletionConsumer(0);
Douglas Gregorc3d43b72010-03-16 06:04:47 +0000389 return;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000390 }
Douglas Gregor2b4074f2009-12-01 05:55:20 +0000391
392 if (CompletionConsumer->isOutputBinary() &&
393 llvm::sys::Program::ChangeStdoutToBinary()) {
394 getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
Erik Verbruggen9bc0c292012-04-12 10:31:12 +0000395 setCodeCompletionConsumer(0);
Douglas Gregor2b4074f2009-12-01 05:55:20 +0000396 }
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000397}
398
Kovarththanan Rajaratnamf79bafa2009-11-29 09:57:35 +0000399void CompilerInstance::createFrontendTimer() {
400 FrontendTimer.reset(new llvm::Timer("Clang front-end timer"));
401}
402
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000403CodeCompleteConsumer *
404CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
405 const std::string &Filename,
406 unsigned Line,
407 unsigned Column,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000408 const CodeCompleteOptions &Opts,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000409 raw_ostream &OS) {
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000410 if (EnableCodeCompletion(PP, Filename, Line, Column))
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000411 return 0;
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000412
413 // Set up the creation routine for code-completion.
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000414 return new PrintingCodeCompleteConsumer(Opts, OS);
Daniel Dunbarc2f484f2009-11-13 09:36:05 +0000415}
Daniel Dunbara9204832009-11-13 10:37:48 +0000416
Douglas Gregor467dc882011-08-25 22:30:56 +0000417void CompilerInstance::createSema(TranslationUnitKind TUKind,
Douglas Gregorf18d0d82010-08-12 23:31:19 +0000418 CodeCompleteConsumer *CompletionConsumer) {
419 TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
Douglas Gregor467dc882011-08-25 22:30:56 +0000420 TUKind, CompletionConsumer));
Douglas Gregorf18d0d82010-08-12 23:31:19 +0000421}
422
Daniel Dunbara9204832009-11-13 10:37:48 +0000423// Output Files
424
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000425void CompilerInstance::addOutputFile(const OutputFile &OutFile) {
426 assert(OutFile.OS && "Attempt to add empty stream to output list!");
427 OutputFiles.push_back(OutFile);
Daniel Dunbara9204832009-11-13 10:37:48 +0000428}
429
Kovarththanan Rajaratname51dd7b2010-03-06 12:07:48 +0000430void CompilerInstance::clearOutputFiles(bool EraseFiles) {
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000431 for (std::list<OutputFile>::iterator
Daniel Dunbara9204832009-11-13 10:37:48 +0000432 it = OutputFiles.begin(), ie = OutputFiles.end(); it != ie; ++it) {
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000433 delete it->OS;
434 if (!it->TempFilename.empty()) {
Anders Carlssonaf036a62011-03-06 22:25:35 +0000435 if (EraseFiles) {
436 bool existed;
437 llvm::sys::fs::remove(it->TempFilename, existed);
438 } else {
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +0000439 SmallString<128> NewOutFile(it->Filename);
Anders Carlssonaf036a62011-03-06 22:25:35 +0000440
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000441 // If '-working-directory' was passed, the output filename should be
442 // relative to that.
Anders Carlsson2e2468e2011-03-14 01:13:54 +0000443 FileMgr->FixupRelativePath(NewOutFile);
Anders Carlssonaf036a62011-03-06 22:25:35 +0000444 if (llvm::error_code ec = llvm::sys::fs::rename(it->TempFilename,
445 NewOutFile.str())) {
Manuel Klimek832a2aa2012-05-16 20:55:58 +0000446 getDiagnostics().Report(diag::err_unable_to_rename_temp)
Anders Carlssonaf036a62011-03-06 22:25:35 +0000447 << it->TempFilename << it->Filename << ec.message();
448
449 bool existed;
450 llvm::sys::fs::remove(it->TempFilename, existed);
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000451 }
452 }
453 } else if (!it->Filename.empty() && EraseFiles)
454 llvm::sys::Path(it->Filename).eraseFromDisk();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000455
Daniel Dunbara9204832009-11-13 10:37:48 +0000456 }
457 OutputFiles.clear();
458}
459
Daniel Dunbarf482d592009-11-13 18:32:08 +0000460llvm::raw_fd_ostream *
461CompilerInstance::createDefaultOutputFile(bool Binary,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000462 StringRef InFile,
463 StringRef Extension) {
Daniel Dunbarf482d592009-11-13 18:32:08 +0000464 return createOutputFile(getFrontendOpts().OutputFile, Binary,
Daniel Dunbare21dd282012-03-03 00:36:06 +0000465 /*RemoveFileOnSignal=*/true, InFile, Extension,
466 /*UseTemporary=*/true);
Daniel Dunbarf482d592009-11-13 18:32:08 +0000467}
468
469llvm::raw_fd_ostream *
Chris Lattner5f9e2722011-07-23 10:55:15 +0000470CompilerInstance::createOutputFile(StringRef OutputPath,
Daniel Dunbarff9cd962011-01-31 22:00:42 +0000471 bool Binary, bool RemoveFileOnSignal,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000472 StringRef InFile,
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000473 StringRef Extension,
Daniel Dunbar12f28ab2012-03-03 00:36:02 +0000474 bool UseTemporary,
475 bool CreateMissingDirectories) {
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000476 std::string Error, OutputPathName, TempPathName;
Daniel Dunbarf482d592009-11-13 18:32:08 +0000477 llvm::raw_fd_ostream *OS = createOutputFile(OutputPath, Error, Binary,
Daniel Dunbarff9cd962011-01-31 22:00:42 +0000478 RemoveFileOnSignal,
Daniel Dunbarf482d592009-11-13 18:32:08 +0000479 InFile, Extension,
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000480 UseTemporary,
Daniel Dunbar12f28ab2012-03-03 00:36:02 +0000481 CreateMissingDirectories,
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000482 &OutputPathName,
483 &TempPathName);
Daniel Dunbarf482d592009-11-13 18:32:08 +0000484 if (!OS) {
Daniel Dunbar36043592009-12-03 09:13:30 +0000485 getDiagnostics().Report(diag::err_fe_unable_to_open_output)
486 << OutputPath << Error;
487 return 0;
Daniel Dunbarf482d592009-11-13 18:32:08 +0000488 }
489
490 // Add the output file -- but don't try to remove "-", since this means we are
491 // using stdin.
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000492 addOutputFile(OutputFile((OutputPathName != "-") ? OutputPathName : "",
493 TempPathName, OS));
Daniel Dunbarf482d592009-11-13 18:32:08 +0000494
495 return OS;
496}
497
498llvm::raw_fd_ostream *
Chris Lattner5f9e2722011-07-23 10:55:15 +0000499CompilerInstance::createOutputFile(StringRef OutputPath,
Daniel Dunbarf482d592009-11-13 18:32:08 +0000500 std::string &Error,
501 bool Binary,
Daniel Dunbarff9cd962011-01-31 22:00:42 +0000502 bool RemoveFileOnSignal,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000503 StringRef InFile,
504 StringRef Extension,
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000505 bool UseTemporary,
Daniel Dunbar12f28ab2012-03-03 00:36:02 +0000506 bool CreateMissingDirectories,
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000507 std::string *ResultPathName,
508 std::string *TempPathName) {
Daniel Dunbar12f28ab2012-03-03 00:36:02 +0000509 assert((!CreateMissingDirectories || UseTemporary) &&
510 "CreateMissingDirectories is only allowed when using temporary files");
511
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000512 std::string OutFile, TempFile;
Daniel Dunbarf482d592009-11-13 18:32:08 +0000513 if (!OutputPath.empty()) {
514 OutFile = OutputPath;
515 } else if (InFile == "-") {
516 OutFile = "-";
517 } else if (!Extension.empty()) {
518 llvm::sys::Path Path(InFile);
519 Path.eraseSuffix();
520 Path.appendSuffix(Extension);
521 OutFile = Path.str();
522 } else {
523 OutFile = "-";
524 }
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000525
Dylan Noblesmith6f42b622012-02-05 02:12:40 +0000526 OwningPtr<llvm::raw_fd_ostream> OS;
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000527 std::string OSFile;
528
529 if (UseTemporary && OutFile != "-") {
Daniel Dunbar12f28ab2012-03-03 00:36:02 +0000530 // Only create the temporary if the parent directory exists (or create
531 // missing directories is true) and we can actually write to OutPath,
532 // otherwise we want to fail early.
533 SmallString<256> AbsPath(OutputPath);
534 llvm::sys::fs::make_absolute(AbsPath);
535 llvm::sys::Path OutPath(AbsPath);
536 bool ParentExists = false;
537 if (llvm::sys::fs::exists(llvm::sys::path::parent_path(AbsPath.str()),
538 ParentExists))
539 ParentExists = false;
Michael J. Spencer32bef4e2011-01-10 02:34:13 +0000540 bool Exists;
Daniel Dunbar12f28ab2012-03-03 00:36:02 +0000541 if ((CreateMissingDirectories || ParentExists) &&
542 ((llvm::sys::fs::exists(AbsPath.str(), Exists) || !Exists) ||
543 (OutPath.isRegularFile() && OutPath.canWrite()))) {
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000544 // Create a temporary file.
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +0000545 SmallString<128> TempPath;
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000546 TempPath = OutFile;
547 TempPath += "-%%%%%%%%";
548 int fd;
549 if (llvm::sys::fs::unique_file(TempPath.str(), fd, TempPath,
Eric Christopher7d9ae252012-05-11 00:10:07 +0000550 /*makeAbsolute=*/false, 0664)
551 == llvm::errc::success) {
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000552 OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
553 OSFile = TempFile = TempPath.str();
554 }
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000555 }
556 }
557
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +0000558 if (!OS) {
559 OSFile = OutFile;
560 OS.reset(
561 new llvm::raw_fd_ostream(OSFile.c_str(), Error,
562 (Binary ? llvm::raw_fd_ostream::F_Binary : 0)));
563 if (!Error.empty())
564 return 0;
565 }
Daniel Dunbarf482d592009-11-13 18:32:08 +0000566
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000567 // Make sure the out stream file gets removed if we crash.
Daniel Dunbarff9cd962011-01-31 22:00:42 +0000568 if (RemoveFileOnSignal)
569 llvm::sys::RemoveFileOnSignal(llvm::sys::Path(OSFile));
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000570
Daniel Dunbarf482d592009-11-13 18:32:08 +0000571 if (ResultPathName)
572 *ResultPathName = OutFile;
Argyrios Kyrtzidisdc245722010-09-17 17:38:48 +0000573 if (TempPathName)
574 *TempPathName = TempFile;
Daniel Dunbarf482d592009-11-13 18:32:08 +0000575
Daniel Dunbarfc971022009-11-20 22:32:38 +0000576 return OS.take();
Daniel Dunbarf482d592009-11-13 18:32:08 +0000577}
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000578
579// Initialization Utilities
580
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000581bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
582 return InitializeSourceManager(Input, getDiagnostics(),
Douglas Gregora1f1fad2012-01-27 19:52:33 +0000583 getFileManager(), getSourceManager(),
584 getFrontendOpts());
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000585}
586
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000587bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input,
David Blaikied6471f72011-09-25 23:23:43 +0000588 DiagnosticsEngine &Diags,
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000589 FileManager &FileMgr,
590 SourceManager &SourceMgr,
591 const FrontendOptions &Opts) {
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000592 SrcMgr::CharacteristicKind
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +0000593 Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000594
Argyrios Kyrtzidisecd27bf2012-11-09 19:40:45 +0000595 if (Input.isBuffer()) {
596 SourceMgr.createMainFileIDForMemBuffer(Input.getBuffer(), Kind);
597 assert(!SourceMgr.getMainFileID().isInvalid() &&
598 "Couldn't establish MainFileID!");
599 return true;
600 }
601
602 StringRef InputFile = Input.getFile();
603
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +0000604 // Figure out where to get and map in the main file.
605 if (InputFile != "-") {
Chris Lattner39b49bc2010-11-23 08:35:12 +0000606 const FileEntry *File = FileMgr.getFile(InputFile);
Dan Gohman694137c2010-10-26 21:13:51 +0000607 if (!File) {
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000608 Diags.Report(diag::err_fe_error_reading) << InputFile;
609 return false;
610 }
Daniel Dunbarce36ecd2012-11-05 22:53:33 +0000611
612 // The natural SourceManager infrastructure can't currently handle named
613 // pipes, but we would at least like to accept them for the main
614 // file. Detect them here, read them with the more generic MemoryBuffer
615 // function, and simply override their contents as we do for STDIN.
616 if (File->isNamedPipe()) {
617 OwningPtr<llvm::MemoryBuffer> MB;
618 if (llvm::error_code ec = llvm::MemoryBuffer::getFile(InputFile, MB)) {
619 Diags.Report(diag::err_cannot_open_file) << InputFile << ec.message();
620 return false;
621 }
Daniel Dunbaracf36122012-11-27 00:04:16 +0000622
623 // Create a new virtual file that will have the correct size.
624 File = FileMgr.getVirtualFile(InputFile, MB->getBufferSize(), 0);
Daniel Dunbarce36ecd2012-11-05 22:53:33 +0000625 SourceMgr.overrideFileContents(File, MB.take());
626 }
Daniel Dunbaracf36122012-11-27 00:04:16 +0000627
628 SourceMgr.createMainFileID(File, Kind);
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000629 } else {
Dylan Noblesmith6f42b622012-02-05 02:12:40 +0000630 OwningPtr<llvm::MemoryBuffer> SB;
Michael J. Spencer4eeebc42010-12-16 03:28:14 +0000631 if (llvm::MemoryBuffer::getSTDIN(SB)) {
Michael J. Spencer3a321e22010-12-09 17:36:38 +0000632 // FIXME: Give ec.message() in this diag.
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000633 Diags.Report(diag::err_fe_error_reading_stdin);
634 return false;
635 }
Dan Gohman90d90812010-10-26 23:21:25 +0000636 const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
Chris Lattner39b49bc2010-11-23 08:35:12 +0000637 SB->getBufferSize(), 0);
Douglas Gregora1f1fad2012-01-27 19:52:33 +0000638 SourceMgr.createMainFileID(File, Kind);
Michael J. Spencer4eeebc42010-12-16 03:28:14 +0000639 SourceMgr.overrideFileContents(File, SB.take());
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000640 }
641
Dan Gohman694137c2010-10-26 21:13:51 +0000642 assert(!SourceMgr.getMainFileID().isInvalid() &&
643 "Couldn't establish MainFileID!");
Daniel Dunbarccb6cb62009-11-14 07:53:04 +0000644 return true;
645}
Daniel Dunbar0397af22010-01-13 00:48:06 +0000646
647// High-Level Operations
648
649bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
650 assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
651 assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
652 assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
653
654 // FIXME: Take this as an argument, once all the APIs we used have moved to
655 // taking it as an input instead of hard-coding llvm::errs.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000656 raw_ostream &OS = llvm::errs();
Daniel Dunbar0397af22010-01-13 00:48:06 +0000657
658 // Create the target instance.
Douglas Gregor49a87542012-11-16 04:24:59 +0000659 setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(), &getTargetOpts()));
Daniel Dunbar0397af22010-01-13 00:48:06 +0000660 if (!hasTarget())
661 return false;
662
663 // Inform the target of the language options.
664 //
665 // FIXME: We shouldn't need to do this, the target should be immutable once
666 // created. This complexity should be lifted elsewhere.
667 getTarget().setForcedLangOptions(getLangOpts());
668
Fariborz Jahanian93a49942012-04-16 21:03:30 +0000669 // rewriter project will change target built-in bool type from its default.
670 if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
671 getTarget().noSignedCharForObjCBool();
672
Daniel Dunbar0397af22010-01-13 00:48:06 +0000673 // Validate/process some options.
674 if (getHeaderSearchOpts().Verbose)
675 OS << "clang -cc1 version " CLANG_VERSION_STRING
676 << " based upon " << PACKAGE_STRING
Sebastian Pop5d8b9542011-11-01 21:33:06 +0000677 << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
Daniel Dunbar0397af22010-01-13 00:48:06 +0000678
679 if (getFrontendOpts().ShowTimers)
680 createFrontendTimer();
681
Douglas Gregor95dd5582010-03-30 17:33:59 +0000682 if (getFrontendOpts().ShowStats)
683 llvm::EnableStatistics();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000684
Daniel Dunbar0397af22010-01-13 00:48:06 +0000685 for (unsigned i = 0, e = getFrontendOpts().Inputs.size(); i != e; ++i) {
Daniel Dunbar20560482010-06-07 23:23:50 +0000686 // Reset the ID tables if we are reusing the SourceManager.
687 if (hasSourceManager())
688 getSourceManager().clearIDTables();
Daniel Dunbar0397af22010-01-13 00:48:06 +0000689
Douglas Gregor1f6b2b52012-01-20 16:28:04 +0000690 if (Act.BeginSourceFile(*this, getFrontendOpts().Inputs[i])) {
Daniel Dunbar0397af22010-01-13 00:48:06 +0000691 Act.Execute();
692 Act.EndSourceFile();
693 }
694 }
695
Argyrios Kyrtzidis29f27872011-12-07 05:52:12 +0000696 // Notify the diagnostic client that all files were processed.
697 getDiagnostics().getClient()->finish();
698
Chris Lattner53eee7b2010-04-07 18:47:42 +0000699 if (getDiagnosticOpts().ShowCarets) {
Argyrios Kyrtzidisf2224d82010-11-18 20:06:46 +0000700 // We can have multiple diagnostics sharing one diagnostic client.
701 // Get the total number of warnings/errors from the client.
702 unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
703 unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000704
Chris Lattner53eee7b2010-04-07 18:47:42 +0000705 if (NumWarnings)
706 OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
707 if (NumWarnings && NumErrors)
708 OS << " and ";
709 if (NumErrors)
710 OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
711 if (NumWarnings || NumErrors)
712 OS << " generated.\n";
713 }
Daniel Dunbar0397af22010-01-13 00:48:06 +0000714
Daniel Dunbar20560482010-06-07 23:23:50 +0000715 if (getFrontendOpts().ShowStats && hasFileManager()) {
Daniel Dunbar0397af22010-01-13 00:48:06 +0000716 getFileManager().PrintStats();
717 OS << "\n";
718 }
719
Argyrios Kyrtzidisab41b972010-11-18 21:13:57 +0000720 return !getDiagnostics().getClient()->getNumErrors();
Daniel Dunbar0397af22010-01-13 00:48:06 +0000721}
722
Douglas Gregor21cae202011-09-12 23:31:24 +0000723/// \brief Determine the appropriate source input kind based on language
724/// options.
725static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
726 if (LangOpts.OpenCL)
727 return IK_OpenCL;
728 if (LangOpts.CUDA)
729 return IK_CUDA;
730 if (LangOpts.ObjC1)
731 return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
732 return LangOpts.CPlusPlus? IK_CXX : IK_C;
733}
734
Douglas Gregor0ced7992011-10-04 00:21:21 +0000735namespace {
Douglas Gregorf9e357d2011-11-29 19:06:37 +0000736 struct CompileModuleMapData {
737 CompilerInstance &Instance;
738 GenerateModuleAction &CreateModuleAction;
739 };
740}
741
742/// \brief Helper function that executes the module-generating action under
743/// a crash recovery context.
744static void doCompileMapModule(void *UserData) {
745 CompileModuleMapData &Data
746 = *reinterpret_cast<CompileModuleMapData *>(UserData);
747 Data.Instance.ExecuteAction(Data.CreateModuleAction);
748}
749
Douglas Gregor2a060852013-02-07 00:21:12 +0000750namespace {
751 /// \brief Function object that checks with the given macro definition should
752 /// be removed, because it is one of the ignored macros.
753 class RemoveIgnoredMacro {
754 const HeaderSearchOptions &HSOpts;
755
756 public:
757 explicit RemoveIgnoredMacro(const HeaderSearchOptions &HSOpts)
758 : HSOpts(HSOpts) { }
759
760 bool operator()(const std::pair<std::string, bool> &def) const {
Douglas Gregor005d51b2013-02-07 01:18:48 +0000761 StringRef MacroDef = def.first;
762 return HSOpts.ModulesIgnoreMacros.count(MacroDef.split('=').first) > 0;
Douglas Gregor2a060852013-02-07 00:21:12 +0000763 }
764 };
765}
766
Douglas Gregorf9e357d2011-11-29 19:06:37 +0000767/// \brief Compile a module file for the given module, using the options
768/// provided by the importing compiler instance.
Douglas Gregor21cae202011-09-12 23:31:24 +0000769static void compileModule(CompilerInstance &ImportingInstance,
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000770 SourceLocation ImportLoc,
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000771 Module *Module,
Douglas Gregor933e7a62011-11-29 18:31:39 +0000772 StringRef ModuleFileName) {
Douglas Gregor52f12722012-01-29 20:15:24 +0000773 llvm::LockFileManager Locked(ModuleFileName);
Douglas Gregor2bc75072011-10-05 14:53:30 +0000774 switch (Locked) {
Douglas Gregor52f12722012-01-29 20:15:24 +0000775 case llvm::LockFileManager::LFS_Error:
Douglas Gregor2bc75072011-10-05 14:53:30 +0000776 return;
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000777
Douglas Gregor52f12722012-01-29 20:15:24 +0000778 case llvm::LockFileManager::LFS_Owned:
Douglas Gregor2bc75072011-10-05 14:53:30 +0000779 // We're responsible for building the module ourselves. Do so below.
780 break;
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000781
Douglas Gregor52f12722012-01-29 20:15:24 +0000782 case llvm::LockFileManager::LFS_Shared:
Douglas Gregor2bc75072011-10-05 14:53:30 +0000783 // Someone else is responsible for building the module. Wait for them to
784 // finish.
785 Locked.waitForUnlock();
Douglas Gregor7cdd2812012-11-07 17:46:15 +0000786 return;
Douglas Gregor2bc75072011-10-05 14:53:30 +0000787 }
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000788
Douglas Gregorf9e357d2011-11-29 19:06:37 +0000789 ModuleMap &ModMap
790 = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
791
Douglas Gregor21cae202011-09-12 23:31:24 +0000792 // Construct a compiler invocation for creating this module.
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000793 IntrusiveRefCntPtr<CompilerInvocation> Invocation
Douglas Gregor21cae202011-09-12 23:31:24 +0000794 (new CompilerInvocation(ImportingInstance.getInvocation()));
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000795
Douglas Gregor18ee5472011-11-29 21:59:16 +0000796 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
797
Douglas Gregorb2d39c22011-09-15 20:53:28 +0000798 // For any options that aren't intended to affect how a module is built,
799 // reset them to their default values.
Ted Kremenekd3b74d92011-11-17 23:01:24 +0000800 Invocation->getLangOpts()->resetNonModularOptions();
Douglas Gregor18ee5472011-11-29 21:59:16 +0000801 PPOpts.resetNonModularOptions();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000802
Douglas Gregor2a060852013-02-07 00:21:12 +0000803 // Remove any macro definitions that are explicitly ignored by the module.
804 // They aren't supposed to affect how the module is built anyway.
805 const HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
806 PPOpts.Macros.erase(std::remove_if(PPOpts.Macros.begin(), PPOpts.Macros.end(),
807 RemoveIgnoredMacro(HSOpts)),
808 PPOpts.Macros.end());
809
810
Douglas Gregorb86b8dc2011-11-15 19:35:01 +0000811 // Note the name of the module we're building.
Douglas Gregor933e7a62011-11-29 18:31:39 +0000812 Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
Douglas Gregorb86b8dc2011-11-15 19:35:01 +0000813
Douglas Gregor463d9092012-11-29 23:55:25 +0000814 // Make sure that the failed-module structure has been allocated in
815 // the importing instance, and propagate the pointer to the newly-created
816 // instance.
817 PreprocessorOptions &ImportingPPOpts
818 = ImportingInstance.getInvocation().getPreprocessorOpts();
819 if (!ImportingPPOpts.FailedModules)
820 ImportingPPOpts.FailedModules = new PreprocessorOptions::FailedModulesSet;
821 PPOpts.FailedModules = ImportingPPOpts.FailedModules;
822
Douglas Gregor18ee5472011-11-29 21:59:16 +0000823 // If there is a module map file, build the module using the module map.
Douglas Gregorb2d39c22011-09-15 20:53:28 +0000824 // Set up the inputs/outputs so that we build the module from its umbrella
825 // header.
Douglas Gregor21cae202011-09-12 23:31:24 +0000826 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
Douglas Gregor6e975c42011-09-13 23:15:45 +0000827 FrontendOpts.OutputFile = ModuleFileName.str();
Douglas Gregor21cae202011-09-12 23:31:24 +0000828 FrontendOpts.DisableFree = false;
Douglas Gregorf575d6e2013-01-25 00:45:27 +0000829 FrontendOpts.GenerateGlobalModuleIndex = false;
Douglas Gregor21cae202011-09-12 23:31:24 +0000830 FrontendOpts.Inputs.clear();
Douglas Gregor18ee5472011-11-29 21:59:16 +0000831 InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000832
Douglas Gregor18ee5472011-11-29 21:59:16 +0000833 // Get or create the module map that we'll use to build this module.
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +0000834 SmallString<128> TempModuleMapFileName;
Douglas Gregor18ee5472011-11-29 21:59:16 +0000835 if (const FileEntry *ModuleMapFile
836 = ModMap.getContainingModuleMapFile(Module)) {
837 // Use the module map where this module resides.
Douglas Gregor1f6b2b52012-01-20 16:28:04 +0000838 FrontendOpts.Inputs.push_back(FrontendInputFile(ModuleMapFile->getName(),
839 IK));
Douglas Gregor18ee5472011-11-29 21:59:16 +0000840 } else {
841 // Create a temporary module map file.
842 TempModuleMapFileName = Module->Name;
843 TempModuleMapFileName += "-%%%%%%%%.map";
844 int FD;
845 if (llvm::sys::fs::unique_file(TempModuleMapFileName.str(), FD,
846 TempModuleMapFileName,
Douglas Gregor1e821e92011-12-06 22:05:29 +0000847 /*makeAbsolute=*/true)
Douglas Gregore9120292011-12-06 23:04:08 +0000848 != llvm::errc::success) {
Douglas Gregorf64114b2011-12-07 00:54:14 +0000849 ImportingInstance.getDiagnostics().Report(diag::err_module_map_temp_file)
850 << TempModuleMapFileName;
Douglas Gregor18ee5472011-11-29 21:59:16 +0000851 return;
Douglas Gregore9120292011-12-06 23:04:08 +0000852 }
Douglas Gregor18ee5472011-11-29 21:59:16 +0000853 // Print the module map to this file.
854 llvm::raw_fd_ostream OS(FD, /*shouldClose=*/true);
855 Module->print(OS);
856 FrontendOpts.Inputs.push_back(
Douglas Gregor1f6b2b52012-01-20 16:28:04 +0000857 FrontendInputFile(TempModuleMapFileName.str().str(), IK));
Douglas Gregor18ee5472011-11-29 21:59:16 +0000858 }
859
860 // Don't free the remapped file buffers; they are owned by our caller.
861 PPOpts.RetainRemappedFileBuffers = true;
862
Douglas Gregor78243652011-09-13 01:26:44 +0000863 Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
Douglas Gregor76d991e2011-09-13 23:20:27 +0000864 assert(ImportingInstance.getInvocation().getModuleHash() ==
Douglas Gregor18ee5472011-11-29 21:59:16 +0000865 Invocation->getModuleHash() && "Module hash mismatch!");
866
Douglas Gregor21cae202011-09-12 23:31:24 +0000867 // Construct a compiler instance that will be used to actually create the
868 // module.
869 CompilerInstance Instance;
870 Instance.setInvocation(&*Invocation);
Sean Silvad47afb92013-01-20 01:58:28 +0000871 Instance.createDiagnostics(&ImportingInstance.getDiagnosticClient(),
Douglas Gregoraee526e2011-09-29 00:38:00 +0000872 /*ShouldOwnClient=*/true,
873 /*ShouldCloneClient=*/true);
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000874
Douglas Gregor4565e482012-11-30 22:11:57 +0000875 // Note that this module is part of the module build stack, so that we
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000876 // can detect cycles in the module graph.
877 Instance.createFileManager(); // FIXME: Adopt file manager from importer?
878 Instance.createSourceManager(Instance.getFileManager());
879 SourceManager &SourceMgr = Instance.getSourceManager();
Douglas Gregor4565e482012-11-30 22:11:57 +0000880 SourceMgr.setModuleBuildStack(
881 ImportingInstance.getSourceManager().getModuleBuildStack());
882 SourceMgr.pushModuleBuildStack(Module->getTopLevelModuleName(),
Douglas Gregor830ea5b2012-11-30 18:38:50 +0000883 FullSourceLoc(ImportLoc, ImportingInstance.getSourceManager()));
884
885
Douglas Gregor21cae202011-09-12 23:31:24 +0000886 // Construct a module-generating action.
Douglas Gregor18ee5472011-11-29 21:59:16 +0000887 GenerateModuleAction CreateModuleAction;
888
Douglas Gregor0ced7992011-10-04 00:21:21 +0000889 // Execute the action to actually build the module in-place. Use a separate
890 // thread so that we get a stack large enough.
891 const unsigned ThreadStackSize = 8 << 20;
892 llvm::CrashRecoveryContext CRC;
Douglas Gregor18ee5472011-11-29 21:59:16 +0000893 CompileModuleMapData Data = { Instance, CreateModuleAction };
894 CRC.RunSafelyOnThread(&doCompileMapModule, &Data, ThreadStackSize);
895
896 // Delete the temporary module map file.
897 // FIXME: Even though we're executing under crash protection, it would still
898 // be nice to do this with RemoveFileOnSignal when we can. However, that
899 // doesn't make sense for all clients, so clean this up manually.
Benjamin Kramera2e94892012-10-14 19:50:53 +0000900 Instance.clearOutputFiles(/*EraseFiles=*/true);
Douglas Gregor18ee5472011-11-29 21:59:16 +0000901 if (!TempModuleMapFileName.empty())
902 llvm::sys::Path(TempModuleMapFileName).eraseFromDisk();
Douglas Gregora6b00fc2013-01-23 22:38:11 +0000903
904 // We've rebuilt a module. If we're allowed to generate or update the global
905 // module index, record that fact in the importing compiler instance.
Douglas Gregorf575d6e2013-01-25 00:45:27 +0000906 if (ImportingInstance.getFrontendOpts().GenerateGlobalModuleIndex) {
Douglas Gregora6b00fc2013-01-23 22:38:11 +0000907 ImportingInstance.setBuildGlobalModuleIndex(true);
908 }
NAKAMURA Takumia789ca92011-10-08 11:31:46 +0000909}
Douglas Gregor21cae202011-09-12 23:31:24 +0000910
Douglas Gregor63a72682013-03-20 00:22:05 +0000911/// \brief Diagnose differences between the current definition of the given
912/// configuration macro and the definition provided on the command line.
913static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
914 Module *Mod, SourceLocation ImportLoc) {
915 IdentifierInfo *Id = PP.getIdentifierInfo(ConfigMacro);
916 SourceManager &SourceMgr = PP.getSourceManager();
917
918 // If this identifier has never had a macro definition, then it could
919 // not have changed.
920 if (!Id->hadMacroDefinition())
921 return;
922
923 // If this identifier does not currently have a macro definition,
924 // check whether it had one on the command line.
925 if (!Id->hasMacroDefinition()) {
926 MacroDirective *UndefMD = PP.getMacroDirectiveHistory(Id);
927 for (MacroDirective *MD = UndefMD; MD; MD = MD->getPrevious()) {
928
929 FileID FID = SourceMgr.getFileID(MD->getLocation());
930 if (FID.isInvalid())
931 continue;
932
933 const llvm::MemoryBuffer *Buffer = SourceMgr.getBuffer(FID);
934 if (!Buffer)
935 continue;
936
937 // We only care about the predefines buffer.
938 if (!StringRef(Buffer->getBufferIdentifier()).equals("<built-in>"))
939 continue;
940
941 // This macro was defined on the command line, then #undef'd later.
942 // Complain.
943 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
944 << true << ConfigMacro << Mod->getFullModuleName();
945 if (UndefMD->getUndefLoc().isValid())
946 PP.Diag(UndefMD->getUndefLoc(), diag::note_module_def_undef_here)
947 << true;
948 return;
949 }
950
951 // Okay: no definition in the predefines buffer.
952 return;
953 }
954
955 // This identifier has a macro definition. Check whether we had a definition
956 // on the command line.
957 MacroDirective *DefMD = PP.getMacroDirective(Id);
958 MacroDirective *PredefinedMD = 0;
959 for (MacroDirective *MD = DefMD; MD; MD = MD->getPrevious()) {
960 FileID FID = SourceMgr.getFileID(MD->getLocation());
961 if (FID.isInvalid())
962 continue;
963
964 const llvm::MemoryBuffer *Buffer = SourceMgr.getBuffer(FID);
965 if (!Buffer)
966 continue;
967
968 // We only care about the predefines buffer.
969 if (!StringRef(Buffer->getBufferIdentifier()).equals("<built-in>"))
970 continue;
971
972 PredefinedMD = MD;
973 break;
974 }
975
976 // If there was no definition for this macro in the predefines buffer,
977 // complain.
978 if (!PredefinedMD ||
979 (!PredefinedMD->getLocation().isValid() &&
980 PredefinedMD->getUndefLoc().isValid())) {
981 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
982 << false << ConfigMacro << Mod->getFullModuleName();
983 PP.Diag(DefMD->getLocation(), diag::note_module_def_undef_here)
984 << false;
985 return;
986 }
987
988 // If the current macro definition is the same as the predefined macro
989 // definition, it's okay.
990 if (DefMD == PredefinedMD ||
991 DefMD->getInfo()->isIdenticalTo(*PredefinedMD->getInfo(), PP))
992 return;
993
994 // The macro definitions differ.
995 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
996 << false << ConfigMacro << Mod->getFullModuleName();
997 PP.Diag(DefMD->getLocation(), diag::note_module_def_undef_here)
998 << false;
999}
1000
Douglas Gregord44d2872013-03-25 21:19:16 +00001001/// \brief Write a new timestamp file with the given path.
1002static void writeTimestampFile(StringRef TimestampFile) {
1003 std::string ErrorInfo;
1004 llvm::raw_fd_ostream Out(TimestampFile.str().c_str(), ErrorInfo,
1005 llvm::raw_fd_ostream::F_Binary);
1006}
1007
1008/// \brief Prune the module cache of modules that haven't been accessed in
1009/// a long time.
1010static void pruneModuleCache(const HeaderSearchOptions &HSOpts) {
1011 struct stat StatBuf;
1012 llvm::SmallString<128> TimestampFile;
1013 TimestampFile = HSOpts.ModuleCachePath;
1014 llvm::sys::path::append(TimestampFile, "modules.timestamp");
1015
1016 // Try to stat() the timestamp file.
1017 if (::stat(TimestampFile.c_str(), &StatBuf)) {
1018 // If the timestamp file wasn't there, create one now.
1019 if (errno == ENOENT) {
1020 writeTimestampFile(TimestampFile);
1021 }
1022 return;
1023 }
1024
1025 // Check whether the time stamp is older than our pruning interval.
1026 // If not, do nothing.
1027 time_t TimeStampModTime = StatBuf.st_mtime;
1028 time_t CurrentTime = time(0);
1029 if (CurrentTime - TimeStampModTime <= HSOpts.ModuleCachePruneInterval) {
1030 return;
1031 }
1032
1033 // Write a new timestamp file so that nobody else attempts to prune.
1034 // There is a benign race condition here, if two Clang instances happen to
1035 // notice at the same time that the timestamp is out-of-date.
1036 writeTimestampFile(TimestampFile);
1037
1038 // Walk the entire module cache, looking for unused module files and module
1039 // indices.
1040 llvm::error_code EC;
1041 SmallString<128> ModuleCachePathNative;
1042 llvm::sys::path::native(HSOpts.ModuleCachePath, ModuleCachePathNative);
1043 for (llvm::sys::fs::directory_iterator
1044 Dir(ModuleCachePathNative.str(), EC), DirEnd;
1045 Dir != DirEnd && !EC; Dir.increment(EC)) {
1046 // If we don't have a directory, there's nothing to look into.
1047 bool IsDirectory;
1048 if (llvm::sys::fs::is_directory(Dir->path(), IsDirectory) || !IsDirectory)
1049 continue;
1050
1051 // Walk all of the files within this directory.
1052 bool RemovedAllFiles = true;
1053 for (llvm::sys::fs::directory_iterator File(Dir->path(), EC), FileEnd;
1054 File != FileEnd && !EC; File.increment(EC)) {
1055 // We only care about module and global module index files.
1056 if (llvm::sys::path::extension(File->path()) != ".pcm" &&
1057 llvm::sys::path::filename(File->path()) != "modules.idx") {
1058 RemovedAllFiles = false;
1059 continue;
1060 }
1061
1062 // Look at this file. If we can't stat it, there's nothing interesting
1063 // there.
1064 if (::stat(File->path().c_str(), &StatBuf)) {
1065 RemovedAllFiles = false;
1066 continue;
1067 }
1068
1069 // If the file has been used recently enough, leave it there.
1070 time_t FileAccessTime = StatBuf.st_atime;
1071 if (CurrentTime - FileAccessTime <= HSOpts.ModuleCachePruneAfter) {
1072 RemovedAllFiles = false;;
1073 continue;
1074 }
1075
1076 // Remove the file.
1077 bool Existed;
1078 if (llvm::sys::fs::remove(File->path(), Existed) || !Existed) {
1079 RemovedAllFiles = false;
1080 }
1081 }
1082
1083 // If we removed all of the files in the directory, remove the directory
1084 // itself.
1085 if (RemovedAllFiles) {
1086 bool Existed;
1087 llvm::sys::fs::remove(Dir->path(), Existed);
1088 }
1089 }
1090}
1091
Douglas Gregor463d9092012-11-29 23:55:25 +00001092ModuleLoadResult
1093CompilerInstance::loadModule(SourceLocation ImportLoc,
1094 ModuleIdPath Path,
1095 Module::NameVisibilityKind Visibility,
1096 bool IsInclusionDirective) {
Douglas Gregorb514c792011-11-30 04:26:53 +00001097 // If we've already handled this import, just return the cached result.
1098 // This one-element cache is important to eliminate redundant diagnostics
1099 // when both the preprocessor and parser see the same import declaration.
Douglas Gregor5e356932011-12-01 17:11:21 +00001100 if (!ImportLoc.isInvalid() && LastModuleImportLoc == ImportLoc) {
1101 // Make the named module visible.
1102 if (LastModuleImportResult)
Argyrios Kyrtzidis5ebcb202013-02-01 16:36:12 +00001103 ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility,
Douglas Gregor906d66a2013-03-20 21:10:35 +00001104 ImportLoc, /*Complain=*/false);
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001105 return LastModuleImportResult;
Douglas Gregor5e356932011-12-01 17:11:21 +00001106 }
Douglas Gregorb514c792011-11-30 04:26:53 +00001107
Douglas Gregor6aa52ec2011-08-26 23:56:07 +00001108 // Determine what file we're searching from.
Douglas Gregor3d3589d2011-11-30 00:36:36 +00001109 StringRef ModuleName = Path[0].first->getName();
1110 SourceLocation ModuleNameLoc = Path[0].second;
Douglas Gregor49009ec2011-11-30 04:03:44 +00001111
Douglas Gregor1a4761e2011-11-30 23:21:26 +00001112 clang::Module *Module = 0;
Douglas Gregor3d3589d2011-11-30 00:36:36 +00001113
Douglas Gregor49009ec2011-11-30 04:03:44 +00001114 // If we don't already have information on this module, load the module now.
Douglas Gregor1a4761e2011-11-30 23:21:26 +00001115 llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001116 = KnownModules.find(Path[0].first);
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001117 if (Known != KnownModules.end()) {
1118 // Retrieve the cached top-level module.
1119 Module = Known->second;
1120 } else if (ModuleName == getLangOpts().CurrentModule) {
1121 // This is the module we're building.
1122 Module = PP->getHeaderSearchInfo().getModuleMap().findModule(ModuleName);
1123 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1124 } else {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001125 // Search for a module with the given name.
Douglas Gregore434ec72012-01-29 17:08:11 +00001126 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
Douglas Gregor49009ec2011-11-30 04:03:44 +00001127 std::string ModuleFileName;
Douglas Gregor8bf778e2013-02-06 22:40:31 +00001128 if (Module) {
Douglas Gregore434ec72012-01-29 17:08:11 +00001129 ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(Module);
Douglas Gregor8bf778e2013-02-06 22:40:31 +00001130 } else
Douglas Gregore434ec72012-01-29 17:08:11 +00001131 ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(ModuleName);
Douglas Gregor463d9092012-11-29 23:55:25 +00001132
Douglas Gregor49009ec2011-11-30 04:03:44 +00001133 // If we don't already have an ASTReader, create one now.
1134 if (!ModuleManager) {
1135 if (!hasASTContext())
1136 createASTContext();
NAKAMURA Takumia789ca92011-10-08 11:31:46 +00001137
Douglas Gregord44d2872013-03-25 21:19:16 +00001138 // If we're not recursively building a module, check whether we
1139 // need to prune the module cache.
1140 if (getSourceManager().getModuleBuildStack().empty() &&
1141 getHeaderSearchOpts().ModuleCachePruneInterval > 0 &&
1142 getHeaderSearchOpts().ModuleCachePruneAfter > 0) {
1143 pruneModuleCache(getHeaderSearchOpts());
1144 }
1145
Douglas Gregor49009ec2011-11-30 04:03:44 +00001146 std::string Sysroot = getHeaderSearchOpts().Sysroot;
1147 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
1148 ModuleManager = new ASTReader(getPreprocessor(), *Context,
1149 Sysroot.empty() ? "" : Sysroot.c_str(),
Douglas Gregorf575d6e2013-01-25 00:45:27 +00001150 PPOpts.DisablePCHValidation,
1151 /*AllowASTWithCompilerErrors=*/false,
1152 getFrontendOpts().UseGlobalModuleIndex);
Douglas Gregor49009ec2011-11-30 04:03:44 +00001153 if (hasASTConsumer()) {
1154 ModuleManager->setDeserializationListener(
1155 getASTConsumer().GetASTDeserializationListener());
1156 getASTContext().setASTMutationListener(
1157 getASTConsumer().GetASTMutationListener());
Douglas Gregora8235d62012-10-09 23:05:51 +00001158 getPreprocessor().setPPMutationListener(
1159 getASTConsumer().GetPPMutationListener());
Douglas Gregor49009ec2011-11-30 04:03:44 +00001160 }
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001161 OwningPtr<ExternalASTSource> Source;
Douglas Gregor49009ec2011-11-30 04:03:44 +00001162 Source.reset(ModuleManager);
1163 getASTContext().setExternalSource(Source);
1164 if (hasSema())
1165 ModuleManager->InitializeSema(getSema());
1166 if (hasASTConsumer())
1167 ModuleManager->StartTranslationUnit(&getASTConsumer());
Douglas Gregorde8a9052011-09-14 23:13:09 +00001168 }
Douglas Gregor49009ec2011-11-30 04:03:44 +00001169
Douglas Gregor677e15f2013-03-19 00:28:20 +00001170 // Try to load the module file.
1171 unsigned ARRFlags = ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing;
1172 switch (ModuleManager->ReadAST(ModuleFileName, serialization::MK_Module,
1173 ImportLoc, ARRFlags)) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001174 case ASTReader::Success:
1175 break;
1176
Douglas Gregor7cdd2812012-11-07 17:46:15 +00001177 case ASTReader::OutOfDate: {
Douglas Gregor677e15f2013-03-19 00:28:20 +00001178 // The module file is out-of-date. Remove it, then rebuild it.
Douglas Gregor7cdd2812012-11-07 17:46:15 +00001179 bool Existed;
1180 llvm::sys::fs::remove(ModuleFileName, Existed);
Douglas Gregor677e15f2013-03-19 00:28:20 +00001181 }
1182 // Fall through to build the module again.
1183
1184 case ASTReader::Missing: {
1185 // The module file is (now) missing. Build it.
1186
1187 // If we don't have a module, we don't know how to build the module file.
1188 // Complain and return.
1189 if (!Module) {
1190 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1191 << ModuleName
1192 << SourceRange(ImportLoc, ModuleNameLoc);
1193 ModuleBuildFailed = true;
1194 return ModuleLoadResult();
1195 }
1196
1197 // Check whether there is a cycle in the module graph.
1198 ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
1199 ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1200 for (; Pos != PosEnd; ++Pos) {
1201 if (Pos->first == ModuleName)
1202 break;
1203 }
1204
1205 if (Pos != PosEnd) {
1206 SmallString<256> CyclePath;
1207 for (; Pos != PosEnd; ++Pos) {
1208 CyclePath += Pos->first;
1209 CyclePath += " -> ";
1210 }
1211 CyclePath += ModuleName;
1212
1213 getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
1214 << ModuleName << CyclePath;
1215 return ModuleLoadResult();
1216 }
Douglas Gregor463d9092012-11-29 23:55:25 +00001217
1218 // Check whether we have already attempted to build this module (but
1219 // failed).
1220 if (getPreprocessorOpts().FailedModules &&
1221 getPreprocessorOpts().FailedModules->hasAlreadyFailed(ModuleName)) {
1222 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_built)
1223 << ModuleName
1224 << SourceRange(ImportLoc, ModuleNameLoc);
Douglas Gregorf575d6e2013-01-25 00:45:27 +00001225 ModuleBuildFailed = true;
Douglas Gregor463d9092012-11-29 23:55:25 +00001226 return ModuleLoadResult();
1227 }
1228
Douglas Gregor677e15f2013-03-19 00:28:20 +00001229 // Try to compile the module.
Douglas Gregor830ea5b2012-11-30 18:38:50 +00001230 compileModule(*this, ModuleNameLoc, Module, ModuleFileName);
Douglas Gregor7cdd2812012-11-07 17:46:15 +00001231
Douglas Gregor677e15f2013-03-19 00:28:20 +00001232 // Try to read the module file, now that we've compiled it.
1233 ASTReader::ASTReadResult ReadResult
1234 = ModuleManager->ReadAST(ModuleFileName,
Argyrios Kyrtzidis958bcaf2012-11-15 18:57:22 +00001235 serialization::MK_Module, ImportLoc,
Douglas Gregor677e15f2013-03-19 00:28:20 +00001236 ASTReader::ARR_Missing);
1237 if (ReadResult != ASTReader::Success) {
1238 if (ReadResult == ASTReader::Missing) {
1239 getDiagnostics().Report(ModuleNameLoc,
1240 Module? diag::err_module_not_built
1241 : diag::err_module_not_found)
1242 << ModuleName
1243 << SourceRange(ImportLoc, ModuleNameLoc);
1244 }
1245
Douglas Gregorb8a8be12013-01-10 02:04:18 +00001246 if (getPreprocessorOpts().FailedModules)
1247 getPreprocessorOpts().FailedModules->addFailed(ModuleName);
Douglas Gregor7cdd2812012-11-07 17:46:15 +00001248 KnownModules[Path[0].first] = 0;
Douglas Gregorf575d6e2013-01-25 00:45:27 +00001249 ModuleBuildFailed = true;
Douglas Gregor463d9092012-11-29 23:55:25 +00001250 return ModuleLoadResult();
Douglas Gregor7cdd2812012-11-07 17:46:15 +00001251 }
1252
1253 // Okay, we've rebuilt and now loaded the module.
1254 break;
1255 }
1256
Douglas Gregor4825fd72012-10-22 22:50:17 +00001257 case ASTReader::VersionMismatch:
1258 case ASTReader::ConfigurationMismatch:
1259 case ASTReader::HadErrors:
Douglas Gregor49009ec2011-11-30 04:03:44 +00001260 // FIXME: The ASTReader will already have complained, but can we showhorn
1261 // that diagnostic information into a more useful form?
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001262 KnownModules[Path[0].first] = 0;
Douglas Gregor463d9092012-11-29 23:55:25 +00001263 return ModuleLoadResult();
Douglas Gregor49009ec2011-11-30 04:03:44 +00001264
1265 case ASTReader::Failure:
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001266 // Already complained, but note now that we failed.
1267 KnownModules[Path[0].first] = 0;
Douglas Gregorf575d6e2013-01-25 00:45:27 +00001268 ModuleBuildFailed = true;
Douglas Gregor463d9092012-11-29 23:55:25 +00001269 return ModuleLoadResult();
Douglas Gregor49009ec2011-11-30 04:03:44 +00001270 }
1271
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001272 if (!Module) {
1273 // If we loaded the module directly, without finding a module map first,
1274 // we'll have loaded the module's information from the module itself.
1275 Module = PP->getHeaderSearchInfo().getModuleMap()
1276 .findModule((Path[0].first->getName()));
1277 }
Argyrios Kyrtzidise2ac16b2012-09-29 01:06:04 +00001278
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001279 // Cache the result of this top-level module lookup for later.
1280 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
Douglas Gregor6aa52ec2011-08-26 23:56:07 +00001281 }
Douglas Gregor49009ec2011-11-30 04:03:44 +00001282
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001283 // If we never found the module, fail.
1284 if (!Module)
Douglas Gregor463d9092012-11-29 23:55:25 +00001285 return ModuleLoadResult();
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001286
Douglas Gregor49009ec2011-11-30 04:03:44 +00001287 // Verify that the rest of the module path actually corresponds to
1288 // a submodule.
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001289 if (Path.size() > 1) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001290 for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1291 StringRef Name = Path[I].first->getName();
Douglas Gregorb7a78192012-01-04 23:32:19 +00001292 clang::Module *Sub = Module->findSubmodule(Name);
Douglas Gregor49009ec2011-11-30 04:03:44 +00001293
Douglas Gregorb7a78192012-01-04 23:32:19 +00001294 if (!Sub) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001295 // Attempt to perform typo correction to find a module name that works.
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00001296 SmallVector<StringRef, 2> Best;
Douglas Gregor49009ec2011-11-30 04:03:44 +00001297 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1298
Douglas Gregorb7a78192012-01-04 23:32:19 +00001299 for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1300 JEnd = Module->submodule_end();
Matt Beaumont-Gaye25633f2011-11-30 19:41:21 +00001301 J != JEnd; ++J) {
Douglas Gregorb7a78192012-01-04 23:32:19 +00001302 unsigned ED = Name.edit_distance((*J)->Name,
Douglas Gregor49009ec2011-11-30 04:03:44 +00001303 /*AllowReplacements=*/true,
1304 BestEditDistance);
1305 if (ED <= BestEditDistance) {
Douglas Gregorb7a78192012-01-04 23:32:19 +00001306 if (ED < BestEditDistance) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001307 Best.clear();
Douglas Gregorb7a78192012-01-04 23:32:19 +00001308 BestEditDistance = ED;
1309 }
1310
1311 Best.push_back((*J)->Name);
Douglas Gregor49009ec2011-11-30 04:03:44 +00001312 }
1313 }
1314
1315 // If there was a clear winner, user it.
1316 if (Best.size() == 1) {
1317 getDiagnostics().Report(Path[I].second,
1318 diag::err_no_submodule_suggest)
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001319 << Path[I].first << Module->getFullModuleName() << Best[0]
Douglas Gregor49009ec2011-11-30 04:03:44 +00001320 << SourceRange(Path[0].second, Path[I-1].second)
1321 << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1322 Best[0]);
Douglas Gregorb7a78192012-01-04 23:32:19 +00001323
1324 Sub = Module->findSubmodule(Best[0]);
Douglas Gregor49009ec2011-11-30 04:03:44 +00001325 }
1326 }
1327
Douglas Gregorb7a78192012-01-04 23:32:19 +00001328 if (!Sub) {
Douglas Gregor49009ec2011-11-30 04:03:44 +00001329 // No submodule by this name. Complain, and don't look for further
1330 // submodules.
1331 getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
Douglas Gregor392ed2b2011-11-30 17:33:56 +00001332 << Path[I].first << Module->getFullModuleName()
Douglas Gregor49009ec2011-11-30 04:03:44 +00001333 << SourceRange(Path[0].second, Path[I-1].second);
1334 break;
1335 }
1336
Douglas Gregorb7a78192012-01-04 23:32:19 +00001337 Module = Sub;
Douglas Gregor49009ec2011-11-30 04:03:44 +00001338 }
Douglas Gregor6aa52ec2011-08-26 23:56:07 +00001339 }
Douglas Gregor49009ec2011-11-30 04:03:44 +00001340
Douglas Gregor5e3f9222011-12-08 17:01:29 +00001341 // Make the named module visible, if it's not already part of the module
1342 // we are parsing.
Douglas Gregor305dc3e2011-12-20 00:28:52 +00001343 if (ModuleName != getLangOpts().CurrentModule) {
1344 if (!Module->IsFromModuleFile) {
1345 // We have an umbrella header or directory that doesn't actually include
1346 // all of the headers within the directory it covers. Complain about
1347 // this missing submodule and recover by forgetting that we ever saw
1348 // this submodule.
1349 // FIXME: Should we detect this at module load time? It seems fairly
1350 // expensive (and rare).
1351 getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1352 << Module->getFullModuleName()
1353 << SourceRange(Path.front().second, Path.back().second);
1354
Douglas Gregor463d9092012-11-29 23:55:25 +00001355 return ModuleLoadResult(0, true);
Douglas Gregor305dc3e2011-12-20 00:28:52 +00001356 }
Douglas Gregor51f564f2011-12-31 04:05:44 +00001357
1358 // Check whether this module is available.
1359 StringRef Feature;
Douglas Gregordc58aa72012-01-30 06:01:29 +00001360 if (!Module->isAvailable(getLangOpts(), getTarget(), Feature)) {
Douglas Gregor51f564f2011-12-31 04:05:44 +00001361 getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1362 << Module->getFullModuleName()
1363 << Feature
1364 << SourceRange(Path.front().second, Path.back().second);
1365 LastModuleImportLoc = ImportLoc;
Douglas Gregor463d9092012-11-29 23:55:25 +00001366 LastModuleImportResult = ModuleLoadResult();
1367 return ModuleLoadResult();
Douglas Gregor51f564f2011-12-31 04:05:44 +00001368 }
1369
Douglas Gregor906d66a2013-03-20 21:10:35 +00001370 ModuleManager->makeModuleVisible(Module, Visibility, ImportLoc,
1371 /*Complain=*/true);
Douglas Gregor305dc3e2011-12-20 00:28:52 +00001372 }
Douglas Gregor63a72682013-03-20 00:22:05 +00001373
1374 // Check for any configuration macros that have changed.
1375 clang::Module *TopModule = Module->getTopLevelModule();
1376 for (unsigned I = 0, N = TopModule->ConfigMacros.size(); I != N; ++I) {
1377 checkConfigMacro(getPreprocessor(), TopModule->ConfigMacros[I],
1378 Module, ImportLoc);
1379 }
1380
Douglas Gregor93ebfa62011-12-02 23:42:12 +00001381 // If this module import was due to an inclusion directive, create an
1382 // implicit import declaration to capture it in the AST.
1383 if (IsInclusionDirective && hasASTContext()) {
1384 TranslationUnitDecl *TU = getASTContext().getTranslationUnitDecl();
Argyrios Kyrtzidisd3d98162012-10-03 01:58:37 +00001385 ImportDecl *ImportD = ImportDecl::CreateImplicit(getASTContext(), TU,
1386 ImportLoc, Module,
1387 Path.back().second);
1388 TU->addDecl(ImportD);
1389 if (Consumer)
1390 Consumer->HandleImplicitImportDecl(ImportD);
Douglas Gregor93ebfa62011-12-02 23:42:12 +00001391 }
Douglas Gregor49009ec2011-11-30 04:03:44 +00001392
Douglas Gregorb514c792011-11-30 04:26:53 +00001393 LastModuleImportLoc = ImportLoc;
Douglas Gregor463d9092012-11-29 23:55:25 +00001394 LastModuleImportResult = ModuleLoadResult(Module, false);
1395 return LastModuleImportResult;
Douglas Gregor6aa52ec2011-08-26 23:56:07 +00001396}
Douglas Gregorca2ab452013-01-12 01:29:50 +00001397
1398void CompilerInstance::makeModuleVisible(Module *Mod,
Argyrios Kyrtzidis5ebcb202013-02-01 16:36:12 +00001399 Module::NameVisibilityKind Visibility,
Douglas Gregor906d66a2013-03-20 21:10:35 +00001400 SourceLocation ImportLoc,
1401 bool Complain){
1402 ModuleManager->makeModuleVisible(Mod, Visibility, ImportLoc, Complain);
Douglas Gregorca2ab452013-01-12 01:29:50 +00001403}
1404