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