contrib/llvm/tools/clang/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 CLANG_CODEGEN_CODEGENMODULE_H
  15 #define CLANG_CODEGEN_CODEGENMODULE_H
  16
  17 #include "CGVTables.h"
  18 #include "CodeGenTypes.h"
  19 #include "clang/AST/Attr.h"
  20 #include "clang/AST/DeclCXX.h"
  21 #include "clang/AST/DeclObjC.h"
  22 #include "clang/AST/GlobalDecl.h"
  23 #include "clang/AST/Mangle.h"
  24 #include "clang/Basic/ABI.h"
  25 #include "clang/Basic/LangOptions.h"
  26 #include "clang/Basic/Module.h"
  27 #include "llvm/ADT/DenseMap.h"
  28 #include "llvm/ADT/SetVector.h"
  29 #include "llvm/ADT/SmallPtrSet.h"
  30 #include "llvm/ADT/StringMap.h"
  31 #include "llvm/IR/CallingConv.h"
  32 #include "llvm/IR/Module.h"
  33 #include "llvm/Support/ValueHandle.h"
  34 #include "llvm/Transforms/Utils/BlackList.h"
  35
  36 namespace llvm {
  37   class Module;
  38   class Constant;
  39   class ConstantInt;
  40   class Function;
  41   class GlobalValue;
  42   class DataLayout;
  43   class FunctionType;
  44   class LLVMContext;
  45 }
  46
  47 namespace clang {
  48   class TargetCodeGenInfo;
  49   class ASTContext;
  50   class AtomicType;
  51   class FunctionDecl;
  52   class IdentifierInfo;
  53   class ObjCMethodDecl;
  54   class ObjCImplementationDecl;
  55   class ObjCCategoryImplDecl;
  56   class ObjCProtocolDecl;
  57   class ObjCEncodeExpr;
  58   class BlockExpr;
  59   class CharUnits;
  60   class Decl;
  61   class Expr;
  62   class Stmt;
  63   class InitListExpr;
  64   class StringLiteral;
  65   class NamedDecl;
  66   class ValueDecl;
  67   class VarDecl;
  68   class LangOptions;
  69   class CodeGenOptions;
  70   class TargetOptions;
  71   class DiagnosticsEngine;
  72   class AnnotateAttr;
  73   class CXXDestructorDecl;
  74   class MangleBuffer;
  75   class Module;
  76
  77 namespace CodeGen {
  78
  79   class CallArgList;
  80   class CodeGenFunction;
  81   class CodeGenTBAA;
  82   class CGCXXABI;
  83   class CGDebugInfo;
  84   class CGObjCRuntime;
  85   class CGOpenCLRuntime;
  86   class CGCUDARuntime;
  87   class BlockFieldFlags;
  88   class FunctionArgList;
  89
  90   struct OrderGlobalInits {
  91     unsigned int priority;
  92     unsigned int lex_order;
  93     OrderGlobalInits(unsigned int p, unsigned int l)
  94       : priority(p), lex_order(l) {}
  95
  96     bool operator==(const OrderGlobalInits &RHS) const {
  97       return priority == RHS.priority &&
  98              lex_order == RHS.lex_order;
  99     }
 100
 101     bool operator<(const OrderGlobalInits &RHS) const {
 102       if (priority < RHS.priority)
 103         return true;
 104
 105       return priority == RHS.priority && lex_order < RHS.lex_order;
 106     }
 107   };
 108
 109   struct CodeGenTypeCache {
 110     /// void
 111     llvm::Type *VoidTy;
 112
 113     /// i8, i16, i32, and i64
 114     llvm::IntegerType *Int8Ty, *Int16Ty, *Int32Ty, *Int64Ty;
 115     /// float, double
 116     llvm::Type *FloatTy, *DoubleTy;
 117
 118     /// int
 119     llvm::IntegerType *IntTy;
 120
 121     /// intptr_t, size_t, and ptrdiff_t, which we assume are the same size.
 122     union {
 123       llvm::IntegerType *IntPtrTy;
 124       llvm::IntegerType *SizeTy;
 125       llvm::IntegerType *PtrDiffTy;
 126     };
 127
 128     /// void* in address space 0
 129     union {
 130       llvm::PointerType *VoidPtrTy;
 131       llvm::PointerType *Int8PtrTy;
 132     };
 133
 134     /// void** in address space 0
 135     union {
 136       llvm::PointerType *VoidPtrPtrTy;
 137       llvm::PointerType *Int8PtrPtrTy;
 138     };
 139
 140     /// The width of a pointer into the generic address space.
 141     unsigned char PointerWidthInBits;
 142
 143     /// The size and alignment of a pointer into the generic address
 144     /// space.
 145     union {
 146       unsigned char PointerAlignInBytes;
 147       unsigned char PointerSizeInBytes;
 148       unsigned char SizeSizeInBytes;     // sizeof(size_t)
 149     };
 150
 151     llvm::CallingConv::ID RuntimeCC;
 152     llvm::CallingConv::ID getRuntimeCC() const {
 153       return RuntimeCC;
 154     }
 155   };
 156
 157 struct RREntrypoints {
 158   RREntrypoints() { memset(this, 0, sizeof(*this)); }
 159   /// void objc_autoreleasePoolPop(void*);
 160   llvm::Constant *objc_autoreleasePoolPop;
 161
 162   /// void *objc_autoreleasePoolPush(void);
 163   llvm::Constant *objc_autoreleasePoolPush;
 164 };
 165
 166 struct ARCEntrypoints {
 167   ARCEntrypoints() { memset(this, 0, sizeof(*this)); }
 168
 169   /// id objc_autorelease(id);
 170   llvm::Constant *objc_autorelease;
 171
 172   /// id objc_autoreleaseReturnValue(id);
 173   llvm::Constant *objc_autoreleaseReturnValue;
 174
 175   /// void objc_copyWeak(id *dest, id *src);
 176   llvm::Constant *objc_copyWeak;
 177
 178   /// void objc_destroyWeak(id*);
 179   llvm::Constant *objc_destroyWeak;
 180
 181   /// id objc_initWeak(id*, id);
 182   llvm::Constant *objc_initWeak;
 183
 184   /// id objc_loadWeak(id*);
 185   llvm::Constant *objc_loadWeak;
 186
 187   /// id objc_loadWeakRetained(id*);
 188   llvm::Constant *objc_loadWeakRetained;
 189
 190   /// void objc_moveWeak(id *dest, id *src);
 191   llvm::Constant *objc_moveWeak;
 192
 193   /// id objc_retain(id);
 194   llvm::Constant *objc_retain;
 195
 196   /// id objc_retainAutorelease(id);
 197   llvm::Constant *objc_retainAutorelease;
 198
 199   /// id objc_retainAutoreleaseReturnValue(id);
 200   llvm::Constant *objc_retainAutoreleaseReturnValue;
 201
 202   /// id objc_retainAutoreleasedReturnValue(id);
 203   llvm::Constant *objc_retainAutoreleasedReturnValue;
 204
 205   /// id objc_retainBlock(id);
 206   llvm::Constant *objc_retainBlock;
 207
 208   /// void objc_release(id);
 209   llvm::Constant *objc_release;
 210
 211   /// id objc_storeStrong(id*, id);
 212   llvm::Constant *objc_storeStrong;
 213
 214   /// id objc_storeWeak(id*, id);
 215   llvm::Constant *objc_storeWeak;
 216
 217   /// A void(void) inline asm to use to mark that the return value of
 218   /// a call will be immediately retain.
 219   llvm::InlineAsm *retainAutoreleasedReturnValueMarker;
 220
 221   /// void clang.arc.use(...);
 222   llvm::Constant *clang_arc_use;
 223 };
 224
 225 /// CodeGenModule - This class organizes the cross-function state that is used
 226 /// while generating LLVM code.
 227 class CodeGenModule : public CodeGenTypeCache {
 228   CodeGenModule(const CodeGenModule &) LLVM_DELETED_FUNCTION;
 229   void operator=(const CodeGenModule &) LLVM_DELETED_FUNCTION;
 230
 231   typedef std::vector<std::pair<llvm::Constant*, int> > CtorList;
 232
 233   ASTContext &Context;
 234   const LangOptions &LangOpts;
 235   const CodeGenOptions &CodeGenOpts;
 236   const TargetOptions &TargetOpts;
 237   llvm::Module &TheModule;
 238   const llvm::DataLayout &TheDataLayout;
 239   mutable const TargetCodeGenInfo *TheTargetCodeGenInfo;
 240   DiagnosticsEngine &Diags;
 241   CGCXXABI &ABI;
 242   CodeGenTypes Types;
 243   CodeGenTBAA *TBAA;
 244
 245   /// VTables - Holds information about C++ vtables.
 246   CodeGenVTables VTables;
 247   friend class CodeGenVTables;
 248
 249   CGObjCRuntime* ObjCRuntime;
 250   CGOpenCLRuntime* OpenCLRuntime;
 251   CGCUDARuntime* CUDARuntime;
 252   CGDebugInfo* DebugInfo;
 253   ARCEntrypoints *ARCData;
 254   llvm::MDNode *NoObjCARCExceptionsMetadata;
 255   RREntrypoints *RRData;
 256
 257   // WeakRefReferences - A set of references that have only been seen via
 258   // a weakref so far. This is used to remove the weak of the reference if we ever
 259   // see a direct reference or a definition.
 260   llvm::SmallPtrSet<llvm::GlobalValue*, 10> WeakRefReferences;
 261
 262   /// DeferredDecls - This contains all the decls which have definitions but
 263   /// which are deferred for emission and therefore should only be output if
 264   /// they are actually used.  If a decl is in this, then it is known to have
 265   /// not been referenced yet.
 266   llvm::StringMap<GlobalDecl> DeferredDecls;
 267
 268   /// DeferredDeclsToEmit - This is a list of deferred decls which we have seen
 269   /// that *are* actually referenced.  These get code generated when the module
 270   /// is done.
 271   std::vector<GlobalDecl> DeferredDeclsToEmit;
 272
 273   /// DeferredVTables - A queue of (optional) vtables to consider emitting.
 274   std::vector<const CXXRecordDecl*> DeferredVTables;
 275
 276   /// LLVMUsed - List of global values which are required to be
 277   /// present in the object file; bitcast to i8*. This is used for
 278   /// forcing visibility of symbols which may otherwise be optimized
 279   /// out.
 280   std::vector<llvm::WeakVH> LLVMUsed;
 281
 282   /// GlobalCtors - Store the list of global constructors and their respective
 283   /// priorities to be emitted when the translation unit is complete.
 284   CtorList GlobalCtors;
 285
 286   /// GlobalDtors - Store the list of global destructors and their respective
 287   /// priorities to be emitted when the translation unit is complete.
 288   CtorList GlobalDtors;
 289
 290   /// MangledDeclNames - A map of canonical GlobalDecls to their mangled names.
 291   llvm::DenseMap<GlobalDecl, StringRef> MangledDeclNames;
 292   llvm::BumpPtrAllocator MangledNamesAllocator;
 293
 294   /// Global annotations.
 295   std::vector<llvm::Constant*> Annotations;
 296
 297   /// Map used to get unique annotation strings.
 298   llvm::StringMap<llvm::Constant*> AnnotationStrings;
 299
 300   llvm::StringMap<llvm::Constant*> CFConstantStringMap;
 301   llvm::StringMap<llvm::GlobalVariable*> ConstantStringMap;
 302   llvm::DenseMap<const Decl*, llvm::Constant *> StaticLocalDeclMap;
 303   llvm::DenseMap<const Decl*, llvm::GlobalVariable*> StaticLocalDeclGuardMap;
 304
 305   llvm::DenseMap<QualType, llvm::Constant *> AtomicSetterHelperFnMap;
 306   llvm::DenseMap<QualType, llvm::Constant *> AtomicGetterHelperFnMap;
 307
 308   /// CXXGlobalInits - Global variables with initializers that need to run
 309   /// before main.
 310   std::vector<llvm::Constant*> CXXGlobalInits;
 311
 312   /// When a C++ decl with an initializer is deferred, null is
 313   /// appended to CXXGlobalInits, and the index of that null is placed
 314   /// here so that the initializer will be performed in the correct
 315   /// order.
 316   llvm::DenseMap<const Decl*, unsigned> DelayedCXXInitPosition;
 317
 318   typedef std::pair<OrderGlobalInits, llvm::Function*> GlobalInitData;
 319
 320   struct GlobalInitPriorityCmp {
 321     bool operator()(const GlobalInitData &LHS,
 322                     const GlobalInitData &RHS) const {
 323       return LHS.first.priority < RHS.first.priority;
 324     }
 325   };
 326
 327   /// - Global variables with initializers whose order of initialization
 328   /// is set by init_priority attribute.
 329   SmallVector<GlobalInitData, 8> PrioritizedCXXGlobalInits;
 330
 331   /// CXXGlobalDtors - Global destructor functions and arguments that need to
 332   /// run on termination.
 333   std::vector<std::pair<llvm::WeakVH,llvm::Constant*> > CXXGlobalDtors;
 334
 335   /// \brief The complete set of modules that has been imported.
 336   llvm::SetVector<clang::Module *> ImportedModules;
 337
 338   /// @name Cache for Objective-C runtime types
 339   /// @{
 340
 341   /// CFConstantStringClassRef - Cached reference to the class for constant
 342   /// strings. This value has type int * but is actually an Obj-C class pointer.
 343   llvm::Constant *CFConstantStringClassRef;
 344
 345   /// ConstantStringClassRef - Cached reference to the class for constant
 346   /// strings. This value has type int * but is actually an Obj-C class pointer.
 347   llvm::Constant *ConstantStringClassRef;
 348
 349   /// \brief The LLVM type corresponding to NSConstantString.
 350   llvm::StructType *NSConstantStringType;
 351
 352   /// \brief The type used to describe the state of a fast enumeration in
 353   /// Objective-C's for..in loop.
 354   QualType ObjCFastEnumerationStateType;
 355
 356   /// @}
 357
 358   /// Lazily create the Objective-C runtime
 359   void createObjCRuntime();
 360
 361   void createOpenCLRuntime();
 362   void createCUDARuntime();
 363
 364   bool isTriviallyRecursive(const FunctionDecl *F);
 365   bool shouldEmitFunction(const FunctionDecl *F);
 366   llvm::LLVMContext &VMContext;
 367
 368   /// @name Cache for Blocks Runtime Globals
 369   /// @{
 370
 371   llvm::Constant *NSConcreteGlobalBlock;
 372   llvm::Constant *NSConcreteStackBlock;
 373
 374   llvm::Constant *BlockObjectAssign;
 375   llvm::Constant *BlockObjectDispose;
 376
 377   llvm::Type *BlockDescriptorType;
 378   llvm::Type *GenericBlockLiteralType;
 379
 380   struct {
 381     int GlobalUniqueCount;
 382   } Block;
 383
 384   /// void @llvm.lifetime.start(i64 %size, i8* nocapture <ptr>)
 385   llvm::Constant *LifetimeStartFn;
 386
 387   /// void @llvm.lifetime.end(i64 %size, i8* nocapture <ptr>)
 388   llvm::Constant *LifetimeEndFn;
 389
 390   GlobalDecl initializedGlobalDecl;
 391
 392   llvm::BlackList SanitizerBlacklist;
 393
 394   const SanitizerOptions &SanOpts;
 395
 396   /// @}
 397 public:
 398   CodeGenModule(ASTContext &C, const CodeGenOptions &CodeGenOpts,
 399                 const TargetOptions &TargetOpts, llvm::Module &M,
 400                 const llvm::DataLayout &TD, DiagnosticsEngine &Diags);
 401
 402   ~CodeGenModule();
 403
 404   /// Release - Finalize LLVM code generation.
 405   void Release();
 406
 407   /// getObjCRuntime() - Return a reference to the configured
 408   /// Objective-C runtime.
 409   CGObjCRuntime &getObjCRuntime() {
 410     if (!ObjCRuntime) createObjCRuntime();
 411     return *ObjCRuntime;
 412   }
 413
 414   /// hasObjCRuntime() - Return true iff an Objective-C runtime has
 415   /// been configured.
 416   bool hasObjCRuntime() { return !!ObjCRuntime; }
 417
 418   /// getOpenCLRuntime() - Return a reference to the configured OpenCL runtime.
 419   CGOpenCLRuntime &getOpenCLRuntime() {
 420     assert(OpenCLRuntime != 0);
 421     return *OpenCLRuntime;
 422   }
 423
 424   /// getCUDARuntime() - Return a reference to the configured CUDA runtime.
 425   CGCUDARuntime &getCUDARuntime() {
 426     assert(CUDARuntime != 0);
 427     return *CUDARuntime;
 428   }
 429
 430   /// getCXXABI() - Return a reference to the configured C++ ABI.
 431   CGCXXABI &getCXXABI() { return ABI; }
 432
 433   ARCEntrypoints &getARCEntrypoints() const {
 434     assert(getLangOpts().ObjCAutoRefCount && ARCData != 0);
 435     return *ARCData;
 436   }
 437
 438   RREntrypoints &getRREntrypoints() const {
 439     assert(RRData != 0);
 440     return *RRData;
 441   }
 442
 443   llvm::Constant *getStaticLocalDeclAddress(const VarDecl *D) {
 444     return StaticLocalDeclMap[D];
 445   }
 446   void setStaticLocalDeclAddress(const VarDecl *D,
 447                                  llvm::Constant *C) {
 448     StaticLocalDeclMap[D] = C;
 449   }
 450
 451   llvm::GlobalVariable *getStaticLocalDeclGuardAddress(const VarDecl *D) {
 452     return StaticLocalDeclGuardMap[D];
 453   }
 454   void setStaticLocalDeclGuardAddress(const VarDecl *D,
 455                                       llvm::GlobalVariable *C) {
 456     StaticLocalDeclGuardMap[D] = C;
 457   }
 458
 459   llvm::Constant *getAtomicSetterHelperFnMap(QualType Ty) {
 460     return AtomicSetterHelperFnMap[Ty];
 461   }
 462   void setAtomicSetterHelperFnMap(QualType Ty,
 463                             llvm::Constant *Fn) {
 464     AtomicSetterHelperFnMap[Ty] = Fn;
 465   }
 466
 467   llvm::Constant *getAtomicGetterHelperFnMap(QualType Ty) {
 468     return AtomicGetterHelperFnMap[Ty];
 469   }
 470   void setAtomicGetterHelperFnMap(QualType Ty,
 471                             llvm::Constant *Fn) {
 472     AtomicGetterHelperFnMap[Ty] = Fn;
 473   }
 474
 475   CGDebugInfo *getModuleDebugInfo() { return DebugInfo; }
 476
 477   llvm::MDNode *getNoObjCARCExceptionsMetadata() {
 478     if (!NoObjCARCExceptionsMetadata)
 479       NoObjCARCExceptionsMetadata =
 480         llvm::MDNode::get(getLLVMContext(),
 481                           SmallVector<llvm::Value*,1>());
 482     return NoObjCARCExceptionsMetadata;
 483   }
 484
 485   ASTContext &getContext() const { return Context; }
 486   const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; }
 487   const LangOptions &getLangOpts() const { return LangOpts; }
 488   llvm::Module &getModule() const { return TheModule; }
 489   CodeGenTypes &getTypes() { return Types; }
 490   CodeGenVTables &getVTables() { return VTables; }
 491   VTableContext &getVTableContext() { return VTables.getVTableContext(); }
 492   DiagnosticsEngine &getDiags() const { return Diags; }
 493   const llvm::DataLayout &getDataLayout() const { return TheDataLayout; }
 494   const TargetInfo &getTarget() const { return Context.getTargetInfo(); }
 495   llvm::LLVMContext &getLLVMContext() { return VMContext; }
 496   const TargetCodeGenInfo &getTargetCodeGenInfo();
 497   bool isTargetDarwin() const;
 498
 499   bool shouldUseTBAA() const { return TBAA != 0; }
 500
 501   llvm::MDNode *getTBAAInfo(QualType QTy);
 502   llvm::MDNode *getTBAAInfoForVTablePtr();
 503   llvm::MDNode *getTBAAStructInfo(QualType QTy);
 504   /// Return the MDNode in the type DAG for the given struct type.
 505   llvm::MDNode *getTBAAStructTypeInfo(QualType QTy);
 506   /// Return the path-aware tag for given base type, access node and offset.
 507   llvm::MDNode *getTBAAStructTagInfo(QualType BaseTy, llvm::MDNode *AccessN,
 508                                      uint64_t O);
 509
 510   bool isTypeConstant(QualType QTy, bool ExcludeCtorDtor);
 511
 512   bool isPaddedAtomicType(QualType type);
 513   bool isPaddedAtomicType(const AtomicType *type);
 514
 515   static void DecorateInstruction(llvm::Instruction *Inst,
 516                                   llvm::MDNode *TBAAInfo);
 517
 518   /// getSize - Emit the given number of characters as a value of type size_t.
 519   llvm::ConstantInt *getSize(CharUnits numChars);
 520
 521   /// setGlobalVisibility - Set the visibility for the given LLVM
 522   /// GlobalValue.
 523   void setGlobalVisibility(llvm::GlobalValue *GV, const NamedDecl *D) const;
 524
 525   /// setTLSMode - Set the TLS mode for the given LLVM GlobalVariable
 526   /// for the thread-local variable declaration D.
 527   void setTLSMode(llvm::GlobalVariable *GV, const VarDecl &D) const;
 528
 529   /// TypeVisibilityKind - The kind of global variable that is passed to
 530   /// setTypeVisibility
 531   enum TypeVisibilityKind {
 532     TVK_ForVTT,
 533     TVK_ForVTable,
 534     TVK_ForConstructionVTable,
 535     TVK_ForRTTI,
 536     TVK_ForRTTIName
 537   };
 538
 539   /// setTypeVisibility - Set the visibility for the given global
 540   /// value which holds information about a type.
 541   void setTypeVisibility(llvm::GlobalValue *GV, const CXXRecordDecl *D,
 542                          TypeVisibilityKind TVK) const;
 543
 544   static llvm::GlobalValue::VisibilityTypes GetLLVMVisibility(Visibility V) {
 545     switch (V) {
 546     case DefaultVisibility:   return llvm::GlobalValue::DefaultVisibility;
 547     case HiddenVisibility:    return llvm::GlobalValue::HiddenVisibility;
 548     case ProtectedVisibility: return llvm::GlobalValue::ProtectedVisibility;
 549     }
 550     llvm_unreachable("unknown visibility!");
 551   }
 552
 553   llvm::Constant *GetAddrOfGlobal(GlobalDecl GD) {
 554     if (isa<CXXConstructorDecl>(GD.getDecl()))
 555       return GetAddrOfCXXConstructor(cast<CXXConstructorDecl>(GD.getDecl()),
 556                                      GD.getCtorType());
 557     else if (isa<CXXDestructorDecl>(GD.getDecl()))
 558       return GetAddrOfCXXDestructor(cast<CXXDestructorDecl>(GD.getDecl()),
 559                                      GD.getDtorType());
 560     else if (isa<FunctionDecl>(GD.getDecl()))
 561       return GetAddrOfFunction(GD);
 562     else
 563       return GetAddrOfGlobalVar(cast<VarDecl>(GD.getDecl()));
 564   }
 565
 566   /// CreateOrReplaceCXXRuntimeVariable - Will return a global variable of the given
 567   /// type. If a variable with a different type already exists then a new
 568   /// variable with the right type will be created and all uses of the old
 569   /// variable will be replaced with a bitcast to the new variable.
 570   llvm::GlobalVariable *
 571   CreateOrReplaceCXXRuntimeVariable(StringRef Name, llvm::Type *Ty,
 572                                     llvm::GlobalValue::LinkageTypes Linkage);
 573
 574   /// GetGlobalVarAddressSpace - Return the address space of the underlying
 575   /// global variable for D, as determined by its declaration.  Normally this
 576   /// is the same as the address space of D's type, but in CUDA, address spaces
 577   /// are associated with declarations, not types.
 578   unsigned GetGlobalVarAddressSpace(const VarDecl *D, unsigned AddrSpace);
 579
 580   /// GetAddrOfGlobalVar - Return the llvm::Constant for the address of the
 581   /// given global variable.  If Ty is non-null and if the global doesn't exist,
 582   /// then it will be greated with the specified type instead of whatever the
 583   /// normal requested type would be.
 584   llvm::Constant *GetAddrOfGlobalVar(const VarDecl *D,
 585                                      llvm::Type *Ty = 0);
 586
 587
 588   /// GetAddrOfFunction - Return the address of the given function.  If Ty is
 589   /// non-null, then this function will use the specified type if it has to
 590   /// create it.
 591   llvm::Constant *GetAddrOfFunction(GlobalDecl GD,
 592                                     llvm::Type *Ty = 0,
 593                                     bool ForVTable = false);
 594
 595   /// GetAddrOfRTTIDescriptor - Get the address of the RTTI descriptor
 596   /// for the given type.
 597   llvm::Constant *GetAddrOfRTTIDescriptor(QualType Ty, bool ForEH = false);
 598
 599   /// GetAddrOfUuidDescriptor - Get the address of a uuid descriptor .
 600   llvm::Constant *GetAddrOfUuidDescriptor(const CXXUuidofExpr* E);
 601
 602   /// GetAddrOfThunk - Get the address of the thunk for the given global decl.
 603   llvm::Constant *GetAddrOfThunk(GlobalDecl GD, const ThunkInfo &Thunk);
 604
 605   /// GetWeakRefReference - Get a reference to the target of VD.
 606   llvm::Constant *GetWeakRefReference(const ValueDecl *VD);
 607
 608   /// GetNonVirtualBaseClassOffset - Returns the offset from a derived class to
 609   /// a class. Returns null if the offset is 0.
 610   llvm::Constant *
 611   GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl,
 612                                CastExpr::path_const_iterator PathBegin,
 613                                CastExpr::path_const_iterator PathEnd);
 614
 615   /// A pair of helper functions for a __block variable.
 616   class ByrefHelpers : public llvm::FoldingSetNode {
 617   public:
 618     llvm::Constant *CopyHelper;
 619     llvm::Constant *DisposeHelper;
 620
 621     /// The alignment of the field.  This is important because
 622     /// different offsets to the field within the byref struct need to
 623     /// have different helper functions.
 624     CharUnits Alignment;
 625
 626     ByrefHelpers(CharUnits alignment) : Alignment(alignment) {}
 627     virtual ~ByrefHelpers();
 628
 629     void Profile(llvm::FoldingSetNodeID &id) const {
 630       id.AddInteger(Alignment.getQuantity());
 631       profileImpl(id);
 632     }
 633     virtual void profileImpl(llvm::FoldingSetNodeID &id) const = 0;
 634
 635     virtual bool needsCopy() const { return true; }
 636     virtual void emitCopy(CodeGenFunction &CGF,
 637                           llvm::Value *dest, llvm::Value *src) = 0;
 638
 639     virtual bool needsDispose() const { return true; }
 640     virtual void emitDispose(CodeGenFunction &CGF, llvm::Value *field) = 0;
 641   };
 642
 643   llvm::FoldingSet<ByrefHelpers> ByrefHelpersCache;
 644
 645   /// getUniqueBlockCount - Fetches the global unique block count.
 646   int getUniqueBlockCount() { return ++Block.GlobalUniqueCount; }
 647
 648   /// getBlockDescriptorType - Fetches the type of a generic block
 649   /// descriptor.
 650   llvm::Type *getBlockDescriptorType();
 651
 652   /// getGenericBlockLiteralType - The type of a generic block literal.
 653   llvm::Type *getGenericBlockLiteralType();
 654
 655   /// GetAddrOfGlobalBlock - Gets the address of a block which
 656   /// requires no captures.
 657   llvm::Constant *GetAddrOfGlobalBlock(const BlockExpr *BE, const char *);
 658
 659   /// GetAddrOfConstantCFString - Return a pointer to a constant CFString object
 660   /// for the given string.
 661   llvm::Constant *GetAddrOfConstantCFString(const StringLiteral *Literal);
 662
 663   /// GetAddrOfConstantString - Return a pointer to a constant NSString object
 664   /// for the given string. Or a user defined String object as defined via
 665   /// -fconstant-string-class=class_name option.
 666   llvm::Constant *GetAddrOfConstantString(const StringLiteral *Literal);
 667
 668   /// GetConstantArrayFromStringLiteral - Return a constant array for the given
 669   /// string.
 670   llvm::Constant *GetConstantArrayFromStringLiteral(const StringLiteral *E);
 671
 672   /// GetAddrOfConstantStringFromLiteral - Return a pointer to a constant array
 673   /// for the given string literal.
 674   llvm::Constant *GetAddrOfConstantStringFromLiteral(const StringLiteral *S);
 675
 676   /// GetAddrOfConstantStringFromObjCEncode - Return a pointer to a constant
 677   /// array for the given ObjCEncodeExpr node.
 678   llvm::Constant *GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *);
 679
 680   /// GetAddrOfConstantString - Returns a pointer to a character array
 681   /// containing the literal. This contents are exactly that of the given
 682   /// string, i.e. it will not be null terminated automatically; see
 683   /// GetAddrOfConstantCString. Note that whether the result is actually a
 684   /// pointer to an LLVM constant depends on Feature.WriteableStrings.
 685   ///
 686   /// The result has pointer to array type.
 687   ///
 688   /// \param GlobalName If provided, the name to use for the global
 689   /// (if one is created).
 690   llvm::Constant *GetAddrOfConstantString(StringRef Str,
 691                                           const char *GlobalName=0,
 692                                           unsigned Alignment=1);
 693
 694   /// GetAddrOfConstantCString - Returns a pointer to a character array
 695   /// containing the literal and a terminating '\0' character. The result has
 696   /// pointer to array type.
 697   ///
 698   /// \param GlobalName If provided, the name to use for the global (if one is
 699   /// created).
 700   llvm::Constant *GetAddrOfConstantCString(const std::string &str,
 701                                            const char *GlobalName=0,
 702                                            unsigned Alignment=1);
 703
 704   /// GetAddrOfConstantCompoundLiteral - Returns a pointer to a constant global
 705   /// variable for the given file-scope compound literal expression.
 706   llvm::Constant *GetAddrOfConstantCompoundLiteral(const CompoundLiteralExpr*E);
 707
 708   /// \brief Retrieve the record type that describes the state of an
 709   /// Objective-C fast enumeration loop (for..in).
 710   QualType getObjCFastEnumerationStateType();
 711
 712   /// GetAddrOfCXXConstructor - Return the address of the constructor of the
 713   /// given type.
 714   llvm::GlobalValue *GetAddrOfCXXConstructor(const CXXConstructorDecl *ctor,
 715                                              CXXCtorType ctorType,
 716                                              const CGFunctionInfo *fnInfo = 0);
 717
 718   /// GetAddrOfCXXDestructor - Return the address of the constructor of the
 719   /// given type.
 720   llvm::GlobalValue *GetAddrOfCXXDestructor(const CXXDestructorDecl *dtor,
 721                                             CXXDtorType dtorType,
 722                                             const CGFunctionInfo *fnInfo = 0);
 723
 724   /// getBuiltinLibFunction - Given a builtin id for a function like
 725   /// "__builtin_fabsf", return a Function* for "fabsf".
 726   llvm::Value *getBuiltinLibFunction(const FunctionDecl *FD,
 727                                      unsigned BuiltinID);
 728
 729   llvm::Function *getIntrinsic(unsigned IID, ArrayRef<llvm::Type*> Tys =
 730                                                  ArrayRef<llvm::Type*>());
 731
 732   /// EmitTopLevelDecl - Emit code for a single top level declaration.
 733   void EmitTopLevelDecl(Decl *D);
 734
 735   /// HandleCXXStaticMemberVarInstantiation - Tell the consumer that this
 736   // variable has been instantiated.
 737   void HandleCXXStaticMemberVarInstantiation(VarDecl *VD);
 738
 739   /// AddUsedGlobal - Add a global which should be forced to be
 740   /// present in the object file; these are emitted to the llvm.used
 741   /// metadata global.
 742   void AddUsedGlobal(llvm::GlobalValue *GV);
 743
 744   /// AddCXXDtorEntry - Add a destructor and object to add to the C++ global
 745   /// destructor function.
 746   void AddCXXDtorEntry(llvm::Constant *DtorFn, llvm::Constant *Object) {
 747     CXXGlobalDtors.push_back(std::make_pair(DtorFn, Object));
 748   }
 749
 750   /// CreateRuntimeFunction - Create a new runtime function with the specified
 751   /// type and name.
 752   llvm::Constant *CreateRuntimeFunction(llvm::FunctionType *Ty,
 753                                         StringRef Name,
 754                                         llvm::AttributeSet ExtraAttrs =
 755                                           llvm::AttributeSet());
 756   /// CreateRuntimeVariable - Create a new runtime global variable with the
 757   /// specified type and name.
 758   llvm::Constant *CreateRuntimeVariable(llvm::Type *Ty,
 759                                         StringRef Name);
 760
 761   ///@name Custom Blocks Runtime Interfaces
 762   ///@{
 763
 764   llvm::Constant *getNSConcreteGlobalBlock();
 765   llvm::Constant *getNSConcreteStackBlock();
 766   llvm::Constant *getBlockObjectAssign();
 767   llvm::Constant *getBlockObjectDispose();
 768
 769   ///@}
 770
 771   llvm::Constant *getLLVMLifetimeStartFn();
 772   llvm::Constant *getLLVMLifetimeEndFn();
 773
 774   // UpdateCompleteType - Make sure that this type is translated.
 775   void UpdateCompletedType(const TagDecl *TD);
 776
 777   llvm::Constant *getMemberPointerConstant(const UnaryOperator *e);
 778
 779   /// EmitConstantInit - Try to emit the initializer for the given declaration
 780   /// as a constant; returns 0 if the expression cannot be emitted as a
 781   /// constant.
 782   llvm::Constant *EmitConstantInit(const VarDecl &D, CodeGenFunction *CGF = 0);
 783
 784   /// EmitConstantExpr - Try to emit the given expression as a
 785   /// constant; returns 0 if the expression cannot be emitted as a
 786   /// constant.
 787   llvm::Constant *EmitConstantExpr(const Expr *E, QualType DestType,
 788                                    CodeGenFunction *CGF = 0);
 789
 790   /// EmitConstantValue - Emit the given constant value as a constant, in the
 791   /// type's scalar representation.
 792   llvm::Constant *EmitConstantValue(const APValue &Value, QualType DestType,
 793                                     CodeGenFunction *CGF = 0);
 794
 795   /// EmitConstantValueForMemory - Emit the given constant value as a constant,
 796   /// in the type's memory representation.
 797   llvm::Constant *EmitConstantValueForMemory(const APValue &Value,
 798                                              QualType DestType,
 799                                              CodeGenFunction *CGF = 0);
 800
 801   /// EmitNullConstant - Return the result of value-initializing the given
 802   /// type, i.e. a null expression of the given type.  This is usually,
 803   /// but not always, an LLVM null constant.
 804   llvm::Constant *EmitNullConstant(QualType T);
 805
 806   /// EmitNullConstantForBase - Return a null constant appropriate for
 807   /// zero-initializing a base class with the given type.  This is usually,
 808   /// but not always, an LLVM null constant.
 809   llvm::Constant *EmitNullConstantForBase(const CXXRecordDecl *Record);
 810
 811   /// Error - Emit a general error that something can't be done.
 812   void Error(SourceLocation loc, StringRef error);
 813
 814   /// ErrorUnsupported - Print out an error that codegen doesn't support the
 815   /// specified stmt yet.
 816   /// \param OmitOnError - If true, then this error should only be emitted if no
 817   /// other errors have been reported.
 818   void ErrorUnsupported(const Stmt *S, const char *Type,
 819                         bool OmitOnError=false);
 820
 821   /// ErrorUnsupported - Print out an error that codegen doesn't support the
 822   /// specified decl yet.
 823   /// \param OmitOnError - If true, then this error should only be emitted if no
 824   /// other errors have been reported.
 825   void ErrorUnsupported(const Decl *D, const char *Type,
 826                         bool OmitOnError=false);
 827
 828   /// SetInternalFunctionAttributes - Set the attributes on the LLVM
 829   /// function for the given decl and function info. This applies
 830   /// attributes necessary for handling the ABI as well as user
 831   /// specified attributes like section.
 832   void SetInternalFunctionAttributes(const Decl *D, llvm::Function *F,
 833                                      const CGFunctionInfo &FI);
 834
 835   /// SetLLVMFunctionAttributes - Set the LLVM function attributes
 836   /// (sext, zext, etc).
 837   void SetLLVMFunctionAttributes(const Decl *D,
 838                                  const CGFunctionInfo &Info,
 839                                  llvm::Function *F);
 840
 841   /// SetLLVMFunctionAttributesForDefinition - Set the LLVM function attributes
 842   /// which only apply to a function definintion.
 843   void SetLLVMFunctionAttributesForDefinition(const Decl *D, llvm::Function *F);
 844
 845   /// ReturnTypeUsesSRet - Return true iff the given type uses 'sret' when used
 846   /// as a return type.
 847   bool ReturnTypeUsesSRet(const CGFunctionInfo &FI);
 848
 849   /// ReturnTypeUsesFPRet - Return true iff the given type uses 'fpret' when
 850   /// used as a return type.
 851   bool ReturnTypeUsesFPRet(QualType ResultType);
 852
 853   /// ReturnTypeUsesFP2Ret - Return true iff the given type uses 'fp2ret' when
 854   /// used as a return type.
 855   bool ReturnTypeUsesFP2Ret(QualType ResultType);
 856
 857   /// ConstructAttributeList - Get the LLVM attributes and calling convention to
 858   /// use for a particular function type.
 859   ///
 860   /// \param Info - The function type information.
 861   /// \param TargetDecl - The decl these attributes are being constructed
 862   /// for. If supplied the attributes applied to this decl may contribute to the
 863   /// function attributes and calling convention.
 864   /// \param PAL [out] - On return, the attribute list to use.
 865   /// \param CallingConv [out] - On return, the LLVM calling convention to use.
 866   void ConstructAttributeList(const CGFunctionInfo &Info,
 867                               const Decl *TargetDecl,
 868                               AttributeListType &PAL,
 869                               unsigned &CallingConv,
 870                               bool AttrOnCallSite);
 871
 872   StringRef getMangledName(GlobalDecl GD);
 873   void getBlockMangledName(GlobalDecl GD, MangleBuffer &Buffer,
 874                            const BlockDecl *BD);
 875
 876   void EmitTentativeDefinition(const VarDecl *D);
 877
 878   void EmitVTable(CXXRecordDecl *Class, bool DefinitionRequired);
 879
 880   llvm::GlobalVariable::LinkageTypes
 881   getFunctionLinkage(const FunctionDecl *FD);
 882
 883   void setFunctionLinkage(const FunctionDecl *FD, llvm::GlobalValue *V) {
 884     V->setLinkage(getFunctionLinkage(FD));
 885   }
 886
 887   /// getVTableLinkage - Return the appropriate linkage for the vtable, VTT,
 888   /// and type information of the given class.
 889   llvm::GlobalVariable::LinkageTypes getVTableLinkage(const CXXRecordDecl *RD);
 890
 891   /// GetTargetTypeStoreSize - Return the store size, in character units, of
 892   /// the given LLVM type.
 893   CharUnits GetTargetTypeStoreSize(llvm::Type *Ty) const;
 894
 895   /// GetLLVMLinkageVarDefinition - Returns LLVM linkage for a global
 896   /// variable.
 897   llvm::GlobalValue::LinkageTypes
 898   GetLLVMLinkageVarDefinition(const VarDecl *D,
 899                               llvm::GlobalVariable *GV);
 900
 901   /// Emit all the global annotations.
 902   void EmitGlobalAnnotations();
 903
 904   /// Emit an annotation string.
 905   llvm::Constant *EmitAnnotationString(StringRef Str);
 906
 907   /// Emit the annotation's translation unit.
 908   llvm::Constant *EmitAnnotationUnit(SourceLocation Loc);
 909
 910   /// Emit the annotation line number.
 911   llvm::Constant *EmitAnnotationLineNo(SourceLocation L);
 912
 913   /// EmitAnnotateAttr - Generate the llvm::ConstantStruct which contains the
 914   /// annotation information for a given GlobalValue. The annotation struct is
 915   /// {i8 *, i8 *, i8 *, i32}. The first field is a constant expression, the
 916   /// GlobalValue being annotated. The second field is the constant string
 917   /// created from the AnnotateAttr's annotation. The third field is a constant
 918   /// string containing the name of the translation unit. The fourth field is
 919   /// the line number in the file of the annotated value declaration.
 920   llvm::Constant *EmitAnnotateAttr(llvm::GlobalValue *GV,
 921                                    const AnnotateAttr *AA,
 922                                    SourceLocation L);
 923
 924   /// Add global annotations that are set on D, for the global GV. Those
 925   /// annotations are emitted during finalization of the LLVM code.
 926   void AddGlobalAnnotations(const ValueDecl *D, llvm::GlobalValue *GV);
 927
 928   const llvm::BlackList &getSanitizerBlacklist() const {
 929     return SanitizerBlacklist;
 930   }
 931
 932   const SanitizerOptions &getSanOpts() const { return SanOpts; }
 933
 934   void addDeferredVTable(const CXXRecordDecl *RD) {
 935     DeferredVTables.push_back(RD);
 936   }
 937
 938 private:
 939   llvm::GlobalValue *GetGlobalValue(StringRef Ref);
 940
 941   llvm::Constant *GetOrCreateLLVMFunction(StringRef MangledName,
 942                                           llvm::Type *Ty,
 943                                           GlobalDecl D,
 944                                           bool ForVTable,
 945                                           llvm::AttributeSet ExtraAttrs =
 946                                             llvm::AttributeSet());
 947   llvm::Constant *GetOrCreateLLVMGlobal(StringRef MangledName,
 948                                         llvm::PointerType *PTy,
 949                                         const VarDecl *D,
 950                                         bool UnnamedAddr = false);
 951
 952   /// SetCommonAttributes - Set attributes which are common to any
 953   /// form of a global definition (alias, Objective-C method,
 954   /// function, global variable).
 955   ///
 956   /// NOTE: This should only be called for definitions.
 957   void SetCommonAttributes(const Decl *D, llvm::GlobalValue *GV);
 958
 959   /// SetFunctionDefinitionAttributes - Set attributes for a global definition.
 960   void SetFunctionDefinitionAttributes(const FunctionDecl *D,
 961                                        llvm::GlobalValue *GV);
 962
 963   /// SetFunctionAttributes - Set function attributes for a function
 964   /// declaration.
 965   void SetFunctionAttributes(GlobalDecl GD,
 966                              llvm::Function *F,
 967                              bool IsIncompleteFunction);
 968
 969   /// EmitGlobal - Emit code for a singal global function or var decl. Forward
 970   /// declarations are emitted lazily.
 971   void EmitGlobal(GlobalDecl D);
 972
 973   void EmitGlobalDefinition(GlobalDecl D);
 974
 975   void EmitGlobalFunctionDefinition(GlobalDecl GD);
 976   void EmitGlobalVarDefinition(const VarDecl *D);
 977   llvm::Constant *MaybeEmitGlobalStdInitializerListInitializer(const VarDecl *D,
 978                                                               const Expr *init);
 979   void EmitAliasDefinition(GlobalDecl GD);
 980   void EmitObjCPropertyImplementations(const ObjCImplementationDecl *D);
 981   void EmitObjCIvarInitializations(ObjCImplementationDecl *D);
 982
 983   // C++ related functions.
 984
 985   bool TryEmitDefinitionAsAlias(GlobalDecl Alias, GlobalDecl Target);
 986   bool TryEmitBaseDestructorAsAlias(const CXXDestructorDecl *D);
 987
 988   void EmitNamespace(const NamespaceDecl *D);
 989   void EmitLinkageSpec(const LinkageSpecDecl *D);
 990
 991   /// EmitCXXConstructors - Emit constructors (base, complete) from a
 992   /// C++ constructor Decl.
 993   void EmitCXXConstructors(const CXXConstructorDecl *D);
 994
 995   /// EmitCXXConstructor - Emit a single constructor with the given type from
 996   /// a C++ constructor Decl.
 997   void EmitCXXConstructor(const CXXConstructorDecl *D, CXXCtorType Type);
 998
 999   /// EmitCXXDestructors - Emit destructors (base, complete) from a
1000   /// C++ destructor Decl.
1001   void EmitCXXDestructors(const CXXDestructorDecl *D);
1002
1003   /// EmitCXXDestructor - Emit a single destructor with the given type from
1004   /// a C++ destructor Decl.
1005   void EmitCXXDestructor(const CXXDestructorDecl *D, CXXDtorType Type);
1006
1007   /// EmitCXXGlobalInitFunc - Emit the function that initializes C++ globals.
1008   void EmitCXXGlobalInitFunc();
1009
1010   /// EmitCXXGlobalDtorFunc - Emit the function that destroys C++ globals.
1011   void EmitCXXGlobalDtorFunc();
1012
1013   /// EmitCXXGlobalVarDeclInitFunc - Emit the function that initializes the
1014   /// specified global (if PerformInit is true) and registers its destructor.
1015   void EmitCXXGlobalVarDeclInitFunc(const VarDecl *D,
1016                                     llvm::GlobalVariable *Addr,
1017                                     bool PerformInit);
1018
1019   // FIXME: Hardcoding priority here is gross.
1020   void AddGlobalCtor(llvm::Function *Ctor, int Priority=65535);
1021   void AddGlobalDtor(llvm::Function *Dtor, int Priority=65535);
1022
1023   /// EmitCtorList - Generates a global array of functions and priorities using
1024   /// the given list and name. This array will have appending linkage and is
1025   /// suitable for use as a LLVM constructor or destructor array.
1026   void EmitCtorList(const CtorList &Fns, const char *GlobalName);
1027
1028   /// EmitFundamentalRTTIDescriptor - Emit the RTTI descriptors for the
1029   /// given type.
1030   void EmitFundamentalRTTIDescriptor(QualType Type);
1031
1032   /// EmitFundamentalRTTIDescriptors - Emit the RTTI descriptors for the
1033   /// builtin types.
1034   void EmitFundamentalRTTIDescriptors();
1035
1036   /// EmitDeferred - Emit any needed decls for which code generation
1037   /// was deferred.
1038   void EmitDeferred();
1039
1040   /// EmitDeferredVTables - Emit any vtables which we deferred and
1041   /// still have a use for.
1042   void EmitDeferredVTables();
1043
1044   /// EmitLLVMUsed - Emit the llvm.used metadata used to force
1045   /// references to global which may otherwise be optimized out.
1046   void EmitLLVMUsed();
1047
1048   /// \brief Emit the link options introduced by imported modules.
1049   void EmitModuleLinkOptions();
1050
1051   void EmitDeclMetadata();
1052
1053   /// EmitCoverageFile - Emit the llvm.gcov metadata used to tell LLVM where
1054   /// to emit the .gcno and .gcda files in a way that persists in .bc files.
1055   void EmitCoverageFile();
1056
1057   /// Emits the initializer for a uuidof string.
1058   llvm::Constant *EmitUuidofInitializer(StringRef uuidstr, QualType IIDType);
1059
1060   /// MayDeferGeneration - Determine if the given decl can be emitted
1061   /// lazily; this is only relevant for definitions. The given decl
1062   /// must be either a function or var decl.
1063   bool MayDeferGeneration(const ValueDecl *D);
1064
1065   /// SimplifyPersonality - Check whether we can use a "simpler", more
1066   /// core exceptions personality function.
1067   void SimplifyPersonality();
1068 };
1069 }  // end namespace CodeGen
1070 }  // end namespace clang
1071
1072 #endif