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 is distributed under the University of Illinois Open Source
   6 // 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 class ParamAttrsList;
  30
  31 // Traits for intrusive list of instructions...
  32 template<> struct ilist_traits<BasicBlock>
  33   : public SymbolTableListTraits<BasicBlock, Function> {
  34
  35   // createSentinel is used to create a node that marks the end of the list...
  36   static BasicBlock *createSentinel();
  37   static void destroySentinel(BasicBlock *BB) { delete BB; }
  38   static iplist<BasicBlock> &getList(Function *F);
  39   static ValueSymbolTable *getSymTab(Function *ItemParent);
  40   static int getListOffset();
  41 };
  42
  43 template<> struct ilist_traits<Argument>
  44   : public SymbolTableListTraits<Argument, Function> {
  45
  46   // createSentinel is used to create a node that marks the end of the list...
  47   static Argument *createSentinel();
  48   static void destroySentinel(Argument *A) { delete A; }
  49   static iplist<Argument> &getList(Function *F);
  50   static ValueSymbolTable *getSymTab(Function *ItemParent);
  51   static int getListOffset();
  52 };
  53
  54 class Function : public GlobalValue, public Annotable {
  55 public:
  56   typedef iplist<Argument> ArgumentListType;
  57   typedef iplist<BasicBlock> BasicBlockListType;
  58
  59   // BasicBlock iterators...
  60   typedef BasicBlockListType::iterator iterator;
  61   typedef BasicBlockListType::const_iterator const_iterator;
  62
  63   typedef ArgumentListType::iterator arg_iterator;
  64   typedef ArgumentListType::const_iterator const_arg_iterator;
  65
  66 private:
  67   // Important things that make up a function!
  68   BasicBlockListType  BasicBlocks;        ///< The basic blocks
  69   mutable ArgumentListType ArgumentList;  ///< The formal arguments
  70   ValueSymbolTable *SymTab;               ///< Symbol table of args/instructions
  71   const ParamAttrsList *ParamAttrs;       ///< Parameter attributes
  72
  73   // The Calling Convention is stored in Value::SubclassData.
  74   /*unsigned CallingConvention;*/
  75
  76   friend class SymbolTableListTraits<Function, Module>;
  77
  78   void setParent(Module *parent);
  79   Function *Prev, *Next;
  80   void setNext(Function *N) { Next = N; }
  81   void setPrev(Function *N) { Prev = N; }
  82
  83   // getNext/Prev - Return the next or previous function in the list.  These
  84   // methods should never be used directly, and are only used to implement the
  85   // function list as part of the module.
  86   //
  87   Function *getNext()             { return Next; }
  88   const Function *getNext() const { return Next; }
  89   Function *getPrev()             { return Prev; }
  90   const Function *getPrev() const { return Prev; }
  91
  92   /// hasLazyArguments/CheckLazyArguments - The argument list of a function is
  93   /// built on demand, so that the list isn't allocated until the first client
  94   /// needs it.  The hasLazyArguments predicate returns true if the arg list
  95   /// hasn't been set up yet.
  96   bool hasLazyArguments() const {
  97     return SubclassData & 1;
  98   }
  99   void CheckLazyArguments() const {
 100     if (hasLazyArguments())
 101       BuildLazyArguments();
 102   }
 103   void BuildLazyArguments() const;
 104 public:
 105   /// Function ctor - If the (optional) Module argument is specified, the
 106   /// function is automatically inserted into the end of the function list for
 107   /// the module.
 108   ///
 109   Function(const FunctionType *Ty, LinkageTypes Linkage,
 110            const std::string &N = "", Module *M = 0);
 111   ~Function();
 112
 113   const Type *getReturnType() const;           // Return the type of the ret val
 114   const FunctionType *getFunctionType() const; // Return the FunctionType for me
 115
 116   /// isVarArg - Return true if this function takes a variable number of
 117   /// arguments.
 118   bool isVarArg() const;
 119
 120   /// isDeclaration - Is the body of this function unknown? (The basic block
 121   /// list is empty if so.) This is true for function declarations, but not
 122   /// true for function definitions.
 123   ///
 124   virtual bool isDeclaration() const { return BasicBlocks.empty(); }
 125
 126   /// getIntrinsicID - This method returns the ID number of the specified
 127   /// function, or Intrinsic::not_intrinsic if the function is not an
 128   /// instrinsic, or if the pointer is null.  This value is always defined to be
 129   /// zero to allow easy checking for whether a function is intrinsic or not.
 130   /// The particular intrinsic functions which correspond to this value are
 131   /// defined in llvm/Intrinsics.h.
 132   ///
 133   unsigned getIntrinsicID(bool noAssert = false) const;
 134   bool isIntrinsic() const { return getIntrinsicID() != 0; }
 135
 136   /// getCallingConv()/setCallingConv(uint) - These method get and set the
 137   /// calling convention of this function.  The enum values for the known
 138   /// calling conventions are defined in CallingConv.h.
 139   unsigned getCallingConv() const { return SubclassData >> 1; }
 140   void setCallingConv(unsigned CC) {
 141     SubclassData = (SubclassData & 1) | (CC << 1);
 142   }
 143
 144   /// Obtains a constant pointer to the ParamAttrsList object which holds the
 145   /// parameter attributes information, if any.
 146   /// @returns 0 if no parameter attributes have been set.
 147   /// @brief Get the parameter attributes.
 148   const ParamAttrsList *getParamAttrs() const { return ParamAttrs; }
 149
 150   /// Sets the parameter attributes for this Function. To construct a
 151   /// ParamAttrsList, see ParameterAttributes.h
 152   /// @brief Set the parameter attributes.
 153   void setParamAttrs(const ParamAttrsList *attrs);
 154
 155   /// hasCollector/getCollector/setCollector/clearCollector - The name of the
 156   /// garbage collection algorithm to use during code generation.
 157   bool hasCollector() const;
 158   const char *getCollector() const;
 159   void setCollector(const char *Str);
 160   void clearCollector();
 161
 162   /// @brief Determine whether the function has the given attribute.
 163   bool paramHasAttr(uint16_t i, unsigned attr) const;
 164
 165   /// @brief Determine if the function cannot return.
 166   bool doesNotReturn() const;
 167
 168   /// @brief Determine if the function cannot unwind.
 169   bool doesNotThrow() const;
 170
 171   /// @brief Determine if the function does not access memory.
 172   bool doesNotAccessMemory() const;
 173
 174   /// @brief Determine if the function does not access or only reads memory.
 175   bool onlyReadsMemory() const;
 176
 177   /// @brief Determine if the function returns a structure.
 178   bool isStructReturn() const;
 179
 180   /// deleteBody - This method deletes the body of the function, and converts
 181   /// the linkage to external.
 182   ///
 183   void deleteBody() {
 184     dropAllReferences();
 185     setLinkage(ExternalLinkage);
 186   }
 187
 188   /// removeFromParent - This method unlinks 'this' from the containing module,
 189   /// but does not delete it.
 190   ///
 191   void removeFromParent();
 192
 193   /// eraseFromParent - This method unlinks 'this' from the containing module
 194   /// and deletes it.
 195   ///
 196   void eraseFromParent();
 197
 198
 199   /// Get the underlying elements of the Function... the basic block list is
 200   /// empty for external functions.
 201   ///
 202   const ArgumentListType &getArgumentList() const {
 203     CheckLazyArguments();
 204     return ArgumentList;
 205   }
 206   ArgumentListType &getArgumentList() {
 207     CheckLazyArguments();
 208     return ArgumentList;
 209   }
 210
 211   const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
 212         BasicBlockListType &getBasicBlockList()       { return BasicBlocks; }
 213
 214   const BasicBlock       &getEntryBlock() const   { return front(); }
 215         BasicBlock       &getEntryBlock()         { return front(); }
 216
 217   //===--------------------------------------------------------------------===//
 218   // Symbol Table Accessing functions...
 219
 220   /// getSymbolTable() - Return the symbol table...
 221   ///
 222   inline       ValueSymbolTable &getValueSymbolTable()       { return *SymTab; }
 223   inline const ValueSymbolTable &getValueSymbolTable() const { return *SymTab; }
 224
 225
 226   //===--------------------------------------------------------------------===//
 227   // BasicBlock iterator forwarding functions
 228   //
 229   iterator                begin()       { return BasicBlocks.begin(); }
 230   const_iterator          begin() const { return BasicBlocks.begin(); }
 231   iterator                end  ()       { return BasicBlocks.end();   }
 232   const_iterator          end  () const { return BasicBlocks.end();   }
 233
 234   size_t                   size() const { return BasicBlocks.size();  }
 235   bool                    empty() const { return BasicBlocks.empty(); }
 236   const BasicBlock       &front() const { return BasicBlocks.front(); }
 237         BasicBlock       &front()       { return BasicBlocks.front(); }
 238   const BasicBlock        &back() const { return BasicBlocks.back();  }
 239         BasicBlock        &back()       { return BasicBlocks.back();  }
 240
 241   //===--------------------------------------------------------------------===//
 242   // Argument iterator forwarding functions
 243   //
 244   arg_iterator arg_begin() {
 245     CheckLazyArguments();
 246     return ArgumentList.begin();
 247   }
 248   const_arg_iterator arg_begin() const {
 249     CheckLazyArguments();
 250     return ArgumentList.begin();
 251   }
 252   arg_iterator arg_end() {
 253     CheckLazyArguments();
 254     return ArgumentList.end();
 255   }
 256   const_arg_iterator arg_end() const {
 257     CheckLazyArguments();
 258     return ArgumentList.end();
 259   }
 260
 261   size_t arg_size() const;
 262   bool arg_empty() const;
 263
 264   virtual void print(std::ostream &OS) const { print(OS, 0); }
 265   void print(std::ostream *OS) const { if (OS) print(*OS); }
 266   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
 267
 268   /// viewCFG - This function is meant for use from the debugger.  You can just
 269   /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 270   /// program, displaying the CFG of the current function with the code for each
 271   /// basic block inside.  This depends on there being a 'dot' and 'gv' program
 272   /// in your path.
 273   ///
 274   void viewCFG() const;
 275
 276   /// viewCFGOnly - This function is meant for use from the debugger.  It works
 277   /// just like viewCFG, but it does not include the contents of basic blocks
 278   /// into the nodes, just the label.  If you are only interested in the CFG
 279   /// this can make the graph smaller.
 280   ///
 281   void viewCFGOnly() const;
 282
 283   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 284   static inline bool classof(const Function *) { return true; }
 285   static inline bool classof(const Value *V) {
 286     return V->getValueID() == Value::FunctionVal;
 287   }
 288
 289   /// dropAllReferences() - This method causes all the subinstructions to "let
 290   /// go" of all references that they are maintaining.  This allows one to
 291   /// 'delete' a whole module at a time, even though there may be circular
 292   /// references... first all references are dropped, and all use counts go to
 293   /// zero.  Then everything is deleted for real.  Note that no operations are
 294   /// valid on an object that has "dropped all references", except operator
 295   /// delete.
 296   ///
 297   /// Since no other object in the module can have references into the body of a
 298   /// function, dropping all references deletes the entire body of the function,
 299   /// including any contained basic blocks.
 300   ///
 301   void dropAllReferences();
 302
 303   static unsigned getBasicBlockListOffset() {
 304     Function *Obj = 0;
 305     return unsigned(reinterpret_cast<uintptr_t>(&Obj->BasicBlocks));
 306   }
 307   static unsigned getArgumentListOffset() {
 308     Function *Obj = 0;
 309     return unsigned(reinterpret_cast<uintptr_t>(&Obj->ArgumentList));
 310   }
 311 };
 312
 313 inline ValueSymbolTable *
 314 ilist_traits<BasicBlock>::getSymTab(Function *F) {
 315   return F ? &F->getValueSymbolTable() : 0;
 316 }
 317
 318 inline ValueSymbolTable *
 319 ilist_traits<Argument>::getSymTab(Function *F) {
 320   return F ? &F->getValueSymbolTable() : 0;
 321 }
 322
 323 inline int
 324 ilist_traits<BasicBlock>::getListOffset() {
 325   return Function::getBasicBlockListOffset();
 326 }
 327
 328 inline int
 329 ilist_traits<Argument>::getListOffset() {
 330   return Function::getArgumentListOffset();
 331 }
 332
 333
 334 } // End llvm namespace
 335
 336 #endif