1 //===- 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 
15 #include "clang/Frontend/ChainedIncludesSource.h"
16 #include "clang/Basic/TargetInfo.h"
17 #include "clang/Frontend/ASTUnit.h"
18 #include "clang/Frontend/CompilerInstance.h"
19 #include "clang/Frontend/TextDiagnosticPrinter.h"
20 #include "clang/Lex/Preprocessor.h"
21 #include "clang/Parse/ParseAST.h"
22 #include "clang/Serialization/ASTReader.h"
23 #include "clang/Serialization/ASTWriter.h"
24 #include "llvm/Support/MemoryBuffer.h"
25 
26 using namespace clang;
27 
28 static ASTReader *createASTReader(CompilerInstance &CI,
29                                   StringRef pchFile,
30                                   SmallVector<llvm::MemoryBuffer *, 4> &memBufs,
31                                   SmallVector<std::string, 4> &bufNames,
32                              ASTDeserializationListener *deserialListener = 0) {
33   Preprocessor &PP = CI.getPreprocessor();
34   OwningPtr<ASTReader> Reader;
35   Reader.reset(new ASTReader(PP, CI.getASTContext(), /*isysroot=*/"",
36                              /*DisableValidation=*/true));
37   for (unsigned ti = 0; ti < bufNames.size(); ++ti) {
38     StringRef sr(bufNames[ti]);
39     Reader->addInMemoryBuffer(sr, memBufs[ti]);
40   }
41   Reader->setDeserializationListener(deserialListener);
42   switch (Reader->ReadAST(pchFile, serialization::MK_PCH, SourceLocation(),
43                           ASTReader::ARR_None)) {
44   case ASTReader::Success:
45     // Set the predefines buffer as suggested by the PCH reader.
46     PP.setPredefines(Reader->getSuggestedPredefines());
47     return Reader.take();
48 
49   case ASTReader::Failure:
50   case ASTReader::Missing:
51   case ASTReader::OutOfDate:
52   case ASTReader::VersionMismatch:
53   case ASTReader::ConfigurationMismatch:
54   case ASTReader::HadErrors:
55     break;
56   }
57   return 0;
58 }
59 
60 ChainedIncludesSource::~ChainedIncludesSource() {
61   for (unsigned i = 0, e = CIs.size(); i != e; ++i)
62     delete CIs[i];
63 }
64 
65 ChainedIncludesSource *ChainedIncludesSource::create(CompilerInstance &CI) {
66 
67   std::vector<std::string> &includes = CI.getPreprocessorOpts().ChainedIncludes;
68   assert(!includes.empty() && "No '-chain-include' in options!");
69 
70   OwningPtr<ChainedIncludesSource> source(new ChainedIncludesSource());
71   InputKind IK = CI.getFrontendOpts().Inputs[0].getKind();
72 
73   SmallVector<llvm::MemoryBuffer *, 4> serialBufs;
74   SmallVector<std::string, 4> serialBufNames;
75 
76   for (unsigned i = 0, e = includes.size(); i != e; ++i) {
77     bool firstInclude = (i == 0);
78     OwningPtr<CompilerInvocation> CInvok;
79     CInvok.reset(new CompilerInvocation(CI.getInvocation()));
80 
81     CInvok->getPreprocessorOpts().ChainedIncludes.clear();
82     CInvok->getPreprocessorOpts().ImplicitPCHInclude.clear();
83     CInvok->getPreprocessorOpts().ImplicitPTHInclude.clear();
84     CInvok->getPreprocessorOpts().DisablePCHValidation = true;
85     CInvok->getPreprocessorOpts().Includes.clear();
86     CInvok->getPreprocessorOpts().MacroIncludes.clear();
87     CInvok->getPreprocessorOpts().Macros.clear();
88 
89     CInvok->getFrontendOpts().Inputs.clear();
90     FrontendInputFile InputFile(includes[i], IK);
91     CInvok->getFrontendOpts().Inputs.push_back(InputFile);
92 
93     TextDiagnosticPrinter *DiagClient =
94       new TextDiagnosticPrinter(llvm::errs(), new DiagnosticOptions());
95     IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
96     IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
97         new DiagnosticsEngine(DiagID, &CI.getDiagnosticOpts(), DiagClient));
98 
99     OwningPtr<CompilerInstance> Clang(new CompilerInstance());
100     Clang->setInvocation(CInvok.take());
101     Clang->setDiagnostics(Diags.getPtr());
102     Clang->setTarget(TargetInfo::CreateTargetInfo(Clang->getDiagnostics(),
103                                                   &Clang->getTargetOpts()));
104     Clang->createFileManager();
105     Clang->createSourceManager(Clang->getFileManager());
106     Clang->createPreprocessor();
107     Clang->getDiagnosticClient().BeginSourceFile(Clang->getLangOpts(),
108                                                  &Clang->getPreprocessor());
109     Clang->createASTContext();
110 
111     SmallVector<char, 256> serialAST;
112     llvm::raw_svector_ostream OS(serialAST);
113     OwningPtr<ASTConsumer> consumer;
114     consumer.reset(new PCHGenerator(Clang->getPreprocessor(), "-", 0,
115                                     /*isysroot=*/"", &OS));
116     Clang->getPreprocessor().setPPMutationListener(
117                                             consumer->GetPPMutationListener());
118     Clang->getASTContext().setASTMutationListener(
119                                             consumer->GetASTMutationListener());
120     Clang->setASTConsumer(consumer.take());
121     Clang->createSema(TU_Prefix, 0);
122 
123     if (firstInclude) {
124       Preprocessor &PP = Clang->getPreprocessor();
125       PP.getBuiltinInfo().InitializeBuiltins(PP.getIdentifierTable(),
126                                              PP.getLangOpts());
127     } else {
128       assert(!serialBufs.empty());
129       SmallVector<llvm::MemoryBuffer *, 4> bufs;
130       for (unsigned si = 0, se = serialBufs.size(); si != se; ++si) {
131         bufs.push_back(llvm::MemoryBuffer::getMemBufferCopy(
132                              StringRef(serialBufs[si]->getBufferStart(),
133                                              serialBufs[si]->getBufferSize())));
134       }
135       std::string pchName = includes[i-1];
136       llvm::raw_string_ostream os(pchName);
137       os << ".pch" << i-1;
138       os.flush();
139 
140       serialBufNames.push_back(pchName);
141 
142       OwningPtr<ExternalASTSource> Reader;
143 
144       Reader.reset(createASTReader(*Clang, pchName, bufs, serialBufNames,
145         Clang->getASTConsumer().GetASTDeserializationListener()));
146       if (!Reader)
147         return 0;
148       Clang->getASTContext().setExternalSource(Reader);
149     }
150 
151     if (!Clang->InitializeSourceManager(InputFile))
152       return 0;
153 
154     ParseAST(Clang->getSema());
155     OS.flush();
156     Clang->getDiagnosticClient().EndSourceFile();
157     serialBufs.push_back(
158       llvm::MemoryBuffer::getMemBufferCopy(StringRef(serialAST.data(),
159                                                            serialAST.size())));
160     source->CIs.push_back(Clang.take());
161   }
162 
163   assert(!serialBufs.empty());
164   std::string pchName = includes.back() + ".pch-final";
165   serialBufNames.push_back(pchName);
166   OwningPtr<ASTReader> Reader;
167   Reader.reset(createASTReader(CI, pchName, serialBufs, serialBufNames));
168   if (!Reader)
169     return 0;
170 
171   source->FinalReader.reset(Reader.take());
172   return source.take();
173 }
174 
175 //===----------------------------------------------------------------------===//
176 // ExternalASTSource interface.
177 //===----------------------------------------------------------------------===//
178 
179 Decl *ChainedIncludesSource::GetExternalDecl(uint32_t ID) {
180   return getFinalReader().GetExternalDecl(ID);
181 }
182 Selector ChainedIncludesSource::GetExternalSelector(uint32_t ID) {
183   return getFinalReader().GetExternalSelector(ID);
184 }
185 uint32_t ChainedIncludesSource::GetNumExternalSelectors() {
186   return getFinalReader().GetNumExternalSelectors();
187 }
188 Stmt *ChainedIncludesSource::GetExternalDeclStmt(uint64_t Offset) {
189   return getFinalReader().GetExternalDeclStmt(Offset);
190 }
191 CXXBaseSpecifier *
192 ChainedIncludesSource::GetExternalCXXBaseSpecifiers(uint64_t Offset) {
193   return getFinalReader().GetExternalCXXBaseSpecifiers(Offset);
194 }
195 bool
196 ChainedIncludesSource::FindExternalVisibleDeclsByName(const DeclContext *DC,
197                                                       DeclarationName Name) {
198   return getFinalReader().FindExternalVisibleDeclsByName(DC, Name);
199 }
200 ExternalLoadResult
201 ChainedIncludesSource::FindExternalLexicalDecls(const DeclContext *DC,
202                                       bool (*isKindWeWant)(Decl::Kind),
203                                       SmallVectorImpl<Decl*> &Result) {
204   return getFinalReader().FindExternalLexicalDecls(DC, isKindWeWant, Result);
205 }
206 void ChainedIncludesSource::CompleteType(TagDecl *Tag) {
207   return getFinalReader().CompleteType(Tag);
208 }
209 void ChainedIncludesSource::CompleteType(ObjCInterfaceDecl *Class) {
210   return getFinalReader().CompleteType(Class);
211 }
212 void ChainedIncludesSource::StartedDeserializing() {
213   return getFinalReader().StartedDeserializing();
214 }
215 void ChainedIncludesSource::FinishedDeserializing() {
216   return getFinalReader().FinishedDeserializing();
217 }
218 void ChainedIncludesSource::StartTranslationUnit(ASTConsumer *Consumer) {
219   return getFinalReader().StartTranslationUnit(Consumer);
220 }
221 void ChainedIncludesSource::PrintStats() {
222   return getFinalReader().PrintStats();
223 }
224 void ChainedIncludesSource::getMemoryBufferSizes(MemoryBufferSizes &sizes)const{
225   for (unsigned i = 0, e = CIs.size(); i != e; ++i) {
226     if (const ExternalASTSource *eSrc =
227         CIs[i]->getASTContext().getExternalSource()) {
228       eSrc->getMemoryBufferSizes(sizes);
229     }
230   }
231 
232   getFinalReader().getMemoryBufferSizes(sizes);
233 }
234 
235 void ChainedIncludesSource::InitializeSema(Sema &S) {
236   return getFinalReader().InitializeSema(S);
237 }
238 void ChainedIncludesSource::ForgetSema() {
239   return getFinalReader().ForgetSema();
240 }
241 void ChainedIncludesSource::ReadMethodPool(Selector Sel) {
242   getFinalReader().ReadMethodPool(Sel);
243 }
244 bool ChainedIncludesSource::LookupUnqualified(LookupResult &R, Scope *S) {
245   return getFinalReader().LookupUnqualified(R, S);
246 }
247 
248