blob: cb260b4f4c6941a3a8a071d0d3c65572aa7c5e03 [file] [log] [blame]
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00001//===- ChainedIncludesSource.cpp - Chained PCHs in Memory -------*- C++ -*-===//
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// This file defines the ChainedIncludesSource class, which converts headers
11// to chained PCHs in memory, mainly used for testing.
12//
13//===----------------------------------------------------------------------===//
14
Chandler Carruth55fc8732012-12-04 09:13:33 +000015#include "clang/Basic/TargetInfo.h"
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +000016#include "clang/Frontend/ASTUnit.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000017#include "clang/Frontend/CompilerInstance.h"
18#include "clang/Frontend/TextDiagnosticPrinter.h"
19#include "clang/Lex/Preprocessor.h"
20#include "clang/Parse/ParseAST.h"
Chandler Carruth71088d12011-12-09 01:55:54 +000021#include "clang/Serialization/ASTReader.h"
22#include "clang/Serialization/ASTWriter.h"
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +000023#include "llvm/Support/MemoryBuffer.h"
24
25using namespace clang;
26
Stephen Hinesc568f1e2014-07-21 00:47:37 -070027namespace {
28class ChainedIncludesSource : public ExternalSemaSource {
29public:
30 virtual ~ChainedIncludesSource();
31
32 ExternalSemaSource &getFinalReader() const { return *FinalReader; }
33
34 std::vector<CompilerInstance *> CIs;
35 IntrusiveRefCntPtr<ExternalSemaSource> FinalReader;
36
37protected:
38 //===----------------------------------------------------------------------===//
39 // ExternalASTSource interface.
40 //===----------------------------------------------------------------------===//
41
42 Decl *GetExternalDecl(uint32_t ID) override;
43 Selector GetExternalSelector(uint32_t ID) override;
44 uint32_t GetNumExternalSelectors() override;
45 Stmt *GetExternalDeclStmt(uint64_t Offset) override;
46 CXXBaseSpecifier *GetExternalCXXBaseSpecifiers(uint64_t Offset) override;
47 bool FindExternalVisibleDeclsByName(const DeclContext *DC,
48 DeclarationName Name) override;
49 ExternalLoadResult
50 FindExternalLexicalDecls(const DeclContext *DC,
51 bool (*isKindWeWant)(Decl::Kind),
52 SmallVectorImpl<Decl *> &Result) override;
53 void CompleteType(TagDecl *Tag) override;
54 void CompleteType(ObjCInterfaceDecl *Class) override;
55 void StartedDeserializing() override;
56 void FinishedDeserializing() override;
57 void StartTranslationUnit(ASTConsumer *Consumer) override;
58 void PrintStats() override;
59
60 /// Return the amount of memory used by memory buffers, breaking down
61 /// by heap-backed versus mmap'ed memory.
62 void getMemoryBufferSizes(MemoryBufferSizes &sizes) const override;
63
64 //===----------------------------------------------------------------------===//
65 // ExternalSemaSource interface.
66 //===----------------------------------------------------------------------===//
67
68 void InitializeSema(Sema &S) override;
69 void ForgetSema() override;
70 void ReadMethodPool(Selector Sel) override;
71 bool LookupUnqualified(LookupResult &R, Scope *S) override;
72};
73}
74
Stephen Hines6bcf27b2014-05-29 04:14:42 -070075static ASTReader *
76createASTReader(CompilerInstance &CI, StringRef pchFile,
Stephen Hines176edba2014-12-01 14:53:08 -080077 SmallVectorImpl<std::unique_ptr<llvm::MemoryBuffer>> &MemBufs,
Stephen Hines6bcf27b2014-05-29 04:14:42 -070078 SmallVectorImpl<std::string> &bufNames,
79 ASTDeserializationListener *deserialListener = nullptr) {
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +000080 Preprocessor &PP = CI.getPreprocessor();
Stephen Hines651f13c2014-04-23 16:59:28 -070081 std::unique_ptr<ASTReader> Reader;
Douglas Gregorf8a1e512011-09-02 00:26:20 +000082 Reader.reset(new ASTReader(PP, CI.getASTContext(), /*isysroot=*/"",
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +000083 /*DisableValidation=*/true));
Jonathan D. Turnerc24a1ee2011-08-02 17:40:32 +000084 for (unsigned ti = 0; ti < bufNames.size(); ++ti) {
85 StringRef sr(bufNames[ti]);
Stephen Hines176edba2014-12-01 14:53:08 -080086 Reader->addInMemoryBuffer(sr, std::move(MemBufs[ti]));
Jonathan D. Turnerc24a1ee2011-08-02 17:40:32 +000087 }
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +000088 Reader->setDeserializationListener(deserialListener);
Argyrios Kyrtzidis958bcaf2012-11-15 18:57:22 +000089 switch (Reader->ReadAST(pchFile, serialization::MK_PCH, SourceLocation(),
Douglas Gregor38295be2012-10-22 23:51:00 +000090 ASTReader::ARR_None)) {
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +000091 case ASTReader::Success:
92 // Set the predefines buffer as suggested by the PCH reader.
93 PP.setPredefines(Reader->getSuggestedPredefines());
Stephen Hines651f13c2014-04-23 16:59:28 -070094 return Reader.release();
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +000095
96 case ASTReader::Failure:
Douglas Gregor677e15f2013-03-19 00:28:20 +000097 case ASTReader::Missing:
Douglas Gregor4825fd72012-10-22 22:50:17 +000098 case ASTReader::OutOfDate:
99 case ASTReader::VersionMismatch:
100 case ASTReader::ConfigurationMismatch:
101 case ASTReader::HadErrors:
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000102 break;
103 }
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700104 return nullptr;
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000105}
106
107ChainedIncludesSource::~ChainedIncludesSource() {
108 for (unsigned i = 0, e = CIs.size(); i != e; ++i)
109 delete CIs[i];
110}
111
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700112IntrusiveRefCntPtr<ExternalSemaSource> clang::createChainedIncludesSource(
113 CompilerInstance &CI, IntrusiveRefCntPtr<ExternalSemaSource> &Reader) {
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000114
115 std::vector<std::string> &includes = CI.getPreprocessorOpts().ChainedIncludes;
116 assert(!includes.empty() && "No '-chain-include' in options!");
117
Stephen Hines651f13c2014-04-23 16:59:28 -0700118 IntrusiveRefCntPtr<ChainedIncludesSource> source(new ChainedIncludesSource());
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +0000119 InputKind IK = CI.getFrontendOpts().Inputs[0].getKind();
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000120
Stephen Hines176edba2014-12-01 14:53:08 -0800121 SmallVector<std::unique_ptr<llvm::MemoryBuffer>, 4> SerialBufs;
Jonathan D. Turnerc24a1ee2011-08-02 17:40:32 +0000122 SmallVector<std::string, 4> serialBufNames;
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000123
124 for (unsigned i = 0, e = includes.size(); i != e; ++i) {
125 bool firstInclude = (i == 0);
Stephen Hines651f13c2014-04-23 16:59:28 -0700126 std::unique_ptr<CompilerInvocation> CInvok;
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000127 CInvok.reset(new CompilerInvocation(CI.getInvocation()));
128
129 CInvok->getPreprocessorOpts().ChainedIncludes.clear();
130 CInvok->getPreprocessorOpts().ImplicitPCHInclude.clear();
131 CInvok->getPreprocessorOpts().ImplicitPTHInclude.clear();
132 CInvok->getPreprocessorOpts().DisablePCHValidation = true;
133 CInvok->getPreprocessorOpts().Includes.clear();
134 CInvok->getPreprocessorOpts().MacroIncludes.clear();
135 CInvok->getPreprocessorOpts().Macros.clear();
136
137 CInvok->getFrontendOpts().Inputs.clear();
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000138 FrontendInputFile InputFile(includes[i], IK);
139 CInvok->getFrontendOpts().Inputs.push_back(InputFile);
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000140
141 TextDiagnosticPrinter *DiagClient =
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000142 new TextDiagnosticPrinter(llvm::errs(), new DiagnosticOptions());
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000143 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
144 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000145 new DiagnosticsEngine(DiagID, &CI.getDiagnosticOpts(), DiagClient));
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000146
Stephen Hines651f13c2014-04-23 16:59:28 -0700147 std::unique_ptr<CompilerInstance> Clang(new CompilerInstance());
148 Clang->setInvocation(CInvok.release());
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700149 Clang->setDiagnostics(Diags.get());
150 Clang->setTarget(TargetInfo::CreateTargetInfo(
151 Clang->getDiagnostics(), Clang->getInvocation().TargetOpts));
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000152 Clang->createFileManager();
153 Clang->createSourceManager(Clang->getFileManager());
Stephen Hines651f13c2014-04-23 16:59:28 -0700154 Clang->createPreprocessor(TU_Prefix);
Sebastian Redl0ab547c2011-03-31 19:29:18 +0000155 Clang->getDiagnosticClient().BeginSourceFile(Clang->getLangOpts(),
156 &Clang->getPreprocessor());
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000157 Clang->createASTContext();
158
Chris Lattner5f9e2722011-07-23 10:55:15 +0000159 SmallVector<char, 256> serialAST;
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000160 llvm::raw_svector_ostream OS(serialAST);
Stephen Hines176edba2014-12-01 14:53:08 -0800161 auto consumer =
162 llvm::make_unique<PCHGenerator>(Clang->getPreprocessor(), "-", nullptr,
163 /*isysroot=*/"", &OS);
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000164 Clang->getASTContext().setASTMutationListener(
165 consumer->GetASTMutationListener());
Stephen Hines176edba2014-12-01 14:53:08 -0800166 Clang->setASTConsumer(std::move(consumer));
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700167 Clang->createSema(TU_Prefix, nullptr);
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000168
169 if (firstInclude) {
170 Preprocessor &PP = Clang->getPreprocessor();
171 PP.getBuiltinInfo().InitializeBuiltins(PP.getIdentifierTable(),
David Blaikie4e4d0842012-03-11 07:00:24 +0000172 PP.getLangOpts());
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000173 } else {
Stephen Hines176edba2014-12-01 14:53:08 -0800174 assert(!SerialBufs.empty());
175 SmallVector<std::unique_ptr<llvm::MemoryBuffer>, 4> Bufs;
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700176 // TODO: Pass through the existing MemoryBuffer instances instead of
177 // allocating new ones.
Stephen Hines176edba2014-12-01 14:53:08 -0800178 for (auto &SB : SerialBufs)
179 Bufs.push_back(llvm::MemoryBuffer::getMemBuffer(SB->getBuffer()));
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000180 std::string pchName = includes[i-1];
181 llvm::raw_string_ostream os(pchName);
182 os << ".pch" << i-1;
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700183 serialBufNames.push_back(os.str());
Jonathan D. Turnerc24a1ee2011-08-02 17:40:32 +0000184
Stephen Hines651f13c2014-04-23 16:59:28 -0700185 IntrusiveRefCntPtr<ASTReader> Reader;
Stephen Hines176edba2014-12-01 14:53:08 -0800186 Reader = createASTReader(
187 *Clang, pchName, Bufs, serialBufNames,
188 Clang->getASTConsumer().GetASTDeserializationListener());
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000189 if (!Reader)
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700190 return nullptr;
Stephen Hines651f13c2014-04-23 16:59:28 -0700191 Clang->setModuleManager(Reader);
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000192 Clang->getASTContext().setExternalSource(Reader);
193 }
194
Argyrios Kyrtzidis8e1fbbc2012-11-09 19:40:33 +0000195 if (!Clang->InitializeSourceManager(InputFile))
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700196 return nullptr;
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000197
198 ParseAST(Clang->getSema());
Sebastian Redl0ab547c2011-03-31 19:29:18 +0000199 Clang->getDiagnosticClient().EndSourceFile();
Stephen Hines176edba2014-12-01 14:53:08 -0800200 SerialBufs.push_back(llvm::MemoryBuffer::getMemBufferCopy(OS.str()));
Stephen Hines651f13c2014-04-23 16:59:28 -0700201 source->CIs.push_back(Clang.release());
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000202 }
203
Stephen Hines176edba2014-12-01 14:53:08 -0800204 assert(!SerialBufs.empty());
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000205 std::string pchName = includes.back() + ".pch-final";
Jonathan D. Turnerc24a1ee2011-08-02 17:40:32 +0000206 serialBufNames.push_back(pchName);
Stephen Hines176edba2014-12-01 14:53:08 -0800207 Reader = createASTReader(CI, pchName, SerialBufs, serialBufNames);
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000208 if (!Reader)
Stephen Hines6bcf27b2014-05-29 04:14:42 -0700209 return nullptr;
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000210
Stephen Hines651f13c2014-04-23 16:59:28 -0700211 source->FinalReader = Reader;
212 return source;
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000213}
214
215//===----------------------------------------------------------------------===//
216// ExternalASTSource interface.
217//===----------------------------------------------------------------------===//
218
219Decl *ChainedIncludesSource::GetExternalDecl(uint32_t ID) {
220 return getFinalReader().GetExternalDecl(ID);
221}
222Selector ChainedIncludesSource::GetExternalSelector(uint32_t ID) {
223 return getFinalReader().GetExternalSelector(ID);
224}
225uint32_t ChainedIncludesSource::GetNumExternalSelectors() {
226 return getFinalReader().GetNumExternalSelectors();
227}
228Stmt *ChainedIncludesSource::GetExternalDeclStmt(uint64_t Offset) {
229 return getFinalReader().GetExternalDeclStmt(Offset);
230}
231CXXBaseSpecifier *
232ChainedIncludesSource::GetExternalCXXBaseSpecifiers(uint64_t Offset) {
233 return getFinalReader().GetExternalCXXBaseSpecifiers(Offset);
234}
Richard Smith3646c682013-02-07 03:30:24 +0000235bool
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000236ChainedIncludesSource::FindExternalVisibleDeclsByName(const DeclContext *DC,
237 DeclarationName Name) {
238 return getFinalReader().FindExternalVisibleDeclsByName(DC, Name);
239}
Douglas Gregorba6ffaf2011-07-15 21:46:17 +0000240ExternalLoadResult
241ChainedIncludesSource::FindExternalLexicalDecls(const DeclContext *DC,
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000242 bool (*isKindWeWant)(Decl::Kind),
Chris Lattner5f9e2722011-07-23 10:55:15 +0000243 SmallVectorImpl<Decl*> &Result) {
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000244 return getFinalReader().FindExternalLexicalDecls(DC, isKindWeWant, Result);
245}
246void ChainedIncludesSource::CompleteType(TagDecl *Tag) {
247 return getFinalReader().CompleteType(Tag);
248}
249void ChainedIncludesSource::CompleteType(ObjCInterfaceDecl *Class) {
250 return getFinalReader().CompleteType(Class);
251}
252void ChainedIncludesSource::StartedDeserializing() {
253 return getFinalReader().StartedDeserializing();
254}
255void ChainedIncludesSource::FinishedDeserializing() {
256 return getFinalReader().FinishedDeserializing();
257}
258void ChainedIncludesSource::StartTranslationUnit(ASTConsumer *Consumer) {
259 return getFinalReader().StartTranslationUnit(Consumer);
260}
261void ChainedIncludesSource::PrintStats() {
262 return getFinalReader().PrintStats();
263}
Ted Kremeneke9b5f3d2011-04-28 23:46:20 +0000264void ChainedIncludesSource::getMemoryBufferSizes(MemoryBufferSizes &sizes)const{
265 for (unsigned i = 0, e = CIs.size(); i != e; ++i) {
266 if (const ExternalASTSource *eSrc =
267 CIs[i]->getASTContext().getExternalSource()) {
268 eSrc->getMemoryBufferSizes(sizes);
269 }
270 }
271
272 getFinalReader().getMemoryBufferSizes(sizes);
273}
Sebastian Redlce0682f2011-03-31 19:29:24 +0000274
275void ChainedIncludesSource::InitializeSema(Sema &S) {
276 return getFinalReader().InitializeSema(S);
277}
278void ChainedIncludesSource::ForgetSema() {
279 return getFinalReader().ForgetSema();
280}
Douglas Gregor5ac4b692012-01-25 00:49:42 +0000281void ChainedIncludesSource::ReadMethodPool(Selector Sel) {
282 getFinalReader().ReadMethodPool(Sel);
Sebastian Redlce0682f2011-03-31 19:29:24 +0000283}
284bool ChainedIncludesSource::LookupUnqualified(LookupResult &R, Scope *S) {
285 return getFinalReader().LookupUnqualified(R, S);
286}
287