| //===--- CodeGenModule.h - Per-Module state for LLVM CodeGen ----*- C++ -*-===// |
| // |
| // The LLVM Compiler Infrastructure |
| // |
| // This file is distributed under the University of Illinois Open Source |
| // License. See LICENSE.TXT for details. |
| // |
| //===----------------------------------------------------------------------===// |
| // |
| // This is the internal per-translation-unit state used for llvm translation. |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #ifndef CLANG_CODEGEN_CODEGENMODULE_H |
| #define CLANG_CODEGEN_CODEGENMODULE_H |
| |
| #include "clang/Basic/ABI.h" |
| #include "clang/Basic/LangOptions.h" |
| #include "clang/AST/Attr.h" |
| #include "clang/AST/DeclCXX.h" |
| #include "clang/AST/DeclObjC.h" |
| #include "clang/AST/GlobalDecl.h" |
| #include "clang/AST/Mangle.h" |
| #include "CGVTables.h" |
| #include "CodeGenTypes.h" |
| #include "llvm/Module.h" |
| #include "llvm/ADT/DenseMap.h" |
| #include "llvm/ADT/StringMap.h" |
| #include "llvm/ADT/SmallPtrSet.h" |
| #include "llvm/Support/ValueHandle.h" |
| |
| namespace llvm { |
| class Module; |
| class Constant; |
| class ConstantInt; |
| class Function; |
| class GlobalValue; |
| class TargetData; |
| class FunctionType; |
| class LLVMContext; |
| } |
| |
| namespace clang { |
| class TargetCodeGenInfo; |
| class ASTContext; |
| class FunctionDecl; |
| class IdentifierInfo; |
| class ObjCMethodDecl; |
| class ObjCImplementationDecl; |
| class ObjCCategoryImplDecl; |
| class ObjCProtocolDecl; |
| class ObjCEncodeExpr; |
| class BlockExpr; |
| class CharUnits; |
| class Decl; |
| class Expr; |
| class Stmt; |
| class StringLiteral; |
| class NamedDecl; |
| class ValueDecl; |
| class VarDecl; |
| class LangOptions; |
| class CodeGenOptions; |
| class DiagnosticsEngine; |
| class AnnotateAttr; |
| class CXXDestructorDecl; |
| class MangleBuffer; |
| |
| namespace CodeGen { |
| |
| class CallArgList; |
| class CodeGenFunction; |
| class CodeGenTBAA; |
| class CGCXXABI; |
| class CGDebugInfo; |
| class CGObjCRuntime; |
| class CGOpenCLRuntime; |
| class CGCUDARuntime; |
| class BlockFieldFlags; |
| class FunctionArgList; |
| |
| struct OrderGlobalInits { |
| unsigned int priority; |
| unsigned int lex_order; |
| OrderGlobalInits(unsigned int p, unsigned int l) |
| : priority(p), lex_order(l) {} |
| |
| bool operator==(const OrderGlobalInits &RHS) const { |
| return priority == RHS.priority && |
| lex_order == RHS.lex_order; |
| } |
| |
| bool operator<(const OrderGlobalInits &RHS) const { |
| if (priority < RHS.priority) |
| return true; |
| |
| return priority == RHS.priority && lex_order < RHS.lex_order; |
| } |
| }; |
| |
| struct CodeGenTypeCache { |
| /// void |
| llvm::Type *VoidTy; |
| |
| /// i8, i32, and i64 |
| llvm::IntegerType *Int8Ty, *Int32Ty, *Int64Ty; |
| |
| /// int |
| llvm::IntegerType *IntTy; |
| |
| /// intptr_t, size_t, and ptrdiff_t, which we assume are the same size. |
| union { |
| llvm::IntegerType *IntPtrTy; |
| llvm::IntegerType *SizeTy; |
| llvm::IntegerType *PtrDiffTy; |
| }; |
| |
| /// void* in address space 0 |
| union { |
| llvm::PointerType *VoidPtrTy; |
| llvm::PointerType *Int8PtrTy; |
| }; |
| |
| /// void** in address space 0 |
| union { |
| llvm::PointerType *VoidPtrPtrTy; |
| llvm::PointerType *Int8PtrPtrTy; |
| }; |
| |
| /// The width of a pointer into the generic address space. |
| unsigned char PointerWidthInBits; |
| |
| /// The size and alignment of a pointer into the generic address |
| /// space. |
| union { |
| unsigned char PointerAlignInBytes; |
| unsigned char PointerSizeInBytes; |
| }; |
| }; |
| |
| struct RREntrypoints { |
| RREntrypoints() { memset(this, 0, sizeof(*this)); } |
| /// void objc_autoreleasePoolPop(void*); |
| llvm::Constant *objc_autoreleasePoolPop; |
| |
| /// void *objc_autoreleasePoolPush(void); |
| llvm::Constant *objc_autoreleasePoolPush; |
| }; |
| |
| struct ARCEntrypoints { |
| ARCEntrypoints() { memset(this, 0, sizeof(*this)); } |
| |
| /// id objc_autorelease(id); |
| llvm::Constant *objc_autorelease; |
| |
| /// id objc_autoreleaseReturnValue(id); |
| llvm::Constant *objc_autoreleaseReturnValue; |
| |
| /// void objc_copyWeak(id *dest, id *src); |
| llvm::Constant *objc_copyWeak; |
| |
| /// void objc_destroyWeak(id*); |
| llvm::Constant *objc_destroyWeak; |
| |
| /// id objc_initWeak(id*, id); |
| llvm::Constant *objc_initWeak; |
| |
| /// id objc_loadWeak(id*); |
| llvm::Constant *objc_loadWeak; |
| |
| /// id objc_loadWeakRetained(id*); |
| llvm::Constant *objc_loadWeakRetained; |
| |
| /// void objc_moveWeak(id *dest, id *src); |
| llvm::Constant *objc_moveWeak; |
| |
| /// id objc_retain(id); |
| llvm::Constant *objc_retain; |
| |
| /// id objc_retainAutorelease(id); |
| llvm::Constant *objc_retainAutorelease; |
| |
| /// id objc_retainAutoreleaseReturnValue(id); |
| llvm::Constant *objc_retainAutoreleaseReturnValue; |
| |
| /// id objc_retainAutoreleasedReturnValue(id); |
| llvm::Constant *objc_retainAutoreleasedReturnValue; |
| |
| /// id objc_retainBlock(id); |
| llvm::Constant *objc_retainBlock; |
| |
| /// void objc_release(id); |
| llvm::Constant *objc_release; |
| |
| /// id objc_storeStrong(id*, id); |
| llvm::Constant *objc_storeStrong; |
| |
| /// id objc_storeWeak(id*, id); |
| llvm::Constant *objc_storeWeak; |
| |
| /// A void(void) inline asm to use to mark that the return value of |
| /// a call will be immediately retain. |
| llvm::InlineAsm *retainAutoreleasedReturnValueMarker; |
| }; |
| |
| /// CodeGenModule - This class organizes the cross-function state that is used |
| /// while generating LLVM code. |
| class CodeGenModule : public CodeGenTypeCache { |
| CodeGenModule(const CodeGenModule&); // DO NOT IMPLEMENT |
| void operator=(const CodeGenModule&); // DO NOT IMPLEMENT |
| |
| typedef std::vector<std::pair<llvm::Constant*, int> > CtorList; |
| |
| ASTContext &Context; |
| const LangOptions &Features; |
| const CodeGenOptions &CodeGenOpts; |
| llvm::Module &TheModule; |
| const llvm::TargetData &TheTargetData; |
| mutable const TargetCodeGenInfo *TheTargetCodeGenInfo; |
| DiagnosticsEngine &Diags; |
| CGCXXABI &ABI; |
| CodeGenTypes Types; |
| CodeGenTBAA *TBAA; |
| |
| /// VTables - Holds information about C++ vtables. |
| CodeGenVTables VTables; |
| friend class CodeGenVTables; |
| |
| CGObjCRuntime* ObjCRuntime; |
| CGOpenCLRuntime* OpenCLRuntime; |
| CGCUDARuntime* CUDARuntime; |
| CGDebugInfo* DebugInfo; |
| ARCEntrypoints *ARCData; |
| RREntrypoints *RRData; |
| |
| // WeakRefReferences - A set of references that have only been seen via |
| // a weakref so far. This is used to remove the weak of the reference if we ever |
| // see a direct reference or a definition. |
| llvm::SmallPtrSet<llvm::GlobalValue*, 10> WeakRefReferences; |
| |
| /// DeferredDecls - This contains all the decls which have definitions but |
| /// which are deferred for emission and therefore should only be output if |
| /// they are actually used. If a decl is in this, then it is known to have |
| /// not been referenced yet. |
| llvm::StringMap<GlobalDecl> DeferredDecls; |
| |
| /// DeferredDeclsToEmit - This is a list of deferred decls which we have seen |
| /// that *are* actually referenced. These get code generated when the module |
| /// is done. |
| std::vector<GlobalDecl> DeferredDeclsToEmit; |
| |
| /// LLVMUsed - List of global values which are required to be |
| /// present in the object file; bitcast to i8*. This is used for |
| /// forcing visibility of symbols which may otherwise be optimized |
| /// out. |
| std::vector<llvm::WeakVH> LLVMUsed; |
| |
| /// GlobalCtors - Store the list of global constructors and their respective |
| /// priorities to be emitted when the translation unit is complete. |
| CtorList GlobalCtors; |
| |
| /// GlobalDtors - Store the list of global destructors and their respective |
| /// priorities to be emitted when the translation unit is complete. |
| CtorList GlobalDtors; |
| |
| /// MangledDeclNames - A map of canonical GlobalDecls to their mangled names. |
| llvm::DenseMap<GlobalDecl, StringRef> MangledDeclNames; |
| llvm::BumpPtrAllocator MangledNamesAllocator; |
| |
| /// Global annotations. |
| std::vector<llvm::Constant*> Annotations; |
| |
| /// Map used to get unique annotation strings. |
| llvm::StringMap<llvm::Constant*> AnnotationStrings; |
| |
| llvm::StringMap<llvm::Constant*> CFConstantStringMap; |
| llvm::StringMap<llvm::GlobalVariable*> ConstantStringMap; |
| llvm::DenseMap<const Decl*, llvm::Value*> StaticLocalDeclMap; |
| |
| llvm::DenseMap<QualType, llvm::Constant *> AtomicSetterHelperFnMap; |
| llvm::DenseMap<QualType, llvm::Constant *> AtomicGetterHelperFnMap; |
| |
| /// CXXGlobalInits - Global variables with initializers that need to run |
| /// before main. |
| std::vector<llvm::Constant*> CXXGlobalInits; |
| |
| /// When a C++ decl with an initializer is deferred, null is |
| /// appended to CXXGlobalInits, and the index of that null is placed |
| /// here so that the initializer will be performed in the correct |
| /// order. |
| llvm::DenseMap<const Decl*, unsigned> DelayedCXXInitPosition; |
| |
| /// - Global variables with initializers whose order of initialization |
| /// is set by init_priority attribute. |
| |
| SmallVector<std::pair<OrderGlobalInits, llvm::Function*>, 8> |
| PrioritizedCXXGlobalInits; |
| |
| /// CXXGlobalDtors - Global destructor functions and arguments that need to |
| /// run on termination. |
| std::vector<std::pair<llvm::WeakVH,llvm::Constant*> > CXXGlobalDtors; |
| |
| /// @name Cache for Objective-C runtime types |
| /// @{ |
| |
| /// CFConstantStringClassRef - Cached reference to the class for constant |
| /// strings. This value has type int * but is actually an Obj-C class pointer. |
| llvm::Constant *CFConstantStringClassRef; |
| |
| /// ConstantStringClassRef - Cached reference to the class for constant |
| /// strings. This value has type int * but is actually an Obj-C class pointer. |
| llvm::Constant *ConstantStringClassRef; |
| |
| /// \brief The LLVM type corresponding to NSConstantString. |
| llvm::StructType *NSConstantStringType; |
| |
| /// \brief The type used to describe the state of a fast enumeration in |
| /// Objective-C's for..in loop. |
| QualType ObjCFastEnumerationStateType; |
| |
| /// @} |
| |
| /// Lazily create the Objective-C runtime |
| void createObjCRuntime(); |
| |
| void createOpenCLRuntime(); |
| void createCUDARuntime(); |
| |
| bool isTriviallyRecursive(const FunctionDecl *F); |
| bool shouldEmitFunction(const FunctionDecl *F); |
| llvm::LLVMContext &VMContext; |
| |
| /// @name Cache for Blocks Runtime Globals |
| /// @{ |
| |
| llvm::Constant *NSConcreteGlobalBlock; |
| llvm::Constant *NSConcreteStackBlock; |
| |
| llvm::Constant *BlockObjectAssign; |
| llvm::Constant *BlockObjectDispose; |
| |
| llvm::Type *BlockDescriptorType; |
| llvm::Type *GenericBlockLiteralType; |
| |
| struct { |
| int GlobalUniqueCount; |
| } Block; |
| |
| /// @} |
| public: |
| CodeGenModule(ASTContext &C, const CodeGenOptions &CodeGenOpts, |
| llvm::Module &M, const llvm::TargetData &TD, |
| DiagnosticsEngine &Diags); |
| |
| ~CodeGenModule(); |
| |
| /// Release - Finalize LLVM code generation. |
| void Release(); |
| |
| /// getObjCRuntime() - Return a reference to the configured |
| /// Objective-C runtime. |
| CGObjCRuntime &getObjCRuntime() { |
| if (!ObjCRuntime) createObjCRuntime(); |
| return *ObjCRuntime; |
| } |
| |
| /// hasObjCRuntime() - Return true iff an Objective-C runtime has |
| /// been configured. |
| bool hasObjCRuntime() { return !!ObjCRuntime; } |
| |
| /// getOpenCLRuntime() - Return a reference to the configured OpenCL runtime. |
| CGOpenCLRuntime &getOpenCLRuntime() { |
| assert(OpenCLRuntime != 0); |
| return *OpenCLRuntime; |
| } |
| |
| /// getCUDARuntime() - Return a reference to the configured CUDA runtime. |
| CGCUDARuntime &getCUDARuntime() { |
| assert(CUDARuntime != 0); |
| return *CUDARuntime; |
| } |
| |
| /// getCXXABI() - Return a reference to the configured C++ ABI. |
| CGCXXABI &getCXXABI() { return ABI; } |
| |
| ARCEntrypoints &getARCEntrypoints() const { |
| assert(getLangOptions().ObjCAutoRefCount && ARCData != 0); |
| return *ARCData; |
| } |
| |
| RREntrypoints &getRREntrypoints() const { |
| assert(RRData != 0); |
| return *RRData; |
| } |
| |
| llvm::Value *getStaticLocalDeclAddress(const VarDecl *VD) { |
| return StaticLocalDeclMap[VD]; |
| } |
| void setStaticLocalDeclAddress(const VarDecl *D, |
| llvm::GlobalVariable *GV) { |
| StaticLocalDeclMap[D] = GV; |
| } |
| |
| llvm::Constant *getAtomicSetterHelperFnMap(QualType Ty) { |
| return AtomicSetterHelperFnMap[Ty]; |
| } |
| void setAtomicSetterHelperFnMap(QualType Ty, |
| llvm::Constant *Fn) { |
| AtomicSetterHelperFnMap[Ty] = Fn; |
| } |
| |
| llvm::Constant *getAtomicGetterHelperFnMap(QualType Ty) { |
| return AtomicGetterHelperFnMap[Ty]; |
| } |
| void setAtomicGetterHelperFnMap(QualType Ty, |
| llvm::Constant *Fn) { |
| AtomicGetterHelperFnMap[Ty] = Fn; |
| } |
| |
| CGDebugInfo *getModuleDebugInfo() { return DebugInfo; } |
| |
| ASTContext &getContext() const { return Context; } |
| const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; } |
| const LangOptions &getLangOptions() const { return Features; } |
| llvm::Module &getModule() const { return TheModule; } |
| CodeGenTypes &getTypes() { return Types; } |
| CodeGenVTables &getVTables() { return VTables; } |
| VTableContext &getVTableContext() { return VTables.getVTableContext(); } |
| DiagnosticsEngine &getDiags() const { return Diags; } |
| const llvm::TargetData &getTargetData() const { return TheTargetData; } |
| const TargetInfo &getTarget() const { return Context.getTargetInfo(); } |
| llvm::LLVMContext &getLLVMContext() { return VMContext; } |
| const TargetCodeGenInfo &getTargetCodeGenInfo(); |
| bool isTargetDarwin() const; |
| |
| bool shouldUseTBAA() const { return TBAA != 0; } |
| |
| llvm::MDNode *getTBAAInfo(QualType QTy); |
| |
| static void DecorateInstruction(llvm::Instruction *Inst, |
| llvm::MDNode *TBAAInfo); |
| |
| /// getSize - Emit the given number of characters as a value of type size_t. |
| llvm::ConstantInt *getSize(CharUnits numChars); |
| |
| /// setGlobalVisibility - Set the visibility for the given LLVM |
| /// GlobalValue. |
| void setGlobalVisibility(llvm::GlobalValue *GV, const NamedDecl *D) const; |
| |
| /// TypeVisibilityKind - The kind of global variable that is passed to |
| /// setTypeVisibility |
| enum TypeVisibilityKind { |
| TVK_ForVTT, |
| TVK_ForVTable, |
| TVK_ForConstructionVTable, |
| TVK_ForRTTI, |
| TVK_ForRTTIName |
| }; |
| |
| /// setTypeVisibility - Set the visibility for the given global |
| /// value which holds information about a type. |
| void setTypeVisibility(llvm::GlobalValue *GV, const CXXRecordDecl *D, |
| TypeVisibilityKind TVK) const; |
| |
| static llvm::GlobalValue::VisibilityTypes GetLLVMVisibility(Visibility V) { |
| switch (V) { |
| case DefaultVisibility: return llvm::GlobalValue::DefaultVisibility; |
| case HiddenVisibility: return llvm::GlobalValue::HiddenVisibility; |
| case ProtectedVisibility: return llvm::GlobalValue::ProtectedVisibility; |
| } |
| llvm_unreachable("unknown visibility!"); |
| } |
| |
| llvm::Constant *GetAddrOfGlobal(GlobalDecl GD) { |
| if (isa<CXXConstructorDecl>(GD.getDecl())) |
| return GetAddrOfCXXConstructor(cast<CXXConstructorDecl>(GD.getDecl()), |
| GD.getCtorType()); |
| else if (isa<CXXDestructorDecl>(GD.getDecl())) |
| return GetAddrOfCXXDestructor(cast<CXXDestructorDecl>(GD.getDecl()), |
| GD.getDtorType()); |
| else if (isa<FunctionDecl>(GD.getDecl())) |
| return GetAddrOfFunction(GD); |
| else |
| return GetAddrOfGlobalVar(cast<VarDecl>(GD.getDecl())); |
| } |
| |
| /// CreateOrReplaceCXXRuntimeVariable - Will return a global variable of the given |
| /// type. If a variable with a different type already exists then a new |
| /// variable with the right type will be created and all uses of the old |
| /// variable will be replaced with a bitcast to the new variable. |
| llvm::GlobalVariable * |
| CreateOrReplaceCXXRuntimeVariable(StringRef Name, llvm::Type *Ty, |
| llvm::GlobalValue::LinkageTypes Linkage); |
| |
| /// GetAddrOfGlobalVar - Return the llvm::Constant for the address of the |
| /// given global variable. If Ty is non-null and if the global doesn't exist, |
| /// then it will be greated with the specified type instead of whatever the |
| /// normal requested type would be. |
| llvm::Constant *GetAddrOfGlobalVar(const VarDecl *D, |
| llvm::Type *Ty = 0); |
| |
| |
| /// GetAddrOfFunction - Return the address of the given function. If Ty is |
| /// non-null, then this function will use the specified type if it has to |
| /// create it. |
| llvm::Constant *GetAddrOfFunction(GlobalDecl GD, |
| llvm::Type *Ty = 0, |
| bool ForVTable = false); |
| |
| /// GetAddrOfRTTIDescriptor - Get the address of the RTTI descriptor |
| /// for the given type. |
| llvm::Constant *GetAddrOfRTTIDescriptor(QualType Ty, bool ForEH = false); |
| |
| /// GetAddrOfThunk - Get the address of the thunk for the given global decl. |
| llvm::Constant *GetAddrOfThunk(GlobalDecl GD, const ThunkInfo &Thunk); |
| |
| /// GetWeakRefReference - Get a reference to the target of VD. |
| llvm::Constant *GetWeakRefReference(const ValueDecl *VD); |
| |
| /// GetNonVirtualBaseClassOffset - Returns the offset from a derived class to |
| /// a class. Returns null if the offset is 0. |
| llvm::Constant * |
| GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl, |
| CastExpr::path_const_iterator PathBegin, |
| CastExpr::path_const_iterator PathEnd); |
| |
| /// A pair of helper functions for a __block variable. |
| class ByrefHelpers : public llvm::FoldingSetNode { |
| public: |
| llvm::Constant *CopyHelper; |
| llvm::Constant *DisposeHelper; |
| |
| /// The alignment of the field. This is important because |
| /// different offsets to the field within the byref struct need to |
| /// have different helper functions. |
| CharUnits Alignment; |
| |
| ByrefHelpers(CharUnits alignment) : Alignment(alignment) {} |
| virtual ~ByrefHelpers(); |
| |
| void Profile(llvm::FoldingSetNodeID &id) const { |
| id.AddInteger(Alignment.getQuantity()); |
| profileImpl(id); |
| } |
| virtual void profileImpl(llvm::FoldingSetNodeID &id) const = 0; |
| |
| virtual bool needsCopy() const { return true; } |
| virtual void emitCopy(CodeGenFunction &CGF, |
| llvm::Value *dest, llvm::Value *src) = 0; |
| |
| virtual bool needsDispose() const { return true; } |
| virtual void emitDispose(CodeGenFunction &CGF, llvm::Value *field) = 0; |
| }; |
| |
| llvm::FoldingSet<ByrefHelpers> ByrefHelpersCache; |
| |
| /// getUniqueBlockCount - Fetches the global unique block count. |
| int getUniqueBlockCount() { return ++Block.GlobalUniqueCount; } |
| |
| /// getBlockDescriptorType - Fetches the type of a generic block |
| /// descriptor. |
| llvm::Type *getBlockDescriptorType(); |
| |
| /// getGenericBlockLiteralType - The type of a generic block literal. |
| llvm::Type *getGenericBlockLiteralType(); |
| |
| /// GetAddrOfGlobalBlock - Gets the address of a block which |
| /// requires no captures. |
| llvm::Constant *GetAddrOfGlobalBlock(const BlockExpr *BE, const char *); |
| |
| /// GetStringForStringLiteral - Return the appropriate bytes for a string |
| /// literal, properly padded to match the literal type. If only the address of |
| /// a constant is needed consider using GetAddrOfConstantStringLiteral. |
| std::string GetStringForStringLiteral(const StringLiteral *E); |
| |
| /// GetAddrOfConstantCFString - Return a pointer to a constant CFString object |
| /// for the given string. |
| llvm::Constant *GetAddrOfConstantCFString(const StringLiteral *Literal); |
| |
| /// GetAddrOfConstantString - Return a pointer to a constant NSString object |
| /// for the given string. Or a user defined String object as defined via |
| /// -fconstant-string-class=class_name option. |
| llvm::Constant *GetAddrOfConstantString(const StringLiteral *Literal); |
| |
| /// GetConstantArrayFromStringLiteral - Return a constant array for the given |
| /// string. |
| llvm::Constant *GetConstantArrayFromStringLiteral(const StringLiteral *E); |
| |
| /// GetAddrOfConstantStringFromLiteral - Return a pointer to a constant array |
| /// for the given string literal. |
| llvm::Constant *GetAddrOfConstantStringFromLiteral(const StringLiteral *S); |
| |
| /// GetAddrOfConstantStringFromObjCEncode - Return a pointer to a constant |
| /// array for the given ObjCEncodeExpr node. |
| llvm::Constant *GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *); |
| |
| /// GetAddrOfConstantString - Returns a pointer to a character array |
| /// containing the literal. This contents are exactly that of the given |
| /// string, i.e. it will not be null terminated automatically; see |
| /// GetAddrOfConstantCString. Note that whether the result is actually a |
| /// pointer to an LLVM constant depends on Feature.WriteableStrings. |
| /// |
| /// The result has pointer to array type. |
| /// |
| /// \param GlobalName If provided, the name to use for the global |
| /// (if one is created). |
| llvm::Constant *GetAddrOfConstantString(StringRef Str, |
| const char *GlobalName=0, |
| unsigned Alignment=1); |
| |
| /// GetAddrOfConstantCString - Returns a pointer to a character array |
| /// containing the literal and a terminating '\0' character. The result has |
| /// pointer to array type. |
| /// |
| /// \param GlobalName If provided, the name to use for the global (if one is |
| /// created). |
| llvm::Constant *GetAddrOfConstantCString(const std::string &str, |
| const char *GlobalName=0, |
| unsigned Alignment=1); |
| |
| /// GetAddrOfConstantCompoundLiteral - Returns a pointer to a constant global |
| /// variable for the given file-scope compound literal expression. |
| llvm::Constant *GetAddrOfConstantCompoundLiteral(const CompoundLiteralExpr*E); |
| |
| /// \brief Retrieve the record type that describes the state of an |
| /// Objective-C fast enumeration loop (for..in). |
| QualType getObjCFastEnumerationStateType(); |
| |
| /// GetAddrOfCXXConstructor - Return the address of the constructor of the |
| /// given type. |
| llvm::GlobalValue *GetAddrOfCXXConstructor(const CXXConstructorDecl *ctor, |
| CXXCtorType ctorType, |
| const CGFunctionInfo *fnInfo = 0); |
| |
| /// GetAddrOfCXXDestructor - Return the address of the constructor of the |
| /// given type. |
| llvm::GlobalValue *GetAddrOfCXXDestructor(const CXXDestructorDecl *dtor, |
| CXXDtorType dtorType, |
| const CGFunctionInfo *fnInfo = 0); |
| |
| /// getBuiltinLibFunction - Given a builtin id for a function like |
| /// "__builtin_fabsf", return a Function* for "fabsf". |
| llvm::Value *getBuiltinLibFunction(const FunctionDecl *FD, |
| unsigned BuiltinID); |
| |
| llvm::Function *getIntrinsic(unsigned IID, ArrayRef<llvm::Type*> Tys = |
| ArrayRef<llvm::Type*>()); |
| |
| /// EmitTopLevelDecl - Emit code for a single top level declaration. |
| void EmitTopLevelDecl(Decl *D); |
| |
| /// AddUsedGlobal - Add a global which should be forced to be |
| /// present in the object file; these are emitted to the llvm.used |
| /// metadata global. |
| void AddUsedGlobal(llvm::GlobalValue *GV); |
| |
| /// AddCXXDtorEntry - Add a destructor and object to add to the C++ global |
| /// destructor function. |
| void AddCXXDtorEntry(llvm::Constant *DtorFn, llvm::Constant *Object) { |
| CXXGlobalDtors.push_back(std::make_pair(DtorFn, Object)); |
| } |
| |
| /// CreateRuntimeFunction - Create a new runtime function with the specified |
| /// type and name. |
| llvm::Constant *CreateRuntimeFunction(llvm::FunctionType *Ty, |
| StringRef Name, |
| llvm::Attributes ExtraAttrs = |
| llvm::Attribute::None); |
| /// CreateRuntimeVariable - Create a new runtime global variable with the |
| /// specified type and name. |
| llvm::Constant *CreateRuntimeVariable(llvm::Type *Ty, |
| StringRef Name); |
| |
| ///@name Custom Blocks Runtime Interfaces |
| ///@{ |
| |
| llvm::Constant *getNSConcreteGlobalBlock(); |
| llvm::Constant *getNSConcreteStackBlock(); |
| llvm::Constant *getBlockObjectAssign(); |
| llvm::Constant *getBlockObjectDispose(); |
| |
| ///@} |
| |
| // UpdateCompleteType - Make sure that this type is translated. |
| void UpdateCompletedType(const TagDecl *TD); |
| |
| llvm::Constant *getMemberPointerConstant(const UnaryOperator *e); |
| |
| /// EmitConstantInit - Try to emit the initializer for the given declaration |
| /// as a constant; returns 0 if the expression cannot be emitted as a |
| /// constant. |
| llvm::Constant *EmitConstantInit(const VarDecl &D, CodeGenFunction *CGF = 0); |
| |
| /// EmitConstantExpr - Try to emit the given expression as a |
| /// constant; returns 0 if the expression cannot be emitted as a |
| /// constant. |
| llvm::Constant *EmitConstantExpr(const Expr *E, QualType DestType, |
| CodeGenFunction *CGF = 0); |
| |
| /// EmitConstantValue - Try to emit the given constant value as a |
| /// constant; returns 0 if the value cannot be emitted as a constant. |
| llvm::Constant *EmitConstantValue(const APValue &Value, QualType DestType, |
| CodeGenFunction *CGF = 0); |
| |
| /// EmitNullConstant - Return the result of value-initializing the given |
| /// type, i.e. a null expression of the given type. This is usually, |
| /// but not always, an LLVM null constant. |
| llvm::Constant *EmitNullConstant(QualType T); |
| |
| /// EmitNullConstantForBase - Return a null constant appropriate for |
| /// zero-initializing a base class with the given type. This is usually, |
| /// but not always, an LLVM null constant. |
| llvm::Constant *EmitNullConstantForBase(const CXXRecordDecl *Record); |
| |
| /// Error - Emit a general error that something can't be done. |
| void Error(SourceLocation loc, StringRef error); |
| |
| /// ErrorUnsupported - Print out an error that codegen doesn't support the |
| /// specified stmt yet. |
| /// \param OmitOnError - If true, then this error should only be emitted if no |
| /// other errors have been reported. |
| void ErrorUnsupported(const Stmt *S, const char *Type, |
| bool OmitOnError=false); |
| |
| /// ErrorUnsupported - Print out an error that codegen doesn't support the |
| /// specified decl yet. |
| /// \param OmitOnError - If true, then this error should only be emitted if no |
| /// other errors have been reported. |
| void ErrorUnsupported(const Decl *D, const char *Type, |
| bool OmitOnError=false); |
| |
| /// SetInternalFunctionAttributes - Set the attributes on the LLVM |
| /// function for the given decl and function info. This applies |
| /// attributes necessary for handling the ABI as well as user |
| /// specified attributes like section. |
| void SetInternalFunctionAttributes(const Decl *D, llvm::Function *F, |
| const CGFunctionInfo &FI); |
| |
| /// SetLLVMFunctionAttributes - Set the LLVM function attributes |
| /// (sext, zext, etc). |
| void SetLLVMFunctionAttributes(const Decl *D, |
| const CGFunctionInfo &Info, |
| llvm::Function *F); |
| |
| /// SetLLVMFunctionAttributesForDefinition - Set the LLVM function attributes |
| /// which only apply to a function definintion. |
| void SetLLVMFunctionAttributesForDefinition(const Decl *D, llvm::Function *F); |
| |
| /// ReturnTypeUsesSRet - Return true iff the given type uses 'sret' when used |
| /// as a return type. |
| bool ReturnTypeUsesSRet(const CGFunctionInfo &FI); |
| |
| /// ReturnTypeUsesFPRet - Return true iff the given type uses 'fpret' when |
| /// used as a return type. |
| bool ReturnTypeUsesFPRet(QualType ResultType); |
| |
| /// ReturnTypeUsesFP2Ret - Return true iff the given type uses 'fp2ret' when |
| /// used as a return type. |
| bool ReturnTypeUsesFP2Ret(QualType ResultType); |
| |
| /// ConstructAttributeList - Get the LLVM attributes and calling convention to |
| /// use for a particular function type. |
| /// |
| /// \param Info - The function type information. |
| /// \param TargetDecl - The decl these attributes are being constructed |
| /// for. If supplied the attributes applied to this decl may contribute to the |
| /// function attributes and calling convention. |
| /// \param PAL [out] - On return, the attribute list to use. |
| /// \param CallingConv [out] - On return, the LLVM calling convention to use. |
| void ConstructAttributeList(const CGFunctionInfo &Info, |
| const Decl *TargetDecl, |
| AttributeListType &PAL, |
| unsigned &CallingConv); |
| |
| StringRef getMangledName(GlobalDecl GD); |
| void getBlockMangledName(GlobalDecl GD, MangleBuffer &Buffer, |
| const BlockDecl *BD); |
| |
| void EmitTentativeDefinition(const VarDecl *D); |
| |
| void EmitVTable(CXXRecordDecl *Class, bool DefinitionRequired); |
| |
| llvm::GlobalVariable::LinkageTypes |
| getFunctionLinkage(const FunctionDecl *FD); |
| |
| void setFunctionLinkage(const FunctionDecl *FD, llvm::GlobalValue *V) { |
| V->setLinkage(getFunctionLinkage(FD)); |
| } |
| |
| /// getVTableLinkage - Return the appropriate linkage for the vtable, VTT, |
| /// and type information of the given class. |
| llvm::GlobalVariable::LinkageTypes getVTableLinkage(const CXXRecordDecl *RD); |
| |
| /// GetTargetTypeStoreSize - Return the store size, in character units, of |
| /// the given LLVM type. |
| CharUnits GetTargetTypeStoreSize(llvm::Type *Ty) const; |
| |
| /// GetLLVMLinkageVarDefinition - Returns LLVM linkage for a global |
| /// variable. |
| llvm::GlobalValue::LinkageTypes |
| GetLLVMLinkageVarDefinition(const VarDecl *D, |
| llvm::GlobalVariable *GV); |
| |
| std::vector<const CXXRecordDecl*> DeferredVTables; |
| |
| /// Emit all the global annotations. |
| void EmitGlobalAnnotations(); |
| |
| /// Emit an annotation string. |
| llvm::Constant *EmitAnnotationString(llvm::StringRef Str); |
| |
| /// Emit the annotation's translation unit. |
| llvm::Constant *EmitAnnotationUnit(SourceLocation Loc); |
| |
| /// Emit the annotation line number. |
| llvm::Constant *EmitAnnotationLineNo(SourceLocation L); |
| |
| /// EmitAnnotateAttr - Generate the llvm::ConstantStruct which contains the |
| /// annotation information for a given GlobalValue. The annotation struct is |
| /// {i8 *, i8 *, i8 *, i32}. The first field is a constant expression, the |
| /// GlobalValue being annotated. The second field is the constant string |
| /// created from the AnnotateAttr's annotation. The third field is a constant |
| /// string containing the name of the translation unit. The fourth field is |
| /// the line number in the file of the annotated value declaration. |
| llvm::Constant *EmitAnnotateAttr(llvm::GlobalValue *GV, |
| const AnnotateAttr *AA, |
| SourceLocation L); |
| |
| /// Add global annotations that are set on D, for the global GV. Those |
| /// annotations are emitted during finalization of the LLVM code. |
| void AddGlobalAnnotations(const ValueDecl *D, llvm::GlobalValue *GV); |
| |
| private: |
| llvm::GlobalValue *GetGlobalValue(StringRef Ref); |
| |
| llvm::Constant *GetOrCreateLLVMFunction(StringRef MangledName, |
| llvm::Type *Ty, |
| GlobalDecl D, |
| bool ForVTable, |
| llvm::Attributes ExtraAttrs = |
| llvm::Attribute::None); |
| llvm::Constant *GetOrCreateLLVMGlobal(StringRef MangledName, |
| llvm::PointerType *PTy, |
| const VarDecl *D, |
| bool UnnamedAddr = false); |
| |
| /// SetCommonAttributes - Set attributes which are common to any |
| /// form of a global definition (alias, Objective-C method, |
| /// function, global variable). |
| /// |
| /// NOTE: This should only be called for definitions. |
| void SetCommonAttributes(const Decl *D, llvm::GlobalValue *GV); |
| |
| /// SetFunctionDefinitionAttributes - Set attributes for a global definition. |
| void SetFunctionDefinitionAttributes(const FunctionDecl *D, |
| llvm::GlobalValue *GV); |
| |
| /// SetFunctionAttributes - Set function attributes for a function |
| /// declaration. |
| void SetFunctionAttributes(GlobalDecl GD, |
| llvm::Function *F, |
| bool IsIncompleteFunction); |
| |
| /// EmitGlobal - Emit code for a singal global function or var decl. Forward |
| /// declarations are emitted lazily. |
| void EmitGlobal(GlobalDecl D); |
| |
| void EmitGlobalDefinition(GlobalDecl D); |
| |
| void EmitGlobalFunctionDefinition(GlobalDecl GD); |
| void EmitGlobalVarDefinition(const VarDecl *D); |
| void EmitAliasDefinition(GlobalDecl GD); |
| void EmitObjCPropertyImplementations(const ObjCImplementationDecl *D); |
| void EmitObjCIvarInitializations(ObjCImplementationDecl *D); |
| |
| // C++ related functions. |
| |
| bool TryEmitDefinitionAsAlias(GlobalDecl Alias, GlobalDecl Target); |
| bool TryEmitBaseDestructorAsAlias(const CXXDestructorDecl *D); |
| |
| void EmitNamespace(const NamespaceDecl *D); |
| void EmitLinkageSpec(const LinkageSpecDecl *D); |
| |
| /// EmitCXXConstructors - Emit constructors (base, complete) from a |
| /// C++ constructor Decl. |
| void EmitCXXConstructors(const CXXConstructorDecl *D); |
| |
| /// EmitCXXConstructor - Emit a single constructor with the given type from |
| /// a C++ constructor Decl. |
| void EmitCXXConstructor(const CXXConstructorDecl *D, CXXCtorType Type); |
| |
| /// EmitCXXDestructors - Emit destructors (base, complete) from a |
| /// C++ destructor Decl. |
| void EmitCXXDestructors(const CXXDestructorDecl *D); |
| |
| /// EmitCXXDestructor - Emit a single destructor with the given type from |
| /// a C++ destructor Decl. |
| void EmitCXXDestructor(const CXXDestructorDecl *D, CXXDtorType Type); |
| |
| /// EmitCXXGlobalInitFunc - Emit the function that initializes C++ globals. |
| void EmitCXXGlobalInitFunc(); |
| |
| /// EmitCXXGlobalDtorFunc - Emit the function that destroys C++ globals. |
| void EmitCXXGlobalDtorFunc(); |
| |
| void EmitCXXGlobalVarDeclInitFunc(const VarDecl *D, |
| llvm::GlobalVariable *Addr); |
| |
| // FIXME: Hardcoding priority here is gross. |
| void AddGlobalCtor(llvm::Function *Ctor, int Priority=65535); |
| void AddGlobalDtor(llvm::Function *Dtor, int Priority=65535); |
| |
| /// EmitCtorList - Generates a global array of functions and priorities using |
| /// the given list and name. This array will have appending linkage and is |
| /// suitable for use as a LLVM constructor or destructor array. |
| void EmitCtorList(const CtorList &Fns, const char *GlobalName); |
| |
| /// EmitFundamentalRTTIDescriptor - Emit the RTTI descriptors for the |
| /// given type. |
| void EmitFundamentalRTTIDescriptor(QualType Type); |
| |
| /// EmitFundamentalRTTIDescriptors - Emit the RTTI descriptors for the |
| /// builtin types. |
| void EmitFundamentalRTTIDescriptors(); |
| |
| /// EmitDeferred - Emit any needed decls for which code generation |
| /// was deferred. |
| void EmitDeferred(void); |
| |
| /// EmitLLVMUsed - Emit the llvm.used metadata used to force |
| /// references to global which may otherwise be optimized out. |
| void EmitLLVMUsed(void); |
| |
| void EmitDeclMetadata(); |
| |
| /// EmitCoverageFile - Emit the llvm.gcov metadata used to tell LLVM where |
| /// to emit the .gcno and .gcda files in a way that persists in .bc files. |
| void EmitCoverageFile(); |
| |
| /// MayDeferGeneration - Determine if the given decl can be emitted |
| /// lazily; this is only relevant for definitions. The given decl |
| /// must be either a function or var decl. |
| bool MayDeferGeneration(const ValueDecl *D); |
| |
| /// SimplifyPersonality - Check whether we can use a "simpler", more |
| /// core exceptions personality function. |
| void SimplifyPersonality(); |
| }; |
| } // end namespace CodeGen |
| } // end namespace clang |
| |
| #endif |