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