Coverage Report

Created: 2021-08-24 07:12

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