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
26using namespace clang;
27
28static ASTReader *createASTReader(CompilerInstance &CI,
29                             StringRef pchFile,
30                             SmallVectorImpl<llvm::MemoryBuffer *> &memBufs,
31                             SmallVectorImpl<std::string> &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
60ChainedIncludesSource::~ChainedIncludesSource() {
61  for (unsigned i = 0, e = CIs.size(); i != e; ++i)
62    delete CIs[i];
63}
64
65ChainedIncludesSource *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->setModuleManager(static_cast<ASTReader*>(Reader.get()));
147      Clang->getASTContext().setExternalSource(Reader);
148    }
149
150    if (!Clang->InitializeSourceManager(InputFile))
151      return 0;
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.take());
160  }
161
162  assert(!serialBufs.empty());
163  std::string pchName = includes.back() + ".pch-final";
164  serialBufNames.push_back(pchName);
165  OwningPtr<ASTReader> Reader;
166  Reader.reset(createASTReader(CI, pchName, serialBufs, serialBufNames));
167  if (!Reader)
168    return 0;
169
170  source->FinalReader.reset(Reader.take());
171  return source.take();
172}
173
174//===----------------------------------------------------------------------===//
175// ExternalASTSource interface.
176//===----------------------------------------------------------------------===//
177
178Decl *ChainedIncludesSource::GetExternalDecl(uint32_t ID) {
179  return getFinalReader().GetExternalDecl(ID);
180}
181Selector ChainedIncludesSource::GetExternalSelector(uint32_t ID) {
182  return getFinalReader().GetExternalSelector(ID);
183}
184uint32_t ChainedIncludesSource::GetNumExternalSelectors() {
185  return getFinalReader().GetNumExternalSelectors();
186}
187Stmt *ChainedIncludesSource::GetExternalDeclStmt(uint64_t Offset) {
188  return getFinalReader().GetExternalDeclStmt(Offset);
189}
190CXXBaseSpecifier *
191ChainedIncludesSource::GetExternalCXXBaseSpecifiers(uint64_t Offset) {
192  return getFinalReader().GetExternalCXXBaseSpecifiers(Offset);
193}
194bool
195ChainedIncludesSource::FindExternalVisibleDeclsByName(const DeclContext *DC,
196                                                      DeclarationName Name) {
197  return getFinalReader().FindExternalVisibleDeclsByName(DC, Name);
198}
199ExternalLoadResult
200ChainedIncludesSource::FindExternalLexicalDecls(const DeclContext *DC,
201                                      bool (*isKindWeWant)(Decl::Kind),
202                                      SmallVectorImpl<Decl*> &Result) {
203  return getFinalReader().FindExternalLexicalDecls(DC, isKindWeWant, Result);
204}
205void ChainedIncludesSource::CompleteType(TagDecl *Tag) {
206  return getFinalReader().CompleteType(Tag);
207}
208void ChainedIncludesSource::CompleteType(ObjCInterfaceDecl *Class) {
209  return getFinalReader().CompleteType(Class);
210}
211void ChainedIncludesSource::StartedDeserializing() {
212  return getFinalReader().StartedDeserializing();
213}
214void ChainedIncludesSource::FinishedDeserializing() {
215  return getFinalReader().FinishedDeserializing();
216}
217void ChainedIncludesSource::StartTranslationUnit(ASTConsumer *Consumer) {
218  return getFinalReader().StartTranslationUnit(Consumer);
219}
220void ChainedIncludesSource::PrintStats() {
221  return getFinalReader().PrintStats();
222}
223void 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
234void ChainedIncludesSource::InitializeSema(Sema &S) {
235  return getFinalReader().InitializeSema(S);
236}
237void ChainedIncludesSource::ForgetSema() {
238  return getFinalReader().ForgetSema();
239}
240void ChainedIncludesSource::ReadMethodPool(Selector Sel) {
241  getFinalReader().ReadMethodPool(Sel);
242}
243bool ChainedIncludesSource::LookupUnqualified(LookupResult &R, Scope *S) {
244  return getFinalReader().LookupUnqualified(R, S);
245}
246
247