include/llvm/Function.h

   1 //===-- llvm/Function.h - Class to represent a single function --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the declaration of the Function class, which represents a
  11 // single function/procedure in LLVM.
  12 //
  13 // A function basically consists of a list of basic blocks, a list of arguments,
  14 // and a symbol table.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_FUNCTION_H
  19 #define LLVM_FUNCTION_H
  20
  21 #include "llvm/GlobalValue.h"
  22 #include "llvm/BasicBlock.h"
  23 #include "llvm/Argument.h"
  24 #include "llvm/Support/Annotation.h"
  25
  26 namespace llvm {
  27
  28 class FunctionType;
  29
  30 // Traits for intrusive list of instructions...
  31 template<> struct ilist_traits<BasicBlock>
  32   : public SymbolTableListTraits<BasicBlock, Function, Function> {
  33
  34   // createSentinel is used to create a node that marks the end of the list...
  35   static BasicBlock *createSentinel();
  36   static void destroySentinel(BasicBlock *BB) { delete BB; }
  37   static iplist<BasicBlock> &getList(Function *F);
  38 };
  39
  40 template<> struct ilist_traits<Argument>
  41   : public SymbolTableListTraits<Argument, Function, Function> {
  42
  43   // createSentinel is used to create a node that marks the end of the list...
  44   static Argument *createSentinel();
  45   static void destroySentinel(Argument *A) { delete A; }
  46   static iplist<Argument> &getList(Function *F);
  47 };
  48
  49 class Function : public GlobalValue, public Annotable {
  50 public:
  51   typedef iplist<Argument> ArgumentListType;
  52   typedef iplist<BasicBlock> BasicBlockListType;
  53
  54   // BasicBlock iterators...
  55   typedef BasicBlockListType::iterator iterator;
  56   typedef BasicBlockListType::const_iterator const_iterator;
  57   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
  58   typedef std::reverse_iterator<iterator>             reverse_iterator;
  59
  60   typedef ArgumentListType::iterator aiterator;
  61   typedef ArgumentListType::const_iterator const_aiterator;
  62   typedef std::reverse_iterator<const_aiterator> const_reverse_aiterator;
  63   typedef std::reverse_iterator<aiterator>             reverse_aiterator;
  64
  65 private:
  66   // Important things that make up a function!
  67   BasicBlockListType  BasicBlocks;      // The basic blocks
  68   ArgumentListType ArgumentList;        // The formal arguments
  69
  70   SymbolTable *SymTab;
  71
  72   friend class SymbolTableListTraits<Function, Module, Module>;
  73
  74   void setParent(Module *parent);
  75   Function *Prev, *Next;
  76   void setNext(Function *N) { Next = N; }
  77   void setPrev(Function *N) { Prev = N; }
  78
  79 public:
  80   /// Function ctor - If the (optional) Module argument is specified, the
  81   /// function is automatically inserted into the end of the function list for
  82   /// the module.
  83   ///
  84   Function(const FunctionType *Ty, LinkageTypes Linkage,
  85            const std::string &N = "", Module *M = 0);
  86   ~Function();
  87
  88   // Specialize setName to handle symbol table majik...
  89   virtual void setName(const std::string &name, SymbolTable *ST = 0);
  90
  91   const Type *getReturnType() const;           // Return the type of the ret val
  92   const FunctionType *getFunctionType() const; // Return the FunctionType for me
  93
  94   /// isVarArg - Return true if this function takes a variable number of
  95   /// arguments.
  96   bool isVarArg() const;
  97
  98   /// isExternal - Is the body of this function unknown? (The basic block list
  99   /// is empty if so.) This is true for external functions, defined as forward
 100   /// "declare"ations
 101   ///
 102   virtual bool isExternal() const { return BasicBlocks.empty(); }
 103
 104   /// getIntrinsicID - This method returns the ID number of the specified
 105   /// function, or Intrinsic::not_intrinsic if the function is not an
 106   /// instrinsic, or if the pointer is null.  This value is always defined to be
 107   /// zero to allow easy checking for whether a function is intrinsic or not.
 108   /// The particular intrinsic functions which correspond to this value are
 109   /// defined in llvm/Intrinsics.h.
 110   ///
 111   unsigned getIntrinsicID() const;
 112   bool isIntrinsic() const { return getIntrinsicID() != 0; }
 113
 114   /// renameLocalSymbols - This method goes through the Function's symbol table
 115   /// and renames any symbols that conflict with symbols at global scope.  This
 116   /// is required before printing out to a textual form, to ensure that there is
 117   /// no ambiguity when parsing.
 118   void renameLocalSymbols();
 119
 120
 121   /// deleteBody - This method deletes the body of the function, and converts
 122   /// the linkage to external.
 123   ///
 124   void deleteBody() {
 125     dropAllReferences();
 126     setLinkage(ExternalLinkage);
 127   }
 128
 129   /// removeFromParent - This method unlinks 'this' from the containing module,
 130   /// but does not delete it.
 131   ///
 132   void removeFromParent();
 133
 134   /// eraseFromParent - This method unlinks 'this' from the containing module
 135   /// and deletes it.
 136   ///
 137   void eraseFromParent();
 138
 139
 140   // getNext/Prev - Return the next or previous function in the list.  These
 141   // methods should never be used directly, and are only used to implement the
 142   // function list as part of the module.
 143   //
 144         Function *getNext()       { return Next; }
 145   const Function *getNext() const { return Next; }
 146         Function *getPrev()       { return Prev; }
 147   const Function *getPrev() const { return Prev; }
 148
 149   /// Get the underlying elements of the Function... the basic block list is
 150   /// empty for external functions.
 151   ///
 152   const ArgumentListType &getArgumentList() const { return ArgumentList; }
 153         ArgumentListType &getArgumentList()       { return ArgumentList; }
 154
 155   const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
 156         BasicBlockListType &getBasicBlockList()       { return BasicBlocks; }
 157
 158   const BasicBlock       &getEntryBlock() const   { return front(); }
 159         BasicBlock       &getEntryBlock()         { return front(); }
 160
 161   //===--------------------------------------------------------------------===//
 162   // Symbol Table Accessing functions...
 163
 164   /// getSymbolTable() - Return the symbol table...
 165   ///
 166   inline       SymbolTable &getSymbolTable()       { return *SymTab; }
 167   inline const SymbolTable &getSymbolTable() const { return *SymTab; }
 168
 169
 170   //===--------------------------------------------------------------------===//
 171   // BasicBlock iterator forwarding functions
 172   //
 173   iterator                begin()       { return BasicBlocks.begin(); }
 174   const_iterator          begin() const { return BasicBlocks.begin(); }
 175   iterator                end  ()       { return BasicBlocks.end();   }
 176   const_iterator          end  () const { return BasicBlocks.end();   }
 177
 178   reverse_iterator       rbegin()       { return BasicBlocks.rbegin(); }
 179   const_reverse_iterator rbegin() const { return BasicBlocks.rbegin(); }
 180   reverse_iterator       rend  ()       { return BasicBlocks.rend();   }
 181   const_reverse_iterator rend  () const { return BasicBlocks.rend();   }
 182
 183   size_t                   size() const { return BasicBlocks.size();  }
 184   bool                    empty() const { return BasicBlocks.empty(); }
 185   const BasicBlock       &front() const { return BasicBlocks.front(); }
 186         BasicBlock       &front()       { return BasicBlocks.front(); }
 187   const BasicBlock        &back() const { return BasicBlocks.back();  }
 188         BasicBlock        &back()       { return BasicBlocks.back();  }
 189
 190   //===--------------------------------------------------------------------===//
 191   // Argument iterator forwarding functions
 192   //
 193   aiterator                abegin()       { return ArgumentList.begin(); }
 194   const_aiterator          abegin() const { return ArgumentList.begin(); }
 195   aiterator                aend  ()       { return ArgumentList.end();   }
 196   const_aiterator          aend  () const { return ArgumentList.end();   }
 197
 198   reverse_aiterator       arbegin()       { return ArgumentList.rbegin(); }
 199   const_reverse_aiterator arbegin() const { return ArgumentList.rbegin(); }
 200   reverse_aiterator       arend  ()       { return ArgumentList.rend();   }
 201   const_reverse_aiterator arend  () const { return ArgumentList.rend();   }
 202
 203   size_t                    asize() const { return ArgumentList.size();  }
 204   bool                     aempty() const { return ArgumentList.empty(); }
 205   const Argument          &afront() const { return ArgumentList.front(); }
 206         Argument          &afront()       { return ArgumentList.front(); }
 207   const Argument           &aback() const { return ArgumentList.back();  }
 208         Argument           &aback()       { return ArgumentList.back();  }
 209
 210   virtual void print(std::ostream &OS) const { print(OS, 0); }
 211   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
 212
 213   /// viewCFG - This function is meant for use from the debugger.  You can just
 214   /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 215   /// program, displaying the CFG of the current function with the code for each
 216   /// basic block inside.  This depends on there being a 'dot' and 'gv' program
 217   /// in your path.
 218   ///
 219   void viewCFG() const;
 220
 221   /// viewCFGOnly - This function is meant for use from the debugger.  It works
 222   /// just like viewCFG, but it does not include the contents of basic blocks
 223   /// into the nodes, just the label.  If you are only interested in the CFG
 224   /// this can make the graph smaller.
 225   ///
 226   void viewCFGOnly() const;
 227
 228   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 229   static inline bool classof(const Function *) { return true; }
 230   static inline bool classof(const Value *V) {
 231     return V->getValueType() == Value::FunctionVal;
 232   }
 233
 234   /// dropAllReferences() - This method causes all the subinstructions to "let
 235   /// go" of all references that they are maintaining.  This allows one to
 236   /// 'delete' a whole module at a time, even though there may be circular
 237   /// references... first all references are dropped, and all use counts go to
 238   /// zero.  Then everything is deleted for real.  Note that no operations are
 239   /// valid on an object that has "dropped all references", except operator
 240   /// delete.
 241   ///
 242   /// Since no other object in the module can have references into the body of a
 243   /// function, dropping all references deletes the entire body of the function,
 244   /// including any contained basic blocks.
 245   ///
 246   void dropAllReferences();
 247 };
 248
 249 } // End llvm namespace
 250
 251 #endif