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 llvm::LLVMContext &VMContext; 328 329 /// @name Cache for Blocks Runtime Globals 330 /// @{ 331 332 llvm::Constant *NSConcreteGlobalBlock; 333 llvm::Constant *NSConcreteStackBlock; 334 335 llvm::Constant *BlockObjectAssign; 336 llvm::Constant *BlockObjectDispose; 337 338 llvm::Type *BlockDescriptorType; 339 llvm::Type *GenericBlockLiteralType; 340 341 struct { 342 int GlobalUniqueCount; 343 } Block; 344 345 /// @} 346 public: 347 CodeGenModule(ASTContext &C, const CodeGenOptions &CodeGenOpts, 348 llvm::Module &M, const llvm::TargetData &TD, 349 DiagnosticsEngine &Diags); 350 351 ~CodeGenModule(); 352 353 /// Release - Finalize LLVM code generation. 354 void Release(); 355 356 /// getObjCRuntime() - Return a reference to the configured 357 /// Objective-C runtime. 358 CGObjCRuntime &getObjCRuntime() { 359 if (!ObjCRuntime) createObjCRuntime(); 360 return *ObjCRuntime; 361 } 362 363 /// hasObjCRuntime() - Return true iff an Objective-C runtime has 364 /// been configured. 365 bool hasObjCRuntime() { return !!ObjCRuntime; } 366 367 /// getOpenCLRuntime() - Return a reference to the configured OpenCL runtime. 368 CGOpenCLRuntime &getOpenCLRuntime() { 369 assert(OpenCLRuntime != 0); 370 return *OpenCLRuntime; 371 } 372 373 /// getCUDARuntime() - Return a reference to the configured CUDA runtime. 374 CGCUDARuntime &getCUDARuntime() { 375 assert(CUDARuntime != 0); 376 return *CUDARuntime; 377 } 378 379 /// getCXXABI() - Return a reference to the configured C++ ABI. 380 CGCXXABI &getCXXABI() { return ABI; } 381 382 ARCEntrypoints &getARCEntrypoints() const { 383 assert(getLangOptions().ObjCAutoRefCount && ARCData != 0); 384 return *ARCData; 385 } 386 387 RREntrypoints &getRREntrypoints() const { 388 assert(RRData != 0); 389 return *RRData; 390 } 391 392 llvm::Value *getStaticLocalDeclAddress(const VarDecl *VD) { 393 return StaticLocalDeclMap[VD]; 394 } 395 void setStaticLocalDeclAddress(const VarDecl *D, 396 llvm::GlobalVariable *GV) { 397 StaticLocalDeclMap[D] = GV; 398 } 399 400 CGDebugInfo *getModuleDebugInfo() { return DebugInfo; } 401 402 ASTContext &getContext() const { return Context; } 403 const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; } 404 const LangOptions &getLangOptions() const { return Features; } 405 llvm::Module &getModule() const { return TheModule; } 406 CodeGenTypes &getTypes() { return Types; } 407 CodeGenVTables &getVTables() { return VTables; } 408 VTableContext &getVTableContext() { return VTables.getVTableContext(); } 409 DiagnosticsEngine &getDiags() const { return Diags; } 410 const llvm::TargetData &getTargetData() const { return TheTargetData; } 411 const TargetInfo &getTarget() const { return Context.getTargetInfo(); } 412 llvm::LLVMContext &getLLVMContext() { return VMContext; } 413 const TargetCodeGenInfo &getTargetCodeGenInfo(); 414 bool isTargetDarwin() const; 415 416 bool shouldUseTBAA() const { return TBAA != 0; } 417 418 llvm::MDNode *getTBAAInfo(QualType QTy); 419 420 static void DecorateInstruction(llvm::Instruction *Inst, 421 llvm::MDNode *TBAAInfo); 422 423 /// getSize - Emit the given number of characters as a value of type size_t. 424 llvm::ConstantInt *getSize(CharUnits numChars); 425 426 /// setGlobalVisibility - Set the visibility for the given LLVM 427 /// GlobalValue. 428 void setGlobalVisibility(llvm::GlobalValue *GV, const NamedDecl *D) const; 429 430 /// TypeVisibilityKind - The kind of global variable that is passed to 431 /// setTypeVisibility 432 enum TypeVisibilityKind { 433 TVK_ForVTT, 434 TVK_ForVTable, 435 TVK_ForConstructionVTable, 436 TVK_ForRTTI, 437 TVK_ForRTTIName 438 }; 439 440 /// setTypeVisibility - Set the visibility for the given global 441 /// value which holds information about a type. 442 void setTypeVisibility(llvm::GlobalValue *GV, const CXXRecordDecl *D, 443 TypeVisibilityKind TVK) const; 444 445 static llvm::GlobalValue::VisibilityTypes GetLLVMVisibility(Visibility V) { 446 switch (V) { 447 case DefaultVisibility: return llvm::GlobalValue::DefaultVisibility; 448 case HiddenVisibility: return llvm::GlobalValue::HiddenVisibility; 449 case ProtectedVisibility: return llvm::GlobalValue::ProtectedVisibility; 450 } 451 llvm_unreachable("unknown visibility!"); 452 return llvm::GlobalValue::DefaultVisibility; 453 } 454 455 llvm::Constant *GetAddrOfGlobal(GlobalDecl GD) { 456 if (isa<CXXConstructorDecl>(GD.getDecl())) 457 return GetAddrOfCXXConstructor(cast<CXXConstructorDecl>(GD.getDecl()), 458 GD.getCtorType()); 459 else if (isa<CXXDestructorDecl>(GD.getDecl())) 460 return GetAddrOfCXXDestructor(cast<CXXDestructorDecl>(GD.getDecl()), 461 GD.getDtorType()); 462 else if (isa<FunctionDecl>(GD.getDecl())) 463 return GetAddrOfFunction(GD); 464 else 465 return GetAddrOfGlobalVar(cast<VarDecl>(GD.getDecl())); 466 } 467 468 /// CreateOrReplaceCXXRuntimeVariable - Will return a global variable of the given 469 /// type. If a variable with a different type already exists then a new 470 /// variable with the right type will be created and all uses of the old 471 /// variable will be replaced with a bitcast to the new variable. 472 llvm::GlobalVariable * 473 CreateOrReplaceCXXRuntimeVariable(StringRef Name, llvm::Type *Ty, 474 llvm::GlobalValue::LinkageTypes Linkage); 475 476 /// GetAddrOfGlobalVar - Return the llvm::Constant for the address of the 477 /// given global variable. If Ty is non-null and if the global doesn't exist, 478 /// then it will be greated with the specified type instead of whatever the 479 /// normal requested type would be. 480 llvm::Constant *GetAddrOfGlobalVar(const VarDecl *D, 481 llvm::Type *Ty = 0); 482 483 484 /// GetAddrOfFunction - Return the address of the given function. If Ty is 485 /// non-null, then this function will use the specified type if it has to 486 /// create it. 487 llvm::Constant *GetAddrOfFunction(GlobalDecl GD, 488 llvm::Type *Ty = 0, 489 bool ForVTable = false); 490 491 /// GetAddrOfRTTIDescriptor - Get the address of the RTTI descriptor 492 /// for the given type. 493 llvm::Constant *GetAddrOfRTTIDescriptor(QualType Ty, bool ForEH = false); 494 495 /// GetAddrOfThunk - Get the address of the thunk for the given global decl. 496 llvm::Constant *GetAddrOfThunk(GlobalDecl GD, const ThunkInfo &Thunk); 497 498 /// GetWeakRefReference - Get a reference to the target of VD. 499 llvm::Constant *GetWeakRefReference(const ValueDecl *VD); 500 501 /// GetNonVirtualBaseClassOffset - Returns the offset from a derived class to 502 /// a class. Returns null if the offset is 0. 503 llvm::Constant * 504 GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl, 505 CastExpr::path_const_iterator PathBegin, 506 CastExpr::path_const_iterator PathEnd); 507 508 /// A pair of helper functions for a __block variable. 509 class ByrefHelpers : public llvm::FoldingSetNode { 510 public: 511 llvm::Constant *CopyHelper; 512 llvm::Constant *DisposeHelper; 513 514 /// The alignment of the field. This is important because 515 /// different offsets to the field within the byref struct need to 516 /// have different helper functions. 517 CharUnits Alignment; 518 519 ByrefHelpers(CharUnits alignment) : Alignment(alignment) {} 520 virtual ~ByrefHelpers(); 521 522 void Profile(llvm::FoldingSetNodeID &id) const { 523 id.AddInteger(Alignment.getQuantity()); 524 profileImpl(id); 525 } 526 virtual void profileImpl(llvm::FoldingSetNodeID &id) const = 0; 527 528 virtual bool needsCopy() const { return true; } 529 virtual void emitCopy(CodeGenFunction &CGF, 530 llvm::Value *dest, llvm::Value *src) = 0; 531 532 virtual bool needsDispose() const { return true; } 533 virtual void emitDispose(CodeGenFunction &CGF, llvm::Value *field) = 0; 534 }; 535 536 llvm::FoldingSet<ByrefHelpers> ByrefHelpersCache; 537 538 /// getUniqueBlockCount - Fetches the global unique block count. 539 int getUniqueBlockCount() { return ++Block.GlobalUniqueCount; } 540 541 /// getBlockDescriptorType - Fetches the type of a generic block 542 /// descriptor. 543 llvm::Type *getBlockDescriptorType(); 544 545 /// getGenericBlockLiteralType - The type of a generic block literal. 546 llvm::Type *getGenericBlockLiteralType(); 547 548 /// GetAddrOfGlobalBlock - Gets the address of a block which 549 /// requires no captures. 550 llvm::Constant *GetAddrOfGlobalBlock(const BlockExpr *BE, const char *); 551 552 /// GetStringForStringLiteral - Return the appropriate bytes for a string 553 /// literal, properly padded to match the literal type. If only the address of 554 /// a constant is needed consider using GetAddrOfConstantStringLiteral. 555 std::string GetStringForStringLiteral(const StringLiteral *E); 556 557 /// GetAddrOfConstantCFString - Return a pointer to a constant CFString object 558 /// for the given string. 559 llvm::Constant *GetAddrOfConstantCFString(const StringLiteral *Literal); 560 561 /// GetAddrOfConstantString - Return a pointer to a constant NSString object 562 /// for the given string. Or a user defined String object as defined via 563 /// -fconstant-string-class=class_name option. 564 llvm::Constant *GetAddrOfConstantString(const StringLiteral *Literal); 565 566 /// GetAddrOfConstantStringFromLiteral - Return a pointer to a constant array 567 /// for the given string literal. 568 llvm::Constant *GetAddrOfConstantStringFromLiteral(const StringLiteral *S); 569 570 /// GetAddrOfConstantStringFromObjCEncode - Return a pointer to a constant 571 /// array for the given ObjCEncodeExpr node. 572 llvm::Constant *GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *); 573 574 /// GetAddrOfConstantString - Returns a pointer to a character array 575 /// containing the literal. This contents are exactly that of the given 576 /// string, i.e. it will not be null terminated automatically; see 577 /// GetAddrOfConstantCString. Note that whether the result is actually a 578 /// pointer to an LLVM constant depends on Feature.WriteableStrings. 579 /// 580 /// The result has pointer to array type. 581 /// 582 /// \param GlobalName If provided, the name to use for the global 583 /// (if one is created). 584 llvm::Constant *GetAddrOfConstantString(StringRef Str, 585 const char *GlobalName=0, 586 unsigned Alignment=1); 587 588 /// GetAddrOfConstantCString - Returns a pointer to a character array 589 /// containing the literal and a terminating '\0' character. The result has 590 /// pointer to array type. 591 /// 592 /// \param GlobalName If provided, the name to use for the global (if one is 593 /// created). 594 llvm::Constant *GetAddrOfConstantCString(const std::string &str, 595 const char *GlobalName=0, 596 unsigned Alignment=1); 597 598 /// \brief Retrieve the record type that describes the state of an 599 /// Objective-C fast enumeration loop (for..in). 600 QualType getObjCFastEnumerationStateType(); 601 602 /// GetAddrOfCXXConstructor - Return the address of the constructor of the 603 /// given type. 604 llvm::GlobalValue *GetAddrOfCXXConstructor(const CXXConstructorDecl *ctor, 605 CXXCtorType ctorType, 606 const CGFunctionInfo *fnInfo = 0); 607 608 /// GetAddrOfCXXDestructor - Return the address of the constructor of the 609 /// given type. 610 llvm::GlobalValue *GetAddrOfCXXDestructor(const CXXDestructorDecl *dtor, 611 CXXDtorType dtorType, 612 const CGFunctionInfo *fnInfo = 0); 613 614 /// getBuiltinLibFunction - Given a builtin id for a function like 615 /// "__builtin_fabsf", return a Function* for "fabsf". 616 llvm::Value *getBuiltinLibFunction(const FunctionDecl *FD, 617 unsigned BuiltinID); 618 619 llvm::Function *getIntrinsic(unsigned IID, ArrayRef<llvm::Type*> Tys = 620 ArrayRef<llvm::Type*>()); 621 622 /// EmitTopLevelDecl - Emit code for a single top level declaration. 623 void EmitTopLevelDecl(Decl *D); 624 625 /// AddUsedGlobal - Add a global which should be forced to be 626 /// present in the object file; these are emitted to the llvm.used 627 /// metadata global. 628 void AddUsedGlobal(llvm::GlobalValue *GV); 629 630 /// AddCXXDtorEntry - Add a destructor and object to add to the C++ global 631 /// destructor function. 632 void AddCXXDtorEntry(llvm::Constant *DtorFn, llvm::Constant *Object) { 633 CXXGlobalDtors.push_back(std::make_pair(DtorFn, Object)); 634 } 635 636 /// CreateRuntimeFunction - Create a new runtime function with the specified 637 /// type and name. 638 llvm::Constant *CreateRuntimeFunction(llvm::FunctionType *Ty, 639 StringRef Name, 640 llvm::Attributes ExtraAttrs = 641 llvm::Attribute::None); 642 /// CreateRuntimeVariable - Create a new runtime global variable with the 643 /// specified type and name. 644 llvm::Constant *CreateRuntimeVariable(llvm::Type *Ty, 645 StringRef Name); 646 647 ///@name Custom Blocks Runtime Interfaces 648 ///@{ 649 650 llvm::Constant *getNSConcreteGlobalBlock(); 651 llvm::Constant *getNSConcreteStackBlock(); 652 llvm::Constant *getBlockObjectAssign(); 653 llvm::Constant *getBlockObjectDispose(); 654 655 ///@} 656 657 // UpdateCompleteType - Make sure that this type is translated. 658 void UpdateCompletedType(const TagDecl *TD); 659 660 llvm::Constant *getMemberPointerConstant(const UnaryOperator *e); 661 662 /// EmitConstantExpr - Try to emit the given expression as a 663 /// constant; returns 0 if the expression cannot be emitted as a 664 /// constant. 665 llvm::Constant *EmitConstantExpr(const Expr *E, QualType DestType, 666 CodeGenFunction *CGF = 0); 667 668 /// EmitNullConstant - Return the result of value-initializing the given 669 /// type, i.e. a null expression of the given type. This is usually, 670 /// but not always, an LLVM null constant. 671 llvm::Constant *EmitNullConstant(QualType T); 672 673 /// EmitNullConstantForBase - Return a null constant appropriate for 674 /// zero-initializing a base class with the given type. This is usually, 675 /// but not always, an LLVM null constant. 676 llvm::Constant *EmitNullConstantForBase(const CXXRecordDecl *Record); 677 678 /// Error - Emit a general error that something can't be done. 679 void Error(SourceLocation loc, StringRef error); 680 681 /// ErrorUnsupported - Print out an error that codegen doesn't support the 682 /// specified stmt yet. 683 /// \param OmitOnError - If true, then this error should only be emitted if no 684 /// other errors have been reported. 685 void ErrorUnsupported(const Stmt *S, const char *Type, 686 bool OmitOnError=false); 687 688 /// ErrorUnsupported - Print out an error that codegen doesn't support the 689 /// specified decl yet. 690 /// \param OmitOnError - If true, then this error should only be emitted if no 691 /// other errors have been reported. 692 void ErrorUnsupported(const Decl *D, const char *Type, 693 bool OmitOnError=false); 694 695 /// SetInternalFunctionAttributes - Set the attributes on the LLVM 696 /// function for the given decl and function info. This applies 697 /// attributes necessary for handling the ABI as well as user 698 /// specified attributes like section. 699 void SetInternalFunctionAttributes(const Decl *D, llvm::Function *F, 700 const CGFunctionInfo &FI); 701 702 /// SetLLVMFunctionAttributes - Set the LLVM function attributes 703 /// (sext, zext, etc). 704 void SetLLVMFunctionAttributes(const Decl *D, 705 const CGFunctionInfo &Info, 706 llvm::Function *F); 707 708 /// SetLLVMFunctionAttributesForDefinition - Set the LLVM function attributes 709 /// which only apply to a function definintion. 710 void SetLLVMFunctionAttributesForDefinition(const Decl *D, llvm::Function *F); 711 712 /// ReturnTypeUsesSRet - Return true iff the given type uses 'sret' when used 713 /// as a return type. 714 bool ReturnTypeUsesSRet(const CGFunctionInfo &FI); 715 716 /// ReturnTypeUsesSret - Return true iff the given type uses 'fpret' when used 717 /// as a return type. 718 bool ReturnTypeUsesFPRet(QualType ResultType); 719 720 /// ConstructAttributeList - Get the LLVM attributes and calling convention to 721 /// use for a particular function type. 722 /// 723 /// \param Info - The function type information. 724 /// \param TargetDecl - The decl these attributes are being constructed 725 /// for. If supplied the attributes applied to this decl may contribute to the 726 /// function attributes and calling convention. 727 /// \param PAL [out] - On return, the attribute list to use. 728 /// \param CallingConv [out] - On return, the LLVM calling convention to use. 729 void ConstructAttributeList(const CGFunctionInfo &Info, 730 const Decl *TargetDecl, 731 AttributeListType &PAL, 732 unsigned &CallingConv); 733 734 StringRef getMangledName(GlobalDecl GD); 735 void getBlockMangledName(GlobalDecl GD, MangleBuffer &Buffer, 736 const BlockDecl *BD); 737 738 void EmitTentativeDefinition(const VarDecl *D); 739 740 void EmitVTable(CXXRecordDecl *Class, bool DefinitionRequired); 741 742 llvm::GlobalVariable::LinkageTypes 743 getFunctionLinkage(const FunctionDecl *FD); 744 745 void setFunctionLinkage(const FunctionDecl *FD, llvm::GlobalValue *V) { 746 V->setLinkage(getFunctionLinkage(FD)); 747 } 748 749 /// getVTableLinkage - Return the appropriate linkage for the vtable, VTT, 750 /// and type information of the given class. 751 llvm::GlobalVariable::LinkageTypes getVTableLinkage(const CXXRecordDecl *RD); 752 753 /// GetTargetTypeStoreSize - Return the store size, in character units, of 754 /// the given LLVM type. 755 CharUnits GetTargetTypeStoreSize(llvm::Type *Ty) const; 756 757 /// GetLLVMLinkageVarDefinition - Returns LLVM linkage for a global 758 /// variable. 759 llvm::GlobalValue::LinkageTypes 760 GetLLVMLinkageVarDefinition(const VarDecl *D, 761 llvm::GlobalVariable *GV); 762 763 std::vector<const CXXRecordDecl*> DeferredVTables; 764 765 /// Emit all the global annotations. 766 void EmitGlobalAnnotations(); 767 768 /// Emit an annotation string. 769 llvm::Constant *EmitAnnotationString(llvm::StringRef Str); 770 771 /// Emit the annotation's translation unit. 772 llvm::Constant *EmitAnnotationUnit(SourceLocation Loc); 773 774 /// Emit the annotation line number. 775 llvm::Constant *EmitAnnotationLineNo(SourceLocation L); 776 777 /// EmitAnnotateAttr - Generate the llvm::ConstantStruct which contains the 778 /// annotation information for a given GlobalValue. The annotation struct is 779 /// {i8 *, i8 *, i8 *, i32}. The first field is a constant expression, the 780 /// GlobalValue being annotated. The second field is the constant string 781 /// created from the AnnotateAttr's annotation. The third field is a constant 782 /// string containing the name of the translation unit. The fourth field is 783 /// the line number in the file of the annotated value declaration. 784 llvm::Constant *EmitAnnotateAttr(llvm::GlobalValue *GV, 785 const AnnotateAttr *AA, 786 SourceLocation L); 787 788 /// Add global annotations that are set on D, for the global GV. Those 789 /// annotations are emitted during finalization of the LLVM code. 790 void AddGlobalAnnotations(const ValueDecl *D, llvm::GlobalValue *GV); 791 792 private: 793 llvm::GlobalValue *GetGlobalValue(StringRef Ref); 794 795 llvm::Constant *GetOrCreateLLVMFunction(StringRef MangledName, 796 llvm::Type *Ty, 797 GlobalDecl D, 798 bool ForVTable, 799 llvm::Attributes ExtraAttrs = 800 llvm::Attribute::None); 801 llvm::Constant *GetOrCreateLLVMGlobal(StringRef MangledName, 802 llvm::PointerType *PTy, 803 const VarDecl *D, 804 bool UnnamedAddr = false); 805 806 /// SetCommonAttributes - Set attributes which are common to any 807 /// form of a global definition (alias, Objective-C method, 808 /// function, global variable). 809 /// 810 /// NOTE: This should only be called for definitions. 811 void SetCommonAttributes(const Decl *D, llvm::GlobalValue *GV); 812 813 /// SetFunctionDefinitionAttributes - Set attributes for a global definition. 814 void SetFunctionDefinitionAttributes(const FunctionDecl *D, 815 llvm::GlobalValue *GV); 816 817 /// SetFunctionAttributes - Set function attributes for a function 818 /// declaration. 819 void SetFunctionAttributes(GlobalDecl GD, 820 llvm::Function *F, 821 bool IsIncompleteFunction); 822 823 /// EmitGlobal - Emit code for a singal global function or var decl. Forward 824 /// declarations are emitted lazily. 825 void EmitGlobal(GlobalDecl D); 826 827 void EmitGlobalDefinition(GlobalDecl D); 828 829 void EmitGlobalFunctionDefinition(GlobalDecl GD); 830 void EmitGlobalVarDefinition(const VarDecl *D); 831 void EmitAliasDefinition(GlobalDecl GD); 832 void EmitObjCPropertyImplementations(const ObjCImplementationDecl *D); 833 void EmitObjCIvarInitializations(ObjCImplementationDecl *D); 834 835 // C++ related functions. 836 837 bool TryEmitDefinitionAsAlias(GlobalDecl Alias, GlobalDecl Target); 838 bool TryEmitBaseDestructorAsAlias(const CXXDestructorDecl *D); 839 840 void EmitNamespace(const NamespaceDecl *D); 841 void EmitLinkageSpec(const LinkageSpecDecl *D); 842 843 /// EmitCXXConstructors - Emit constructors (base, complete) from a 844 /// C++ constructor Decl. 845 void EmitCXXConstructors(const CXXConstructorDecl *D); 846 847 /// EmitCXXConstructor - Emit a single constructor with the given type from 848 /// a C++ constructor Decl. 849 void EmitCXXConstructor(const CXXConstructorDecl *D, CXXCtorType Type); 850 851 /// EmitCXXDestructors - Emit destructors (base, complete) from a 852 /// C++ destructor Decl. 853 void EmitCXXDestructors(const CXXDestructorDecl *D); 854 855 /// EmitCXXDestructor - Emit a single destructor with the given type from 856 /// a C++ destructor Decl. 857 void EmitCXXDestructor(const CXXDestructorDecl *D, CXXDtorType Type); 858 859 /// EmitCXXGlobalInitFunc - Emit the function that initializes C++ globals. 860 void EmitCXXGlobalInitFunc(); 861 862 /// EmitCXXGlobalDtorFunc - Emit the function that destroys C++ globals. 863 void EmitCXXGlobalDtorFunc(); 864 865 void EmitCXXGlobalVarDeclInitFunc(const VarDecl *D, 866 llvm::GlobalVariable *Addr); 867 868 // FIXME: Hardcoding priority here is gross. 869 void AddGlobalCtor(llvm::Function *Ctor, int Priority=65535); 870 void AddGlobalDtor(llvm::Function *Dtor, int Priority=65535); 871 872 /// EmitCtorList - Generates a global array of functions and priorities using 873 /// the given list and name. This array will have appending linkage and is 874 /// suitable for use as a LLVM constructor or destructor array. 875 void EmitCtorList(const CtorList &Fns, const char *GlobalName); 876 877 /// EmitFundamentalRTTIDescriptor - Emit the RTTI descriptors for the 878 /// given type. 879 void EmitFundamentalRTTIDescriptor(QualType Type); 880 881 /// EmitFundamentalRTTIDescriptors - Emit the RTTI descriptors for the 882 /// builtin types. 883 void EmitFundamentalRTTIDescriptors(); 884 885 /// EmitDeferred - Emit any needed decls for which code generation 886 /// was deferred. 887 void EmitDeferred(void); 888 889 /// EmitLLVMUsed - Emit the llvm.used metadata used to force 890 /// references to global which may otherwise be optimized out. 891 void EmitLLVMUsed(void); 892 893 void EmitDeclMetadata(); 894 895 /// EmitCoverageFile - Emit the llvm.gcov metadata used to tell LLVM where 896 /// to emit the .gcno and .gcda files in a way that persists in .bc files. 897 void EmitCoverageFile(); 898 899 /// MayDeferGeneration - Determine if the given decl can be emitted 900 /// lazily; this is only relevant for definitions. The given decl 901 /// must be either a function or var decl. 902 bool MayDeferGeneration(const ValueDecl *D); 903 904 /// SimplifyPersonality - Check whether we can use a "simpler", more 905 /// core exceptions personality function. 906 void SimplifyPersonality(); 907 }; 908 } // end namespace CodeGen 909 } // end namespace clang 910 911 #endif 912
