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