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->getASTContext().setASTMutationListener(
117                                             consumer->GetASTMutationListener());
118     Clang->setASTConsumer(consumer.take());
119     Clang->createSema(TU_Prefix, 0);
120 
121     if (firstInclude) {
122       Preprocessor &PP = Clang->getPreprocessor();
123       PP.getBuiltinInfo().InitializeBuiltins(PP.getIdentifierTable(),
124                                              PP.getLangOpts());
125     } else {
126       assert(!serialBufs.empty());
127       SmallVector<llvm::MemoryBuffer *, 4> bufs;
128       for (unsigned si = 0, se = serialBufs.size(); si != se; ++si) {
129         bufs.push_back(llvm::MemoryBuffer::getMemBufferCopy(
130                              StringRef(serialBufs[si]->getBufferStart(),
131                                              serialBufs[si]->getBufferSize())));
132       }
133       std::string pchName = includes[i-1];
134       llvm::raw_string_ostream os(pchName);
135       os << ".pch" << i-1;
136       os.flush();
137 
138       serialBufNames.push_back(pchName);
139 
140       OwningPtr<ExternalASTSource> Reader;
141 
142       Reader.reset(createASTReader(*Clang, pchName, bufs, serialBufNames,
143         Clang->getASTConsumer().GetASTDeserializationListener()));
144       if (!Reader)
145         return 0;
146       Clang->getASTContext().setExternalSource(Reader);
147     }
148 
149     if (!Clang->InitializeSourceManager(InputFile))
150       return 0;
151 
152     ParseAST(Clang->getSema());
153     OS.flush();
154     Clang->getDiagnosticClient().EndSourceFile();
155     serialBufs.push_back(
156       llvm::MemoryBuffer::getMemBufferCopy(StringRef(serialAST.data(),
157                                                            serialAST.size())));
158     source->CIs.push_back(Clang.take());
159   }
160 
161   assert(!serialBufs.empty());
162   std::string pchName = includes.back() + ".pch-final";
163   serialBufNames.push_back(pchName);
164   OwningPtr<ASTReader> Reader;
165   Reader.reset(createASTReader(CI, pchName, serialBufs, serialBufNames));
166   if (!Reader)
167     return 0;
168 
169   source->FinalReader.reset(Reader.take());
170   return source.take();
171 }
172 
173 //===----------------------------------------------------------------------===//
174 // ExternalASTSource interface.
175 //===----------------------------------------------------------------------===//
176 
177 Decl *ChainedIncludesSource::GetExternalDecl(uint32_t ID) {
178   return getFinalReader().GetExternalDecl(ID);
179 }
180 Selector ChainedIncludesSource::GetExternalSelector(uint32_t ID) {
181   return getFinalReader().GetExternalSelector(ID);
182 }
183 uint32_t ChainedIncludesSource::GetNumExternalSelectors() {
184   return getFinalReader().GetNumExternalSelectors();
185 }
186 Stmt *ChainedIncludesSource::GetExternalDeclStmt(uint64_t Offset) {
187   return getFinalReader().GetExternalDeclStmt(Offset);
188 }
189 CXXBaseSpecifier *
190 ChainedIncludesSource::GetExternalCXXBaseSpecifiers(uint64_t Offset) {
191   return getFinalReader().GetExternalCXXBaseSpecifiers(Offset);
192 }
193 bool
194 ChainedIncludesSource::FindExternalVisibleDeclsByName(const DeclContext *DC,
195                                                       DeclarationName Name) {
196   return getFinalReader().FindExternalVisibleDeclsByName(DC, Name);
197 }
198 ExternalLoadResult
199 ChainedIncludesSource::FindExternalLexicalDecls(const DeclContext *DC,
200                                       bool (*isKindWeWant)(Decl::Kind),
201                                       SmallVectorImpl<Decl*> &Result) {
202   return getFinalReader().FindExternalLexicalDecls(DC, isKindWeWant, Result);
203 }
204 void ChainedIncludesSource::CompleteType(TagDecl *Tag) {
205   return getFinalReader().CompleteType(Tag);
206 }
207 void ChainedIncludesSource::CompleteType(ObjCInterfaceDecl *Class) {
208   return getFinalReader().CompleteType(Class);
209 }
210 void ChainedIncludesSource::StartedDeserializing() {
211   return getFinalReader().StartedDeserializing();
212 }
213 void ChainedIncludesSource::FinishedDeserializing() {
214   return getFinalReader().FinishedDeserializing();
215 }
216 void ChainedIncludesSource::StartTranslationUnit(ASTConsumer *Consumer) {
217   return getFinalReader().StartTranslationUnit(Consumer);
218 }
219 void ChainedIncludesSource::PrintStats() {
220   return getFinalReader().PrintStats();
221 }
222 void ChainedIncludesSource::getMemoryBufferSizes(MemoryBufferSizes &sizes)const{
223   for (unsigned i = 0, e = CIs.size(); i != e; ++i) {
224     if (const ExternalASTSource *eSrc =
225         CIs[i]->getASTContext().getExternalSource()) {
226       eSrc->getMemoryBufferSizes(sizes);
227     }
228   }
229 
230   getFinalReader().getMemoryBufferSizes(sizes);
231 }
232 
233 void ChainedIncludesSource::InitializeSema(Sema &S) {
234   return getFinalReader().InitializeSema(S);
235 }
236 void ChainedIncludesSource::ForgetSema() {
237   return getFinalReader().ForgetSema();
238 }
239 void ChainedIncludesSource::ReadMethodPool(Selector Sel) {
240   getFinalReader().ReadMethodPool(Sel);
241 }
242 bool ChainedIncludesSource::LookupUnqualified(LookupResult &R, Scope *S) {
243   return getFinalReader().LookupUnqualified(R, S);
244 }
245 
246