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