Coverage Report

Created: 2021-09-21 08:58

/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
24.4M
          : Self(Self), EmitDeferred(EmitDeferred) {
50
24.4M
        ++Self.HandlingTopLevelDecls;
51
24.4M
      }
52
24.4M
      ~HandlingTopLevelDeclRAII() {
53
24.4M
        unsigned Level = --Self.HandlingTopLevelDecls;
54
24.4M
        if (Level == 0 && 
EmitDeferred24.4M
)
55
21.4M
          Self.EmitDeferredDecls();
56
24.4M
      }
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
46.8k
                                            const CodeGenOptions &CGO) {
70
46.8k
      if (ModuleName == "-" && 
!CGO.MainFileName.empty()287
)
71
86
        return CGO.MainFileName;
72
46.7k
      return ModuleName;
73
46.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
46.8k
          M(new llvm::Module(ExpandModuleName(ModuleName, CGO), C)) {
85
46.8k
      C.setDiscardValueNames(CGO.DiscardValueNames);
86
46.8k
    }
87
88
46.7k
    ~CodeGeneratorImpl() override {
89
      // There should normally not be any leftover inline method definitions.
90
46.7k
      assert(DeferredInlineMemberFuncDefs.empty() ||
91
46.7k
             Diags.hasErrorOccurred());
92
46.7k
    }
93
94
24
    CodeGenModule &CGM() {
95
24
      return *Builder;
96
24
    }
97
98
80.1k
    llvm::Module *GetModule() {
99
80.1k
      return M.get();
100
80.1k
    }
101
102
1.37k
    CGDebugInfo *getCGDebugInfo() {
103
1.37k
      return Builder->getModuleDebugInfo();
104
1.37k
    }
105
106
36.6k
    llvm::Module *ReleaseModule() {
107
36.6k
      return M.release();
108
36.6k
    }
109
110
70
    const Decl *GetDeclForMangledName(StringRef MangledName) {
111
70
      GlobalDecl Result;
112
70
      if (!Builder->lookupRepresentativeDecl(MangledName, Result))
113
1
        return nullptr;
114
69
      const Decl *D = Result.getCanonicalDecl().getDecl();
115
69
      if (auto FD = dyn_cast<FunctionDecl>(D)) {
116
67
        if (FD->hasBody(FD))
117
31
          return FD;
118
67
      } else 
if (auto 2
TD2
= dyn_cast<TagDecl>(D)) {
119
0
        if (auto Def = TD->getDefinition())
120
0
          return Def;
121
0
      }
122
38
      return D;
123
69
    }
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
26
                              llvm::LLVMContext &C) {
131
26
      assert(!M && "Replacing existing Module?");
132
0
      M.reset(new llvm::Module(ExpandModuleName(ModuleName, CodeGenOpts), C));
133
26
      Initialize(*Ctx);
134
26
      return M.get();
135
26
    }
136
137
46.6k
    void Initialize(ASTContext &Context) override {
138
46.6k
      Ctx = &Context;
139
140
46.6k
      M->setTargetTriple(Ctx->getTargetInfo().getTriple().getTriple());
141
46.6k
      M->setDataLayout(Ctx->getTargetInfo().getDataLayoutString());
142
46.6k
      const auto &SDKVersion = Ctx->getTargetInfo().getSDKVersion();
143
46.6k
      if (!SDKVersion.empty())
144
3.53k
        M->setSDKVersion(SDKVersion);
145
46.6k
      Builder.reset(new CodeGen::CodeGenModule(Context, HeaderSearchOpts,
146
46.6k
                                               PreprocessorOpts, CodeGenOpts,
147
46.6k
                                               *M, Diags, CoverageInfo));
148
149
46.6k
      for (auto &&Lib : CodeGenOpts.DependentLibraries)
150
52
        Builder->AddDependentLib(Lib);
151
46.6k
      for (auto &&Opt : CodeGenOpts.LinkerOptions)
152
1
        Builder->AppendLinkerOptions(Opt);
153
46.6k
    }
154
155
566k
    void HandleCXXStaticMemberVarInstantiation(VarDecl *VD) override {
156
566k
      if (Diags.hasErrorOccurred())
157
47
        return;
158
159
565k
      Builder->HandleCXXStaticMemberVarInstantiation(VD);
160
565k
    }
161
162
21.4M
    bool HandleTopLevelDecl(DeclGroupRef DG) override {
163
21.4M
      if (Diags.hasErrorOccurred())
164
15.7k
        return true;
165
166
21.4M
      HandlingTopLevelDeclRAII HandlingDecl(*this);
167
168
      // Make sure to emit all elements of a Decl.
169
43.3M
      for (DeclGroupRef::iterator I = DG.begin(), E = DG.end(); I != E; 
++I21.9M
)
170
21.9M
        Builder->EmitTopLevelDecl(*I);
171
172
21.4M
      return true;
173
21.4M
    }
174
175
21.4M
    void EmitDeferredDecls() {
176
21.4M
      if (DeferredInlineMemberFuncDefs.empty())
177
21.4M
        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
33.4k
      HandlingTopLevelDeclRAII HandlingDecl(*this);
183
476k
      for (unsigned I = 0; I != DeferredInlineMemberFuncDefs.size(); 
++I442k
)
184
442k
        Builder->EmitTopLevelDecl(DeferredInlineMemberFuncDefs[I]);
185
33.4k
      DeferredInlineMemberFuncDefs.clear();
186
33.4k
    }
187
188
444k
    void HandleInlineFunctionDefinition(FunctionDecl *D) override {
189
444k
      if (Diags.hasErrorOccurred())
190
1.29k
        return;
191
192
442k
      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
0
      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
442k
      if (!D->getLexicalDeclContext()->isDependentContext())
208
101k
        Builder->AddDeferredUnusedCoverageMapping(D);
209
442k
    }
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.06M
    void HandleTagDeclDefinition(TagDecl *D) override {
216
2.06M
      if (Diags.hasErrorOccurred())
217
1.40k
        return;
218
219
      // Don't allow re-entrant calls to CodeGen triggered by PCH
220
      // deserialization to emit deferred decls.
221
2.06M
      HandlingTopLevelDeclRAII HandlingDecl(*this, /*EmitDeferred=*/false);
222
223
2.06M
      Builder->UpdateCompletedType(D);
224
225
      // For MSVC compatibility, treat declarations of static data members with
226
      // inline initializers as definitions.
227
2.06M
      if (Ctx->getTargetInfo().getCXXABI().isMicrosoft()) {
228
24.4k
        for (Decl *Member : D->decls()) {
229
24.4k
          if (VarDecl *VD = dyn_cast<VarDecl>(Member)) {
230
330
            if (Ctx->isMSStaticDataMemberInlineDefinition(VD) &&
231
330
                
Ctx->DeclMustBeEmitted(VD)83
) {
232
38
              Builder->EmitGlobal(VD);
233
38
            }
234
330
          }
235
24.4k
        }
236
6.17k
      }
237
      // For OpenMP emit declare reduction functions, if required.
238
2.06M
      if (Ctx->getLangOpts().OpenMP) {
239
32.7k
        for (Decl *Member : D->decls()) {
240
32.7k
          if (auto *DRD = dyn_cast<OMPDeclareReductionDecl>(Member)) {
241
16
            if (Ctx->DeclMustBeEmitted(DRD))
242
10
              Builder->EmitGlobal(DRD);
243
32.6k
          } else if (auto *DMD = dyn_cast<OMPDeclareMapperDecl>(Member)) {
244
0
            if (Ctx->DeclMustBeEmitted(DMD))
245
0
              Builder->EmitGlobal(DMD);
246
0
          }
247
32.7k
        }
248
6.62k
      }
249
2.06M
    }
250
251
961k
    void HandleTagDeclRequiredDefinition(const TagDecl *D) override {
252
961k
      if (Diags.hasErrorOccurred())
253
1.58k
        return;
254
255
      // Don't allow re-entrant calls to CodeGen triggered by PCH
256
      // deserialization to emit deferred decls.
257
960k
      HandlingTopLevelDeclRAII HandlingDecl(*this, /*EmitDeferred=*/false);
258
259
960k
      if (CodeGen::CGDebugInfo *DI = Builder->getModuleDebugInfo())
260
905k
        if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
261
896k
          DI->completeRequiredType(RD);
262
960k
    }
263
264
46.6k
    void HandleTranslationUnit(ASTContext &Ctx) override {
265
      // Release the Builder when there is no error.
266
46.6k
      if (!Diags.hasErrorOccurred() && 
Builder36.5k
)
267
36.5k
        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
46.6k
      if (Diags.hasErrorOccurred()) {
272
10.0k
        if (Builder)
273
10.0k
          Builder->clear();
274
10.0k
        M.reset();
275
10.0k
        return;
276
10.0k
      }
277
46.6k
    }
278
279
494
    void AssignInheritanceModel(CXXRecordDecl *RD) override {
280
494
      if (Diags.hasErrorOccurred())
281
18
        return;
282
283
476
      Builder->RefreshTypeCacheForClass(RD);
284
476
    }
285
286
5.26k
    void CompleteTentativeDefinition(VarDecl *D) override {
287
5.26k
      if (Diags.hasErrorOccurred())
288
172
        return;
289
290
5.09k
      Builder->EmitTentativeDefinition(D);
291
5.09k
    }
292
293
7
    void CompleteExternalDeclaration(VarDecl *D) override {
294
7
      Builder->EmitExternalDeclaration(D);
295
7
    }
296
297
797
    void HandleVTable(CXXRecordDecl *RD) override {
298
797
      if (Diags.hasErrorOccurred())
299
0
        return;
300
301
797
      Builder->EmitVTable(RD);
302
797
    }
303
  };
304
}
305
306
0
void CodeGenerator::anchor() { }
307
308
24
CodeGenModule &CodeGenerator::CGM() {
309
24
  return static_cast<CodeGeneratorImpl*>(this)->CGM();
310
24
}
311
312
80.1k
llvm::Module *CodeGenerator::GetModule() {
313
80.1k
  return static_cast<CodeGeneratorImpl*>(this)->GetModule();
314
80.1k
}
315
316
36.6k
llvm::Module *CodeGenerator::ReleaseModule() {
317
36.6k
  return static_cast<CodeGeneratorImpl*>(this)->ReleaseModule();
318
36.6k
}
319
320
1.37k
CGDebugInfo *CodeGenerator::getCGDebugInfo() {
321
1.37k
  return static_cast<CodeGeneratorImpl*>(this)->getCGDebugInfo();
322
1.37k
}
323
324
70
const Decl *CodeGenerator::GetDeclForMangledName(llvm::StringRef name) {
325
70
  return static_cast<CodeGeneratorImpl*>(this)->GetDeclForMangledName(name);
326
70
}
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
26
                                         llvm::LLVMContext &C) {
336
26
  return static_cast<CodeGeneratorImpl*>(this)->StartModule(ModuleName, C);
337
26
}
338
339
CodeGenerator *clang::CreateLLVMCodeGen(
340
    DiagnosticsEngine &Diags, llvm::StringRef ModuleName,
341
    const HeaderSearchOptions &HeaderSearchOpts,
342
    const PreprocessorOptions &PreprocessorOpts, const CodeGenOptions &CGO,
343
46.8k
    llvm::LLVMContext &C, CoverageSourceInfo *CoverageInfo) {
344
46.8k
  return new CodeGeneratorImpl(Diags, ModuleName, HeaderSearchOpts,
345
46.8k
                               PreprocessorOpts, CGO, C, CoverageInfo);
346
46.8k
}