X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FFunction.h;h=4c0e0ec5235c52f9ee46441bd56b2ffd3f5690bd;hb=87944916a4764dabc2f89cbec0a6c7e439c28530;hp=51dbd646b318e11d084952666ea256c81fe7de07;hpb=1020b3982c9eae15844c5612b0cf251917931b1d;p=oota-llvm.git diff --git a/include/llvm/Function.h b/include/llvm/Function.h index 51dbd646b31..4c0e0ec5235 100644 --- a/include/llvm/Function.h +++ b/include/llvm/Function.h @@ -1,203 +1,191 @@ -//===-- llvm/Method.h - Class to represent a single VM method ----*- C++ -*--=// +//===-- llvm/Function.h - Class to represent a single function --*- C++ -*-===// // -// This file contains the declaration of the Method class, which represents a -// single Method/function/procedure in the VM. +// This file contains the declaration of the Function class, which represents a +// single function/procedure in LLVM. // -// Note that basic blocks themselves are Def's, because they are referenced -// by instructions like calls and can go in virtual function tables and stuff. +// A function basically consists of a list of basic blocks, a list of arguments, +// and a symbol table. // //===----------------------------------------------------------------------===// -#ifndef LLVM_METHOD_H -#define LLVM_METHOD_H +#ifndef LLVM_FUNCTION_H +#define LLVM_FUNCTION_H -#include "llvm/SymTabValue.h" +#include "llvm/GlobalValue.h" #include "llvm/BasicBlock.h" -#include +#include "llvm/Argument.h" -class Instruction; -class BasicBlock; -class MethodArgument; -class MethodType; -class Method; -class Module; +class FunctionType; -typedef UseTy MethodUse; +// Traits for intrusive list of instructions... +template<> struct ilist_traits + : public SymbolTableListTraits { -class Method : public SymTabValue { + // createNode is used to create a node that marks the end of the list... + static BasicBlock *createNode(); + + static iplist &getList(Function *F); +}; + +template<> struct ilist_traits + : public SymbolTableListTraits { + + // createNode is used to create a node that marks the end of the list... + static Argument *createNode(); + static iplist &getList(Function *F); +}; + +class Function : public GlobalValue { public: - typedef ValueHolder ArgumentListType; - typedef ValueHolder BasicBlocksType; + typedef iplist ArgumentListType; + typedef iplist BasicBlockListType; // BasicBlock iterators... - typedef BasicBlocksType::iterator iterator; - typedef BasicBlocksType::const_iterator const_iterator; - typedef reverse_iterator const_reverse_iterator; - typedef reverse_iterator reverse_iterator; + 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; private: - // Important things that make up a method! - BasicBlocksType BasicBlocks; // The basic blocks - ArgumentListType ArgumentList; // The formal arguments + // Important things that make up a function! + BasicBlockListType BasicBlocks; // The basic blocks + ArgumentListType ArgumentList; // The formal arguments - Module *Parent; // The module that contains this method + SymbolTable *SymTab, *ParentSymTab; + + friend class SymbolTableListTraits; - friend class ValueHolder; void setParent(Module *parent); + Function *Prev, *Next; + void setNext(Function *N) { Next = N; } + void setPrev(Function *N) { Prev = N; } public: - Method(const MethodType *Ty, const string &Name = ""); - ~Method(); + /// 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, bool isInternal, const std::string &N = "", + Module *M = 0); + ~Function(); // Specialize setName to handle symbol table majik... - virtual void setName(const string &name); + virtual void setName(const std::string &name, SymbolTable *ST = 0); - const Type *getReturnType() const; - const MethodType *getMethodType() const; + const Type *getReturnType() const; // Return the type of the ret val + const FunctionType *getFunctionType() const; // Return the FunctionType for me - // Is the body of this method unknown? (the basic block list is empty if so) - // this is true for "extern"al methods. - bool isMethodExternal() const { return BasicBlocks.empty(); } + /// 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 + /// + bool isExternal() const { return BasicBlocks.empty(); } + // 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; } - // Get the class structure that this method is contained inside of... - inline Module *getParent() { return Parent; } - inline const Module *getParent() const { return Parent; } - - // Get the underlying elements of the Method... - inline const ArgumentListType &getArgumentList() const{ return ArgumentList; } - inline ArgumentListType &getArgumentList() { return ArgumentList; } + /// Get the underlying elements of the Function... both the argument list and + /// basic block list are empty for external functions. + /// + const ArgumentListType &getArgumentList() const { return ArgumentList; } + ArgumentListType &getArgumentList() { return ArgumentList; } - inline const BasicBlocksType &getBasicBlocks() const { return BasicBlocks; } - inline BasicBlocksType &getBasicBlocks() { return BasicBlocks; } + const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; } + BasicBlockListType &getBasicBlockList() { return BasicBlocks; } + const BasicBlock &getEntryNode() const { return front(); } + BasicBlock &getEntryNode() { return front(); } + //===--------------------------------------------------------------------===// + // Symbol Table Accessing functions... + + /// hasSymbolTable() - Returns true if there is a symbol table allocated to + /// this object AND if there is at least one name in it! + /// + bool hasSymbolTable() const; + + /// getSymbolTable() - CAUTION: The current symbol table may be null if there + /// are no names (ie, the symbol table is empty) + /// + inline SymbolTable *getSymbolTable() { return SymTab; } + inline const SymbolTable *getSymbolTable() const { return SymTab; } + + /// getSymbolTableSure is guaranteed to not return a null pointer, because if + /// the function does not already have a symtab, one is created. Use this if + /// you intend to put something into the symbol table for the function. + /// + SymbolTable *getSymbolTableSure(); // Implemented in Value.cpp + + //===--------------------------------------------------------------------===// // BasicBlock iterator forwarding functions // - inline iterator begin() { return BasicBlocks.begin(); } - inline const_iterator begin() const { return BasicBlocks.begin(); } - inline iterator end () { return BasicBlocks.end(); } - inline const_iterator end () const { return BasicBlocks.end(); } - - inline reverse_iterator rbegin() { return BasicBlocks.rbegin(); } - inline const_reverse_iterator rbegin() const { return BasicBlocks.rbegin(); } - inline reverse_iterator rend () { return BasicBlocks.rend(); } - inline const_reverse_iterator rend () const { return BasicBlocks.rend(); } - - inline unsigned size() const { return BasicBlocks.size(); } - inline bool empty() const { return BasicBlocks.empty(); } - inline const BasicBlock *front() const { return BasicBlocks.front(); } - inline BasicBlock *front() { return BasicBlocks.front(); } - inline const BasicBlock *back() const { return BasicBlocks.back(); } - inline BasicBlock *back() { return BasicBlocks.back(); } - - - - // dropAllReferences() - This function causes all the subinstructions to "let - // go" of all references that they are maintaining. This allows one to - // 'delete' a whole class 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 delete'd for real. Note that no operations are - // valid on an object that has "dropped all references", except operator - // delete. - // - void dropAllReferences(); + iterator begin() { return BasicBlocks.begin(); } + const_iterator begin() const { return BasicBlocks.begin(); } + 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(); } + + unsigned size() const { return BasicBlocks.size(); } + bool empty() const { return BasicBlocks.empty(); } + const BasicBlock &front() const { return BasicBlocks.front(); } + BasicBlock &front() { return BasicBlocks.front(); } + const BasicBlock &back() const { return BasicBlocks.back(); } + BasicBlock &back() { return BasicBlocks.back(); } //===--------------------------------------------------------------------===// - // Method Instruction iterator code - //===--------------------------------------------------------------------===// - // - template - class InstIterator; - typedef InstIterator inst_iterator; - typedef InstIterator inst_const_iterator; - - // This inner class is used to implement inst_begin() & inst_end() for - // inst_iterator and inst_const_iterator's. + // Argument iterator forwarding functions // - template - class InstIterator { - typedef _BB_t BBty; - typedef _BB_i_t BBIty; - typedef _BI_t BIty; - typedef _II_t IIty; - _BB_t &BBs; // BasicBlocksType - _BB_i_t BB; // BasicBlocksType::iterator - _BI_t BI; // BasicBlock::iterator - public: - typedef bidirectional_iterator_tag iterator_category; - - template InstIterator(M &m) - : BBs(m.getBasicBlocks()), BB(BBs.begin()) { // begin ctor - if (BB != BBs.end()) { - BI = (*BB)->begin(); - resyncInstructionIterator(); - } - } - - template InstIterator(M &m, bool) - : BBs(m.getBasicBlocks()), BB(BBs.end()) { // end ctor - } - - // Accessors to get at the underlying iterators... - inline BBIty &getBasicBlockIterator() { return BB; } - inline BIty &getInstructionIterator() { return BI; } - - inline IIty operator*() const { return *BI; } - inline IIty *operator->() const { return &(operator*()); } - - inline bool operator==(const InstIterator &y) const { - return BB == y.BB && (BI == y.BI || BB == BBs.end()); - } - inline bool operator!=(const InstIterator& y) const { - return !operator==(y); - } - - // resyncInstructionIterator - This should be called if the - // InstructionIterator is modified outside of our control. This resynchs - // the internals of the InstIterator to a consistent state. - // - inline void resyncInstructionIterator() { - // The only way that the II could be broken is if it is now pointing to - // the end() of the current BasicBlock and there are successor BBs. - while (BI == (*BB)->end()) { - ++BB; - if (BB == BBs.end()) break; - BI = (*BB)->begin(); - } - } - - InstIterator& operator++() { - ++BI; - resyncInstructionIterator(); // Make sure it is still valid. - return *this; - } - inline InstIterator operator++(int) { - InstIterator tmp = *this; ++*this; return tmp; - } - - InstIterator& operator--() { - while (BB == BBs.end() || BI == (*BB)->begin()) { - --BB; - BI = (*BB)->end(); - } - --BI; - return *this; - } - inline InstIterator operator--(int) { - InstIterator tmp = *this; --*this; return tmp; - } - }; - - inline inst_iterator inst_begin() { return inst_iterator(*this); } - inline inst_iterator inst_end() { return inst_iterator(*this, true); } - inline inst_const_iterator inst_begin() const { return inst_const_iterator(*this); } - inline inst_const_iterator inst_end() const { return inst_const_iterator(*this, true); } + 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(); } + + unsigned 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(); } + + virtual void print(std::ostream &OS) 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->getValueType() == Value::FunctionVal; + } + + /// dropAllReferences() - This function causes all the subinstructions to "let + /// go" of all references that they are maintaining. This allows one to + /// 'delete' a whole class 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 delete'd for real. Note that no operations are + /// valid on an object that has "dropped all references", except operator + /// delete. + /// + void dropAllReferences(); }; #endif