X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FFunction.h;h=f78365085fba29eb63a5a2a614d281eb7a92f446;hb=eb913b6b34a81b95ea5f692b710e5766526853c6;hp=e67ef01a56b3bde3fe290f6de6a1c8510413789d;hpb=c063502e326fe0206942192773b263a3d88d93f5;p=oota-llvm.git diff --git a/include/llvm/Function.h b/include/llvm/Function.h index e67ef01a56b..f78365085fb 100644 --- a/include/llvm/Function.h +++ b/include/llvm/Function.h @@ -1,13 +1,13 @@ //===-- llvm/Function.h - Class to represent a single function --*- C++ -*-===// -// +// // The LLVM Compiler Infrastructure // // This file was developed by the LLVM research group and is distributed under // the University of Illinois Open Source License. See LICENSE.TXT for details. -// +// //===----------------------------------------------------------------------===// // -// This file contains the declaration of the Function class, which represents a +// This file contains the declaration of the Function class, which represents a // single function/procedure in LLVM. // // A function basically consists of a list of basic blocks, a list of arguments, @@ -26,23 +26,29 @@ namespace llvm { class FunctionType; +class ParamAttrsList; // Traits for intrusive list of instructions... template<> struct ilist_traits - : public SymbolTableListTraits { - - // createNode is used to create a node that marks the end of the list... - static BasicBlock *createNode(); + : 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); + static ValueSymbolTable *getSymTab(Function *ItemParent); + static int getListOffset(); }; template<> struct ilist_traits - : public SymbolTableListTraits { + : public SymbolTableListTraits { - // createNode is used to create a node that marks the end of the list... - static Argument *createNode(); + // 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); + static ValueSymbolTable *getSymTab(Function *ItemParent); + static int getListOffset(); }; class Function : public GlobalValue, public Annotable { @@ -53,22 +59,22 @@ public: // BasicBlock iterators... typedef BasicBlockListType::iterator iterator; typedef BasicBlockListType::const_iterator const_iterator; - typedef std::reverse_iterator const_reverse_iterator; - typedef std::reverse_iterator reverse_iterator; - typedef ArgumentListType::iterator aiterator; - typedef ArgumentListType::const_iterator const_aiterator; - typedef std::reverse_iterator const_reverse_aiterator; - typedef std::reverse_iterator reverse_aiterator; + typedef ArgumentListType::iterator arg_iterator; + typedef ArgumentListType::const_iterator const_arg_iterator; private: // Important things that make up a function! - BasicBlockListType BasicBlocks; // The basic blocks - ArgumentListType ArgumentList; // The formal arguments + BasicBlockListType BasicBlocks; ///< The basic blocks + ArgumentListType ArgumentList; ///< The formal arguments + ValueSymbolTable *SymTab; ///< Symbol table of args/instructions + ParamAttrsList *ParamAttrs; ///< Parameter attributes - SymbolTable *SymTab; - friend class SymbolTableListTraits; + // The Calling Convention is stored in Value::SubclassData. + /*unsigned CallingConvention;*/ + + friend class SymbolTableListTraits; void setParent(Module *parent); Function *Prev, *Next; @@ -84,17 +90,18 @@ public: const std::string &N = "", Module *M = 0); ~Function(); - // Specialize setName to handle symbol table majik... - virtual void setName(const std::string &name, SymbolTable *ST = 0); - const Type *getReturnType() const; // Return the type of the ret val const FunctionType *getFunctionType() const; // Return the FunctionType for me - /// isExternal - Is the body of this function unknown? (The basic block list - /// is empty if so.) This is true for external functions, defined as forward - /// "declare"ations + /// 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 isExternal() const { return BasicBlocks.empty(); } + 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 @@ -103,9 +110,26 @@ public: /// The particular intrinsic functions which correspond to this value are /// defined in llvm/Intrinsics.h. /// - unsigned getIntrinsicID() const; + unsigned getIntrinsicID(bool noAssert = false) const; bool isIntrinsic() const { return getIntrinsicID() != 0; } + /// getCallingConv()/setCallingConv(uint) - 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; } + void setCallingConv(unsigned CC) { SubclassData = CC; } + + /// Obtains a constant pointer to the ParamAttrsList object which holds the + /// parameter attributes information, if any. + /// @returns 0 if no parameter attributes have been set. + /// @brief Get the parameter attributes. + const ParamAttrsList *getParamAttrs() const { return ParamAttrs; } + + /// Sets the parameter attributes for this Function. To construct a + /// ParamAttrsList, see ParameterAttributes.h + /// @brief Set the parameter attributes. + void setParamAttrs(ParamAttrsList *attrs) { ParamAttrs = attrs; } + /// deleteBody - This method deletes the body of the function, and converts /// the linkage to external. /// @@ -151,10 +175,10 @@ public: /// getSymbolTable() - Return the symbol table... /// - inline SymbolTable &getSymbolTable() { return *SymTab; } - inline const SymbolTable &getSymbolTable() const { return *SymTab; } + inline ValueSymbolTable &getValueSymbolTable() { return *SymTab; } + inline const ValueSymbolTable &getValueSymbolTable() const { return *SymTab; } + - //===--------------------------------------------------------------------===// // BasicBlock iterator forwarding functions // @@ -163,11 +187,6 @@ public: iterator end () { return BasicBlocks.end(); } const_iterator end () const { return BasicBlocks.end(); } - reverse_iterator rbegin() { return BasicBlocks.rbegin(); } - const_reverse_iterator rbegin() const { return BasicBlocks.rbegin(); } - reverse_iterator rend () { return BasicBlocks.rend(); } - const_reverse_iterator rend () const { return BasicBlocks.rend(); } - size_t size() const { return BasicBlocks.size(); } bool empty() const { return BasicBlocks.empty(); } const BasicBlock &front() const { return BasicBlocks.front(); } @@ -178,24 +197,16 @@ public: //===--------------------------------------------------------------------===// // Argument iterator forwarding functions // - aiterator abegin() { return ArgumentList.begin(); } - const_aiterator abegin() const { return ArgumentList.begin(); } - aiterator aend () { return ArgumentList.end(); } - const_aiterator aend () const { return ArgumentList.end(); } - - reverse_aiterator arbegin() { return ArgumentList.rbegin(); } - const_reverse_aiterator arbegin() const { return ArgumentList.rbegin(); } - reverse_aiterator arend () { return ArgumentList.rend(); } - const_reverse_aiterator arend () const { return ArgumentList.rend(); } - - size_t asize() const { return ArgumentList.size(); } - bool aempty() const { return ArgumentList.empty(); } - const Argument &afront() const { return ArgumentList.front(); } - Argument &afront() { return ArgumentList.front(); } - const Argument &aback() const { return ArgumentList.back(); } - Argument &aback() { return ArgumentList.back(); } + arg_iterator arg_begin() { return ArgumentList.begin(); } + const_arg_iterator arg_begin() const { return ArgumentList.begin(); } + arg_iterator arg_end () { return ArgumentList.end(); } + const_arg_iterator arg_end () const { return ArgumentList.end(); } + + size_t arg_size () const { return ArgumentList.size(); } + bool arg_empty() const { return ArgumentList.empty(); } 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 @@ -205,7 +216,7 @@ public: /// in your path. /// void viewCFG() const; - + /// viewCFGOnly - This function is meant for use from the debugger. It works /// just like viewCFG, but it does not include the contents of basic blocks /// into the nodes, just the label. If you are only interested in the CFG @@ -216,7 +227,7 @@ public: /// 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->getValueType() == Value::FunctionVal; + return V->getValueID() == Value::FunctionVal; } /// dropAllReferences() - This method causes all the subinstructions to "let @@ -224,7 +235,7 @@ public: /// 'delete' a whole module at a time, even though there may be circular /// references... first all references are dropped, and all use counts go to /// zero. Then everything is deleted for real. Note that no operations are - /// valid on an object that has "dropped all references", except operator + /// valid on an object that has "dropped all references", except operator /// delete. /// /// Since no other object in the module can have references into the body of a @@ -232,8 +243,38 @@ 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)); + } }; +inline ValueSymbolTable * +ilist_traits::getSymTab(Function *F) { + return F ? &F->getValueSymbolTable() : 0; +} + +inline ValueSymbolTable * +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