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