X-Git-Url: http://plrg.eecs.uci.edu/git/?p=oota-llvm.git;a=blobdiff_plain;f=include%2Fllvm%2FFunction.h;h=d8647110469c641f3b1340bf8a1309e591b009c3;hp=36b0dd3df8cb424ac503c6a7185bc2aee7ba7501;hb=255f89faee13dc491cb64fbeae3c763e7e2ea4e6;hpb=d5d94df73f2af639a4cffc7e4f3491001817df08 diff --git a/include/llvm/Function.h b/include/llvm/Function.h index 36b0dd3df8c..d8647110469 100644 --- a/include/llvm/Function.h +++ b/include/llvm/Function.h @@ -18,40 +18,57 @@ #ifndef LLVM_FUNCTION_H #define LLVM_FUNCTION_H -#include "llvm/GlobalValue.h" -#include "llvm/BasicBlock.h" #include "llvm/Argument.h" -#include "llvm/Support/Annotation.h" -#include "llvm/ParameterAttributes.h" +#include "llvm/Attributes.h" +#include "llvm/BasicBlock.h" +#include "llvm/CallingConv.h" +#include "llvm/GlobalValue.h" +#include "llvm/Support/Compiler.h" namespace llvm { class FunctionType; +class LLVMContext; -// Traits for intrusive list of instructions... +// Traits for intrusive list of basic blocks... template<> struct ilist_traits : public SymbolTableListTraits { - // createSentinel is used to create a node that marks the end of the list... - static BasicBlock *createSentinel(); - static void destroySentinel(BasicBlock *BB) { delete BB; } - static iplist &getList(Function *F); + // createSentinel is used to get hold of the node that marks the end of the + // list... (same trick used here as in ilist_traits) + BasicBlock *createSentinel() const { + return static_cast(&Sentinel); + } + static void destroySentinel(BasicBlock*) {} + + BasicBlock *provideInitialHead() const { return createSentinel(); } + BasicBlock *ensureHead(BasicBlock*) const { return createSentinel(); } + static void noteHead(BasicBlock*, BasicBlock*) {} + static ValueSymbolTable *getSymTab(Function *ItemParent); - static int getListOffset(); +private: + mutable ilist_half_node Sentinel; }; template<> struct ilist_traits : public SymbolTableListTraits { - // createSentinel is used to create a node that marks the end of the list... - static Argument *createSentinel(); - static void destroySentinel(Argument *A) { delete A; } - static iplist &getList(Function *F); + Argument *createSentinel() const { + return static_cast(&Sentinel); + } + static void destroySentinel(Argument*) {} + + Argument *provideInitialHead() const { return createSentinel(); } + Argument *ensureHead(Argument*) const { return createSentinel(); } + static void noteHead(Argument*, Argument*) {} + static ValueSymbolTable *getSymTab(Function *ItemParent); - static int getListOffset(); +private: + mutable ilist_half_node Sentinel; }; -class Function : public GlobalValue, public Annotable { +class Function : public GlobalValue, + public ilist_node { public: typedef iplist ArgumentListType; typedef iplist BasicBlockListType; @@ -68,64 +85,60 @@ private: BasicBlockListType BasicBlocks; ///< The basic blocks mutable ArgumentListType ArgumentList; ///< The formal arguments ValueSymbolTable *SymTab; ///< Symbol table of args/instructions - PAListPtr ParamAttrs; ///< Parameter attributes - + AttrListPtr AttributeList; ///< Parameter attributes + + // HasLazyArguments is stored in Value::SubclassData. + /*bool HasLazyArguments;*/ + // The Calling Convention is stored in Value::SubclassData. - /*unsigned CallingConvention;*/ + /*CallingConv::ID CallingConvention;*/ friend class SymbolTableListTraits; void setParent(Module *parent); - Function *Prev, *Next; - void setNext(Function *N) { Next = N; } - void setPrev(Function *N) { Prev = N; } - - // getNext/Prev - Return the next or previous function in the list. These - // methods should never be used directly, and are only used to implement the - // function list as part of the module. - // - Function *getNext() { return Next; } - const Function *getNext() const { return Next; } - Function *getPrev() { return Prev; } - const Function *getPrev() const { return Prev; } /// hasLazyArguments/CheckLazyArguments - The argument list of a function is /// built on demand, so that the list isn't allocated until the first client /// needs it. The hasLazyArguments predicate returns true if the arg list /// hasn't been set up yet. bool hasLazyArguments() const { - return SubclassData & 1; + return getSubclassDataFromValue() & 1; } void CheckLazyArguments() const { if (hasLazyArguments()) BuildLazyArguments(); } void BuildLazyArguments() const; - - Function(const Function&); // DO NOT IMPLEMENT - void operator=(const Function&); // DO NOT IMPLEMENT -public: + + Function(const Function&) LLVM_DELETED_FUNCTION; + void operator=(const Function&) LLVM_DELETED_FUNCTION; + /// Function ctor - If the (optional) Module argument is specified, the /// function is automatically inserted into the end of the function list for /// the module. /// - Function(const FunctionType *Ty, LinkageTypes Linkage, - const std::string &N = "", Module *M = 0); + Function(FunctionType *Ty, LinkageTypes Linkage, + const Twine &N = "", Module *M = 0); + +public: + static Function *Create(FunctionType *Ty, LinkageTypes Linkage, + const Twine &N = "", Module *M = 0) { + return new(0) Function(Ty, Linkage, N, M); + } + ~Function(); - const Type *getReturnType() const; // Return the type of the ret val - const FunctionType *getFunctionType() const; // Return the FunctionType for me + Type *getReturnType() const; // Return the type of the ret val + FunctionType *getFunctionType() const; // Return the FunctionType for me + + /// getContext - Return a pointer to the LLVMContext associated with this + /// function, or NULL if this function is not bound to a context yet. + LLVMContext &getContext() const; /// isVarArg - Return true if this function takes a variable number of /// arguments. bool isVarArg() const; - /// isDeclaration - Is the body of this function unknown? (The basic block - /// list is empty if so.) This is true for function declarations, but not - /// true for function definitions. - /// - virtual bool isDeclaration() const { return BasicBlocks.empty(); } - /// getIntrinsicID - This method returns the ID number of the specified /// function, or Intrinsic::not_intrinsic if the function is not an /// instrinsic, or if the pointer is null. This value is always defined to be @@ -133,66 +146,152 @@ public: /// The particular intrinsic functions which correspond to this value are /// defined in llvm/Intrinsics.h. /// - unsigned getIntrinsicID(bool noAssert = false) const; + unsigned getIntrinsicID() const LLVM_READONLY; bool isIntrinsic() const { return getIntrinsicID() != 0; } - /// getCallingConv()/setCallingConv(uint) - These method get and set the + /// getCallingConv()/setCallingConv(CC) - These method get and set the /// calling convention of this function. The enum values for the known /// calling conventions are defined in CallingConv.h. - unsigned getCallingConv() const { return SubclassData >> 1; } - void setCallingConv(unsigned CC) { - SubclassData = (SubclassData & 1) | (CC << 1); + CallingConv::ID getCallingConv() const { + return static_cast(getSubclassDataFromValue() >> 1); + } + void setCallingConv(CallingConv::ID CC) { + setValueSubclassData((getSubclassDataFromValue() & 1) | + (static_cast(CC) << 1)); } - /// getParamAttrs - Return the parameter attributes for this Function. + /// getAttributes - Return the attribute list for this Function. /// - const PAListPtr &getParamAttrs() const { return ParamAttrs; } + const AttrListPtr &getAttributes() const { return AttributeList; } - /// setParamAttrs - Set the parameter attributes for this Function. + /// setAttributes - Set the attribute list for this Function. /// - void setParamAttrs(const PAListPtr &attrs) { ParamAttrs = attrs; } + void setAttributes(const AttrListPtr &attrs) { AttributeList = attrs; } - /// hasCollector/getCollector/setCollector/clearCollector - The name of the - /// garbage collection algorithm to use during code generation. - bool hasCollector() const; - const char *getCollector() const; - void setCollector(const char *Str); - void clearCollector(); + /// getFnAttributes - Return the function attributes for querying. + /// + Attributes getFnAttributes() const { + return AttributeList.getFnAttributes(); + } - /// @brief Determine whether the function has the given attribute. - bool paramHasAttr(unsigned i, ParameterAttributes attr) const { - return ParamAttrs.paramHasAttr(i, attr); + /// addFnAttr - Add function attributes to this function. + /// + void addFnAttr(Attributes::AttrVal N) { + // Function Attributes are stored at ~0 index + addAttribute(AttrListPtr::FunctionIndex, Attributes::get(getContext(), N)); } + + /// removeFnAttr - Remove function attributes from this function. + /// + void removeFnAttr(Attributes N) { + // Function Attributes are stored at ~0 index + removeAttribute(~0U, N); + } + + /// hasGC/getGC/setGC/clearGC - The name of the garbage collection algorithm + /// to use during code generation. + bool hasGC() const; + const char *getGC() const; + void setGC(const char *Str); + void clearGC(); + + + /// getRetAttributes - Return the return attributes for querying. + Attributes getRetAttributes() const { + return AttributeList.getRetAttributes(); + } + + /// getParamAttributes - Return the parameter attributes for querying. + Attributes getParamAttributes(unsigned Idx) const { + return AttributeList.getParamAttributes(Idx); + } + + /// addAttribute - adds the attribute to the list of attributes. + void addAttribute(unsigned i, Attributes attr); + /// removeAttribute - removes the attribute from the list of attributes. + void removeAttribute(unsigned i, Attributes attr); + /// @brief Extract the alignment for a call or parameter (0=unknown). unsigned getParamAlignment(unsigned i) const { - return ParamAttrs.getParamAlignment(i); + return AttributeList.getParamAlignment(i); + } + + /// @brief Determine if the function does not access memory. + bool doesNotAccessMemory() const { + return getFnAttributes().hasAttribute(Attributes::ReadNone); + } + void setDoesNotAccessMemory() { + addFnAttr(Attributes::ReadNone); + } + + /// @brief Determine if the function does not access or only reads memory. + bool onlyReadsMemory() const { + return doesNotAccessMemory() || + getFnAttributes().hasAttribute(Attributes::ReadOnly); + } + void setOnlyReadsMemory() { + addFnAttr(Attributes::ReadOnly); } /// @brief Determine if the function cannot return. - bool doesNotReturn() const { return paramHasAttr(0, ParamAttr::NoReturn); } + bool doesNotReturn() const { + return getFnAttributes().hasAttribute(Attributes::NoReturn); + } + void setDoesNotReturn() { + addFnAttr(Attributes::NoReturn); + } /// @brief Determine if the function cannot unwind. bool doesNotThrow() const { - return paramHasAttr(0, ParamAttr::NoUnwind); + return getFnAttributes().hasAttribute(Attributes::NoUnwind); + } + void setDoesNotThrow() { + addFnAttr(Attributes::NoUnwind); } - /// @brief Determine if the function does not access memory. - bool doesNotAccessMemory() const { - return paramHasAttr(0, ParamAttr::ReadNone); + /// @brief True if the ABI mandates (or the user requested) that this + /// function be in a unwind table. + bool hasUWTable() const { + return getFnAttributes().hasAttribute(Attributes::UWTable); + } + void setHasUWTable() { + addFnAttr(Attributes::UWTable); } - /// @brief Determine if the function does not access or only reads memory. - bool onlyReadsMemory() const { - return doesNotAccessMemory() || paramHasAttr(0, ParamAttr::ReadOnly); + /// @brief True if this function needs an unwind table. + bool needsUnwindTableEntry() const { + return hasUWTable() || !doesNotThrow(); } /// @brief Determine if the function returns a structure through first /// pointer argument. bool hasStructRetAttr() const { - return paramHasAttr(1, ParamAttr::StructRet); + return getParamAttributes(1).hasAttribute(Attributes::StructRet); + } + + /// @brief Determine if the parameter does not alias other parameters. + /// @param n The parameter to check. 1 is the first parameter, 0 is the return + bool doesNotAlias(unsigned n) const { + return getParamAttributes(n).hasAttribute(Attributes::NoAlias); + } + void setDoesNotAlias(unsigned n) { + addAttribute(n, Attributes::get(getContext(), Attributes::NoAlias)); } + /// @brief Determine if the parameter can be captured. + /// @param n The parameter to check. 1 is the first parameter, 0 is the return + bool doesNotCapture(unsigned n) const { + return getParamAttributes(n).hasAttribute(Attributes::NoCapture); + } + void setDoesNotCapture(unsigned n) { + addAttribute(n, Attributes::get(getContext(), Attributes::NoCapture)); + } + + /// copyAttributesFrom - copy all additional attributes (those not needed to + /// create a Function) from the Function Src to this one. + void copyAttributesFrom(const GlobalValue *Src); + /// deleteBody - This method deletes the body of the function, and converts /// the linkage to external. /// @@ -204,12 +303,12 @@ public: /// removeFromParent - This method unlinks 'this' from the containing module, /// but does not delete it. /// - void removeFromParent(); + virtual void removeFromParent(); /// eraseFromParent - This method unlinks 'this' from the containing module /// and deletes it. /// - void eraseFromParent(); + virtual void eraseFromParent(); /// Get the underlying elements of the Function... the basic block list is @@ -223,9 +322,15 @@ public: CheckLazyArguments(); return ArgumentList; } + static iplist Function::*getSublistAccess(Argument*) { + return &Function::ArgumentList; + } const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; } BasicBlockListType &getBasicBlockList() { return BasicBlocks; } + static iplist Function::*getSublistAccess(BasicBlock*) { + return &Function::BasicBlocks; + } const BasicBlock &getEntryBlock() const { return front(); } BasicBlock &getEntryBlock() { return front(); } @@ -277,10 +382,6 @@ public: size_t arg_size() const; bool arg_empty() const; - virtual void print(std::ostream &OS) const { print(OS, 0); } - void print(std::ostream *OS) const { if (OS) print(*OS); } - void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const; - /// viewCFG - This function is meant for use from the debugger. You can just /// say 'call F->viewCFG()' and a ghostview window should pop up from the /// program, displaying the CFG of the current function with the code for each @@ -297,7 +398,6 @@ public: void viewCFGOnly() const; /// Methods for support type inquiry through isa, cast, and dyn_cast: - static inline bool classof(const Function *) { return true; } static inline bool classof(const Value *V) { return V->getValueID() == Value::FunctionVal; } @@ -315,14 +415,28 @@ public: /// including any contained basic blocks. /// void dropAllReferences(); - - static unsigned getBasicBlockListOffset() { - Function *Obj = 0; - return unsigned(reinterpret_cast(&Obj->BasicBlocks)); - } - static unsigned getArgumentListOffset() { - Function *Obj = 0; - return unsigned(reinterpret_cast(&Obj->ArgumentList)); + + /// hasAddressTaken - returns true if there are any uses of this function + /// other than direct calls or invokes to it, or blockaddress expressions. + /// Optionally passes back an offending user for diagnostic purposes. + /// + bool hasAddressTaken(const User** = 0) const; + + /// isDefTriviallyDead - Return true if it is trivially safe to remove + /// this function definition from the module (because it isn't externally + /// visible, does not have its address taken, and has no callers). To make + /// this more accurate, call removeDeadConstantUsers first. + bool isDefTriviallyDead() const; + + /// callsFunctionThatReturnsTwice - Return true if the function has a call to + /// setjmp or other function that gcc recognizes as "returning twice". + bool callsFunctionThatReturnsTwice() const; + +private: + // Shadow Value::setValueSubclassData with a private forwarding method so that + // subclasses cannot accidentally use it. + void setValueSubclassData(unsigned short D) { + Value::setValueSubclassData(D); } }; @@ -336,17 +450,6 @@ ilist_traits::getSymTab(Function *F) { return F ? &F->getValueSymbolTable() : 0; } -inline int -ilist_traits::getListOffset() { - return Function::getBasicBlockListOffset(); -} - -inline int -ilist_traits::getListOffset() { - return Function::getArgumentListOffset(); -} - - } // End llvm namespace #endif