X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FFunction.h;h=a4545a79ab1404813aa587acacd831c067b347d8;hb=ec285706aedd7027ec09a53bda9f2a8d919489cf;hp=23ebc31a4fa450eeaccc79e24f9d6c480f872da1;hpb=9aa4142dad5316aed1ee1014b6bc1977092ce9fb;p=oota-llvm.git diff --git a/include/llvm/Function.h b/include/llvm/Function.h index 23ebc31a4fa..a4545a79ab1 100644 --- a/include/llvm/Function.h +++ b/include/llvm/Function.h @@ -1,108 +1,250 @@ -//===-- llvm/Method.h - Class to represent a single VM method ----*- C++ -*--=// +//===-- llvm/Function.h - Class to represent a single function --*- C++ -*-===// +// +// The LLVM Compiler Infrastructure // -// This file contains the declaration of the Method class, which represents a -// single Method/function/procedure in the VM. +// 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 +// 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/ValueHolder.h" +#include "llvm/BasicBlock.h" +#include "llvm/Argument.h" +#include "llvm/Support/Annotation.h" + +namespace llvm { + +class FunctionType; + +// 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(); + + static iplist &getList(Function *F); +}; + +template<> struct ilist_traits + : public SymbolTableListTraits { -class Instruction; -class BasicBlock; -class MethodArgument; -class MethodType; -class Module; + // createNode is used to create a node that marks the end of the list... + static Argument *createNode(); + static iplist &getList(Function *F); +}; -class Method : public GlobalValue, public SymTabValue { +class Function : public GlobalValue, public Annotable { 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 BasicBlockListType::iterator iterator; + typedef BasicBlockListType::const_iterator const_iterator; typedef std::reverse_iterator const_reverse_iterator; typedef std::reverse_iterator reverse_iterator; -private: + typedef ArgumentListType::iterator aiterator; + typedef ArgumentListType::const_iterator const_aiterator; + typedef std::reverse_iterator const_reverse_aiterator; + typedef std::reverse_iterator reverse_aiterator; - // Important things that make up a method! - BasicBlocksType BasicBlocks; // The basic blocks +private: + // Important things that make up a function! + BasicBlockListType BasicBlocks; // The basic blocks ArgumentListType ArgumentList; // The formal arguments + + SymbolTable *SymTab; - friend class ValueHolder; + friend class SymbolTableListTraits; + void setParent(Module *parent); + Function *Prev, *Next; + void setNext(Function *N) { Next = N; } + void setPrev(Function *N) { Prev = N; } public: - Method(const MethodType *Ty, bool isInternal, const std::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, LinkageTypes Linkage, + 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 return type of method - const MethodType *getMethodType() const; // Return the MethodType for me + const Type *getReturnType() const; // Return the type of the ret val + const FunctionType *getFunctionType() const; // Return the FunctionType for me + + /// isVarArg - Return true if this function takes a variable number of + /// arguments. + bool isVarArg() const; + + /// 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 + /// + virtual bool isExternal() 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 + /// zero to allow easy checking for whether a function is intrinsic or not. + /// The particular intrinsic functions which correspond to this value are + /// defined in llvm/Intrinsics.h. + /// + unsigned getIntrinsicID() const; + bool isIntrinsic() const { return getIntrinsicID() != 0; } + + /// renameLocalSymbols - This method goes through the Function's symbol table + /// and renames any symbols that conflict with symbols at global scope. This + /// is required before printing out to a textual form, to ensure that there is + /// no ambiguity when parsing. + void renameLocalSymbols(); + + + /// deleteBody - This method deletes the body of the function, and converts + /// the linkage to external. + /// + void deleteBody() { + dropAllReferences(); + setLinkage(ExternalLinkage); + } + + /// removeFromParent - This method unlinks 'this' from the containing module, + /// but does not delete it. + /// + void removeFromParent(); - // Is the body of this method unknown? (the basic block list is empty if so) - // this is true for external methods, defined as forward "declare"ations - bool isExternal() const { return BasicBlocks.empty(); } + /// eraseFromParent - This method unlinks 'this' from the containing module + /// and deletes it. + /// + void eraseFromParent(); - // Get the underlying elements of the Method... both the argument list and - // basic block list are empty for external methods. + + // 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. // - inline const ArgumentListType &getArgumentList() const{ return ArgumentList; } - inline ArgumentListType &getArgumentList() { return ArgumentList; } + Function *getNext() { return Next; } + const Function *getNext() const { return Next; } + Function *getPrev() { return Prev; } + const Function *getPrev() const { return Prev; } + + /// Get the underlying elements of the Function... the basic block list is + /// empty for external functions. + /// + const ArgumentListType &getArgumentList() const { return ArgumentList; } + ArgumentListType &getArgumentList() { return ArgumentList; } + + const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; } + BasicBlockListType &getBasicBlockList() { return BasicBlocks; } + + const BasicBlock &getEntryBlock() const { return front(); } + BasicBlock &getEntryBlock() { return front(); } + + //===--------------------------------------------------------------------===// + // Symbol Table Accessing functions... - inline const BasicBlocksType &getBasicBlocks() const { return BasicBlocks; } - inline BasicBlocksType &getBasicBlocks() { return BasicBlocks; } + /// getSymbolTable() - Return the symbol table... + /// + inline SymbolTable &getSymbolTable() { return *SymTab; } + inline const SymbolTable &getSymbolTable() const { return *SymTab; } - inline const BasicBlock *getEntryNode() const { return front(); } - inline BasicBlock *getEntryNode() { return front(); } //===--------------------------------------------------------------------===// // 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(); } - - - // Methods for support type inquiry through isa, cast, and dyn_cast: - static inline bool classof(const Method *T) { return true; } + 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(); } + + size_t 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(); } + + //===--------------------------------------------------------------------===// + // 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(); } + + virtual void print(std::ostream &OS) const { print(OS, 0); } + 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 + /// basic block inside. This depends on there being a 'dot' and 'gv' program + /// 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 + /// this can make the graph smaller. + /// + 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->getValueType() == Value::MethodVal; + 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. - // + /// dropAllReferences() - This method causes all the subinstructions to "let + /// go" of all references that they are maintaining. This allows one to + /// '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 + /// delete. + /// + /// Since no other object in the module can have references into the body of a + /// function, dropping all references deletes the entire body of the function, + /// including any contained basic blocks. + /// void dropAllReferences(); }; +} // End llvm namespace + #endif