Coverage Report

Created: 2019-07-24 05:18

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