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