Coverage Report

Created: 2020-11-24 06:42

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/CodeGen/ModuleBuilder.cpp
Line
Count
Source (jump to first uncovered line)
1
//===--- ModuleBuilder.cpp - Emit LLVM Code from ASTs ---------------------===//
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
// This builds an AST and converts it to LLVM Code.
10
//
11
//===----------------------------------------------------------------------===//
12
13
#include "clang/CodeGen/ModuleBuilder.h"
14
#include "CGDebugInfo.h"
15
#include "CodeGenModule.h"
16
#include "clang/AST/ASTContext.h"
17
#include "clang/AST/DeclObjC.h"
18
#include "clang/AST/Expr.h"
19
#include "clang/Basic/CodeGenOptions.h"
20
#include "clang/Basic/Diagnostic.h"
21
#include "clang/Basic/TargetInfo.h"
22
#include "llvm/ADT/StringRef.h"
23
#include "llvm/IR/DataLayout.h"
24
#include "llvm/IR/LLVMContext.h"
25
#include "llvm/IR/Module.h"
26
#include <memory>
27
28
using namespace clang;
29
using namespace CodeGen;
30
31
namespace {
32
  class CodeGeneratorImpl : public CodeGenerator {
33
    DiagnosticsEngine &Diags;
34
    ASTContext *Ctx;
35
    const HeaderSearchOptions &HeaderSearchOpts; // Only used for debug info.
36
    const PreprocessorOptions &PreprocessorOpts; // Only used for debug info.
37
    const CodeGenOptions CodeGenOpts;  // Intentionally copied in.
38
39
    unsigned HandlingTopLevelDecls;
40
41
    /// Use this when emitting decls to block re-entrant decl emission. It will
42
    /// emit all deferred decls on scope exit. Set EmitDeferred to false if decl
43
    /// emission must be deferred longer, like at the end of a tag definition.
44
    struct HandlingTopLevelDeclRAII {
45
      CodeGeneratorImpl &Self;
46
      bool EmitDeferred;
47
      HandlingTopLevelDeclRAII(CodeGeneratorImpl &Self,
48
                               bool EmitDeferred = true)
49
16.6M
          : Self(Self), EmitDeferred(EmitDeferred) {
50
16.6M
        ++Self.HandlingTopLevelDecls;
51
16.6M
      }
52
16.6M
      ~HandlingTopLevelDeclRAII() {
53
16.6M
        unsigned Level = --Self.HandlingTopLevelDecls;
54
16.6M
        if (Level == 0 && 
EmitDeferred16.6M
)
55
13.3M
          Self.EmitDeferredDecls();
56
16.6M
      }
57
    };
58
59
    CoverageSourceInfo *CoverageInfo;
60
61
  protected:
62
    std::unique_ptr<llvm::Module> M;
63
    std::unique_ptr<CodeGen::CodeGenModule> Builder;
64
65
  private:
66
    SmallVector<FunctionDecl *, 8> DeferredInlineMemberFuncDefs;
67
68
    static llvm::StringRef ExpandModuleName(llvm::StringRef ModuleName,
69
30.9k
                                            const CodeGenOptions &CGO) {
70
30.9k
      if (ModuleName == "-" && 
!CGO.MainFileName.empty()287
)
71
104
        return CGO.MainFileName;
72
30.8k
      return ModuleName;
73
30.8k
    }
74
75
  public:
76
    CodeGeneratorImpl(DiagnosticsEngine &diags, llvm::StringRef ModuleName,
77
                      const HeaderSearchOptions &HSO,
78
                      const PreprocessorOptions &PPO, const CodeGenOptions &CGO,
79
                      llvm::LLVMContext &C,
80
                      CoverageSourceInfo *CoverageInfo = nullptr)
81
        : Diags(diags), Ctx(nullptr), HeaderSearchOpts(HSO),
82
          PreprocessorOpts(PPO), CodeGenOpts(CGO), HandlingTopLevelDecls(0),
83
          CoverageInfo(CoverageInfo),
84
30.9k
          M(new llvm::Module(ExpandModuleName(ModuleName, CGO), C)) {
85
30.9k
      C.setDiscardValueNames(CGO.DiscardValueNames);
86
30.9k
    }
87
88
30.8k
    ~CodeGeneratorImpl() override {
89
      // There should normally not be any leftover inline method definitions.
90
30.8k
      assert(DeferredInlineMemberFuncDefs.empty() ||
91
30.8k
             Diags.hasErrorOccurred());
92
30.8k
    }
93
94
23
    CodeGenModule &CGM() {
95
23
      return *Builder;
96
23
    }
97
98
69.9k
    llvm::Module *GetModule() {
99
69.9k
      return M.get();
100
69.9k
    }
101
102
1.36k
    CGDebugInfo *getCGDebugInfo() {
103
1.36k
      return Builder->getModuleDebugInfo();
104
1.36k
    }
105
106
29.4k
    llvm::Module *ReleaseModule() {
107
29.4k
      return M.release();
108
29.4k
    }
109
110
48
    const Decl *GetDeclForMangledName(StringRef MangledName) {
111
48
      GlobalDecl Result;
112
48
      if (!Builder->lookupRepresentativeDecl(MangledName, Result))
113
17
        return nullptr;
114
31
      const Decl *D = Result.getCanonicalDecl().getDecl();
115
31
      if (auto FD = dyn_cast<FunctionDecl>(D)) {
116
29
        if (FD->hasBody(FD))
117
29
          return FD;
118
2
      } else if (auto TD = dyn_cast<TagDecl>(D)) {
119
0
        if (auto Def = TD->getDefinition())
120
0
          return Def;
121
2
      }
122
2
      return D;
123
2
    }
124
125
1
    llvm::Constant *GetAddrOfGlobal(GlobalDecl global, bool isForDefinition) {
126
1
      return Builder->GetAddrOfGlobal(global, ForDefinition_t(isForDefinition));
127
1
    }
128
129
    llvm::Module *StartModule(llvm::StringRef ModuleName,
130
3
                              llvm::LLVMContext &C) {
131
3
      assert(!M && "Replacing existing Module?");
132
3
      M.reset(new llvm::Module(ExpandModuleName(ModuleName, CodeGenOpts), C));
133
3
      Initialize(*Ctx);
134
3
      return M.get();
135
3
    }
136
137
30.7k
    void Initialize(ASTContext &Context) override {
138
30.7k
      Ctx = &Context;
139
140
30.7k
      M->setTargetTriple(Ctx->getTargetInfo().getTriple().getTriple());
141
30.7k
      M->setDataLayout(Ctx->getTargetInfo().getDataLayout());
142
30.7k
      const auto &SDKVersion = Ctx->getTargetInfo().getSDKVersion();
143
30.7k
      if (!SDKVersion.empty())
144
3.31k
        M->setSDKVersion(SDKVersion);
145
30.7k
      Builder.reset(new CodeGen::CodeGenModule(Context, HeaderSearchOpts,
146
30.7k
                                               PreprocessorOpts, CodeGenOpts,
147
30.7k
                                               *M, Diags, CoverageInfo));
148
149
30.7k
      for (auto &&Lib : CodeGenOpts.DependentLibraries)
150
54
        Builder->AddDependentLib(Lib);
151
30.7k
      for (auto &&Opt : CodeGenOpts.LinkerOptions)
152
1
        Builder->AppendLinkerOptions(Opt);
153
30.7k
    }
154
155
542k
    void HandleCXXStaticMemberVarInstantiation(VarDecl *VD) override {
156
542k
      if (Diags.hasErrorOccurred())
157
47
        return;
158
159
542k
      Builder->HandleCXXStaticMemberVarInstantiation(VD);
160
542k
    }
161
162
13.3M
    bool HandleTopLevelDecl(DeclGroupRef DG) override {
163
13.3M
      if (Diags.hasErrorOccurred())
164
6.61k
        return true;
165
166
13.3M
      HandlingTopLevelDeclRAII HandlingDecl(*this);
167
168
      // Make sure to emit all elements of a Decl.
169
27.4M
      for (DeclGroupRef::iterator I = DG.begin(), E = DG.end(); I != E; 
++I14.0M
)
170
14.0M
        Builder->EmitTopLevelDecl(*I);
171
172
13.3M
      return true;
173
13.3M
    }
174
175
13.3M
    void EmitDeferredDecls() {
176
13.3M
      if (DeferredInlineMemberFuncDefs.empty())
177
13.3M
        return;
178
179
      // Emit any deferred inline method definitions. Note that more deferred
180
      // methods may be added during this loop, since ASTConsumer callbacks
181
      // can be invoked if AST inspection results in declarations being added.
182
19.6k
      HandlingTopLevelDeclRAII HandlingDecl(*this);
183
438k
      for (unsigned I = 0; I != DeferredInlineMemberFuncDefs.size(); 
++I418k
)
184
418k
        Builder->EmitTopLevelDecl(DeferredInlineMemberFuncDefs[I]);
185
19.6k
      DeferredInlineMemberFuncDefs.clear();
186
19.6k
    }
187
188
418k
    void HandleInlineFunctionDefinition(FunctionDecl *D) override {
189
418k
      if (Diags.hasErrorOccurred())
190
426
        return;
191
192
418k
      assert(D->doesThisDeclarationHaveABody());
193
194
      // We may want to emit this definition. However, that decision might be
195
      // based on computing the linkage, and we have to defer that in case we
196
      // are inside of something that will change the method's final linkage,
197
      // e.g.
198
      //   typedef struct {
199
      //     void bar();
200
      //     void foo() { bar(); }
201
      //   } A;
202
418k
      DeferredInlineMemberFuncDefs.push_back(D);
203
204
      // Provide some coverage mapping even for methods that aren't emitted.
205
      // Don't do this for templated classes though, as they may not be
206
      // instantiable.
207
418k
      if (!D->getLexicalDeclContext()->isDependentContext())
208
98.1k
        Builder->AddDeferredUnusedCoverageMapping(D);
209
418k
    }
210
211
    /// HandleTagDeclDefinition - This callback is invoked each time a TagDecl
212
    /// to (e.g. struct, union, enum, class) is completed. This allows the
213
    /// client hack on the type, which can occur at any point in the file
214
    /// (because these can be defined in declspecs).
215
2.25M
    void HandleTagDeclDefinition(TagDecl *D) override {
216
2.25M
      if (Diags.hasErrorOccurred())
217
525
        return;
218
219
      // Don't allow re-entrant calls to CodeGen triggered by PCH
220
      // deserialization to emit deferred decls.
221
2.25M
      HandlingTopLevelDeclRAII HandlingDecl(*this, /*EmitDeferred=*/false);
222
223
2.25M
      Builder->UpdateCompletedType(D);
224
225
      // For MSVC compatibility, treat declarations of static data members with
226
      // inline initializers as definitions.
227
2.25M
      if (Ctx->getTargetInfo().getCXXABI().isMicrosoft()) {
228
24.1k
        for (Decl *Member : D->decls()) {
229
24.1k
          if (VarDecl *VD = dyn_cast<VarDecl>(Member)) {
230
322
            if (Ctx->isMSStaticDataMemberInlineDefinition(VD) &&
231
83
                Ctx->DeclMustBeEmitted(VD)) {
232
38
              Builder->EmitGlobal(VD);
233
38
            }
234
322
          }
235
24.1k
        }
236
6.04k
      }
237
      // For OpenMP emit declare reduction functions, if required.
238
2.25M
      if (Ctx->getLangOpts().OpenMP) {
239
31.6k
        for (Decl *Member : D->decls()) {
240
31.6k
          if (auto *DRD = dyn_cast<OMPDeclareReductionDecl>(Member)) {
241
16
            if (Ctx->DeclMustBeEmitted(DRD))
242
10
              Builder->EmitGlobal(DRD);
243
31.6k
          } else if (auto *DMD = dyn_cast<OMPDeclareMapperDecl>(Member)) {
244
0
            if (Ctx->DeclMustBeEmitted(DMD))
245
0
              Builder->EmitGlobal(DMD);
246
0
          }
247
31.6k
        }
248
6.34k
      }
249
2.25M
    }
250
251
1.00M
    void HandleTagDeclRequiredDefinition(const TagDecl *D) override {
252
1.00M
      if (Diags.hasErrorOccurred())
253
1.52k
        return;
254
255
      // Don't allow re-entrant calls to CodeGen triggered by PCH
256
      // deserialization to emit deferred decls.
257
1.00M
      HandlingTopLevelDeclRAII HandlingDecl(*this, /*EmitDeferred=*/false);
258
259
1.00M
      if (CodeGen::CGDebugInfo *DI = Builder->getModuleDebugInfo())
260
942k
        if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
261
931k
          DI->completeRequiredType(RD);
262
1.00M
    }
263
264
30.7k
    void HandleTranslationUnit(ASTContext &Ctx) override {
265
      // Release the Builder when there is no error.
266
30.7k
      if (!Diags.hasErrorOccurred() && 
Builder29.3k
)
267
29.3k
        Builder->Release();
268
269
      // If there are errors before or when releasing the Builder, reset
270
      // the module to stop here before invoking the backend.
271
30.7k
      if (Diags.hasErrorOccurred()) {
272
1.34k
        if (Builder)
273
1.34k
          Builder->clear();
274
1.34k
        M.reset();
275
1.34k
        return;
276
1.34k
      }
277
30.7k
    }
278
279
482
    void AssignInheritanceModel(CXXRecordDecl *RD) override {
280
482
      if (Diags.hasErrorOccurred())
281
18
        return;
282
283
464
      Builder->RefreshTypeCacheForClass(RD);
284
464
    }
285
286
4.56k
    void CompleteTentativeDefinition(VarDecl *D) override {
287
4.56k
      if (Diags.hasErrorOccurred())
288
62
        return;
289
290
4.50k
      Builder->EmitTentativeDefinition(D);
291
4.50k
    }
292
293
7
    void CompleteExternalDeclaration(VarDecl *D) override {
294
7
      Builder->EmitExternalDeclaration(D);
295
7
    }
296
297
780
    void HandleVTable(CXXRecordDecl *RD) override {
298
780
      if (Diags.hasErrorOccurred())
299
0
        return;
300
301
780
      Builder->EmitVTable(RD);
302
780
    }
303
  };
304
}
305
306
0
void CodeGenerator::anchor() { }
307
308
23
CodeGenModule &CodeGenerator::CGM() {
309
23
  return static_cast<CodeGeneratorImpl*>(this)->CGM();
310
23
}
311
312
69.9k
llvm::Module *CodeGenerator::GetModule() {
313
69.9k
  return static_cast<CodeGeneratorImpl*>(this)->GetModule();
314
69.9k
}
315
316
29.4k
llvm::Module *CodeGenerator::ReleaseModule() {
317
29.4k
  return static_cast<CodeGeneratorImpl*>(this)->ReleaseModule();
318
29.4k
}
319
320
1.36k
CGDebugInfo *CodeGenerator::getCGDebugInfo() {
321
1.36k
  return static_cast<CodeGeneratorImpl*>(this)->getCGDebugInfo();
322
1.36k
}
323
324
48
const Decl *CodeGenerator::GetDeclForMangledName(llvm::StringRef name) {
325
48
  return static_cast<CodeGeneratorImpl*>(this)->GetDeclForMangledName(name);
326
48
}
327
328
llvm::Constant *CodeGenerator::GetAddrOfGlobal(GlobalDecl global,
329
1
                                               bool isForDefinition) {
330
1
  return static_cast<CodeGeneratorImpl*>(this)
331
1
           ->GetAddrOfGlobal(global, isForDefinition);
332
1
}
333
334
llvm::Module *CodeGenerator::StartModule(llvm::StringRef ModuleName,
335
3
                                         llvm::LLVMContext &C) {
336
3
  return static_cast<CodeGeneratorImpl*>(this)->StartModule(ModuleName, C);
337
3
}
338
339
CodeGenerator *clang::CreateLLVMCodeGen(
340
    DiagnosticsEngine &Diags, llvm::StringRef ModuleName,
341
    const HeaderSearchOptions &HeaderSearchOpts,
342
    const PreprocessorOptions &PreprocessorOpts, const CodeGenOptions &CGO,
343
30.9k
    llvm::LLVMContext &C, CoverageSourceInfo *CoverageInfo) {
344
30.9k
  return new CodeGeneratorImpl(Diags, ModuleName, HeaderSearchOpts,
345
30.9k
                               PreprocessorOpts, CGO, C, CoverageInfo);
346
30.9k
}