Coverage Report

Created: 2021-09-21 08:58

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/CodeGen/CodeGenModule.h
Line
Count
Source (jump to first uncovered line)
1
//===--- CodeGenModule.h - Per-Module state for LLVM CodeGen ----*- C++ -*-===//
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 is the internal per-translation-unit state used for llvm translation.
10
//
11
//===----------------------------------------------------------------------===//
12
13
#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H
14
#define LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H
15
16
#include "CGVTables.h"
17
#include "CodeGenTypeCache.h"
18
#include "CodeGenTypes.h"
19
#include "SanitizerMetadata.h"
20
#include "clang/AST/DeclCXX.h"
21
#include "clang/AST/DeclObjC.h"
22
#include "clang/AST/DeclOpenMP.h"
23
#include "clang/AST/GlobalDecl.h"
24
#include "clang/AST/Mangle.h"
25
#include "clang/Basic/ABI.h"
26
#include "clang/Basic/LangOptions.h"
27
#include "clang/Basic/Module.h"
28
#include "clang/Basic/NoSanitizeList.h"
29
#include "clang/Basic/TargetInfo.h"
30
#include "clang/Basic/XRayLists.h"
31
#include "clang/Lex/PreprocessorOptions.h"
32
#include "llvm/ADT/DenseMap.h"
33
#include "llvm/ADT/SetVector.h"
34
#include "llvm/ADT/SmallPtrSet.h"
35
#include "llvm/ADT/StringMap.h"
36
#include "llvm/IR/Module.h"
37
#include "llvm/IR/ValueHandle.h"
38
#include "llvm/Transforms/Utils/SanitizerStats.h"
39
40
namespace llvm {
41
class Module;
42
class Constant;
43
class ConstantInt;
44
class Function;
45
class GlobalValue;
46
class DataLayout;
47
class FunctionType;
48
class LLVMContext;
49
class OpenMPIRBuilder;
50
class IndexedInstrProfReader;
51
}
52
53
namespace clang {
54
class ASTContext;
55
class AtomicType;
56
class FunctionDecl;
57
class IdentifierInfo;
58
class ObjCMethodDecl;
59
class ObjCImplementationDecl;
60
class ObjCCategoryImplDecl;
61
class ObjCProtocolDecl;
62
class ObjCEncodeExpr;
63
class BlockExpr;
64
class CharUnits;
65
class Decl;
66
class Expr;
67
class Stmt;
68
class InitListExpr;
69
class StringLiteral;
70
class NamedDecl;
71
class ValueDecl;
72
class VarDecl;
73
class LangOptions;
74
class CodeGenOptions;
75
class HeaderSearchOptions;
76
class DiagnosticsEngine;
77
class AnnotateAttr;
78
class CXXDestructorDecl;
79
class Module;
80
class CoverageSourceInfo;
81
class TargetAttr;
82
class InitSegAttr;
83
struct ParsedTargetAttr;
84
85
namespace CodeGen {
86
87
class CallArgList;
88
class CodeGenFunction;
89
class CodeGenTBAA;
90
class CGCXXABI;
91
class CGDebugInfo;
92
class CGObjCRuntime;
93
class CGOpenCLRuntime;
94
class CGOpenMPRuntime;
95
class CGCUDARuntime;
96
class BlockFieldFlags;
97
class FunctionArgList;
98
class CoverageMappingModuleGen;
99
class TargetCodeGenInfo;
100
101
enum ForDefinition_t : bool {
102
  NotForDefinition = false,
103
  ForDefinition = true
104
};
105
106
struct OrderGlobalInitsOrStermFinalizers {
107
  unsigned int priority;
108
  unsigned int lex_order;
109
  OrderGlobalInitsOrStermFinalizers(unsigned int p, unsigned int l)
110
937
      : priority(p), lex_order(l) {}
111
112
0
  bool operator==(const OrderGlobalInitsOrStermFinalizers &RHS) const {
113
0
    return priority == RHS.priority && lex_order == RHS.lex_order;
114
0
  }
115
116
663
  bool operator<(const OrderGlobalInitsOrStermFinalizers &RHS) const {
117
663
    return std::tie(priority, lex_order) <
118
663
           std::tie(RHS.priority, RHS.lex_order);
119
663
  }
120
};
121
122
struct ObjCEntrypoints {
123
26.4k
  ObjCEntrypoints() { memset(this, 0, sizeof(*this)); }
124
125
  /// void objc_alloc(id);
126
  llvm::FunctionCallee objc_alloc;
127
128
  /// void objc_allocWithZone(id);
129
  llvm::FunctionCallee objc_allocWithZone;
130
131
  /// void objc_alloc_init(id);
132
  llvm::FunctionCallee objc_alloc_init;
133
134
  /// void objc_autoreleasePoolPop(void*);
135
  llvm::FunctionCallee objc_autoreleasePoolPop;
136
137
  /// void objc_autoreleasePoolPop(void*);
138
  /// Note this method is used when we are using exception handling
139
  llvm::FunctionCallee objc_autoreleasePoolPopInvoke;
140
141
  /// void *objc_autoreleasePoolPush(void);
142
  llvm::Function *objc_autoreleasePoolPush;
143
144
  /// id objc_autorelease(id);
145
  llvm::Function *objc_autorelease;
146
147
  /// id objc_autorelease(id);
148
  /// Note this is the runtime method not the intrinsic.
149
  llvm::FunctionCallee objc_autoreleaseRuntimeFunction;
150
151
  /// id objc_autoreleaseReturnValue(id);
152
  llvm::Function *objc_autoreleaseReturnValue;
153
154
  /// void objc_copyWeak(id *dest, id *src);
155
  llvm::Function *objc_copyWeak;
156
157
  /// void objc_destroyWeak(id*);
158
  llvm::Function *objc_destroyWeak;
159
160
  /// id objc_initWeak(id*, id);
161
  llvm::Function *objc_initWeak;
162
163
  /// id objc_loadWeak(id*);
164
  llvm::Function *objc_loadWeak;
165
166
  /// id objc_loadWeakRetained(id*);
167
  llvm::Function *objc_loadWeakRetained;
168
169
  /// void objc_moveWeak(id *dest, id *src);
170
  llvm::Function *objc_moveWeak;
171
172
  /// id objc_retain(id);
173
  llvm::Function *objc_retain;
174
175
  /// id objc_retain(id);
176
  /// Note this is the runtime method not the intrinsic.
177
  llvm::FunctionCallee objc_retainRuntimeFunction;
178
179
  /// id objc_retainAutorelease(id);
180
  llvm::Function *objc_retainAutorelease;
181
182
  /// id objc_retainAutoreleaseReturnValue(id);
183
  llvm::Function *objc_retainAutoreleaseReturnValue;
184
185
  /// id objc_retainAutoreleasedReturnValue(id);
186
  llvm::Function *objc_retainAutoreleasedReturnValue;
187
188
  /// id objc_retainBlock(id);
189
  llvm::Function *objc_retainBlock;
190
191
  /// void objc_release(id);
192
  llvm::Function *objc_release;
193
194
  /// void objc_release(id);
195
  /// Note this is the runtime method not the intrinsic.
196
  llvm::FunctionCallee objc_releaseRuntimeFunction;
197
198
  /// void objc_storeStrong(id*, id);
199
  llvm::Function *objc_storeStrong;
200
201
  /// id objc_storeWeak(id*, id);
202
  llvm::Function *objc_storeWeak;
203
204
  /// id objc_unsafeClaimAutoreleasedReturnValue(id);
205
  llvm::Function *objc_unsafeClaimAutoreleasedReturnValue;
206
207
  /// A void(void) inline asm to use to mark that the return value of
208
  /// a call will be immediately retain.
209
  llvm::InlineAsm *retainAutoreleasedReturnValueMarker;
210
211
  /// void clang.arc.use(...);
212
  llvm::Function *clang_arc_use;
213
214
  /// void clang.arc.noop.use(...);
215
  llvm::Function *clang_arc_noop_use;
216
};
217
218
/// This class records statistics on instrumentation based profiling.
219
class InstrProfStats {
220
  uint32_t VisitedInMainFile;
221
  uint32_t MissingInMainFile;
222
  uint32_t Visited;
223
  uint32_t Missing;
224
  uint32_t Mismatched;
225
226
public:
227
  InstrProfStats()
228
      : VisitedInMainFile(0), MissingInMainFile(0), Visited(0), Missing(0),
229
46.8k
        Mismatched(0) {}
230
  /// Record that we've visited a function and whether or not that function was
231
  /// in the main source file.
232
194
  void addVisited(bool MainFile) {
233
194
    if (MainFile)
234
191
      ++VisitedInMainFile;
235
194
    ++Visited;
236
194
  }
237
  /// Record that a function we've visited has no profile data.
238
6
  void addMissing(bool MainFile) {
239
6
    if (MainFile)
240
6
      ++MissingInMainFile;
241
6
    ++Missing;
242
6
  }
243
  /// Record that a function we've visited has mismatched profile data.
244
9
  void addMismatched(bool MainFile) { ++Mismatched; }
245
  /// Whether or not the stats we've gathered indicate any potential problems.
246
53
  bool hasDiagnostics() { return Missing || 
Mismatched43
; }
247
  /// Report potential problems we've found to \c Diags.
248
  void reportDiagnostics(DiagnosticsEngine &Diags, StringRef MainFile);
249
};
250
251
/// A pair of helper functions for a __block variable.
252
class BlockByrefHelpers : public llvm::FoldingSetNode {
253
  // MSVC requires this type to be complete in order to process this
254
  // header.
255
public:
256
  llvm::Constant *CopyHelper;
257
  llvm::Constant *DisposeHelper;
258
259
  /// The alignment of the field.  This is important because
260
  /// different offsets to the field within the byref struct need to
261
  /// have different helper functions.
262
  CharUnits Alignment;
263
264
  BlockByrefHelpers(CharUnits alignment)
265
87
      : CopyHelper(nullptr), DisposeHelper(nullptr), Alignment(alignment) {}
266
67
  BlockByrefHelpers(const BlockByrefHelpers &) = default;
267
  virtual ~BlockByrefHelpers();
268
269
107
  void Profile(llvm::FoldingSetNodeID &id) const {
270
107
    id.AddInteger(Alignment.getQuantity());
271
107
    profileImpl(id);
272
107
  }
273
  virtual void profileImpl(llvm::FoldingSetNodeID &id) const = 0;
274
275
54
  virtual bool needsCopy() const { return true; }
276
  virtual void emitCopy(CodeGenFunction &CGF, Address dest, Address src) = 0;
277
278
57
  virtual bool needsDispose() const { return true; }
279
  virtual void emitDispose(CodeGenFunction &CGF, Address field) = 0;
280
};
281
282
/// This class organizes the cross-function state that is used while generating
283
/// LLVM code.
284
class CodeGenModule : public CodeGenTypeCache {
285
  CodeGenModule(const CodeGenModule &) = delete;
286
  void operator=(const CodeGenModule &) = delete;
287
288
public:
289
  struct Structor {
290
0
    Structor() : Priority(0), Initializer(nullptr), AssociatedData(nullptr) {}
291
    Structor(int Priority, llvm::Constant *Initializer,
292
             llvm::Constant *AssociatedData)
293
        : Priority(Priority), Initializer(Initializer),
294
4.28k
          AssociatedData(AssociatedData) {}
295
    int Priority;
296
    llvm::Constant *Initializer;
297
    llvm::Constant *AssociatedData;
298
  };
299
300
  typedef std::vector<Structor> CtorList;
301
302
private:
303
  ASTContext &Context;
304
  const LangOptions &LangOpts;
305
  const HeaderSearchOptions &HeaderSearchOpts; // Only used for debug info.
306
  const PreprocessorOptions &PreprocessorOpts; // Only used for debug info.
307
  const CodeGenOptions &CodeGenOpts;
308
  unsigned NumAutoVarInit = 0;
309
  llvm::Module &TheModule;
310
  DiagnosticsEngine &Diags;
311
  const TargetInfo &Target;
312
  std::unique_ptr<CGCXXABI> ABI;
313
  llvm::LLVMContext &VMContext;
314
  std::string ModuleNameHash = "";
315
316
  std::unique_ptr<CodeGenTBAA> TBAA;
317
318
  mutable std::unique_ptr<TargetCodeGenInfo> TheTargetCodeGenInfo;
319
320
  // This should not be moved earlier, since its initialization depends on some
321
  // of the previous reference members being already initialized and also checks
322
  // if TheTargetCodeGenInfo is NULL
323
  CodeGenTypes Types;
324
325
  /// Holds information about C++ vtables.
326
  CodeGenVTables VTables;
327
328
  std::unique_ptr<CGObjCRuntime> ObjCRuntime;
329
  std::unique_ptr<CGOpenCLRuntime> OpenCLRuntime;
330
  std::unique_ptr<CGOpenMPRuntime> OpenMPRuntime;
331
  std::unique_ptr<CGCUDARuntime> CUDARuntime;
332
  std::unique_ptr<CGDebugInfo> DebugInfo;
333
  std::unique_ptr<ObjCEntrypoints> ObjCData;
334
  llvm::MDNode *NoObjCARCExceptionsMetadata = nullptr;
335
  std::unique_ptr<llvm::IndexedInstrProfReader> PGOReader;
336
  InstrProfStats PGOStats;
337
  std::unique_ptr<llvm::SanitizerStatReport> SanStats;
338
339
  // A set of references that have only been seen via a weakref so far. This is
340
  // used to remove the weak of the reference if we ever see a direct reference
341
  // or a definition.
342
  llvm::SmallPtrSet<llvm::GlobalValue*, 10> WeakRefReferences;
343
344
  /// This contains all the decls which have definitions but/ which are deferred
345
  /// for emission and therefore should only be output if they are actually
346
  /// used. If a decl is in this, then it is known to have not been referenced
347
  /// yet.
348
  std::map<StringRef, GlobalDecl> DeferredDecls;
349
350
  /// This is a list of deferred decls which we have seen that *are* actually
351
  /// referenced. These get code generated when the module is done.
352
  std::vector<GlobalDecl> DeferredDeclsToEmit;
353
167k
  void addDeferredDeclToEmit(GlobalDecl GD) {
354
167k
    DeferredDeclsToEmit.emplace_back(GD);
355
167k
  }
356
357
  /// List of alias we have emitted. Used to make sure that what they point to
358
  /// is defined once we get to the end of the of the translation unit.
359
  std::vector<GlobalDecl> Aliases;
360
361
  /// List of multiversion functions that have to be emitted.  Used to make sure
362
  /// we properly emit the iFunc.
363
  std::vector<GlobalDecl> MultiVersionFuncs;
364
365
  typedef llvm::StringMap<llvm::TrackingVH<llvm::Constant> > ReplacementsTy;
366
  ReplacementsTy Replacements;
367
368
  /// List of global values to be replaced with something else. Used when we
369
  /// want to replace a GlobalValue but can't identify it by its mangled name
370
  /// anymore (because the name is already taken).
371
  llvm::SmallVector<std::pair<llvm::GlobalValue *, llvm::Constant *>, 8>
372
    GlobalValReplacements;
373
374
  /// Variables for which we've emitted globals containing their constant
375
  /// values along with the corresponding globals, for opportunistic reuse.
376
  llvm::DenseMap<const VarDecl*, llvm::GlobalVariable*> InitializerConstants;
377
378
  /// Set of global decls for which we already diagnosed mangled name conflict.
379
  /// Required to not issue a warning (on a mangling conflict) multiple times
380
  /// for the same decl.
381
  llvm::DenseSet<GlobalDecl> DiagnosedConflictingDefinitions;
382
383
  /// A queue of (optional) vtables to consider emitting.
384
  std::vector<const CXXRecordDecl*> DeferredVTables;
385
386
  /// A queue of (optional) vtables that may be emitted opportunistically.
387
  std::vector<const CXXRecordDecl *> OpportunisticVTables;
388
389
  /// List of global values which are required to be present in the object file;
390
  /// bitcast to i8*. This is used for forcing visibility of symbols which may
391
  /// otherwise be optimized out.
392
  std::vector<llvm::WeakTrackingVH> LLVMUsed;
393
  std::vector<llvm::WeakTrackingVH> LLVMCompilerUsed;
394
395
  /// Store the list of global constructors and their respective priorities to
396
  /// be emitted when the translation unit is complete.
397
  CtorList GlobalCtors;
398
399
  /// Store the list of global destructors and their respective priorities to be
400
  /// emitted when the translation unit is complete.
401
  CtorList GlobalDtors;
402
403
  /// An ordered map of canonical GlobalDecls to their mangled names.
404
  llvm::MapVector<GlobalDecl, StringRef> MangledDeclNames;
405
  llvm::StringMap<GlobalDecl, llvm::BumpPtrAllocator> Manglings;
406
407
  // An ordered map of canonical GlobalDecls paired with the cpu-index for
408
  // cpu-specific name manglings.
409
  llvm::MapVector<std::pair<GlobalDecl, unsigned>, StringRef>
410
      CPUSpecificMangledDeclNames;
411
  llvm::StringMap<std::pair<GlobalDecl, unsigned>, llvm::BumpPtrAllocator>
412
      CPUSpecificManglings;
413
414
  /// Global annotations.
415
  std::vector<llvm::Constant*> Annotations;
416
417
  /// Map used to get unique annotation strings.
418
  llvm::StringMap<llvm::Constant*> AnnotationStrings;
419
420
  /// Used for uniquing of annotation arguments.
421
  llvm::DenseMap<unsigned, llvm::Constant *> AnnotationArgs;
422
423
  llvm::StringMap<llvm::GlobalVariable *> CFConstantStringMap;
424
425
  llvm::DenseMap<llvm::Constant *, llvm::GlobalVariable *> ConstantStringMap;
426
  llvm::DenseMap<const Decl*, llvm::Constant *> StaticLocalDeclMap;
427
  llvm::DenseMap<const Decl*, llvm::GlobalVariable*> StaticLocalDeclGuardMap;
428
  llvm::DenseMap<const Expr*, llvm::Constant *> MaterializedGlobalTemporaryMap;
429
430
  llvm::DenseMap<QualType, llvm::Constant *> AtomicSetterHelperFnMap;
431
  llvm::DenseMap<QualType, llvm::Constant *> AtomicGetterHelperFnMap;
432
433
  /// Map used to get unique type descriptor constants for sanitizers.
434
  llvm::DenseMap<QualType, llvm::Constant *> TypeDescriptorMap;
435
436
  /// Map used to track internal linkage functions declared within
437
  /// extern "C" regions.
438
  typedef llvm::MapVector<IdentifierInfo *,
439
                          llvm::GlobalValue *> StaticExternCMap;
440
  StaticExternCMap StaticExternCValues;
441
442
  /// thread_local variables defined or used in this TU.
443
  std::vector<const VarDecl *> CXXThreadLocals;
444
445
  /// thread_local variables with initializers that need to run
446
  /// before any thread_local variable in this TU is odr-used.
447
  std::vector<llvm::Function *> CXXThreadLocalInits;
448
  std::vector<const VarDecl *> CXXThreadLocalInitVars;
449
450
  /// Global variables with initializers that need to run before main.
451
  std::vector<llvm::Function *> CXXGlobalInits;
452
453
  /// When a C++ decl with an initializer is deferred, null is
454
  /// appended to CXXGlobalInits, and the index of that null is placed
455
  /// here so that the initializer will be performed in the correct
456
  /// order. Once the decl is emitted, the index is replaced with ~0U to ensure
457
  /// that we don't re-emit the initializer.
458
  llvm::DenseMap<const Decl*, unsigned> DelayedCXXInitPosition;
459
460
  typedef std::pair<OrderGlobalInitsOrStermFinalizers, llvm::Function *>
461
      GlobalInitData;
462
463
  struct GlobalInitPriorityCmp {
464
    bool operator()(const GlobalInitData &LHS,
465
623
                    const GlobalInitData &RHS) const {
466
623
      return LHS.first.priority < RHS.first.priority;
467
623
    }
468
  };
469
470
  /// Global variables with initializers whose order of initialization is set by
471
  /// init_priority attribute.
472
  SmallVector<GlobalInitData, 8> PrioritizedCXXGlobalInits;
473
474
  /// Global destructor functions and arguments that need to run on termination.
475
  /// When UseSinitAndSterm is set, it instead contains sterm finalizer
476
  /// functions, which also run on unloading a shared library.
477
  typedef std::tuple<llvm::FunctionType *, llvm::WeakTrackingVH,
478
                     llvm::Constant *>
479
      CXXGlobalDtorsOrStermFinalizer_t;
480
  SmallVector<CXXGlobalDtorsOrStermFinalizer_t, 8>
481
      CXXGlobalDtorsOrStermFinalizers;
482
483
  typedef std::pair<OrderGlobalInitsOrStermFinalizers, llvm::Function *>
484
      StermFinalizerData;
485
486
  struct StermFinalizerPriorityCmp {
487
    bool operator()(const StermFinalizerData &LHS,
488
8
                    const StermFinalizerData &RHS) const {
489
8
      return LHS.first.priority < RHS.first.priority;
490
8
    }
491
  };
492
493
  /// Global variables with sterm finalizers whose order of initialization is
494
  /// set by init_priority attribute.
495
  SmallVector<StermFinalizerData, 8> PrioritizedCXXStermFinalizers;
496
497
  /// The complete set of modules that has been imported.
498
  llvm::SetVector<clang::Module *> ImportedModules;
499
500
  /// The set of modules for which the module initializers
501
  /// have been emitted.
502
  llvm::SmallPtrSet<clang::Module *, 16> EmittedModuleInitializers;
503
504
  /// A vector of metadata strings for linker options.
505
  SmallVector<llvm::MDNode *, 16> LinkerOptionsMetadata;
506
507
  /// A vector of metadata strings for dependent libraries for ELF.
508
  SmallVector<llvm::MDNode *, 16> ELFDependentLibraries;
509
510
  /// @name Cache for Objective-C runtime types
511
  /// @{
512
513
  /// Cached reference to the class for constant strings. This value has type
514
  /// int * but is actually an Obj-C class pointer.
515
  llvm::WeakTrackingVH CFConstantStringClassRef;
516
517
  /// The type used to describe the state of a fast enumeration in
518
  /// Objective-C's for..in loop.
519
  QualType ObjCFastEnumerationStateType;
520
521
  /// @}
522
523
  /// Lazily create the Objective-C runtime
524
  void createObjCRuntime();
525
526
  void createOpenCLRuntime();
527
  void createOpenMPRuntime();
528
  void createCUDARuntime();
529
530
  bool isTriviallyRecursive(const FunctionDecl *F);
531
  bool shouldEmitFunction(GlobalDecl GD);
532
  bool shouldOpportunisticallyEmitVTables();
533
  /// Map used to be sure we don't emit the same CompoundLiteral twice.
534
  llvm::DenseMap<const CompoundLiteralExpr *, llvm::GlobalVariable *>
535
      EmittedCompoundLiterals;
536
537
  /// Map of the global blocks we've emitted, so that we don't have to re-emit
538
  /// them if the constexpr evaluator gets aggressive.
539
  llvm::DenseMap<const BlockExpr *, llvm::Constant *> EmittedGlobalBlocks;
540
541
  /// @name Cache for Blocks Runtime Globals
542
  /// @{
543
544
  llvm::Constant *NSConcreteGlobalBlock = nullptr;
545
  llvm::Constant *NSConcreteStackBlock = nullptr;
546
547
  llvm::FunctionCallee BlockObjectAssign = nullptr;
548
  llvm::FunctionCallee BlockObjectDispose = nullptr;
549
550
  llvm::Type *BlockDescriptorType = nullptr;
551
  llvm::Type *GenericBlockLiteralType = nullptr;
552
553
  struct {
554
    int GlobalUniqueCount;
555
  } Block;
556
557
  GlobalDecl initializedGlobalDecl;
558
559
  /// @}
560
561
  /// void @llvm.lifetime.start(i64 %size, i8* nocapture <ptr>)
562
  llvm::Function *LifetimeStartFn = nullptr;
563
564
  /// void @llvm.lifetime.end(i64 %size, i8* nocapture <ptr>)
565
  llvm::Function *LifetimeEndFn = nullptr;
566
567
  std::unique_ptr<SanitizerMetadata> SanitizerMD;
568
569
  llvm::MapVector<const Decl *, bool> DeferredEmptyCoverageMappingDecls;
570
571
  std::unique_ptr<CoverageMappingModuleGen> CoverageMapping;
572
573
  /// Mapping from canonical types to their metadata identifiers. We need to
574
  /// maintain this mapping because identifiers may be formed from distinct
575
  /// MDNodes.
576
  typedef llvm::DenseMap<QualType, llvm::Metadata *> MetadataTypeMap;
577
  MetadataTypeMap MetadataIdMap;
578
  MetadataTypeMap VirtualMetadataIdMap;
579
  MetadataTypeMap GeneralizedMetadataIdMap;
580
581
public:
582
  CodeGenModule(ASTContext &C, const HeaderSearchOptions &headersearchopts,
583
                const PreprocessorOptions &ppopts,
584
                const CodeGenOptions &CodeGenOpts, llvm::Module &M,
585
                DiagnosticsEngine &Diags,
586
                CoverageSourceInfo *CoverageInfo = nullptr);
587
588
  ~CodeGenModule();
589
590
  void clear();
591
592
  /// Finalize LLVM code generation.
593
  void Release();
594
595
  /// Return true if we should emit location information for expressions.
596
  bool getExpressionLocationsEnabled() const;
597
598
  /// Return a reference to the configured Objective-C runtime.
599
25.5k
  CGObjCRuntime &getObjCRuntime() {
600
25.5k
    if (!ObjCRuntime) 
createObjCRuntime()0
;
601
25.5k
    return *ObjCRuntime;
602
25.5k
  }
603
604
  /// Return true iff an Objective-C runtime has been configured.
605
0
  bool hasObjCRuntime() { return !!ObjCRuntime; }
606
607
4.38M
  const std::string &getModuleNameHash() const { return ModuleNameHash; }
608
609
  /// Return a reference to the configured OpenCL runtime.
610
717
  CGOpenCLRuntime &getOpenCLRuntime() {
611
717
    assert(OpenCLRuntime != nullptr);
612
0
    return *OpenCLRuntime;
613
717
  }
614
615
  /// Return a reference to the configured OpenMP runtime.
616
908k
  CGOpenMPRuntime &getOpenMPRuntime() {
617
908k
    assert(OpenMPRuntime != nullptr);
618
0
    return *OpenMPRuntime;
619
908k
  }
620
621
  /// Return a reference to the configured CUDA runtime.
622
1.03k
  CGCUDARuntime &getCUDARuntime() {
623
1.03k
    assert(CUDARuntime != nullptr);
624
0
    return *CUDARuntime;
625
1.03k
  }
626
627
7.14k
  ObjCEntrypoints &getObjCEntrypoints() const {
628
7.14k
    assert(ObjCData != nullptr);
629
0
    return *ObjCData;
630
7.14k
  }
631
632
  // Version checking functions, used to implement ObjC's @available:
633
  // i32 @__isOSVersionAtLeast(i32, i32, i32)
634
  llvm::FunctionCallee IsOSVersionAtLeastFn = nullptr;
635
  // i32 @__isPlatformVersionAtLeast(i32, i32, i32, i32)
636
  llvm::FunctionCallee IsPlatformVersionAtLeastFn = nullptr;
637
638
209
  InstrProfStats &getPGOStats() { return PGOStats; }
639
361k
  llvm::IndexedInstrProfReader *getPGOReader() const { return PGOReader.get(); }
640
641
497
  CoverageMappingModuleGen *getCoverageMapping() const {
642
497
    return CoverageMapping.get();
643
497
  }
644
645
22
  llvm::Constant *getStaticLocalDeclAddress(const VarDecl *D) {
646
22
    return StaticLocalDeclMap[D];
647
22
  }
648
  void setStaticLocalDeclAddress(const VarDecl *D,
649
27.1k
                                 llvm::Constant *C) {
650
27.1k
    StaticLocalDeclMap[D] = C;
651
27.1k
  }
652
653
  llvm::Constant *
654
  getOrCreateStaticVarDecl(const VarDecl &D,
655
                           llvm::GlobalValue::LinkageTypes Linkage);
656
657
10.1k
  llvm::GlobalVariable *getStaticLocalDeclGuardAddress(const VarDecl *D) {
658
10.1k
    return StaticLocalDeclGuardMap[D];
659
10.1k
  }
660
  void setStaticLocalDeclGuardAddress(const VarDecl *D,
661
10.1k
                                      llvm::GlobalVariable *C) {
662
10.1k
    StaticLocalDeclGuardMap[D] = C;
663
10.1k
  }
664
665
  Address createUnnamedGlobalFrom(const VarDecl &D, llvm::Constant *Constant,
666
                                  CharUnits Align);
667
668
  bool lookupRepresentativeDecl(StringRef MangledName,
669
                                GlobalDecl &Result) const;
670
671
7
  llvm::Constant *getAtomicSetterHelperFnMap(QualType Ty) {
672
7
    return AtomicSetterHelperFnMap[Ty];
673
7
  }
674
  void setAtomicSetterHelperFnMap(QualType Ty,
675
5
                            llvm::Constant *Fn) {
676
5
    AtomicSetterHelperFnMap[Ty] = Fn;
677
5
  }
678
679
6
  llvm::Constant *getAtomicGetterHelperFnMap(QualType Ty) {
680
6
    return AtomicGetterHelperFnMap[Ty];
681
6
  }
682
  void setAtomicGetterHelperFnMap(QualType Ty,
683
4
                            llvm::Constant *Fn) {
684
4
    AtomicGetterHelperFnMap[Ty] = Fn;
685
4
  }
686
687
2.67k
  llvm::Constant *getTypeDescriptorFromMap(QualType Ty) {
688
2.67k
    return TypeDescriptorMap[Ty];
689
2.67k
  }
690
542
  void setTypeDescriptorInMap(QualType Ty, llvm::Constant *C) {
691
542
    TypeDescriptorMap[Ty] = C;
692
542
  }
693
694
7.03M
  CGDebugInfo *getModuleDebugInfo() { return DebugInfo.get(); }
695
696
356
  llvm::MDNode *getNoObjCARCExceptionsMetadata() {
697
356
    if (!NoObjCARCExceptionsMetadata)
698
24
      NoObjCARCExceptionsMetadata = llvm::MDNode::get(getLLVMContext(), None);
699
356
    return NoObjCARCExceptionsMetadata;
700
356
  }
701
702
83.6M
  ASTContext &getContext() const { return Context; }
703
33.7M
  const LangOptions &getLangOpts() const { return LangOpts; }
704
  const HeaderSearchOptions &getHeaderSearchOpts()
705
3.55k
    const { return HeaderSearchOpts; }
706
  const PreprocessorOptions &getPreprocessorOpts()
707
25.6k
    const { return PreprocessorOpts; }
708
30.2M
  const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; }
709
5.44M
  llvm::Module &getModule() const { return TheModule; }
710
52.6k
  DiagnosticsEngine &getDiags() const { return Diags; }
711
2.75M
  const llvm::DataLayout &getDataLayout() const {
712
2.75M
    return TheModule.getDataLayout();
713
2.75M
  }
714
6.58M
  const TargetInfo &getTarget() const { return Target; }
715
1.83M
  const llvm::Triple &getTriple() const { return Target.getTriple(); }
716
  bool supportsCOMDAT() const;
717
  void maybeSetTrivialComdat(const Decl &D, llvm::GlobalObject &GO);
718
719
5.07M
  CGCXXABI &getCXXABI() const { return *ABI; }
720
13.1M
  llvm::LLVMContext &getLLVMContext() { return VMContext; }
721
722
0
  bool shouldUseTBAA() const { return TBAA != nullptr; }
723
724
  const TargetCodeGenInfo &getTargetCodeGenInfo();
725
726
11.1M
  CodeGenTypes &getTypes() { return Types; }
727
728
14.1k
  CodeGenVTables &getVTables() { return VTables; }
729
730
48.9k
  ItaniumVTableContext &getItaniumVTableContext() {
731
48.9k
    return VTables.getItaniumVTableContext();
732
48.9k
  }
733
734
8.12k
  MicrosoftVTableContext &getMicrosoftVTableContext() {
735
8.12k
    return VTables.getMicrosoftVTableContext();
736
8.12k
  }
737
738
0
  CtorList &getGlobalCtors() { return GlobalCtors; }
739
0
  CtorList &getGlobalDtors() { return GlobalDtors; }
740
741
  /// getTBAATypeInfo - Get metadata used to describe accesses to objects of
742
  /// the given type.
743
  llvm::MDNode *getTBAATypeInfo(QualType QTy);
744
745
  /// getTBAAAccessInfo - Get TBAA information that describes an access to
746
  /// an object of the given type.
747
  TBAAAccessInfo getTBAAAccessInfo(QualType AccessType);
748
749
  /// getTBAAVTablePtrAccessInfo - Get the TBAA information that describes an
750
  /// access to a virtual table pointer.
751
  TBAAAccessInfo getTBAAVTablePtrAccessInfo(llvm::Type *VTablePtrType);
752
753
  llvm::MDNode *getTBAAStructInfo(QualType QTy);
754
755
  /// getTBAABaseTypeInfo - Get metadata that describes the given base access
756
  /// type. Return null if the type is not suitable for use in TBAA access tags.
757
  llvm::MDNode *getTBAABaseTypeInfo(QualType QTy);
758
759
  /// getTBAAAccessTagInfo - Get TBAA tag for a given memory access.
760
  llvm::MDNode *getTBAAAccessTagInfo(TBAAAccessInfo Info);
761
762
  /// mergeTBAAInfoForCast - Get merged TBAA information for the purposes of
763
  /// type casts.
764
  TBAAAccessInfo mergeTBAAInfoForCast(TBAAAccessInfo SourceInfo,
765
                                      TBAAAccessInfo TargetInfo);
766
767
  /// mergeTBAAInfoForConditionalOperator - Get merged TBAA information for the
768
  /// purposes of conditional operator.
769
  TBAAAccessInfo mergeTBAAInfoForConditionalOperator(TBAAAccessInfo InfoA,
770
                                                     TBAAAccessInfo InfoB);
771
772
  /// mergeTBAAInfoForMemoryTransfer - Get merged TBAA information for the
773
  /// purposes of memory transfer calls.
774
  TBAAAccessInfo mergeTBAAInfoForMemoryTransfer(TBAAAccessInfo DestInfo,
775
                                                TBAAAccessInfo SrcInfo);
776
777
  /// getTBAAInfoForSubobject - Get TBAA information for an access with a given
778
  /// base lvalue.
779
36.3k
  TBAAAccessInfo getTBAAInfoForSubobject(LValue Base, QualType AccessType) {
780
36.3k
    if (Base.getTBAAInfo().isMayAlias())
781
585
      return TBAAAccessInfo::getMayAliasInfo();
782
35.7k
    return getTBAAAccessInfo(AccessType);
783
36.3k
  }
784
785
  bool isTypeConstant(QualType QTy, bool ExcludeCtorDtor);
786
787
  bool isPaddedAtomicType(QualType type);
788
  bool isPaddedAtomicType(const AtomicType *type);
789
790
  /// DecorateInstructionWithTBAA - Decorate the instruction with a TBAA tag.
791
  void DecorateInstructionWithTBAA(llvm::Instruction *Inst,
792
                                   TBAAAccessInfo TBAAInfo);
793
794
  /// Adds !invariant.barrier !tag to instruction
795
  void DecorateInstructionWithInvariantGroup(llvm::Instruction *I,
796
                                             const CXXRecordDecl *RD);
797
798
  /// Emit the given number of characters as a value of type size_t.
799
  llvm::ConstantInt *getSize(CharUnits numChars);
800
801
  /// Set the visibility for the given LLVM GlobalValue.
802
  void setGlobalVisibility(llvm::GlobalValue *GV, const NamedDecl *D) const;
803
804
  void setDSOLocal(llvm::GlobalValue *GV) const;
805
806
  void setDLLImportDLLExport(llvm::GlobalValue *GV, GlobalDecl D) const;
807
  void setDLLImportDLLExport(llvm::GlobalValue *GV, const NamedDecl *D) const;
808
  /// Set visibility, dllimport/dllexport and dso_local.
809
  /// This must be called after dllimport/dllexport is set.
810
  void setGVProperties(llvm::GlobalValue *GV, GlobalDecl GD) const;
811
  void setGVProperties(llvm::GlobalValue *GV, const NamedDecl *D) const;
812
813
  void setGVPropertiesAux(llvm::GlobalValue *GV, const NamedDecl *D) const;
814
815
  /// Set the TLS mode for the given LLVM GlobalValue for the thread-local
816
  /// variable declaration D.
817
  void setTLSMode(llvm::GlobalValue *GV, const VarDecl &D) const;
818
819
  /// Get LLVM TLS mode from CodeGenOptions.
820
  llvm::GlobalVariable::ThreadLocalMode GetDefaultLLVMTLSModel() const;
821
822
466k
  static llvm::GlobalValue::VisibilityTypes GetLLVMVisibility(Visibility V) {
823
466k
    switch (V) {
824
294k
    case DefaultVisibility:   return llvm::GlobalValue::DefaultVisibility;
825
171k
    case HiddenVisibility:    return llvm::GlobalValue::HiddenVisibility;
826
158
    case ProtectedVisibility: return llvm::GlobalValue::ProtectedVisibility;
827
466k
    }
828
0
    llvm_unreachable("unknown visibility!");
829
0
  }
830
831
  llvm::Constant *GetAddrOfGlobal(GlobalDecl GD,
832
                                  ForDefinition_t IsForDefinition
833
                                    = NotForDefinition);
834
835
  /// Will return a global variable of the given type. If a variable with a
836
  /// different type already exists then a new  variable with the right type
837
  /// will be created and all uses of the old variable will be replaced with a
838
  /// bitcast to the new variable.
839
  llvm::GlobalVariable *
840
  CreateOrReplaceCXXRuntimeVariable(StringRef Name, llvm::Type *Ty,
841
                                    llvm::GlobalValue::LinkageTypes Linkage,
842
                                    unsigned Alignment);
843
844
  llvm::Function *CreateGlobalInitOrCleanUpFunction(
845
      llvm::FunctionType *ty, const Twine &name, const CGFunctionInfo &FI,
846
      SourceLocation Loc = SourceLocation(), bool TLS = false);
847
848
  /// Return the AST address space of the underlying global variable for D, as
849
  /// determined by its declaration. Normally this is the same as the address
850
  /// space of D's type, but in CUDA, address spaces are associated with
851
  /// declarations, not types. If D is nullptr, return the default address
852
  /// space for global variable.
853
  ///
854
  /// For languages without explicit address spaces, if D has default address
855
  /// space, target-specific global or constant address space may be returned.
856
  LangAS GetGlobalVarAddressSpace(const VarDecl *D);
857
858
  /// Return the AST address space of constant literal, which is used to emit
859
  /// the constant literal as global variable in LLVM IR.
860
  /// Note: This is not necessarily the address space of the constant literal
861
  /// in AST. For address space agnostic language, e.g. C++, constant literal
862
  /// in AST is always in default address space.
863
  LangAS GetGlobalConstantAddressSpace() const;
864
865
  /// Return the llvm::Constant for the address of the given global variable.
866
  /// If Ty is non-null and if the global doesn't exist, then it will be created
867
  /// with the specified type instead of whatever the normal requested type
868
  /// would be. If IsForDefinition is true, it is guaranteed that an actual
869
  /// global with type Ty will be returned, not conversion of a variable with
870
  /// the same mangled name but some other type.
871
  llvm::Constant *GetAddrOfGlobalVar(const VarDecl *D,
872
                                     llvm::Type *Ty = nullptr,
873
                                     ForDefinition_t IsForDefinition
874
                                       = NotForDefinition);
875
876
  /// Return the address of the given function. If Ty is non-null, then this
877
  /// function will use the specified type if it has to create it.
878
  llvm::Constant *GetAddrOfFunction(GlobalDecl GD, llvm::Type *Ty = nullptr,
879
                                    bool ForVTable = false,
880
                                    bool DontDefer = false,
881
                                    ForDefinition_t IsForDefinition
882
                                      = NotForDefinition);
883
884
  /// Get the address of the RTTI descriptor for the given type.
885
  llvm::Constant *GetAddrOfRTTIDescriptor(QualType Ty, bool ForEH = false);
886
887
  /// Get the address of a GUID.
888
  ConstantAddress GetAddrOfMSGuidDecl(const MSGuidDecl *GD);
889
890
  /// Get the address of a template parameter object.
891
  ConstantAddress
892
  GetAddrOfTemplateParamObject(const TemplateParamObjectDecl *TPO);
893
894
  /// Get the address of the thunk for the given global decl.
895
  llvm::Constant *GetAddrOfThunk(StringRef Name, llvm::Type *FnTy,
896
                                 GlobalDecl GD);
897
898
  /// Get a reference to the target of VD.
899
  ConstantAddress GetWeakRefReference(const ValueDecl *VD);
900
901
  /// Returns the assumed alignment of an opaque pointer to the given class.
902
  CharUnits getClassPointerAlignment(const CXXRecordDecl *CD);
903
904
  /// Returns the minimum object size for an object of the given class type
905
  /// (or a class derived from it).
906
  CharUnits getMinimumClassObjectSize(const CXXRecordDecl *CD);
907
908
  /// Returns the minimum object size for an object of the given type.
909
481k
  CharUnits getMinimumObjectSize(QualType Ty) {
910
481k
    if (CXXRecordDecl *RD = Ty->getAsCXXRecordDecl())
911
382k
      return getMinimumClassObjectSize(RD);
912
98.3k
    return getContext().getTypeSizeInChars(Ty);
913
481k
  }
914
915
  /// Returns the assumed alignment of a virtual base of a class.
916
  CharUnits getVBaseAlignment(CharUnits DerivedAlign,
917
                              const CXXRecordDecl *Derived,
918
                              const CXXRecordDecl *VBase);
919
920
  /// Given a class pointer with an actual known alignment, and the
921
  /// expected alignment of an object at a dynamic offset w.r.t that
922
  /// pointer, return the alignment to assume at the offset.
923
  CharUnits getDynamicOffsetAlignment(CharUnits ActualAlign,
924
                                      const CXXRecordDecl *Class,
925
                                      CharUnits ExpectedTargetAlign);
926
927
  CharUnits
928
  computeNonVirtualBaseClassOffset(const CXXRecordDecl *DerivedClass,
929
                                   CastExpr::path_const_iterator Start,
930
                                   CastExpr::path_const_iterator End);
931
932
  /// Returns the offset from a derived class to  a class. Returns null if the
933
  /// offset is 0.
934
  llvm::Constant *
935
  GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl,
936
                               CastExpr::path_const_iterator PathBegin,
937
                               CastExpr::path_const_iterator PathEnd);
938
939
  llvm::FoldingSet<BlockByrefHelpers> ByrefHelpersCache;
940
941
  /// Fetches the global unique block count.
942
171
  int getUniqueBlockCount() { return ++Block.GlobalUniqueCount; }
943
944
  /// Fetches the type of a generic block descriptor.
945
  llvm::Type *getBlockDescriptorType();
946
947
  /// The type of a generic block literal.
948
  llvm::Type *getGenericBlockLiteralType();
949
950
  /// Gets the address of a block which requires no captures.
951
  llvm::Constant *GetAddrOfGlobalBlock(const BlockExpr *BE, StringRef Name);
952
953
  /// Returns the address of a block which requires no caputres, or null if
954
  /// we've yet to emit the block for BE.
955
1.12k
  llvm::Constant *getAddrOfGlobalBlockIfEmitted(const BlockExpr *BE) {
956
1.12k
    return EmittedGlobalBlocks.lookup(BE);
957
1.12k
  }
958
959
  /// Notes that BE's global block is available via Addr. Asserts that BE
960
  /// isn't already emitted.
961
  void setAddrOfGlobalBlock(const BlockExpr *BE, llvm::Constant *Addr);
962
963
  /// Return a pointer to a constant CFString object for the given string.
964
  ConstantAddress GetAddrOfConstantCFString(const StringLiteral *Literal);
965
966
  /// Return a pointer to a constant NSString object for the given string. Or a
967
  /// user defined String object as defined via
968
  /// -fconstant-string-class=class_name option.
969
  ConstantAddress GetAddrOfConstantString(const StringLiteral *Literal);
970
971
  /// Return a constant array for the given string.
972
  llvm::Constant *GetConstantArrayFromStringLiteral(const StringLiteral *E);
973
974
  /// Return a pointer to a constant array for the given string literal.
975
  ConstantAddress
976
  GetAddrOfConstantStringFromLiteral(const StringLiteral *S,
977
                                     StringRef Name = ".str");
978
979
  /// Return a pointer to a constant array for the given ObjCEncodeExpr node.
980
  ConstantAddress
981
  GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *);
982
983
  /// Returns a pointer to a character array containing the literal and a
984
  /// terminating '\0' character. The result has pointer to array type.
985
  ///
986
  /// \param GlobalName If provided, the name to use for the global (if one is
987
  /// created).
988
  ConstantAddress
989
  GetAddrOfConstantCString(const std::string &Str,
990
                           const char *GlobalName = nullptr);
991
992
  /// Returns a pointer to a constant global variable for the given file-scope
993
  /// compound literal expression.
994
  ConstantAddress GetAddrOfConstantCompoundLiteral(const CompoundLiteralExpr*E);
995
996
  /// If it's been emitted already, returns the GlobalVariable corresponding to
997
  /// a compound literal. Otherwise, returns null.
998
  llvm::GlobalVariable *
999
  getAddrOfConstantCompoundLiteralIfEmitted(const CompoundLiteralExpr *E);
1000
1001
  /// Notes that CLE's GlobalVariable is GV. Asserts that CLE isn't already
1002
  /// emitted.
1003
  void setAddrOfConstantCompoundLiteral(const CompoundLiteralExpr *CLE,
1004
                                        llvm::GlobalVariable *GV);
1005
1006
  /// Returns a pointer to a global variable representing a temporary
1007
  /// with static or thread storage duration.
1008
  ConstantAddress GetAddrOfGlobalTemporary(const MaterializeTemporaryExpr *E,
1009
                                           const Expr *Inner);
1010
1011
  /// Retrieve the record type that describes the state of an
1012
  /// Objective-C fast enumeration loop (for..in).
1013
  QualType getObjCFastEnumerationStateType();
1014
1015
  // Produce code for this constructor/destructor. This method doesn't try
1016
  // to apply any ABI rules about which other constructors/destructors
1017
  // are needed or if they are alias to each other.
1018
  llvm::Function *codegenCXXStructor(GlobalDecl GD);
1019
1020
  /// Return the address of the constructor/destructor of the given type.
1021
  llvm::Constant *
1022
  getAddrOfCXXStructor(GlobalDecl GD, const CGFunctionInfo *FnInfo = nullptr,
1023
                       llvm::FunctionType *FnType = nullptr,
1024
                       bool DontDefer = false,
1025
200k
                       ForDefinition_t IsForDefinition = NotForDefinition) {
1026
200k
    return cast<llvm::Constant>(getAddrAndTypeOfCXXStructor(GD, FnInfo, FnType,
1027
200k
                                                            DontDefer,
1028
200k
                                                            IsForDefinition)
1029
200k
                                    .getCallee());
1030
200k
  }
1031
1032
  llvm::FunctionCallee getAddrAndTypeOfCXXStructor(
1033
      GlobalDecl GD, const CGFunctionInfo *FnInfo = nullptr,
1034
      llvm::FunctionType *FnType = nullptr, bool DontDefer = false,
1035
      ForDefinition_t IsForDefinition = NotForDefinition);
1036
1037
  /// Given a builtin id for a function like "__builtin_fabsf", return a
1038
  /// Function* for "fabsf".
1039
  llvm::Constant *getBuiltinLibFunction(const FunctionDecl *FD,
1040
                                        unsigned BuiltinID);
1041
1042
  llvm::Function *getIntrinsic(unsigned IID, ArrayRef<llvm::Type*> Tys = None);
1043
1044
  /// Emit code for a single top level declaration.
1045
  void EmitTopLevelDecl(Decl *D);
1046
1047
  /// Stored a deferred empty coverage mapping for an unused
1048
  /// and thus uninstrumented top level declaration.
1049
  void AddDeferredUnusedCoverageMapping(Decl *D);
1050
1051
  /// Remove the deferred empty coverage mapping as this
1052
  /// declaration is actually instrumented.
1053
  void ClearUnusedCoverageMapping(const Decl *D);
1054
1055
  /// Emit all the deferred coverage mappings
1056
  /// for the uninstrumented functions.
1057
  void EmitDeferredUnusedCoverageMappings();
1058
1059
  /// Emit an alias for "main" if it has no arguments (needed for wasm).
1060
  void EmitMainVoidAlias();
1061
1062
  /// Tell the consumer that this variable has been instantiated.
1063
  void HandleCXXStaticMemberVarInstantiation(VarDecl *VD);
1064
1065
  /// If the declaration has internal linkage but is inside an
1066
  /// extern "C" linkage specification, prepare to emit an alias for it
1067
  /// to the expected name.
1068
  template<typename SomeDecl>
1069
  void MaybeHandleStaticInExternC(const SomeDecl *D, llvm::GlobalValue *GV);
1070
1071
  /// Add a global to a list to be added to the llvm.used metadata.
1072
  void addUsedGlobal(llvm::GlobalValue *GV);
1073
1074
  /// Add a global to a list to be added to the llvm.compiler.used metadata.
1075
  void addCompilerUsedGlobal(llvm::GlobalValue *GV);
1076
1077
  /// Add a global to a list to be added to the llvm.compiler.used metadata.
1078
  void addUsedOrCompilerUsedGlobal(llvm::GlobalValue *GV);
1079
1080
  /// Add a destructor and object to add to the C++ global destructor function.
1081
6
  void AddCXXDtorEntry(llvm::FunctionCallee DtorFn, llvm::Constant *Object) {
1082
6
    CXXGlobalDtorsOrStermFinalizers.emplace_back(DtorFn.getFunctionType(),
1083
6
                                                 DtorFn.getCallee(), Object);
1084
6
  }
1085
1086
  /// Add an sterm finalizer to the C++ global cleanup function.
1087
22
  void AddCXXStermFinalizerEntry(llvm::FunctionCallee DtorFn) {
1088
22
    CXXGlobalDtorsOrStermFinalizers.emplace_back(DtorFn.getFunctionType(),
1089
22
                                                 DtorFn.getCallee(), nullptr);
1090
22
  }
1091
1092
  /// Add an sterm finalizer to its own llvm.global_dtors entry.
1093
  void AddCXXStermFinalizerToGlobalDtor(llvm::Function *StermFinalizer,
1094
6
                                        int Priority) {
1095
6
    AddGlobalDtor(StermFinalizer, Priority);
1096
6
  }
1097
1098
  void AddCXXPrioritizedStermFinalizerEntry(llvm::Function *StermFinalizer,
1099
8
                                            int Priority) {
1100
8
    OrderGlobalInitsOrStermFinalizers Key(Priority,
1101
8
                                          PrioritizedCXXStermFinalizers.size());
1102
8
    PrioritizedCXXStermFinalizers.push_back(
1103
8
        std::make_pair(Key, StermFinalizer));
1104
8
  }
1105
1106
  /// Create or return a runtime function declaration with the specified type
1107
  /// and name. If \p AssumeConvergent is true, the call will have the
1108
  /// convergent attribute added.
1109
  llvm::FunctionCallee
1110
  CreateRuntimeFunction(llvm::FunctionType *Ty, StringRef Name,
1111
                        llvm::AttributeList ExtraAttrs = llvm::AttributeList(),
1112
                        bool Local = false, bool AssumeConvergent = false);
1113
1114
  /// Create a new runtime global variable with the specified type and name.
1115
  llvm::Constant *CreateRuntimeVariable(llvm::Type *Ty,
1116
                                        StringRef Name);
1117
1118
  ///@name Custom Blocks Runtime Interfaces
1119
  ///@{
1120
1121
  llvm::Constant *getNSConcreteGlobalBlock();
1122
  llvm::Constant *getNSConcreteStackBlock();
1123
  llvm::FunctionCallee getBlockObjectAssign();
1124
  llvm::FunctionCallee getBlockObjectDispose();
1125
1126
  ///@}
1127
1128
  llvm::Function *getLLVMLifetimeStartFn();
1129
  llvm::Function *getLLVMLifetimeEndFn();
1130
1131
  // Make sure that this type is translated.
1132
  void UpdateCompletedType(const TagDecl *TD);
1133
1134
  llvm::Constant *getMemberPointerConstant(const UnaryOperator *e);
1135
1136
  /// Emit type info if type of an expression is a variably modified
1137
  /// type. Also emit proper debug info for cast types.
1138
  void EmitExplicitCastExprType(const ExplicitCastExpr *E,
1139
                                CodeGenFunction *CGF = nullptr);
1140
1141
  /// Return the result of value-initializing the given type, i.e. a null
1142
  /// expression of the given type.  This is usually, but not always, an LLVM
1143
  /// null constant.
1144
  llvm::Constant *EmitNullConstant(QualType T);
1145
1146
  /// Return a null constant appropriate for zero-initializing a base class with
1147
  /// the given type. This is usually, but not always, an LLVM null constant.
1148
  llvm::Constant *EmitNullConstantForBase(const CXXRecordDecl *Record);
1149
1150
  /// Emit a general error that something can't be done.
1151
  void Error(SourceLocation loc, StringRef error);
1152
1153
  /// Print out an error that codegen doesn't support the specified stmt yet.
1154
  void ErrorUnsupported(const Stmt *S, const char *Type);
1155
1156
  /// Print out an error that codegen doesn't support the specified decl yet.
1157
  void ErrorUnsupported(const Decl *D, const char *Type);
1158
1159
  /// Set the attributes on the LLVM function for the given decl and function
1160
  /// info. This applies attributes necessary for handling the ABI as well as
1161
  /// user specified attributes like section.
1162
  void SetInternalFunctionAttributes(GlobalDecl GD, llvm::Function *F,
1163
                                     const CGFunctionInfo &FI);
1164
1165
  /// Set the LLVM function attributes (sext, zext, etc).
1166
  void SetLLVMFunctionAttributes(GlobalDecl GD, const CGFunctionInfo &Info,
1167
                                 llvm::Function *F, bool IsThunk);
1168
1169
  /// Set the LLVM function attributes which only apply to a function
1170
  /// definition.
1171
  void SetLLVMFunctionAttributesForDefinition(const Decl *D, llvm::Function *F);
1172
1173
  /// Set the LLVM function attributes that represent floating point
1174
  /// environment.
1175
  void setLLVMFunctionFEnvAttributes(const FunctionDecl *D, llvm::Function *F);
1176
1177
  /// Return true iff the given type uses 'sret' when used as a return type.
1178
  bool ReturnTypeUsesSRet(const CGFunctionInfo &FI);
1179
1180
  /// Return true iff the given type uses an argument slot when 'sret' is used
1181
  /// as a return type.
1182
  bool ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI);
1183
1184
  /// Return true iff the given type uses 'fpret' when used as a return type.
1185
  bool ReturnTypeUsesFPRet(QualType ResultType);
1186
1187
  /// Return true iff the given type uses 'fp2ret' when used as a return type.
1188
  bool ReturnTypeUsesFP2Ret(QualType ResultType);
1189
1190
  /// Get the LLVM attributes and calling convention to use for a particular
1191
  /// function type.
1192
  ///
1193
  /// \param Name - The function name.
1194
  /// \param Info - The function type information.
1195
  /// \param CalleeInfo - The callee information these attributes are being
1196
  /// constructed for. If valid, the attributes applied to this decl may
1197
  /// contribute to the function attributes and calling convention.
1198
  /// \param Attrs [out] - On return, the attribute list to use.
1199
  /// \param CallingConv [out] - On return, the LLVM calling convention to use.
1200
  void ConstructAttributeList(StringRef Name, const CGFunctionInfo &Info,
1201
                              CGCalleeInfo CalleeInfo,
1202
                              llvm::AttributeList &Attrs, unsigned &CallingConv,
1203
                              bool AttrOnCallSite, bool IsThunk);
1204
1205
  /// Adds attributes to F according to our CodeGenOptions and LangOptions, as
1206
  /// though we had emitted it ourselves.  We remove any attributes on F that
1207
  /// conflict with the attributes we add here.
1208
  ///
1209
  /// This is useful for adding attrs to bitcode modules that you want to link
1210
  /// with but don't control, such as CUDA's libdevice.  When linking with such
1211
  /// a bitcode library, you might want to set e.g. its functions'
1212
  /// "unsafe-fp-math" attribute to match the attr of the functions you're
1213
  /// codegen'ing.  Otherwise, LLVM will interpret the bitcode module's lack of
1214
  /// unsafe-fp-math attrs as tantamount to unsafe-fp-math=false, and then LLVM
1215
  /// will propagate unsafe-fp-math=false up to every transitive caller of a
1216
  /// function in the bitcode library!
1217
  ///
1218
  /// With the exception of fast-math attrs, this will only make the attributes
1219
  /// on the function more conservative.  But it's unsafe to call this on a
1220
  /// function which relies on particular fast-math attributes for correctness.
1221
  /// It's up to you to ensure that this is safe.
1222
  void addDefaultFunctionDefinitionAttributes(llvm::Function &F);
1223
1224
  /// Like the overload taking a `Function &`, but intended specifically
1225
  /// for frontends that want to build on Clang's target-configuration logic.
1226
  void addDefaultFunctionDefinitionAttributes(llvm::AttrBuilder &attrs);
1227
1228
  StringRef getMangledName(GlobalDecl GD);
1229
  StringRef getBlockMangledName(GlobalDecl GD, const BlockDecl *BD);
1230
1231
  void EmitTentativeDefinition(const VarDecl *D);
1232
1233
  void EmitExternalDeclaration(const VarDecl *D);
1234
1235
  void EmitVTable(CXXRecordDecl *Class);
1236
1237
  void RefreshTypeCacheForClass(const CXXRecordDecl *Class);
1238
1239
  /// Appends Opts to the "llvm.linker.options" metadata value.
1240
  void AppendLinkerOptions(StringRef Opts);
1241
1242
  /// Appends a detect mismatch command to the linker options.
1243
  void AddDetectMismatch(StringRef Name, StringRef Value);
1244
1245
  /// Appends a dependent lib to the appropriate metadata value.
1246
  void AddDependentLib(StringRef Lib);
1247
1248
1249
  llvm::GlobalVariable::LinkageTypes getFunctionLinkage(GlobalDecl GD);
1250
1251
333k
  void setFunctionLinkage(GlobalDecl GD, llvm::Function *F) {
1252
333k
    F->setLinkage(getFunctionLinkage(GD));
1253
333k
  }
1254
1255
  /// Return the appropriate linkage for the vtable, VTT, and type information
1256
  /// of the given class.
1257
  llvm::GlobalVariable::LinkageTypes getVTableLinkage(const CXXRecordDecl *RD);
1258
1259
  /// Return the store size, in character units, of the given LLVM type.
1260
  CharUnits GetTargetTypeStoreSize(llvm::Type *Ty) const;
1261
1262
  /// Returns LLVM linkage for a declarator.
1263
  llvm::GlobalValue::LinkageTypes
1264
  getLLVMLinkageForDeclarator(const DeclaratorDecl *D, GVALinkage Linkage,
1265
                              bool IsConstantVariable);
1266
1267
  /// Returns LLVM linkage for a declarator.
1268
  llvm::GlobalValue::LinkageTypes
1269
  getLLVMLinkageVarDefinition(const VarDecl *VD, bool IsConstant);
1270
1271
  /// Emit all the global annotations.
1272
  void EmitGlobalAnnotations();
1273
1274
  /// Emit an annotation string.
1275
  llvm::Constant *EmitAnnotationString(StringRef Str);
1276
1277
  /// Emit the annotation's translation unit.
1278
  llvm::Constant *EmitAnnotationUnit(SourceLocation Loc);
1279
1280
  /// Emit the annotation line number.
1281
  llvm::Constant *EmitAnnotationLineNo(SourceLocation L);
1282
1283
  /// Emit additional args of the annotation.
1284
  llvm::Constant *EmitAnnotationArgs(const AnnotateAttr *Attr);
1285
1286
  /// Generate the llvm::ConstantStruct which contains the annotation
1287
  /// information for a given GlobalValue. The annotation struct is
1288
  /// {i8 *, i8 *, i8 *, i32}. The first field is a constant expression, the
1289
  /// GlobalValue being annotated. The second field is the constant string
1290
  /// created from the AnnotateAttr's annotation. The third field is a constant
1291
  /// string containing the name of the translation unit. The fourth field is
1292
  /// the line number in the file of the annotated value declaration.
1293
  llvm::Constant *EmitAnnotateAttr(llvm::GlobalValue *GV,
1294
                                   const AnnotateAttr *AA,
1295
                                   SourceLocation L);
1296
1297
  /// Add global annotations that are set on D, for the global GV. Those
1298
  /// annotations are emitted during finalization of the LLVM code.
1299
  void AddGlobalAnnotations(const ValueDecl *D, llvm::GlobalValue *GV);
1300
1301
  bool isInNoSanitizeList(SanitizerMask Kind, llvm::Function *Fn,
1302
                          SourceLocation Loc) const;
1303
1304
  bool isInNoSanitizeList(llvm::GlobalVariable *GV, SourceLocation Loc,
1305
                          QualType Ty, StringRef Category = StringRef()) const;
1306
1307
  /// Imbue XRay attributes to a function, applying the always/never attribute
1308
  /// lists in the process. Returns true if we did imbue attributes this way,
1309
  /// false otherwise.
1310
  bool imbueXRayAttrs(llvm::Function *Fn, SourceLocation Loc,
1311
                      StringRef Category = StringRef()) const;
1312
1313
  /// Returns true if function at the given location should be excluded from
1314
  /// profile instrumentation.
1315
  bool isProfileInstrExcluded(llvm::Function *Fn, SourceLocation Loc) const;
1316
1317
33.1k
  SanitizerMetadata *getSanitizerMetadata() {
1318
33.1k
    return SanitizerMD.get();
1319
33.1k
  }
1320
1321
3.04k
  void addDeferredVTable(const CXXRecordDecl *RD) {
1322
3.04k
    DeferredVTables.push_back(RD);
1323
3.04k
  }
1324
1325
  /// Emit code for a single global function or var decl. Forward declarations
1326
  /// are emitted lazily.
1327
  void EmitGlobal(GlobalDecl D);
1328
1329
  bool TryEmitBaseDestructorAsAlias(const CXXDestructorDecl *D);
1330
1331
  llvm::GlobalValue *GetGlobalValue(StringRef Ref);
1332
1333
  /// Set attributes which are common to any form of a global definition (alias,
1334
  /// Objective-C method, function, global variable).
1335
  ///
1336
  /// NOTE: This should only be called for definitions.
1337
  void SetCommonAttributes(GlobalDecl GD, llvm::GlobalValue *GV);
1338
1339
  void addReplacement(StringRef Name, llvm::Constant *C);
1340
1341
  void addGlobalValReplacement(llvm::GlobalValue *GV, llvm::Constant *C);
1342
1343
  /// Emit a code for threadprivate directive.
1344
  /// \param D Threadprivate declaration.
1345
  void EmitOMPThreadPrivateDecl(const OMPThreadPrivateDecl *D);
1346
1347
  /// Emit a code for declare reduction construct.
1348
  void EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D,
1349
                               CodeGenFunction *CGF = nullptr);
1350
1351
  /// Emit a code for declare mapper construct.
1352
  void EmitOMPDeclareMapper(const OMPDeclareMapperDecl *D,
1353
                            CodeGenFunction *CGF = nullptr);
1354
1355
  /// Emit a code for requires directive.
1356
  /// \param D Requires declaration
1357
  void EmitOMPRequiresDecl(const OMPRequiresDecl *D);
1358
1359
  /// Emit a code for the allocate directive.
1360
  /// \param D The allocate declaration
1361
  void EmitOMPAllocateDecl(const OMPAllocateDecl *D);
1362
1363
  /// Returns whether the given record has hidden LTO visibility and therefore
1364
  /// may participate in (single-module) CFI and whole-program vtable
1365
  /// optimization.
1366
  bool HasHiddenLTOVisibility(const CXXRecordDecl *RD);
1367
1368
  /// Returns whether the given record has public std LTO visibility
1369
  /// and therefore may not participate in (single-module) CFI and whole-program
1370
  /// vtable optimization.
1371
  bool HasLTOVisibilityPublicStd(const CXXRecordDecl *RD);
1372
1373
  /// Returns the vcall visibility of the given type. This is the scope in which
1374
  /// a virtual function call could be made which ends up being dispatched to a
1375
  /// member function of this class. This scope can be wider than the visibility
1376
  /// of the class itself when the class has a more-visible dynamic base class.
1377
  /// The client should pass in an empty Visited set, which is used to prevent
1378
  /// redundant recursive processing.
1379
  llvm::GlobalObject::VCallVisibility
1380
  GetVCallVisibilityLevel(const CXXRecordDecl *RD,
1381
                          llvm::DenseSet<const CXXRecordDecl *> &Visited);
1382
1383
  /// Emit type metadata for the given vtable using the given layout.
1384
  void EmitVTableTypeMetadata(const CXXRecordDecl *RD,
1385
                              llvm::GlobalVariable *VTable,
1386
                              const VTableLayout &VTLayout);
1387
1388
  /// Generate a cross-DSO type identifier for MD.
1389
  llvm::ConstantInt *CreateCrossDsoCfiTypeId(llvm::Metadata *MD);
1390
1391
  /// Create a metadata identifier for the given type. This may either be an
1392
  /// MDString (for external identifiers) or a distinct unnamed MDNode (for
1393
  /// internal identifiers).
1394
  llvm::Metadata *CreateMetadataIdentifierForType(QualType T);
1395
1396
  /// Create a metadata identifier that is intended to be used to check virtual
1397
  /// calls via a member function pointer.
1398
  llvm::Metadata *CreateMetadataIdentifierForVirtualMemPtrType(QualType T);
1399
1400
  /// Create a metadata identifier for the generalization of the given type.
1401
  /// This may either be an MDString (for external identifiers) or a distinct
1402
  /// unnamed MDNode (for internal identifiers).
1403
  llvm::Metadata *CreateMetadataIdentifierGeneralized(QualType T);
1404
1405
  /// Create and attach type metadata to the given function.
1406
  void CreateFunctionTypeMetadataForIcall(const FunctionDecl *FD,
1407
                                          llvm::Function *F);
1408
1409
  /// Whether this function's return type has no side effects, and thus may
1410
  /// be trivially discarded if it is unused.
1411
  bool MayDropFunctionReturn(const ASTContext &Context, QualType ReturnType);
1412
1413
  /// Returns whether this module needs the "all-vtables" type identifier.
1414
  bool NeedAllVtablesTypeId() const;
1415
1416
  /// Create and attach type metadata for the given vtable.
1417
  void AddVTableTypeMetadata(llvm::GlobalVariable *VTable, CharUnits Offset,
1418
                             const CXXRecordDecl *RD);
1419
1420
  /// Return a vector of most-base classes for RD. This is used to implement
1421
  /// control flow integrity checks for member function pointers.
1422
  ///
1423
  /// A most-base class of a class C is defined as a recursive base class of C,
1424
  /// including C itself, that does not have any bases.
1425
  std::vector<const CXXRecordDecl *>
1426
  getMostBaseClasses(const CXXRecordDecl *RD);
1427
1428
  /// Get the declaration of std::terminate for the platform.
1429
  llvm::FunctionCallee getTerminateFn();
1430
1431
  llvm::SanitizerStatReport &getSanStats();
1432
1433
  llvm::Value *
1434
  createOpenCLIntToSamplerConversion(const Expr *E, CodeGenFunction &CGF);
1435
1436
  /// OpenCL v1.2 s5.6.4.6 allows the compiler to store kernel argument
1437
  /// information in the program executable. The argument information stored
1438
  /// includes the argument name, its type, the address and access qualifiers
1439
  /// used. This helper can be used to generate metadata for source code kernel
1440
  /// function as well as generated implicitly kernels. If a kernel is generated
1441
  /// implicitly null value has to be passed to the last two parameters,
1442
  /// otherwise all parameters must have valid non-null values.
1443
  /// \param FN is a pointer to IR function being generated.
1444
  /// \param FD is a pointer to function declaration if any.
1445
  /// \param CGF is a pointer to CodeGenFunction that generates this function.
1446
  void GenOpenCLArgMetadata(llvm::Function *FN,
1447
                            const FunctionDecl *FD = nullptr,
1448
                            CodeGenFunction *CGF = nullptr);
1449
1450
  /// Get target specific null pointer.
1451
  /// \param T is the LLVM type of the null pointer.
1452
  /// \param QT is the clang QualType of the null pointer.
1453
  llvm::Constant *getNullPointer(llvm::PointerType *T, QualType QT);
1454
1455
  CharUnits getNaturalTypeAlignment(QualType T,
1456
                                    LValueBaseInfo *BaseInfo = nullptr,
1457
                                    TBAAAccessInfo *TBAAInfo = nullptr,
1458
                                    bool forPointeeType = false);
1459
  CharUnits getNaturalPointeeTypeAlignment(QualType T,
1460
                                           LValueBaseInfo *BaseInfo = nullptr,
1461
                                           TBAAAccessInfo *TBAAInfo = nullptr);
1462
  bool stopAutoInit();
1463
1464
  /// Print the postfix for externalized static variable for single source
1465
  /// offloading languages CUDA and HIP.
1466
  void printPostfixForExternalizedStaticVar(llvm::raw_ostream &OS) const;
1467
1468
private:
1469
  llvm::Constant *GetOrCreateLLVMFunction(
1470
      StringRef MangledName, llvm::Type *Ty, GlobalDecl D, bool ForVTable,
1471
      bool DontDefer = false, bool IsThunk = false,
1472
      llvm::AttributeList ExtraAttrs = llvm::AttributeList(),
1473
      ForDefinition_t IsForDefinition = NotForDefinition);
1474
1475
  llvm::Constant *GetOrCreateMultiVersionResolver(GlobalDecl GD,
1476
                                                  llvm::Type *DeclTy,
1477
                                                  const FunctionDecl *FD);
1478
  void UpdateMultiVersionNames(GlobalDecl GD, const FunctionDecl *FD);
1479
1480
  llvm::Constant *
1481
  GetOrCreateLLVMGlobal(StringRef MangledName, llvm::Type *Ty, LangAS AddrSpace,
1482
                        const VarDecl *D,
1483
                        ForDefinition_t IsForDefinition = NotForDefinition);
1484
1485
  bool GetCPUAndFeaturesAttributes(GlobalDecl GD,
1486
                                   llvm::AttrBuilder &AttrBuilder);
1487
  void setNonAliasAttributes(GlobalDecl GD, llvm::GlobalObject *GO);
1488
1489
  /// Set function attributes for a function declaration.
1490
  void SetFunctionAttributes(GlobalDecl GD, llvm::Function *F,
1491
                             bool IsIncompleteFunction, bool IsThunk);
1492
1493
  void EmitGlobalDefinition(GlobalDecl D, llvm::GlobalValue *GV = nullptr);
1494
1495
  void EmitGlobalFunctionDefinition(GlobalDecl GD, llvm::GlobalValue *GV);
1496
  void EmitMultiVersionFunctionDefinition(GlobalDecl GD, llvm::GlobalValue *GV);
1497
1498
  void EmitGlobalVarDefinition(const VarDecl *D, bool IsTentative = false);
1499
  void EmitExternalVarDeclaration(const VarDecl *D);
1500
  void EmitAliasDefinition(GlobalDecl GD);
1501
  void emitIFuncDefinition(GlobalDecl GD);
1502
  void emitCPUDispatchDefinition(GlobalDecl GD);
1503
  void EmitObjCPropertyImplementations(const ObjCImplementationDecl *D);
1504
  void EmitObjCIvarInitializations(ObjCImplementationDecl *D);
1505
1506
  // C++ related functions.
1507
1508
  void EmitDeclContext(const DeclContext *DC);
1509
  void EmitLinkageSpec(const LinkageSpecDecl *D);
1510
1511
  /// Emit the function that initializes C++ thread_local variables.
1512
  void EmitCXXThreadLocalInitFunc();
1513
1514
  /// Emit the function that initializes C++ globals.
1515
  void EmitCXXGlobalInitFunc();
1516
1517
  /// Emit the function that performs cleanup associated with C++ globals.
1518
  void EmitCXXGlobalCleanUpFunc();
1519
1520
  /// Emit the function that initializes the specified global (if PerformInit is
1521
  /// true) and registers its destructor.
1522
  void EmitCXXGlobalVarDeclInitFunc(const VarDecl *D,
1523
                                    llvm::GlobalVariable *Addr,
1524
                                    bool PerformInit);
1525
1526
  void EmitPointerToInitFunc(const VarDecl *VD, llvm::GlobalVariable *Addr,
1527
                             llvm::Function *InitFunc, InitSegAttr *ISA);
1528
1529
  // FIXME: Hardcoding priority here is gross.
1530
  void AddGlobalCtor(llvm::Function *Ctor, int Priority = 65535,
1531
                     llvm::Constant *AssociatedData = nullptr);
1532
  void AddGlobalDtor(llvm::Function *Dtor, int Priority = 65535,
1533
                     bool IsDtorAttrFunc = false);
1534
1535
  /// EmitCtorList - Generates a global array of functions and priorities using
1536
  /// the given list and name. This array will have appending linkage and is
1537
  /// suitable for use as a LLVM constructor or destructor array. Clears Fns.
1538
  void EmitCtorList(CtorList &Fns, const char *GlobalName);
1539
1540
  /// Emit any needed decls for which code generation was deferred.
1541
  void EmitDeferred();
1542
1543
  /// Try to emit external vtables as available_externally if they have emitted
1544
  /// all inlined virtual functions.  It runs after EmitDeferred() and therefore
1545
  /// is not allowed to create new references to things that need to be emitted
1546
  /// lazily.
1547
  void EmitVTablesOpportunistically();
1548
1549
  /// Call replaceAllUsesWith on all pairs in Replacements.
1550
  void applyReplacements();
1551
1552
  /// Call replaceAllUsesWith on all pairs in GlobalValReplacements.
1553
  void applyGlobalValReplacements();
1554
1555
  void checkAliases();
1556
1557
  std::map<int, llvm::TinyPtrVector<llvm::Function *>> DtorsUsingAtExit;
1558
1559
  /// Register functions annotated with __attribute__((destructor)) using
1560
  /// __cxa_atexit, if it is available, or atexit otherwise.
1561
  void registerGlobalDtorsWithAtExit();
1562
1563
  // When using sinit and sterm functions, unregister
1564
  // __attribute__((destructor)) annotated functions which were previously
1565
  // registered by the atexit subroutine using unatexit.
1566
  void unregisterGlobalDtorsWithUnAtExit();
1567
1568
  void emitMultiVersionFunctions();
1569
1570
  /// Emit any vtables which we deferred and still have a use for.
1571
  void EmitDeferredVTables();
1572
1573
  /// Emit a dummy function that reference a CoreFoundation symbol when
1574
  /// @available is used on Darwin.
1575
  void emitAtAvailableLinkGuard();
1576
1577
  /// Emit the llvm.used and llvm.compiler.used metadata.
1578
  void emitLLVMUsed();
1579
1580
  /// Emit the link options introduced by imported modules.
1581
  void EmitModuleLinkOptions();
1582
1583
  /// Emit aliases for internal-linkage declarations inside "C" language
1584
  /// linkage specifications, giving them the "expected" name where possible.
1585
  void EmitStaticExternCAliases();
1586
1587
  void EmitDeclMetadata();
1588
1589
  /// Emit the Clang version as llvm.ident metadata.
1590
  void EmitVersionIdentMetadata();
1591
1592
  /// Emit the Clang commandline as llvm.commandline metadata.
1593
  void EmitCommandLineMetadata();
1594
1595
  /// Emit the module flag metadata used to pass options controlling the
1596
  /// the backend to LLVM.
1597
  void EmitBackendOptionsMetadata(const CodeGenOptions CodeGenOpts);
1598
1599
  /// Emits OpenCL specific Metadata e.g. OpenCL version.
1600
  void EmitOpenCLMetadata();
1601
1602
  /// Emit the llvm.gcov metadata used to tell LLVM where to emit the .gcno and
1603
  /// .gcda files in a way that persists in .bc files.
1604
  void EmitCoverageFile();
1605
1606
  /// Determine whether the definition must be emitted; if this returns \c
1607
  /// false, the definition can be emitted lazily if it's used.
1608
  bool MustBeEmitted(const ValueDecl *D);
1609
1610
  /// Determine whether the definition can be emitted eagerly, or should be
1611
  /// delayed until the end of the translation unit. This is relevant for
1612
  /// definitions whose linkage can change, e.g. implicit function instantions
1613
  /// which may later be explicitly instantiated.
1614
  bool MayBeEmittedEagerly(const ValueDecl *D);
1615
1616
  /// Check whether we can use a "simpler", more core exceptions personality
1617
  /// function.
1618
  void SimplifyPersonality();
1619
1620
  /// Helper function for ConstructAttributeList and
1621
  /// addDefaultFunctionDefinitionAttributes.  Builds a set of function
1622
  /// attributes to add to a function with the given properties.
1623
  void getDefaultFunctionAttributes(StringRef Name, bool HasOptnone,
1624
                                    bool AttrOnCallSite,
1625
                                    llvm::AttrBuilder &FuncAttrs);
1626
1627
  llvm::Metadata *CreateMetadataIdentifierImpl(QualType T, MetadataTypeMap &Map,
1628
                                               StringRef Suffix);
1629
};
1630
1631
}  // end namespace CodeGen
1632
}  // end namespace clang
1633
1634
#endif // LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H