granicus.if.org Git - clang/blob - lib/CodeGen/CodeGenModule.h

   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"
  28 #include "clang/Basic/LangOptions.h"
  29 #include "clang/Basic/Module.h"
  30 #include "clang/Basic/SanitizerBlacklist.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 struct OrderGlobalInits {
  98   unsigned int priority;
  99   unsigned int lex_order;
 100   OrderGlobalInits(unsigned int p, unsigned int l)
 101       : priority(p), lex_order(l) {}
 102
 103   bool operator==(const OrderGlobalInits &RHS) const {
 104     return priority == RHS.priority && lex_order == RHS.lex_order;
 105   }
 106
 107   bool operator<(const OrderGlobalInits &RHS) const {
 108     return std::tie(priority, lex_order) <
 109            std::tie(RHS.priority, RHS.lex_order);
 110   }
 111 };
 112
 113 struct ObjCEntrypoints {
 114   ObjCEntrypoints() { memset(this, 0, sizeof(*this)); }
 115
 116     /// void objc_autoreleasePoolPop(void*);
 117   llvm::Constant *objc_autoreleasePoolPop;
 118
 119   /// void *objc_autoreleasePoolPush(void);
 120   llvm::Constant *objc_autoreleasePoolPush;
 121
 122   /// id objc_autorelease(id);
 123   llvm::Constant *objc_autorelease;
 124
 125   /// id objc_autoreleaseReturnValue(id);
 126   llvm::Constant *objc_autoreleaseReturnValue;
 127
 128   /// void objc_copyWeak(id *dest, id *src);
 129   llvm::Constant *objc_copyWeak;
 130
 131   /// void objc_destroyWeak(id*);
 132   llvm::Constant *objc_destroyWeak;
 133
 134   /// id objc_initWeak(id*, id);
 135   llvm::Constant *objc_initWeak;
 136
 137   /// id objc_loadWeak(id*);
 138   llvm::Constant *objc_loadWeak;
 139
 140   /// id objc_loadWeakRetained(id*);
 141   llvm::Constant *objc_loadWeakRetained;
 142
 143   /// void objc_moveWeak(id *dest, id *src);
 144   llvm::Constant *objc_moveWeak;
 145
 146   /// id objc_retain(id);
 147   llvm::Constant *objc_retain;
 148
 149   /// id objc_retainAutorelease(id);
 150   llvm::Constant *objc_retainAutorelease;
 151
 152   /// id objc_retainAutoreleaseReturnValue(id);
 153   llvm::Constant *objc_retainAutoreleaseReturnValue;
 154
 155   /// id objc_retainAutoreleasedReturnValue(id);
 156   llvm::Constant *objc_retainAutoreleasedReturnValue;
 157
 158   /// id objc_retainBlock(id);
 159   llvm::Constant *objc_retainBlock;
 160
 161   /// void objc_release(id);
 162   llvm::Constant *objc_release;
 163
 164   /// id objc_storeStrong(id*, id);
 165   llvm::Constant *objc_storeStrong;
 166
 167   /// id objc_storeWeak(id*, id);
 168   llvm::Constant *objc_storeWeak;
 169
 170   /// id objc_unsafeClaimAutoreleasedReturnValue(id);
 171   llvm::Constant *objc_unsafeClaimAutoreleasedReturnValue;
 172
 173   /// A void(void) inline asm to use to mark that the return value of
 174   /// a call will be immediately retain.
 175   llvm::InlineAsm *retainAutoreleasedReturnValueMarker;
 176
 177   /// void clang.arc.use(...);
 178   llvm::Constant *clang_arc_use;
 179 };
 180
 181 /// This class records statistics on instrumentation based profiling.
 182 class InstrProfStats {
 183   uint32_t VisitedInMainFile;
 184   uint32_t MissingInMainFile;
 185   uint32_t Visited;
 186   uint32_t Missing;
 187   uint32_t Mismatched;
 188
 189 public:
 190   InstrProfStats()
 191       : VisitedInMainFile(0), MissingInMainFile(0), Visited(0), Missing(0),
 192         Mismatched(0) {}
 193   /// Record that we've visited a function and whether or not that function was
 194   /// in the main source file.
 195   void addVisited(bool MainFile) {
 196     if (MainFile)
 197       ++VisitedInMainFile;
 198     ++Visited;
 199   }
 200   /// Record that a function we've visited has no profile data.
 201   void addMissing(bool MainFile) {
 202     if (MainFile)
 203       ++MissingInMainFile;
 204     ++Missing;
 205   }
 206   /// Record that a function we've visited has mismatched profile data.
 207   void addMismatched(bool MainFile) { ++Mismatched; }
 208   /// Whether or not the stats we've gathered indicate any potential problems.
 209   bool hasDiagnostics() { return Missing || Mismatched; }
 210   /// Report potential problems we've found to \c Diags.
 211   void reportDiagnostics(DiagnosticsEngine &Diags, StringRef MainFile);
 212 };
 213
 214 /// A pair of helper functions for a __block variable.
 215 class BlockByrefHelpers : public llvm::FoldingSetNode {
 216   // MSVC requires this type to be complete in order to process this
 217   // header.
 218 public:
 219   llvm::Constant *CopyHelper;
 220   llvm::Constant *DisposeHelper;
 221
 222   /// The alignment of the field.  This is important because
 223   /// different offsets to the field within the byref struct need to
 224   /// have different helper functions.
 225   CharUnits Alignment;
 226
 227   BlockByrefHelpers(CharUnits alignment) : Alignment(alignment) {}
 228   BlockByrefHelpers(const BlockByrefHelpers &) = default;
 229   virtual ~BlockByrefHelpers();
 230
 231   void Profile(llvm::FoldingSetNodeID &id) const {
 232     id.AddInteger(Alignment.getQuantity());
 233     profileImpl(id);
 234   }
 235   virtual void profileImpl(llvm::FoldingSetNodeID &id) const = 0;
 236
 237   virtual bool needsCopy() const { return true; }
 238   virtual void emitCopy(CodeGenFunction &CGF, Address dest, Address src) = 0;
 239
 240   virtual bool needsDispose() const { return true; }
 241   virtual void emitDispose(CodeGenFunction &CGF, Address field) = 0;
 242 };
 243
 244 /// This class organizes the cross-function state that is used while generating
 245 /// LLVM code.
 246 class CodeGenModule : public CodeGenTypeCache {
 247   CodeGenModule(const CodeGenModule &) = delete;
 248   void operator=(const CodeGenModule &) = delete;
 249
 250 public:
 251   struct Structor {
 252     Structor() : Priority(0), Initializer(nullptr), AssociatedData(nullptr) {}
 253     Structor(int Priority, llvm::Constant *Initializer,
 254              llvm::Constant *AssociatedData)
 255         : Priority(Priority), Initializer(Initializer),
 256           AssociatedData(AssociatedData) {}
 257     int Priority;
 258     llvm::Constant *Initializer;
 259     llvm::Constant *AssociatedData;
 260   };
 261
 262   typedef std::vector<Structor> CtorList;
 263
 264 private:
 265   ASTContext &Context;
 266   const LangOptions &LangOpts;
 267   const HeaderSearchOptions &HeaderSearchOpts; // Only used for debug info.
 268   const PreprocessorOptions &PreprocessorOpts; // Only used for debug info.
 269   const CodeGenOptions &CodeGenOpts;
 270   llvm::Module &TheModule;
 271   DiagnosticsEngine &Diags;
 272   const TargetInfo &Target;
 273   std::unique_ptr<CGCXXABI> ABI;
 274   llvm::LLVMContext &VMContext;
 275
 276   std::unique_ptr<CodeGenTBAA> TBAA;
 277
 278   mutable std::unique_ptr<TargetCodeGenInfo> TheTargetCodeGenInfo;
 279
 280   // This should not be moved earlier, since its initialization depends on some
 281   // of the previous reference members being already initialized and also checks
 282   // if TheTargetCodeGenInfo is NULL
 283   CodeGenTypes Types;
 284
 285   /// Holds information about C++ vtables.
 286   CodeGenVTables VTables;
 287
 288   std::unique_ptr<CGObjCRuntime> ObjCRuntime;
 289   std::unique_ptr<CGOpenCLRuntime> OpenCLRuntime;
 290   std::unique_ptr<CGOpenMPRuntime> OpenMPRuntime;
 291   std::unique_ptr<CGCUDARuntime> CUDARuntime;
 292   std::unique_ptr<CGDebugInfo> DebugInfo;
 293   std::unique_ptr<ObjCEntrypoints> ObjCData;
 294   llvm::MDNode *NoObjCARCExceptionsMetadata = nullptr;
 295   std::unique_ptr<llvm::IndexedInstrProfReader> PGOReader;
 296   InstrProfStats PGOStats;
 297   std::unique_ptr<llvm::SanitizerStatReport> SanStats;
 298
 299   // A set of references that have only been seen via a weakref so far. This is
 300   // used to remove the weak of the reference if we ever see a direct reference
 301   // or a definition.
 302   llvm::SmallPtrSet<llvm::GlobalValue*, 10> WeakRefReferences;
 303
 304   /// This contains all the decls which have definitions but/ which are deferred
 305   /// for emission and therefore should only be output if they are actually
 306   /// used. If a decl is in this, then it is known to have not been referenced
 307   /// yet.
 308   std::map<StringRef, GlobalDecl> DeferredDecls;
 309
 310   /// This is a list of deferred decls which we have seen that *are* actually
 311   /// referenced. These get code generated when the module is done.
 312   struct DeferredGlobal {
 313     DeferredGlobal(llvm::GlobalValue *GV, GlobalDecl GD) : GV(GV), GD(GD) {}
 314     llvm::TrackingVH<llvm::GlobalValue> GV;
 315     GlobalDecl GD;
 316   };
 317   std::vector<DeferredGlobal> DeferredDeclsToEmit;
 318   void addDeferredDeclToEmit(llvm::GlobalValue *GV, GlobalDecl GD) {
 319     DeferredDeclsToEmit.emplace_back(GV, GD);
 320   }
 321
 322   /// List of alias we have emitted. Used to make sure that what they point to
 323   /// is defined once we get to the end of the of the translation unit.
 324   std::vector<GlobalDecl> Aliases;
 325
 326   typedef llvm::StringMap<llvm::TrackingVH<llvm::Constant> > ReplacementsTy;
 327   ReplacementsTy Replacements;
 328
 329   /// List of global values to be replaced with something else. Used when we
 330   /// want to replace a GlobalValue but can't identify it by its mangled name
 331   /// anymore (because the name is already taken).
 332   llvm::SmallVector<std::pair<llvm::GlobalValue *, llvm::Constant *>, 8>
 333     GlobalValReplacements;
 334
 335   /// Set of global decls for which we already diagnosed mangled name conflict.
 336   /// Required to not issue a warning (on a mangling conflict) multiple times
 337   /// for the same decl.
 338   llvm::DenseSet<GlobalDecl> DiagnosedConflictingDefinitions;
 339
 340   /// A queue of (optional) vtables to consider emitting.
 341   std::vector<const CXXRecordDecl*> DeferredVTables;
 342
 343   /// List of global values which are required to be present in the object file;
 344   /// bitcast to i8*. This is used for forcing visibility of symbols which may
 345   /// otherwise be optimized out.
 346   std::vector<llvm::WeakVH> LLVMUsed;
 347   std::vector<llvm::WeakVH> LLVMCompilerUsed;
 348
 349   /// Store the list of global constructors and their respective priorities to
 350   /// be emitted when the translation unit is complete.
 351   CtorList GlobalCtors;
 352
 353   /// Store the list of global destructors and their respective priorities to be
 354   /// emitted when the translation unit is complete.
 355   CtorList GlobalDtors;
 356
 357   /// An ordered map of canonical GlobalDecls to their mangled names.
 358   llvm::MapVector<GlobalDecl, StringRef> MangledDeclNames;
 359   llvm::StringMap<GlobalDecl, llvm::BumpPtrAllocator> Manglings;
 360
 361   /// Global annotations.
 362   std::vector<llvm::Constant*> Annotations;
 363
 364   /// Map used to get unique annotation strings.
 365   llvm::StringMap<llvm::Constant*> AnnotationStrings;
 366
 367   llvm::StringMap<llvm::GlobalVariable *> CFConstantStringMap;
 368
 369   llvm::DenseMap<llvm::Constant *, llvm::GlobalVariable *> ConstantStringMap;
 370   llvm::DenseMap<const Decl*, llvm::Constant *> StaticLocalDeclMap;
 371   llvm::DenseMap<const Decl*, llvm::GlobalVariable*> StaticLocalDeclGuardMap;
 372   llvm::DenseMap<const Expr*, llvm::Constant *> MaterializedGlobalTemporaryMap;
 373
 374   llvm::DenseMap<QualType, llvm::Constant *> AtomicSetterHelperFnMap;
 375   llvm::DenseMap<QualType, llvm::Constant *> AtomicGetterHelperFnMap;
 376
 377   /// Map used to get unique type descriptor constants for sanitizers.
 378   llvm::DenseMap<QualType, llvm::Constant *> TypeDescriptorMap;
 379
 380   /// Map used to track internal linkage functions declared within
 381   /// extern "C" regions.
 382   typedef llvm::MapVector<IdentifierInfo *,
 383                           llvm::GlobalValue *> StaticExternCMap;
 384   StaticExternCMap StaticExternCValues;
 385
 386   /// \brief thread_local variables defined or used in this TU.
 387   std::vector<const VarDecl *> CXXThreadLocals;
 388
 389   /// \brief thread_local variables with initializers that need to run
 390   /// before any thread_local variable in this TU is odr-used.
 391   std::vector<llvm::Function *> CXXThreadLocalInits;
 392   std::vector<const VarDecl *> CXXThreadLocalInitVars;
 393
 394   /// Global variables with initializers that need to run before main.
 395   std::vector<llvm::Function *> CXXGlobalInits;
 396
 397   /// When a C++ decl with an initializer is deferred, null is
 398   /// appended to CXXGlobalInits, and the index of that null is placed
 399   /// here so that the initializer will be performed in the correct
 400   /// order. Once the decl is emitted, the index is replaced with ~0U to ensure
 401   /// that we don't re-emit the initializer.
 402   llvm::DenseMap<const Decl*, unsigned> DelayedCXXInitPosition;
 403
 404   typedef std::pair<OrderGlobalInits, llvm::Function*> GlobalInitData;
 405
 406   struct GlobalInitPriorityCmp {
 407     bool operator()(const GlobalInitData &LHS,
 408                     const GlobalInitData &RHS) const {
 409       return LHS.first.priority < RHS.first.priority;
 410     }
 411   };
 412
 413   /// Global variables with initializers whose order of initialization is set by
 414   /// init_priority attribute.
 415   SmallVector<GlobalInitData, 8> PrioritizedCXXGlobalInits;
 416
 417   /// Global destructor functions and arguments that need to run on termination.
 418   std::vector<std::pair<llvm::WeakVH,llvm::Constant*> > CXXGlobalDtors;
 419
 420   /// \brief The complete set of modules that has been imported.
 421   llvm::SetVector<clang::Module *> ImportedModules;
 422
 423   /// \brief A vector of metadata strings.
 424   SmallVector<llvm::Metadata *, 16> LinkerOptionsMetadata;
 425
 426   /// @name Cache for Objective-C runtime types
 427   /// @{
 428
 429   /// Cached reference to the class for constant strings. This value has type
 430   /// int * but is actually an Obj-C class pointer.
 431   llvm::WeakVH CFConstantStringClassRef;
 432
 433   /// Cached reference to the class for constant strings. This value has type
 434   /// int * but is actually an Obj-C class pointer.
 435   llvm::WeakVH ConstantStringClassRef;
 436
 437   /// \brief The LLVM type corresponding to NSConstantString.
 438   llvm::StructType *NSConstantStringType = nullptr;
 439
 440   /// \brief The type used to describe the state of a fast enumeration in
 441   /// Objective-C's for..in loop.
 442   QualType ObjCFastEnumerationStateType;
 443
 444   /// @}
 445
 446   /// Lazily create the Objective-C runtime
 447   void createObjCRuntime();
 448
 449   void createOpenCLRuntime();
 450   void createOpenMPRuntime();
 451   void createCUDARuntime();
 452
 453   bool isTriviallyRecursive(const FunctionDecl *F);
 454   bool shouldEmitFunction(GlobalDecl GD);
 455
 456   /// @name Cache for Blocks Runtime Globals
 457   /// @{
 458
 459   llvm::Constant *NSConcreteGlobalBlock = nullptr;
 460   llvm::Constant *NSConcreteStackBlock = nullptr;
 461
 462   llvm::Constant *BlockObjectAssign = nullptr;
 463   llvm::Constant *BlockObjectDispose = nullptr;
 464
 465   llvm::Type *BlockDescriptorType = nullptr;
 466   llvm::Type *GenericBlockLiteralType = nullptr;
 467
 468   struct {
 469     int GlobalUniqueCount;
 470   } Block;
 471
 472   /// void @llvm.lifetime.start(i64 %size, i8* nocapture <ptr>)
 473   llvm::Constant *LifetimeStartFn = nullptr;
 474
 475   /// void @llvm.lifetime.end(i64 %size, i8* nocapture <ptr>)
 476   llvm::Constant *LifetimeEndFn = nullptr;
 477
 478   GlobalDecl initializedGlobalDecl;
 479
 480   std::unique_ptr<SanitizerMetadata> SanitizerMD;
 481
 482   /// @}
 483
 484   llvm::DenseMap<const Decl *, bool> DeferredEmptyCoverageMappingDecls;
 485
 486   std::unique_ptr<CoverageMappingModuleGen> CoverageMapping;
 487
 488   /// Mapping from canonical types to their metadata identifiers. We need to
 489   /// maintain this mapping because identifiers may be formed from distinct
 490   /// MDNodes.
 491   llvm::DenseMap<QualType, llvm::Metadata *> MetadataIdMap;
 492
 493   /// Diags gathered from FunctionDecl::takeDeferredDiags().  Emitted at the
 494   /// very end of codegen.
 495   std::vector<std::pair<SourceLocation, PartialDiagnostic>> DeferredDiags;
 496
 497 public:
 498   CodeGenModule(ASTContext &C, const HeaderSearchOptions &headersearchopts,
 499                 const PreprocessorOptions &ppopts,
 500                 const CodeGenOptions &CodeGenOpts, llvm::Module &M,
 501                 DiagnosticsEngine &Diags,
 502                 CoverageSourceInfo *CoverageInfo = nullptr);
 503
 504   ~CodeGenModule();
 505
 506   void clear();
 507
 508   /// Finalize LLVM code generation.
 509   void Release();
 510
 511   /// Return a reference to the configured Objective-C runtime.
 512   CGObjCRuntime &getObjCRuntime() {
 513     if (!ObjCRuntime) createObjCRuntime();
 514     return *ObjCRuntime;
 515   }
 516
 517   /// Return true iff an Objective-C runtime has been configured.
 518   bool hasObjCRuntime() { return !!ObjCRuntime; }
 519
 520   /// Return a reference to the configured OpenCL runtime.
 521   CGOpenCLRuntime &getOpenCLRuntime() {
 522     assert(OpenCLRuntime != nullptr);
 523     return *OpenCLRuntime;
 524   }
 525
 526   /// Return a reference to the configured OpenMP runtime.
 527   CGOpenMPRuntime &getOpenMPRuntime() {
 528     assert(OpenMPRuntime != nullptr);
 529     return *OpenMPRuntime;
 530   }
 531
 532   /// Return a reference to the configured CUDA runtime.
 533   CGCUDARuntime &getCUDARuntime() {
 534     assert(CUDARuntime != nullptr);
 535     return *CUDARuntime;
 536   }
 537
 538   ObjCEntrypoints &getObjCEntrypoints() const {
 539     assert(ObjCData != nullptr);
 540     return *ObjCData;
 541   }
 542
 543   InstrProfStats &getPGOStats() { return PGOStats; }
 544   llvm::IndexedInstrProfReader *getPGOReader() const { return PGOReader.get(); }
 545
 546   CoverageMappingModuleGen *getCoverageMapping() const {
 547     return CoverageMapping.get();
 548   }
 549
 550   llvm::Constant *getStaticLocalDeclAddress(const VarDecl *D) {
 551     return StaticLocalDeclMap[D];
 552   }
 553   void setStaticLocalDeclAddress(const VarDecl *D,
 554                                  llvm::Constant *C) {
 555     StaticLocalDeclMap[D] = C;
 556   }
 557
 558   llvm::Constant *
 559   getOrCreateStaticVarDecl(const VarDecl &D,
 560                            llvm::GlobalValue::LinkageTypes Linkage);
 561
 562   llvm::GlobalVariable *getStaticLocalDeclGuardAddress(const VarDecl *D) {
 563     return StaticLocalDeclGuardMap[D];
 564   }
 565   void setStaticLocalDeclGuardAddress(const VarDecl *D,
 566                                       llvm::GlobalVariable *C) {
 567     StaticLocalDeclGuardMap[D] = C;
 568   }
 569
 570   bool lookupRepresentativeDecl(StringRef MangledName,
 571                                 GlobalDecl &Result) const;
 572
 573   llvm::Constant *getAtomicSetterHelperFnMap(QualType Ty) {
 574     return AtomicSetterHelperFnMap[Ty];
 575   }
 576   void setAtomicSetterHelperFnMap(QualType Ty,
 577                             llvm::Constant *Fn) {
 578     AtomicSetterHelperFnMap[Ty] = Fn;
 579   }
 580
 581   llvm::Constant *getAtomicGetterHelperFnMap(QualType Ty) {
 582     return AtomicGetterHelperFnMap[Ty];
 583   }
 584   void setAtomicGetterHelperFnMap(QualType Ty,
 585                             llvm::Constant *Fn) {
 586     AtomicGetterHelperFnMap[Ty] = Fn;
 587   }
 588
 589   llvm::Constant *getTypeDescriptorFromMap(QualType Ty) {
 590     return TypeDescriptorMap[Ty];
 591   }
 592   void setTypeDescriptorInMap(QualType Ty, llvm::Constant *C) {
 593     TypeDescriptorMap[Ty] = C;
 594   }
 595
 596   CGDebugInfo *getModuleDebugInfo() { return DebugInfo.get(); }
 597
 598   llvm::MDNode *getNoObjCARCExceptionsMetadata() {
 599     if (!NoObjCARCExceptionsMetadata)
 600       NoObjCARCExceptionsMetadata = llvm::MDNode::get(getLLVMContext(), None);
 601     return NoObjCARCExceptionsMetadata;
 602   }
 603
 604   ASTContext &getContext() const { return Context; }
 605   const LangOptions &getLangOpts() const { return LangOpts; }
 606   const HeaderSearchOptions &getHeaderSearchOpts()
 607     const { return HeaderSearchOpts; }
 608   const PreprocessorOptions &getPreprocessorOpts()
 609     const { return PreprocessorOpts; }
 610   const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; }
 611   llvm::Module &getModule() const { return TheModule; }
 612   DiagnosticsEngine &getDiags() const { return Diags; }
 613   const llvm::DataLayout &getDataLayout() const {
 614     return TheModule.getDataLayout();
 615   }
 616   const TargetInfo &getTarget() const { return Target; }
 617   const llvm::Triple &getTriple() const;
 618   bool supportsCOMDAT() const;
 619   void maybeSetTrivialComdat(const Decl &D, llvm::GlobalObject &GO);
 620
 621   CGCXXABI &getCXXABI() const { return *ABI; }
 622   llvm::LLVMContext &getLLVMContext() { return VMContext; }
 623
 624   bool shouldUseTBAA() const { return TBAA != nullptr; }
 625
 626   const TargetCodeGenInfo &getTargetCodeGenInfo();
 627
 628   CodeGenTypes &getTypes() { return Types; }
 629
 630   CodeGenVTables &getVTables() { return VTables; }
 631
 632   ItaniumVTableContext &getItaniumVTableContext() {
 633     return VTables.getItaniumVTableContext();
 634   }
 635
 636   MicrosoftVTableContext &getMicrosoftVTableContext() {
 637     return VTables.getMicrosoftVTableContext();
 638   }
 639
 640   CtorList &getGlobalCtors() { return GlobalCtors; }
 641   CtorList &getGlobalDtors() { return GlobalDtors; }
 642
 643   llvm::MDNode *getTBAAInfo(QualType QTy);
 644   llvm::MDNode *getTBAAInfoForVTablePtr();
 645   llvm::MDNode *getTBAAStructInfo(QualType QTy);
 646   /// Return the path-aware tag for given base type, access node and offset.
 647   llvm::MDNode *getTBAAStructTagInfo(QualType BaseTy, llvm::MDNode *AccessN,
 648                                      uint64_t O);
 649
 650   bool isTypeConstant(QualType QTy, bool ExcludeCtorDtor);
 651
 652   bool isPaddedAtomicType(QualType type);
 653   bool isPaddedAtomicType(const AtomicType *type);
 654
 655   /// Decorate the instruction with a TBAA tag. For scalar TBAA, the tag
 656   /// is the same as the type. For struct-path aware TBAA, the tag
 657   /// is different from the type: base type, access type and offset.
 658   /// When ConvertTypeToTag is true, we create a tag based on the scalar type.
 659   void DecorateInstructionWithTBAA(llvm::Instruction *Inst,
 660                                    llvm::MDNode *TBAAInfo,
 661                                    bool ConvertTypeToTag = true);
 662
 663   /// Adds !invariant.barrier !tag to instruction
 664   void DecorateInstructionWithInvariantGroup(llvm::Instruction *I,
 665                                              const CXXRecordDecl *RD);
 666
 667   /// Emit the given number of characters as a value of type size_t.
 668   llvm::ConstantInt *getSize(CharUnits numChars);
 669
 670   /// Set the visibility for the given LLVM GlobalValue.
 671   void setGlobalVisibility(llvm::GlobalValue *GV, const NamedDecl *D) const;
 672
 673   /// Set the TLS mode for the given LLVM GlobalValue for the thread-local
 674   /// variable declaration D.
 675   void setTLSMode(llvm::GlobalValue *GV, const VarDecl &D) const;
 676
 677   static llvm::GlobalValue::VisibilityTypes GetLLVMVisibility(Visibility V) {
 678     switch (V) {
 679     case DefaultVisibility:   return llvm::GlobalValue::DefaultVisibility;
 680     case HiddenVisibility:    return llvm::GlobalValue::HiddenVisibility;
 681     case ProtectedVisibility: return llvm::GlobalValue::ProtectedVisibility;
 682     }
 683     llvm_unreachable("unknown visibility!");
 684   }
 685
 686   llvm::Constant *GetAddrOfGlobal(GlobalDecl GD, bool IsForDefinition = false);
 687
 688   /// Will return a global variable of the given type. If a variable with a
 689   /// different type already exists then a new  variable with the right type
 690   /// will be created and all uses of the old variable will be replaced with a
 691   /// bitcast to the new variable.
 692   llvm::GlobalVariable *
 693   CreateOrReplaceCXXRuntimeVariable(StringRef Name, llvm::Type *Ty,
 694                                     llvm::GlobalValue::LinkageTypes Linkage);
 695
 696   llvm::Function *
 697   CreateGlobalInitOrDestructFunction(llvm::FunctionType *ty, const Twine &name,
 698                                      const CGFunctionInfo &FI,
 699                                      SourceLocation Loc = SourceLocation(),
 700                                      bool TLS = false);
 701
 702   /// Return the address space of the underlying global variable for D, as
 703   /// determined by its declaration. Normally this is the same as the address
 704   /// space of D's type, but in CUDA, address spaces are associated with
 705   /// declarations, not types.
 706   unsigned GetGlobalVarAddressSpace(const VarDecl *D, unsigned AddrSpace);
 707
 708   /// Return the llvm::Constant for the address of the given global variable.
 709   /// If Ty is non-null and if the global doesn't exist, then it will be created
 710   /// with the specified type instead of whatever the normal requested type
 711   /// would be. If IsForDefinition is true, it is guranteed that an actual
 712   /// global with type Ty will be returned, not conversion of a variable with
 713   /// the same mangled name but some other type.
 714   llvm::Constant *GetAddrOfGlobalVar(const VarDecl *D,
 715                                      llvm::Type *Ty = nullptr,
 716                                      bool IsForDefinition = false);
 717
 718   /// Return the address of the given function. If Ty is non-null, then this
 719   /// function will use the specified type if it has to create it.
 720   llvm::Constant *GetAddrOfFunction(GlobalDecl GD, llvm::Type *Ty = nullptr,
 721                                     bool ForVTable = false,
 722                                     bool DontDefer = false,
 723                                     bool IsForDefinition = false);
 724
 725   /// Get the address of the RTTI descriptor for the given type.
 726   llvm::Constant *GetAddrOfRTTIDescriptor(QualType Ty, bool ForEH = false);
 727
 728   /// Get the address of a uuid descriptor .
 729   ConstantAddress GetAddrOfUuidDescriptor(const CXXUuidofExpr* E);
 730
 731   /// Get the address of the thunk for the given global decl.
 732   llvm::Constant *GetAddrOfThunk(GlobalDecl GD, const ThunkInfo &Thunk);
 733
 734   /// Get a reference to the target of VD.
 735   ConstantAddress GetWeakRefReference(const ValueDecl *VD);
 736
 737   /// Returns the assumed alignment of an opaque pointer to the given class.
 738   CharUnits getClassPointerAlignment(const CXXRecordDecl *CD);
 739
 740   /// Returns the assumed alignment of a virtual base of a class.
 741   CharUnits getVBaseAlignment(CharUnits DerivedAlign,
 742                               const CXXRecordDecl *Derived,
 743                               const CXXRecordDecl *VBase);
 744
 745   /// Given a class pointer with an actual known alignment, and the
 746   /// expected alignment of an object at a dynamic offset w.r.t that
 747   /// pointer, return the alignment to assume at the offset.
 748   CharUnits getDynamicOffsetAlignment(CharUnits ActualAlign,
 749                                       const CXXRecordDecl *Class,
 750                                       CharUnits ExpectedTargetAlign);
 751
 752   CharUnits
 753   computeNonVirtualBaseClassOffset(const CXXRecordDecl *DerivedClass,
 754                                    CastExpr::path_const_iterator Start,
 755                                    CastExpr::path_const_iterator End);
 756
 757   /// Returns the offset from a derived class to  a class. Returns null if the
 758   /// offset is 0.
 759   llvm::Constant *
 760   GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl,
 761                                CastExpr::path_const_iterator PathBegin,
 762                                CastExpr::path_const_iterator PathEnd);
 763
 764   llvm::FoldingSet<BlockByrefHelpers> ByrefHelpersCache;
 765
 766   /// Fetches the global unique block count.
 767   int getUniqueBlockCount() { return ++Block.GlobalUniqueCount; }
 768
 769   /// Fetches the type of a generic block descriptor.
 770   llvm::Type *getBlockDescriptorType();
 771
 772   /// The type of a generic block literal.
 773   llvm::Type *getGenericBlockLiteralType();
 774
 775   /// Gets the address of a block which requires no captures.
 776   llvm::Constant *GetAddrOfGlobalBlock(const BlockExpr *BE, const char *);
 777
 778   /// Return a pointer to a constant CFString object for the given string.
 779   ConstantAddress GetAddrOfConstantCFString(const StringLiteral *Literal);
 780
 781   /// Return a pointer to a constant NSString object for the given string. Or a
 782   /// user defined String object as defined via
 783   /// -fconstant-string-class=class_name option.
 784   ConstantAddress GetAddrOfConstantString(const StringLiteral *Literal);
 785
 786   /// Return a constant array for the given string.
 787   llvm::Constant *GetConstantArrayFromStringLiteral(const StringLiteral *E);
 788
 789   /// Return a pointer to a constant array for the given string literal.
 790   ConstantAddress
 791   GetAddrOfConstantStringFromLiteral(const StringLiteral *S,
 792                                      StringRef Name = ".str");
 793
 794   /// Return a pointer to a constant array for the given ObjCEncodeExpr node.
 795   ConstantAddress
 796   GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *);
 797
 798   /// Returns a pointer to a character array containing the literal and a
 799   /// terminating '\0' character. The result has pointer to array type.
 800   ///
 801   /// \param GlobalName If provided, the name to use for the global (if one is
 802   /// created).
 803   ConstantAddress
 804   GetAddrOfConstantCString(const std::string &Str,
 805                            const char *GlobalName = nullptr);
 806
 807   /// Returns a pointer to a constant global variable for the given file-scope
 808   /// compound literal expression.
 809   ConstantAddress GetAddrOfConstantCompoundLiteral(const CompoundLiteralExpr*E);
 810
 811   /// \brief Returns a pointer to a global variable representing a temporary
 812   /// with static or thread storage duration.
 813   ConstantAddress GetAddrOfGlobalTemporary(const MaterializeTemporaryExpr *E,
 814                                            const Expr *Inner);
 815
 816   /// \brief Retrieve the record type that describes the state of an
 817   /// Objective-C fast enumeration loop (for..in).
 818   QualType getObjCFastEnumerationStateType();
 819
 820   // Produce code for this constructor/destructor. This method doesn't try
 821   // to apply any ABI rules about which other constructors/destructors
 822   // are needed or if they are alias to each other.
 823   llvm::Function *codegenCXXStructor(const CXXMethodDecl *MD,
 824                                      StructorType Type);
 825
 826   /// Return the address of the constructor/destructor of the given type.
 827   llvm::Constant *
 828   getAddrOfCXXStructor(const CXXMethodDecl *MD, StructorType Type,
 829                        const CGFunctionInfo *FnInfo = nullptr,
 830                        llvm::FunctionType *FnType = nullptr,
 831                        bool DontDefer = false, bool IsForDefinition = false);
 832
 833   /// Given a builtin id for a function like "__builtin_fabsf", return a
 834   /// Function* for "fabsf".
 835   llvm::Value *getBuiltinLibFunction(const FunctionDecl *FD,
 836                                      unsigned BuiltinID);
 837
 838   llvm::Function *getIntrinsic(unsigned IID, ArrayRef<llvm::Type*> Tys = None);
 839
 840   /// Emit code for a single top level declaration.
 841   void EmitTopLevelDecl(Decl *D);
 842
 843   /// \brief Stored a deferred empty coverage mapping for an unused
 844   /// and thus uninstrumented top level declaration.
 845   void AddDeferredUnusedCoverageMapping(Decl *D);
 846
 847   /// \brief Remove the deferred empty coverage mapping as this
 848   /// declaration is actually instrumented.
 849   void ClearUnusedCoverageMapping(const Decl *D);
 850
 851   /// \brief Emit all the deferred coverage mappings
 852   /// for the uninstrumented functions.
 853   void EmitDeferredUnusedCoverageMappings();
 854
 855   /// Tell the consumer that this variable has been instantiated.
 856   void HandleCXXStaticMemberVarInstantiation(VarDecl *VD);
 857
 858   /// \brief If the declaration has internal linkage but is inside an
 859   /// extern "C" linkage specification, prepare to emit an alias for it
 860   /// to the expected name.
 861   template<typename SomeDecl>
 862   void MaybeHandleStaticInExternC(const SomeDecl *D, llvm::GlobalValue *GV);
 863
 864   /// Add a global to a list to be added to the llvm.used metadata.
 865   void addUsedGlobal(llvm::GlobalValue *GV);
 866
 867   /// Add a global to a list to be added to the llvm.compiler.used metadata.
 868   void addCompilerUsedGlobal(llvm::GlobalValue *GV);
 869
 870   /// Add a destructor and object to add to the C++ global destructor function.
 871   void AddCXXDtorEntry(llvm::Constant *DtorFn, llvm::Constant *Object) {
 872     CXXGlobalDtors.emplace_back(DtorFn, Object);
 873   }
 874
 875   /// Create a new runtime function with the specified type and name.
 876   llvm::Constant *CreateRuntimeFunction(llvm::FunctionType *Ty,
 877                                         StringRef Name,
 878                                         llvm::AttributeSet ExtraAttrs =
 879                                           llvm::AttributeSet());
 880   /// Create a new compiler builtin function with the specified type and name.
 881   llvm::Constant *CreateBuiltinFunction(llvm::FunctionType *Ty,
 882                                         StringRef Name,
 883                                         llvm::AttributeSet ExtraAttrs =
 884                                           llvm::AttributeSet());
 885   /// Create a new runtime global variable with the specified type and name.
 886   llvm::Constant *CreateRuntimeVariable(llvm::Type *Ty,
 887                                         StringRef Name);
 888
 889   ///@name Custom Blocks Runtime Interfaces
 890   ///@{
 891
 892   llvm::Constant *getNSConcreteGlobalBlock();
 893   llvm::Constant *getNSConcreteStackBlock();
 894   llvm::Constant *getBlockObjectAssign();
 895   llvm::Constant *getBlockObjectDispose();
 896
 897   ///@}
 898
 899   llvm::Constant *getLLVMLifetimeStartFn();
 900   llvm::Constant *getLLVMLifetimeEndFn();
 901
 902   // Make sure that this type is translated.
 903   void UpdateCompletedType(const TagDecl *TD);
 904
 905   llvm::Constant *getMemberPointerConstant(const UnaryOperator *e);
 906
 907   /// Try to emit the initializer for the given declaration as a constant;
 908   /// returns 0 if the expression cannot be emitted as a constant.
 909   llvm::Constant *EmitConstantInit(const VarDecl &D,
 910                                    CodeGenFunction *CGF = nullptr);
 911
 912   /// Try to emit the given expression as a constant; returns 0 if the
 913   /// expression cannot be emitted as a constant.
 914   llvm::Constant *EmitConstantExpr(const Expr *E, QualType DestType,
 915                                    CodeGenFunction *CGF = nullptr);
 916
 917   /// Emit the given constant value as a constant, in the type's scalar
 918   /// representation.
 919   llvm::Constant *EmitConstantValue(const APValue &Value, QualType DestType,
 920                                     CodeGenFunction *CGF = nullptr);
 921
 922   /// Emit the given constant value as a constant, in the type's memory
 923   /// representation.
 924   llvm::Constant *EmitConstantValueForMemory(const APValue &Value,
 925                                              QualType DestType,
 926                                              CodeGenFunction *CGF = nullptr);
 927
 928   /// \brief Emit type info if type of an expression is a variably modified
 929   /// type. Also emit proper debug info for cast types.
 930   void EmitExplicitCastExprType(const ExplicitCastExpr *E,
 931                                 CodeGenFunction *CGF = nullptr);
 932
 933   /// Return the result of value-initializing the given type, i.e. a null
 934   /// expression of the given type.  This is usually, but not always, an LLVM
 935   /// null constant.
 936   llvm::Constant *EmitNullConstant(QualType T);
 937
 938   /// Return a null constant appropriate for zero-initializing a base class with
 939   /// the given type. This is usually, but not always, an LLVM null constant.
 940   llvm::Constant *EmitNullConstantForBase(const CXXRecordDecl *Record);
 941
 942   /// Emit a general error that something can't be done.
 943   void Error(SourceLocation loc, StringRef error);
 944
 945   /// Print out an error that codegen doesn't support the specified stmt yet.
 946   void ErrorUnsupported(const Stmt *S, const char *Type);
 947
 948   /// Print out an error that codegen doesn't support the specified decl yet.
 949   void ErrorUnsupported(const Decl *D, const char *Type);
 950
 951   /// Set the attributes on the LLVM function for the given decl and function
 952   /// info. This applies attributes necessary for handling the ABI as well as
 953   /// user specified attributes like section.
 954   void SetInternalFunctionAttributes(const Decl *D, llvm::Function *F,
 955                                      const CGFunctionInfo &FI);
 956
 957   /// Set the LLVM function attributes (sext, zext, etc).
 958   void SetLLVMFunctionAttributes(const Decl *D,
 959                                  const CGFunctionInfo &Info,
 960                                  llvm::Function *F);
 961
 962   /// Set the LLVM function attributes which only apply to a function
 963   /// definition.
 964   void SetLLVMFunctionAttributesForDefinition(const Decl *D, llvm::Function *F);
 965
 966   /// Return true iff the given type uses 'sret' when used as a return type.
 967   bool ReturnTypeUsesSRet(const CGFunctionInfo &FI);
 968
 969   /// Return true iff the given type uses an argument slot when 'sret' is used
 970   /// as a return type.
 971   bool ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI);
 972
 973   /// Return true iff the given type uses 'fpret' when used as a return type.
 974   bool ReturnTypeUsesFPRet(QualType ResultType);
 975
 976   /// Return true iff the given type uses 'fp2ret' when used as a return type.
 977   bool ReturnTypeUsesFP2Ret(QualType ResultType);
 978
 979   /// Get the LLVM attributes and calling convention to use for a particular
 980   /// function type.
 981   ///
 982   /// \param Name - The function name.
 983   /// \param Info - The function type information.
 984   /// \param CalleeInfo - The callee information these attributes are being
 985   /// constructed for. If valid, the attributes applied to this decl may
 986   /// contribute to the function attributes and calling convention.
 987   /// \param PAL [out] - On return, the attribute list to use.
 988   /// \param CallingConv [out] - On return, the LLVM calling convention to use.
 989   void ConstructAttributeList(StringRef Name, const CGFunctionInfo &Info,
 990                               CGCalleeInfo CalleeInfo, AttributeListType &PAL,
 991                               unsigned &CallingConv, bool AttrOnCallSite);
 992
 993   // Fills in the supplied string map with the set of target features for the
 994   // passed in function.
 995   void getFunctionFeatureMap(llvm::StringMap<bool> &FeatureMap,
 996                              const FunctionDecl *FD);
 997
 998   StringRef getMangledName(GlobalDecl GD);
 999   StringRef getBlockMangledName(GlobalDecl GD, const BlockDecl *BD);
1000
1001   void EmitTentativeDefinition(const VarDecl *D);
1002
1003   void EmitVTable(CXXRecordDecl *Class);
1004
1005   void RefreshTypeCacheForClass(const CXXRecordDecl *Class);
1006
1007   /// \brief Appends Opts to the "Linker Options" metadata value.
1008   void AppendLinkerOptions(StringRef Opts);
1009
1010   /// \brief Appends a detect mismatch command to the linker options.
1011   void AddDetectMismatch(StringRef Name, StringRef Value);
1012
1013   /// \brief Appends a dependent lib to the "Linker Options" metadata value.
1014   void AddDependentLib(StringRef Lib);
1015
1016   llvm::GlobalVariable::LinkageTypes getFunctionLinkage(GlobalDecl GD);
1017
1018   void setFunctionLinkage(GlobalDecl GD, llvm::Function *F) {
1019     F->setLinkage(getFunctionLinkage(GD));
1020   }
1021
1022   /// Set the DLL storage class on F.
1023   void setFunctionDLLStorageClass(GlobalDecl GD, llvm::Function *F);
1024
1025   /// Return the appropriate linkage for the vtable, VTT, and type information
1026   /// of the given class.
1027   llvm::GlobalVariable::LinkageTypes getVTableLinkage(const CXXRecordDecl *RD);
1028
1029   /// Return the store size, in character units, of the given LLVM type.
1030   CharUnits GetTargetTypeStoreSize(llvm::Type *Ty) const;
1031
1032   /// Returns LLVM linkage for a declarator.
1033   llvm::GlobalValue::LinkageTypes
1034   getLLVMLinkageForDeclarator(const DeclaratorDecl *D, GVALinkage Linkage,
1035                               bool IsConstantVariable);
1036
1037   /// Returns LLVM linkage for a declarator.
1038   llvm::GlobalValue::LinkageTypes
1039   getLLVMLinkageVarDefinition(const VarDecl *VD, bool IsConstant);
1040
1041   /// Emit all the global annotations.
1042   void EmitGlobalAnnotations();
1043
1044   /// Emit an annotation string.
1045   llvm::Constant *EmitAnnotationString(StringRef Str);
1046
1047   /// Emit the annotation's translation unit.
1048   llvm::Constant *EmitAnnotationUnit(SourceLocation Loc);
1049
1050   /// Emit the annotation line number.
1051   llvm::Constant *EmitAnnotationLineNo(SourceLocation L);
1052
1053   /// Generate the llvm::ConstantStruct which contains the annotation
1054   /// information for a given GlobalValue. The annotation struct is
1055   /// {i8 *, i8 *, i8 *, i32}. The first field is a constant expression, the
1056   /// GlobalValue being annotated. The second field is the constant string
1057   /// created from the AnnotateAttr's annotation. The third field is a constant
1058   /// string containing the name of the translation unit. The fourth field is
1059   /// the line number in the file of the annotated value declaration.
1060   llvm::Constant *EmitAnnotateAttr(llvm::GlobalValue *GV,
1061                                    const AnnotateAttr *AA,
1062                                    SourceLocation L);
1063
1064   /// Add global annotations that are set on D, for the global GV. Those
1065   /// annotations are emitted during finalization of the LLVM code.
1066   void AddGlobalAnnotations(const ValueDecl *D, llvm::GlobalValue *GV);
1067
1068   bool isInSanitizerBlacklist(llvm::Function *Fn, SourceLocation Loc) const;
1069
1070   bool isInSanitizerBlacklist(llvm::GlobalVariable *GV, SourceLocation Loc,
1071                               QualType Ty,
1072                               StringRef Category = StringRef()) const;
1073
1074   SanitizerMetadata *getSanitizerMetadata() {
1075     return SanitizerMD.get();
1076   }
1077
1078   void addDeferredVTable(const CXXRecordDecl *RD) {
1079     DeferredVTables.push_back(RD);
1080   }
1081
1082   /// Emit code for a singal global function or var decl. Forward declarations
1083   /// are emitted lazily.
1084   void EmitGlobal(GlobalDecl D);
1085
1086   bool TryEmitDefinitionAsAlias(GlobalDecl Alias, GlobalDecl Target,
1087                                 bool InEveryTU);
1088   bool TryEmitBaseDestructorAsAlias(const CXXDestructorDecl *D);
1089
1090   /// Set attributes for a global definition.
1091   void setFunctionDefinitionAttributes(const FunctionDecl *D,
1092                                        llvm::Function *F);
1093
1094   llvm::GlobalValue *GetGlobalValue(StringRef Ref);
1095
1096   /// Set attributes which are common to any form of a global definition (alias,
1097   /// Objective-C method, function, global variable).
1098   ///
1099   /// NOTE: This should only be called for definitions.
1100   void SetCommonAttributes(const Decl *D, llvm::GlobalValue *GV);
1101
1102   /// Set attributes which must be preserved by an alias. This includes common
1103   /// attributes (i.e. it includes a call to SetCommonAttributes).
1104   ///
1105   /// NOTE: This should only be called for definitions.
1106   void setAliasAttributes(const Decl *D, llvm::GlobalValue *GV);
1107
1108   void addReplacement(StringRef Name, llvm::Constant *C);
1109
1110   void addGlobalValReplacement(llvm::GlobalValue *GV, llvm::Constant *C);
1111
1112   /// \brief Emit a code for threadprivate directive.
1113   /// \param D Threadprivate declaration.
1114   void EmitOMPThreadPrivateDecl(const OMPThreadPrivateDecl *D);
1115
1116   /// \brief Emit a code for declare reduction construct.
1117   void EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D,
1118                                CodeGenFunction *CGF = nullptr);
1119
1120   /// Returns whether the given record has hidden LTO visibility and therefore
1121   /// may participate in (single-module) CFI and whole-program vtable
1122   /// optimization.
1123   bool HasHiddenLTOVisibility(const CXXRecordDecl *RD);
1124
1125   /// Emit type metadata for the given vtable using the given layout.
1126   void EmitVTableTypeMetadata(llvm::GlobalVariable *VTable,
1127                               const VTableLayout &VTLayout);
1128
1129   /// Generate a cross-DSO type identifier for MD.
1130   llvm::ConstantInt *CreateCrossDsoCfiTypeId(llvm::Metadata *MD);
1131
1132   /// Create a metadata identifier for the given type. This may either be an
1133   /// MDString (for external identifiers) or a distinct unnamed MDNode (for
1134   /// internal identifiers).
1135   llvm::Metadata *CreateMetadataIdentifierForType(QualType T);
1136
1137   /// Create and attach type metadata to the given function.
1138   void CreateFunctionTypeMetadata(const FunctionDecl *FD, llvm::Function *F);
1139
1140   /// Returns whether this module needs the "all-vtables" type identifier.
1141   bool NeedAllVtablesTypeId() const;
1142
1143   /// Create and attach type metadata for the given vtable.
1144   void AddVTableTypeMetadata(llvm::GlobalVariable *VTable, CharUnits Offset,
1145                              const CXXRecordDecl *RD);
1146
1147   /// \breif Get the declaration of std::terminate for the platform.
1148   llvm::Constant *getTerminateFn();
1149
1150   llvm::SanitizerStatReport &getSanStats();
1151
1152   llvm::Value *
1153   createOpenCLIntToSamplerConversion(const Expr *E, CodeGenFunction &CGF);
1154
1155 private:
1156   llvm::Constant *
1157   GetOrCreateLLVMFunction(StringRef MangledName, llvm::Type *Ty, GlobalDecl D,
1158                           bool ForVTable, bool DontDefer = false,
1159                           bool IsThunk = false,
1160                           llvm::AttributeSet ExtraAttrs = llvm::AttributeSet(),
1161                           bool IsForDefinition = false);
1162
1163   llvm::Constant *GetOrCreateLLVMGlobal(StringRef MangledName,
1164                                         llvm::PointerType *PTy,
1165                                         const VarDecl *D,
1166                                         bool IsForDefinition = false);
1167
1168   void setNonAliasAttributes(const Decl *D, llvm::GlobalObject *GO);
1169
1170   /// Set function attributes for a function declaration.
1171   void SetFunctionAttributes(GlobalDecl GD, llvm::Function *F,
1172                              bool IsIncompleteFunction, bool IsThunk);
1173
1174   void EmitGlobalDefinition(GlobalDecl D, llvm::GlobalValue *GV = nullptr);
1175
1176   void EmitGlobalFunctionDefinition(GlobalDecl GD, llvm::GlobalValue *GV);
1177   void EmitGlobalVarDefinition(const VarDecl *D, bool IsTentative = false);
1178   void EmitAliasDefinition(GlobalDecl GD);
1179   void emitIFuncDefinition(GlobalDecl GD);
1180   void EmitObjCPropertyImplementations(const ObjCImplementationDecl *D);
1181   void EmitObjCIvarInitializations(ObjCImplementationDecl *D);
1182
1183   // C++ related functions.
1184
1185   void EmitDeclContext(const DeclContext *DC);
1186   void EmitLinkageSpec(const LinkageSpecDecl *D);
1187   void CompleteDIClassType(const CXXMethodDecl* D);
1188
1189   /// \brief Emit the function that initializes C++ thread_local variables.
1190   void EmitCXXThreadLocalInitFunc();
1191
1192   /// Emit the function that initializes C++ globals.
1193   void EmitCXXGlobalInitFunc();
1194
1195   /// Emit the function that destroys C++ globals.
1196   void EmitCXXGlobalDtorFunc();
1197
1198   /// Emit the function that initializes the specified global (if PerformInit is
1199   /// true) and registers its destructor.
1200   void EmitCXXGlobalVarDeclInitFunc(const VarDecl *D,
1201                                     llvm::GlobalVariable *Addr,
1202                                     bool PerformInit);
1203
1204   void EmitPointerToInitFunc(const VarDecl *VD, llvm::GlobalVariable *Addr,
1205                              llvm::Function *InitFunc, InitSegAttr *ISA);
1206
1207   // FIXME: Hardcoding priority here is gross.
1208   void AddGlobalCtor(llvm::Function *Ctor, int Priority = 65535,
1209                      llvm::Constant *AssociatedData = nullptr);
1210   void AddGlobalDtor(llvm::Function *Dtor, int Priority = 65535);
1211
1212   /// Generates a global array of functions and priorities using the given list
1213   /// and name. This array will have appending linkage and is suitable for use
1214   /// as a LLVM constructor or destructor array.
1215   void EmitCtorList(const CtorList &Fns, const char *GlobalName);
1216
1217   /// Emit any needed decls for which code generation was deferred.
1218   void EmitDeferred();
1219
1220   /// Call replaceAllUsesWith on all pairs in Replacements.
1221   void applyReplacements();
1222
1223   /// Call replaceAllUsesWith on all pairs in GlobalValReplacements.
1224   void applyGlobalValReplacements();
1225
1226   void checkAliases();
1227
1228   /// Emit any vtables which we deferred and still have a use for.
1229   void EmitDeferredVTables();
1230
1231   /// Emit the llvm.used and llvm.compiler.used metadata.
1232   void emitLLVMUsed();
1233
1234   /// \brief Emit the link options introduced by imported modules.
1235   void EmitModuleLinkOptions();
1236
1237   /// \brief Emit aliases for internal-linkage declarations inside "C" language
1238   /// linkage specifications, giving them the "expected" name where possible.
1239   void EmitStaticExternCAliases();
1240
1241   void EmitDeclMetadata();
1242
1243   /// \brief Emit the Clang version as llvm.ident metadata.
1244   void EmitVersionIdentMetadata();
1245
1246   /// Emits target specific Metadata for global declarations.
1247   void EmitTargetMetadata();
1248
1249   /// Emit the llvm.gcov metadata used to tell LLVM where to emit the .gcno and
1250   /// .gcda files in a way that persists in .bc files.
1251   void EmitCoverageFile();
1252
1253   /// Emits the initializer for a uuidof string.
1254   llvm::Constant *EmitUuidofInitializer(StringRef uuidstr);
1255
1256   /// Determine whether the definition must be emitted; if this returns \c
1257   /// false, the definition can be emitted lazily if it's used.
1258   bool MustBeEmitted(const ValueDecl *D);
1259
1260   /// Determine whether the definition can be emitted eagerly, or should be
1261   /// delayed until the end of the translation unit. This is relevant for
1262   /// definitions whose linkage can change, e.g. implicit function instantions
1263   /// which may later be explicitly instantiated.
1264   bool MayBeEmittedEagerly(const ValueDecl *D);
1265
1266   /// Check whether we can use a "simpler", more core exceptions personality
1267   /// function.
1268   void SimplifyPersonality();
1269 };
1270 }  // end namespace CodeGen
1271 }  // end namespace clang
1272
1273 #endif // LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H