1 //===--- ObjectFilePCHContainerOperations.cpp -----------------------------===//
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 #include "clang/CodeGen/ObjectFilePCHContainerOperations.h"
11 #include "CGDebugInfo.h"
12 #include "CodeGenModule.h"
13 #include "clang/AST/ASTContext.h"
14 #include "clang/AST/DeclObjC.h"
15 #include "clang/AST/Expr.h"
16 #include "clang/AST/RecursiveASTVisitor.h"
17 #include "clang/Basic/Diagnostic.h"
18 #include "clang/Basic/TargetInfo.h"
19 #include "clang/CodeGen/BackendUtil.h"
20 #include "clang/Frontend/CodeGenOptions.h"
21 #include "clang/Frontend/CompilerInstance.h"
22 #include "clang/Lex/HeaderSearch.h"
23 #include "clang/Lex/Preprocessor.h"
24 #include "clang/Serialization/ASTWriter.h"
25 #include "llvm/ADT/StringRef.h"
26 #include "llvm/Bitcode/BitstreamReader.h"
27 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
28 #include "llvm/IR/Constants.h"
29 #include "llvm/IR/DataLayout.h"
30 #include "llvm/IR/LLVMContext.h"
31 #include "llvm/IR/Module.h"
32 #include "llvm/Object/COFF.h"
33 #include "llvm/Object/ObjectFile.h"
34 #include "llvm/Support/Path.h"
35 #include "llvm/Support/TargetRegistry.h"
36 #include <memory>
37 #include <utility>
38 
39 using namespace clang;
40 
41 #define DEBUG_TYPE "pchcontainer"
42 
43 namespace {
44 class PCHContainerGenerator : public ASTConsumer {
45   DiagnosticsEngine &Diags;
46   const std::string MainFileName;
47   const std::string OutputFileName;
48   ASTContext *Ctx;
49   ModuleMap &MMap;
50   const HeaderSearchOptions &HeaderSearchOpts;
51   const PreprocessorOptions &PreprocessorOpts;
52   CodeGenOptions CodeGenOpts;
53   const TargetOptions TargetOpts;
54   const LangOptions LangOpts;
55   std::unique_ptr<llvm::LLVMContext> VMContext;
56   std::unique_ptr<llvm::Module> M;
57   std::unique_ptr<CodeGen::CodeGenModule> Builder;
58   std::unique_ptr<raw_pwrite_stream> OS;
59   std::shared_ptr<PCHBuffer> Buffer;
60 
61   /// Visit every type and emit debug info for it.
62   struct DebugTypeVisitor : public RecursiveASTVisitor<DebugTypeVisitor> {
63     clang::CodeGen::CGDebugInfo &DI;
64     ASTContext &Ctx;
65     DebugTypeVisitor(clang::CodeGen::CGDebugInfo &DI, ASTContext &Ctx)
66         : DI(DI), Ctx(Ctx) {}
67 
68     /// Determine whether this type can be represented in DWARF.
69     static bool CanRepresent(const Type *Ty) {
70       return !Ty->isDependentType() && !Ty->isUndeducedType();
71     }
72 
73     bool VisitImportDecl(ImportDecl *D) {
74       auto *Import = cast<ImportDecl>(D);
75       if (!Import->getImportedOwningModule())
76         DI.EmitImportDecl(*Import);
77       return true;
78     }
79 
80     bool VisitTypeDecl(TypeDecl *D) {
81       // TagDecls may be deferred until after all decls have been merged and we
82       // know the complete type. Pure forward declarations will be skipped, but
83       // they don't need to be emitted into the module anyway.
84       if (auto *TD = dyn_cast<TagDecl>(D))
85         if (!TD->isCompleteDefinition())
86           return true;
87 
88       QualType QualTy = Ctx.getTypeDeclType(D);
89       if (!QualTy.isNull() && CanRepresent(QualTy.getTypePtr()))
90         DI.getOrCreateStandaloneType(QualTy, D->getLocation());
91       return true;
92     }
93 
94     bool VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
95       QualType QualTy(D->getTypeForDecl(), 0);
96       if (!QualTy.isNull() && CanRepresent(QualTy.getTypePtr()))
97         DI.getOrCreateStandaloneType(QualTy, D->getLocation());
98       return true;
99     }
100 
101     bool VisitFunctionDecl(FunctionDecl *D) {
102       if (isa<CXXMethodDecl>(D))
103         // This is not yet supported. Constructing the `this' argument
104         // mandates a CodeGenFunction.
105         return true;
106 
107       SmallVector<QualType, 16> ArgTypes;
108       for (auto i : D->parameters())
109         ArgTypes.push_back(i->getType());
110       QualType RetTy = D->getReturnType();
111       QualType FnTy = Ctx.getFunctionType(RetTy, ArgTypes,
112                                           FunctionProtoType::ExtProtoInfo());
113       if (CanRepresent(FnTy.getTypePtr()))
114         DI.EmitFunctionDecl(D, D->getLocation(), FnTy);
115       return true;
116     }
117 
118     bool VisitObjCMethodDecl(ObjCMethodDecl *D) {
119       if (!D->getClassInterface())
120         return true;
121 
122       bool selfIsPseudoStrong, selfIsConsumed;
123       SmallVector<QualType, 16> ArgTypes;
124       ArgTypes.push_back(D->getSelfType(Ctx, D->getClassInterface(),
125                                         selfIsPseudoStrong, selfIsConsumed));
126       ArgTypes.push_back(Ctx.getObjCSelType());
127       for (auto i : D->parameters())
128         ArgTypes.push_back(i->getType());
129       QualType RetTy = D->getReturnType();
130       QualType FnTy = Ctx.getFunctionType(RetTy, ArgTypes,
131                                           FunctionProtoType::ExtProtoInfo());
132       if (CanRepresent(FnTy.getTypePtr()))
133         DI.EmitFunctionDecl(D, D->getLocation(), FnTy);
134       return true;
135     }
136   };
137 
138 public:
139   PCHContainerGenerator(CompilerInstance &CI, const std::string &MainFileName,
140                         const std::string &OutputFileName,
141                         std::unique_ptr<raw_pwrite_stream> OS,
142                         std::shared_ptr<PCHBuffer> Buffer)
143       : Diags(CI.getDiagnostics()), MainFileName(MainFileName),
144         OutputFileName(OutputFileName), Ctx(nullptr),
145         MMap(CI.getPreprocessor().getHeaderSearchInfo().getModuleMap()),
146         HeaderSearchOpts(CI.getHeaderSearchOpts()),
147         PreprocessorOpts(CI.getPreprocessorOpts()),
148         TargetOpts(CI.getTargetOpts()), LangOpts(CI.getLangOpts()),
149         OS(std::move(OS)), Buffer(std::move(Buffer)) {
150     // The debug info output isn't affected by CodeModel and
151     // ThreadModel, but the backend expects them to be nonempty.
152     CodeGenOpts.CodeModel = "default";
153     CodeGenOpts.ThreadModel = "single";
154     CodeGenOpts.DebugTypeExtRefs = true;
155     // When building a module MainFileName is the name of the modulemap file.
156     CodeGenOpts.MainFileName =
157         LangOpts.CurrentModule.empty() ? MainFileName : LangOpts.CurrentModule;
158     CodeGenOpts.setDebugInfo(codegenoptions::FullDebugInfo);
159     CodeGenOpts.setDebuggerTuning(CI.getCodeGenOpts().getDebuggerTuning());
160   }
161 
162   ~PCHContainerGenerator() override = default;
163 
164   void Initialize(ASTContext &Context) override {
165     assert(!Ctx && "initialized multiple times");
166 
167     Ctx = &Context;
168     VMContext.reset(new llvm::LLVMContext());
169     M.reset(new llvm::Module(MainFileName, *VMContext));
170     M->setDataLayout(Ctx->getTargetInfo().getDataLayout());
171     Builder.reset(new CodeGen::CodeGenModule(
172         *Ctx, HeaderSearchOpts, PreprocessorOpts, CodeGenOpts, *M, Diags));
173 
174     // Prepare CGDebugInfo to emit debug info for a clang module.
175     auto *DI = Builder->getModuleDebugInfo();
176     StringRef ModuleName = llvm::sys::path::filename(MainFileName);
177     DI->setPCHDescriptor({ModuleName, "", OutputFileName,
178                           ASTFileSignature{{{~0U, ~0U, ~0U, ~0U, ~1U}}}});
179     DI->setModuleMap(MMap);
180   }
181 
182   bool HandleTopLevelDecl(DeclGroupRef D) override {
183     if (Diags.hasErrorOccurred())
184       return true;
185 
186     // Collect debug info for all decls in this group.
187     for (auto *I : D)
188       if (!I->isFromASTFile()) {
189         DebugTypeVisitor DTV(*Builder->getModuleDebugInfo(), *Ctx);
190         DTV.TraverseDecl(I);
191       }
192     return true;
193   }
194 
195   void HandleTopLevelDeclInObjCContainer(DeclGroupRef D) override {
196     HandleTopLevelDecl(D);
197   }
198 
199   void HandleTagDeclDefinition(TagDecl *D) override {
200     if (Diags.hasErrorOccurred())
201       return;
202 
203     if (D->isFromASTFile())
204       return;
205 
206     // Anonymous tag decls are deferred until we are building their declcontext.
207     if (D->getName().empty())
208       return;
209 
210     // Defer tag decls until their declcontext is complete.
211     auto *DeclCtx = D->getDeclContext();
212     while (DeclCtx) {
213       if (auto *D = dyn_cast<TagDecl>(DeclCtx))
214         if (!D->isCompleteDefinition())
215           return;
216       DeclCtx = DeclCtx->getParent();
217     }
218 
219     DebugTypeVisitor DTV(*Builder->getModuleDebugInfo(), *Ctx);
220     DTV.TraverseDecl(D);
221     Builder->UpdateCompletedType(D);
222   }
223 
224   void HandleTagDeclRequiredDefinition(const TagDecl *D) override {
225     if (Diags.hasErrorOccurred())
226       return;
227 
228     if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
229       Builder->getModuleDebugInfo()->completeRequiredType(RD);
230   }
231 
232   void HandleImplicitImportDecl(ImportDecl *D) override {
233     if (!D->getImportedOwningModule())
234       Builder->getModuleDebugInfo()->EmitImportDecl(*D);
235   }
236 
237   /// Emit a container holding the serialized AST.
238   void HandleTranslationUnit(ASTContext &Ctx) override {
239     assert(M && VMContext && Builder);
240     // Delete these on function exit.
241     std::unique_ptr<llvm::LLVMContext> VMContext = std::move(this->VMContext);
242     std::unique_ptr<llvm::Module> M = std::move(this->M);
243     std::unique_ptr<CodeGen::CodeGenModule> Builder = std::move(this->Builder);
244 
245     if (Diags.hasErrorOccurred())
246       return;
247 
248     M->setTargetTriple(Ctx.getTargetInfo().getTriple().getTriple());
249     M->setDataLayout(Ctx.getTargetInfo().getDataLayout());
250 
251     // PCH files don't have a signature field in the control block,
252     // but LLVM detects DWO CUs by looking for a non-zero DWO id.
253     // We use the lower 64 bits for debug info.
254     uint64_t Signature =
255         Buffer->Signature
256             ? (uint64_t)Buffer->Signature[1] << 32 | Buffer->Signature[0]
257             : ~1ULL;
258     Builder->getModuleDebugInfo()->setDwoId(Signature);
259 
260     // Finalize the Builder.
261     if (Builder)
262       Builder->Release();
263 
264     // Ensure the target exists.
265     std::string Error;
266     auto Triple = Ctx.getTargetInfo().getTriple();
267     if (!llvm::TargetRegistry::lookupTarget(Triple.getTriple(), Error))
268       llvm::report_fatal_error(Error);
269 
270     // Emit the serialized Clang AST into its own section.
271     assert(Buffer->IsComplete && "serialization did not complete");
272     auto &SerializedAST = Buffer->Data;
273     auto Size = SerializedAST.size();
274     auto Int8Ty = llvm::Type::getInt8Ty(*VMContext);
275     auto *Ty = llvm::ArrayType::get(Int8Ty, Size);
276     auto *Data = llvm::ConstantDataArray::getString(
277         *VMContext, StringRef(SerializedAST.data(), Size),
278         /*AddNull=*/false);
279     auto *ASTSym = new llvm::GlobalVariable(
280         *M, Ty, /*constant*/ true, llvm::GlobalVariable::InternalLinkage, Data,
281         "__clang_ast");
282     // The on-disk hashtable needs to be aligned.
283     ASTSym->setAlignment(8);
284 
285     // Mach-O also needs a segment name.
286     if (Triple.isOSBinFormatMachO())
287       ASTSym->setSection("__CLANG,__clangast");
288     // COFF has an eight character length limit.
289     else if (Triple.isOSBinFormatCOFF())
290       ASTSym->setSection("clangast");
291     else
292       ASTSym->setSection("__clangast");
293 
294     DEBUG({
295       // Print the IR for the PCH container to the debug output.
296       llvm::SmallString<0> Buffer;
297       clang::EmitBackendOutput(
298           Diags, HeaderSearchOpts, CodeGenOpts, TargetOpts, LangOpts,
299           Ctx.getTargetInfo().getDataLayout(), M.get(),
300           BackendAction::Backend_EmitLL,
301           llvm::make_unique<llvm::raw_svector_ostream>(Buffer));
302       llvm::dbgs() << Buffer;
303     });
304 
305     // Use the LLVM backend to emit the pch container.
306     clang::EmitBackendOutput(Diags, HeaderSearchOpts, CodeGenOpts, TargetOpts,
307                              LangOpts, Ctx.getTargetInfo().getDataLayout(),
308                              M.get(), BackendAction::Backend_EmitObj,
309                              std::move(OS));
310 
311     // Free the memory for the temporary buffer.
312     llvm::SmallVector<char, 0> Empty;
313     SerializedAST = std::move(Empty);
314   }
315 };
316 
317 } // anonymous namespace
318 
319 std::unique_ptr<ASTConsumer>
320 ObjectFilePCHContainerWriter::CreatePCHContainerGenerator(
321     CompilerInstance &CI, const std::string &MainFileName,
322     const std::string &OutputFileName,
323     std::unique_ptr<llvm::raw_pwrite_stream> OS,
324     std::shared_ptr<PCHBuffer> Buffer) const {
325   return llvm::make_unique<PCHContainerGenerator>(
326       CI, MainFileName, OutputFileName, std::move(OS), Buffer);
327 }
328 
329 StringRef
330 ObjectFilePCHContainerReader::ExtractPCH(llvm::MemoryBufferRef Buffer) const {
331   StringRef PCH;
332   auto OFOrErr = llvm::object::ObjectFile::createObjectFile(Buffer);
333   if (OFOrErr) {
334     auto &OF = OFOrErr.get();
335     bool IsCOFF = isa<llvm::object::COFFObjectFile>(*OF);
336     // Find the clang AST section in the container.
337     for (auto &Section : OF->sections()) {
338       StringRef Name;
339       Section.getName(Name);
340       if ((!IsCOFF && Name == "__clangast") || (IsCOFF && Name == "clangast")) {
341         Section.getContents(PCH);
342         return PCH;
343       }
344     }
345   }
346   handleAllErrors(OFOrErr.takeError(), [&](const llvm::ErrorInfoBase &EIB) {
347     if (EIB.convertToErrorCode() ==
348         llvm::object::object_error::invalid_file_type)
349       // As a fallback, treat the buffer as a raw AST.
350       PCH = Buffer.getBuffer();
351     else
352       EIB.log(llvm::errs());
353   });
354   return PCH;
355 }
356