Home | History | Annotate | Download | only in Frontend 
      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::OutOfDate:
     51   case ASTReader::VersionMismatch:
     52   case ASTReader::ConfigurationMismatch:
     53   case ASTReader::HadErrors:
     54     break;
     55   }
     56   return 0;
     57 }
     58 
     59 ChainedIncludesSource::~ChainedIncludesSource() {
     60   for (unsigned i = 0, e = CIs.size(); i != e; ++i)
     61     delete CIs[i];
     62 }
     63 
     64 ChainedIncludesSource *ChainedIncludesSource::create(CompilerInstance &CI) {
     65 
     66   std::vector<std::string> &includes = CI.getPreprocessorOpts().ChainedIncludes;
     67   assert(!includes.empty() && "No '-chain-include' in options!");
     68 
     69   OwningPtr<ChainedIncludesSource> source(new ChainedIncludesSource());
     70   InputKind IK = CI.getFrontendOpts().Inputs[0].getKind();
     71 
     72   SmallVector<llvm::MemoryBuffer *, 4> serialBufs;
     73   SmallVector<std::string, 4> serialBufNames;
     74 
     75   for (unsigned i = 0, e = includes.size(); i != e; ++i) {
     76     bool firstInclude = (i == 0);
     77     OwningPtr<CompilerInvocation> CInvok;
     78     CInvok.reset(new CompilerInvocation(CI.getInvocation()));
     79 
     80     CInvok->getPreprocessorOpts().ChainedIncludes.clear();
     81     CInvok->getPreprocessorOpts().ImplicitPCHInclude.clear();
     82     CInvok->getPreprocessorOpts().ImplicitPTHInclude.clear();
     83     CInvok->getPreprocessorOpts().DisablePCHValidation = true;
     84     CInvok->getPreprocessorOpts().Includes.clear();
     85     CInvok->getPreprocessorOpts().MacroIncludes.clear();
     86     CInvok->getPreprocessorOpts().Macros.clear();
     87 
     88     CInvok->getFrontendOpts().Inputs.clear();
     89     FrontendInputFile InputFile(includes[i], IK);
     90     CInvok->getFrontendOpts().Inputs.push_back(InputFile);
     91 
     92     TextDiagnosticPrinter *DiagClient =
     93       new TextDiagnosticPrinter(llvm::errs(), new DiagnosticOptions());
     94     IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
     95     IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
     96         new DiagnosticsEngine(DiagID, &CI.getDiagnosticOpts(), DiagClient));
     97 
     98     OwningPtr<CompilerInstance> Clang(new CompilerInstance());
     99     Clang->setInvocation(CInvok.take());
    100     Clang->setDiagnostics(Diags.getPtr());
    101     Clang->setTarget(TargetInfo::CreateTargetInfo(Clang->getDiagnostics(),
    102                                                   &Clang->getTargetOpts()));
    103     Clang->createFileManager();
    104     Clang->createSourceManager(Clang->getFileManager());
    105     Clang->createPreprocessor();
    106     Clang->getDiagnosticClient().BeginSourceFile(Clang->getLangOpts(),
    107                                                  &Clang->getPreprocessor());
    108     Clang->createASTContext();
    109 
    110     SmallVector<char, 256> serialAST;
    111     llvm::raw_svector_ostream OS(serialAST);
    112     OwningPtr<ASTConsumer> consumer;
    113     consumer.reset(new PCHGenerator(Clang->getPreprocessor(), "-", 0,
    114                                     /*isysroot=*/"", &OS));
    115     Clang->getPreprocessor().setPPMutationListener(
    116                                             consumer->GetPPMutationListener());
    117     Clang->getASTContext().setASTMutationListener(
    118                                             consumer->GetASTMutationListener());
    119     Clang->setASTConsumer(consumer.take());
    120     Clang->createSema(TU_Prefix, 0);
    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       OwningPtr<ExternalASTSource> Reader;
    142 
    143       Reader.reset(createASTReader(*Clang, pchName, bufs, serialBufNames,
    144         Clang->getASTConsumer().GetASTDeserializationListener()));
    145       if (!Reader)
    146         return 0;
    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 
    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