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 #include "llvm/Attributes.h"
  26
  27 namespace llvm {
  28
  29 class FunctionType;
  30
  31 // Traits for intrusive list of basic blocks...
  32 template<> struct ilist_traits<BasicBlock>
  33   : public SymbolTableListTraits<BasicBlock, Function> {
  34
  35   // createSentinel is used to get hold of the node that marks the end of the
  36   // list... (same trick used here as in ilist_traits<Instruction>)
  37   BasicBlock *createSentinel() const {
  38     return static_cast<BasicBlock*>(&Sentinel);
  39   }
  40   static void destroySentinel(BasicBlock*) {}
  41
  42   BasicBlock *provideInitialHead() const { return createSentinel(); }
  43   BasicBlock *ensureHead(BasicBlock*) const { return createSentinel(); }
  44
  45   static iplist<BasicBlock> &getList(Function *F);
  46   static ValueSymbolTable *getSymTab(Function *ItemParent);
  47   static int getListOffset();
  48 private:
  49   mutable ilist_node<BasicBlock> Sentinel;
  50 };
  51
  52 template<> struct ilist_traits<Argument>
  53   : public SymbolTableListTraits<Argument, Function> {
  54
  55   Argument *createSentinel() const {
  56     return static_cast<Argument*>(&Sentinel);
  57   }
  58   static void destroySentinel(Argument*) {}
  59
  60   Argument *provideInitialHead() const { return createSentinel(); }
  61   Argument *ensureHead(Argument*) const { return createSentinel(); }
  62
  63   static iplist<Argument> &getList(Function *F);
  64   static ValueSymbolTable *getSymTab(Function *ItemParent);
  65   static int getListOffset();
  66 private:
  67   mutable ilist_node<Argument> Sentinel;
  68 };
  69
  70 class Function : public GlobalValue, public Annotable,
  71                  public ilist_node<Function> {
  72 public:
  73   typedef iplist<Argument> ArgumentListType;
  74   typedef iplist<BasicBlock> BasicBlockListType;
  75
  76   // BasicBlock iterators...
  77   typedef BasicBlockListType::iterator iterator;
  78   typedef BasicBlockListType::const_iterator const_iterator;
  79
  80   typedef ArgumentListType::iterator arg_iterator;
  81   typedef ArgumentListType::const_iterator const_arg_iterator;
  82
  83 private:
  84   // Important things that make up a function!
  85   BasicBlockListType  BasicBlocks;        ///< The basic blocks
  86   mutable ArgumentListType ArgumentList;  ///< The formal arguments
  87   ValueSymbolTable *SymTab;               ///< Symbol table of args/instructions
  88   AttrListPtr AttributeList;              ///< Parameter attributes
  89
  90   // The Calling Convention is stored in Value::SubclassData.
  91   /*unsigned CallingConvention;*/
  92
  93   friend class SymbolTableListTraits<Function, Module>;
  94
  95   void setParent(Module *parent);
  96
  97   /// hasLazyArguments/CheckLazyArguments - The argument list of a function is
  98   /// built on demand, so that the list isn't allocated until the first client
  99   /// needs it.  The hasLazyArguments predicate returns true if the arg list
 100   /// hasn't been set up yet.
 101   bool hasLazyArguments() const {
 102     return SubclassData & 1;
 103   }
 104   void CheckLazyArguments() const {
 105     if (hasLazyArguments())
 106       BuildLazyArguments();
 107   }
 108   void BuildLazyArguments() const;
 109
 110   Function(const Function&); // DO NOT IMPLEMENT
 111   void operator=(const Function&); // DO NOT IMPLEMENT
 112
 113   /// Function ctor - If the (optional) Module argument is specified, the
 114   /// function is automatically inserted into the end of the function list for
 115   /// the module.
 116   ///
 117   Function(const FunctionType *Ty, LinkageTypes Linkage,
 118            const std::string &N = "", Module *M = 0);
 119
 120 public:
 121   static Function *Create(const FunctionType *Ty, LinkageTypes Linkage,
 122                           const std::string &N = "", Module *M = 0) {
 123     return new(0) Function(Ty, Linkage, N, M);
 124   }
 125
 126   ~Function();
 127
 128   const Type *getReturnType() const;           // Return the type of the ret val
 129   const FunctionType *getFunctionType() const; // Return the FunctionType for me
 130
 131   /// isVarArg - Return true if this function takes a variable number of
 132   /// arguments.
 133   bool isVarArg() const;
 134
 135   /// isDeclaration - Is the body of this function unknown? (The basic block
 136   /// list is empty if so.) This is true for function declarations, but not
 137   /// true for function definitions.
 138   ///
 139   virtual bool isDeclaration() const { return BasicBlocks.empty(); }
 140
 141   /// getIntrinsicID - This method returns the ID number of the specified
 142   /// function, or Intrinsic::not_intrinsic if the function is not an
 143   /// instrinsic, or if the pointer is null.  This value is always defined to be
 144   /// zero to allow easy checking for whether a function is intrinsic or not.
 145   /// The particular intrinsic functions which correspond to this value are
 146   /// defined in llvm/Intrinsics.h.
 147   ///
 148   unsigned getIntrinsicID() const;
 149   bool isIntrinsic() const { return getIntrinsicID() != 0; }
 150
 151   /// getCallingConv()/setCallingConv(uint) - These method get and set the
 152   /// calling convention of this function.  The enum values for the known
 153   /// calling conventions are defined in CallingConv.h.
 154   unsigned getCallingConv() const { return SubclassData >> 1; }
 155   void setCallingConv(unsigned CC) {
 156     SubclassData = (SubclassData & 1) | (CC << 1);
 157   }
 158
 159   /// getAttributes - Return the attribute list for this Function.
 160   ///
 161   const AttrListPtr &getAttributes() const { return AttributeList; }
 162
 163   /// setAttributes - Set the attribute list for this Function.
 164   ///
 165   void setAttributes(const AttrListPtr &attrs) { AttributeList = attrs; }
 166
 167   /// hasFnAttr - Return true if this function has the given attribute.
 168   bool hasFnAttr(Attributes N) const {
 169     // Function Attributes are stored at ~0 index
 170     return AttributeList.paramHasAttr(~0U, N);
 171   }
 172
 173   /// addFnAttr - Add function attributes to this function.
 174   ///
 175   void addFnAttr(Attributes N) {
 176     // Function Attributes are stored at ~0 index
 177     addAttribute(~0U, N);
 178   }
 179
 180   /// removeFnAttr - Remove function attributes from this function.
 181   ///
 182   void removeFnAttr(Attributes N) {
 183     // Function Attributes are stored at ~0 index
 184     removeAttribute(~0U, N);
 185   }
 186
 187   /// hasGC/getGC/setGC/clearGC - The name of the garbage collection algorithm
 188   ///                             to use during code generation.
 189   bool hasGC() const;
 190   const char *getGC() const;
 191   void setGC(const char *Str);
 192   void clearGC();
 193
 194   /// @brief Determine whether the function has the given attribute.
 195   bool paramHasAttr(unsigned i, Attributes attr) const {
 196     return AttributeList.paramHasAttr(i, attr);
 197   }
 198
 199   /// addAttribute - adds the attribute to the list of attributes.
 200   void addAttribute(unsigned i, Attributes attr);
 201
 202   /// removeAttribute - removes the attribute from the list of attributes.
 203   void removeAttribute(unsigned i, Attributes attr);
 204
 205   /// @brief Extract the alignment for a call or parameter (0=unknown).
 206   unsigned getParamAlignment(unsigned i) const {
 207     return AttributeList.getParamAlignment(i);
 208   }
 209
 210   /// @brief Determine if the function does not access memory.
 211   bool doesNotAccessMemory() const {
 212     return hasFnAttr(Attribute::ReadNone);
 213   }
 214   void setDoesNotAccessMemory(bool DoesNotAccessMemory = true) {
 215     if (DoesNotAccessMemory) addFnAttr(Attribute::ReadNone);
 216     else removeFnAttr(Attribute::ReadNone);
 217   }
 218
 219   /// @brief Determine if the function does not access or only reads memory.
 220   bool onlyReadsMemory() const {
 221     return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
 222   }
 223   void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
 224     if (OnlyReadsMemory) addFnAttr(Attribute::ReadOnly);
 225     else removeFnAttr(Attribute::ReadOnly | Attribute::ReadNone);
 226   }
 227
 228   /// @brief Determine if the function cannot return.
 229   bool doesNotReturn() const {
 230     return hasFnAttr(Attribute::NoReturn);
 231   }
 232   void setDoesNotReturn(bool DoesNotReturn = true) {
 233     if (DoesNotReturn) addFnAttr(Attribute::NoReturn);
 234     else removeFnAttr(Attribute::NoReturn);
 235   }
 236
 237   /// @brief Determine if the function cannot unwind.
 238   bool doesNotThrow() const {
 239     return hasFnAttr(Attribute::NoUnwind);
 240   }
 241   void setDoesNotThrow(bool DoesNotThrow = true) {
 242     if (DoesNotThrow) addFnAttr(Attribute::NoUnwind);
 243     else removeFnAttr(Attribute::NoUnwind);
 244   }
 245
 246   /// @brief Determine if the function returns a structure through first
 247   /// pointer argument.
 248   bool hasStructRetAttr() const {
 249     return paramHasAttr(1, Attribute::StructRet);
 250   }
 251
 252   /// @brief Determine if the parameter does not alias other parameters.
 253   /// @param n The parameter to check. 1 is the first parameter, 0 is the return
 254   bool doesNotAlias(unsigned n) const {
 255     return paramHasAttr(n, Attribute::NoAlias);
 256   }
 257   void setDoesNotAlias(unsigned n, bool DoesNotAlias = true) {
 258     if (DoesNotAlias) addAttribute(n, Attribute::NoAlias);
 259     else removeAttribute(n, Attribute::NoAlias);
 260   }
 261
 262   /// @brief Determine if the parameter can be captured.
 263   /// @param n The parameter to check. 1 is the first parameter, 0 is the return
 264   bool doesNotCapture(unsigned n) const {
 265     return paramHasAttr(n, Attribute::NoCapture);
 266   }
 267   void setDoesNotCapture(unsigned n, bool DoesNotCapture = true) {
 268     if (DoesNotCapture) addAttribute(n, Attribute::NoCapture);
 269     else removeAttribute(n, Attribute::NoCapture);
 270   }
 271
 272   /// copyAttributesFrom - copy all additional attributes (those not needed to
 273   /// create a Function) from the Function Src to this one.
 274   void copyAttributesFrom(const GlobalValue *Src);
 275
 276   /// deleteBody - This method deletes the body of the function, and converts
 277   /// the linkage to external.
 278   ///
 279   void deleteBody() {
 280     dropAllReferences();
 281     setLinkage(ExternalLinkage);
 282   }
 283
 284   /// removeFromParent - This method unlinks 'this' from the containing module,
 285   /// but does not delete it.
 286   ///
 287   virtual void removeFromParent();
 288
 289   /// eraseFromParent - This method unlinks 'this' from the containing module
 290   /// and deletes it.
 291   ///
 292   virtual void eraseFromParent();
 293
 294
 295   /// Get the underlying elements of the Function... the basic block list is
 296   /// empty for external functions.
 297   ///
 298   const ArgumentListType &getArgumentList() const {
 299     CheckLazyArguments();
 300     return ArgumentList;
 301   }
 302   ArgumentListType &getArgumentList() {
 303     CheckLazyArguments();
 304     return ArgumentList;
 305   }
 306
 307   const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
 308         BasicBlockListType &getBasicBlockList()       { return BasicBlocks; }
 309
 310   const BasicBlock       &getEntryBlock() const   { return front(); }
 311         BasicBlock       &getEntryBlock()         { return front(); }
 312
 313   //===--------------------------------------------------------------------===//
 314   // Symbol Table Accessing functions...
 315
 316   /// getSymbolTable() - Return the symbol table...
 317   ///
 318   inline       ValueSymbolTable &getValueSymbolTable()       { return *SymTab; }
 319   inline const ValueSymbolTable &getValueSymbolTable() const { return *SymTab; }
 320
 321
 322   //===--------------------------------------------------------------------===//
 323   // BasicBlock iterator forwarding functions
 324   //
 325   iterator                begin()       { return BasicBlocks.begin(); }
 326   const_iterator          begin() const { return BasicBlocks.begin(); }
 327   iterator                end  ()       { return BasicBlocks.end();   }
 328   const_iterator          end  () const { return BasicBlocks.end();   }
 329
 330   size_t                   size() const { return BasicBlocks.size();  }
 331   bool                    empty() const { return BasicBlocks.empty(); }
 332   const BasicBlock       &front() const { return BasicBlocks.front(); }
 333         BasicBlock       &front()       { return BasicBlocks.front(); }
 334   const BasicBlock        &back() const { return BasicBlocks.back();  }
 335         BasicBlock        &back()       { return BasicBlocks.back();  }
 336
 337   //===--------------------------------------------------------------------===//
 338   // Argument iterator forwarding functions
 339   //
 340   arg_iterator arg_begin() {
 341     CheckLazyArguments();
 342     return ArgumentList.begin();
 343   }
 344   const_arg_iterator arg_begin() const {
 345     CheckLazyArguments();
 346     return ArgumentList.begin();
 347   }
 348   arg_iterator arg_end() {
 349     CheckLazyArguments();
 350     return ArgumentList.end();
 351   }
 352   const_arg_iterator arg_end() const {
 353     CheckLazyArguments();
 354     return ArgumentList.end();
 355   }
 356
 357   size_t arg_size() const;
 358   bool arg_empty() const;
 359
 360   /// viewCFG - This function is meant for use from the debugger.  You can just
 361   /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 362   /// program, displaying the CFG of the current function with the code for each
 363   /// basic block inside.  This depends on there being a 'dot' and 'gv' program
 364   /// in your path.
 365   ///
 366   void viewCFG() const;
 367
 368   /// viewCFGOnly - This function is meant for use from the debugger.  It works
 369   /// just like viewCFG, but it does not include the contents of basic blocks
 370   /// into the nodes, just the label.  If you are only interested in the CFG
 371   /// this can make the graph smaller.
 372   ///
 373   void viewCFGOnly() const;
 374
 375   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 376   static inline bool classof(const Function *) { return true; }
 377   static inline bool classof(const Value *V) {
 378     return V->getValueID() == Value::FunctionVal;
 379   }
 380
 381   /// dropAllReferences() - This method causes all the subinstructions to "let
 382   /// go" of all references that they are maintaining.  This allows one to
 383   /// 'delete' a whole module at a time, even though there may be circular
 384   /// references... first all references are dropped, and all use counts go to
 385   /// zero.  Then everything is deleted for real.  Note that no operations are
 386   /// valid on an object that has "dropped all references", except operator
 387   /// delete.
 388   ///
 389   /// Since no other object in the module can have references into the body of a
 390   /// function, dropping all references deletes the entire body of the function,
 391   /// including any contained basic blocks.
 392   ///
 393   void dropAllReferences();
 394
 395   static unsigned getBasicBlockListOffset() {
 396     Function *Obj = 0;
 397     return unsigned(reinterpret_cast<uintptr_t>(&Obj->BasicBlocks));
 398   }
 399   static unsigned getArgumentListOffset() {
 400     Function *Obj = 0;
 401     return unsigned(reinterpret_cast<uintptr_t>(&Obj->ArgumentList));
 402   }
 403 };
 404
 405 inline ValueSymbolTable *
 406 ilist_traits<BasicBlock>::getSymTab(Function *F) {
 407   return F ? &F->getValueSymbolTable() : 0;
 408 }
 409
 410 inline ValueSymbolTable *
 411 ilist_traits<Argument>::getSymTab(Function *F) {
 412   return F ? &F->getValueSymbolTable() : 0;
 413 }
 414
 415 inline int
 416 ilist_traits<BasicBlock>::getListOffset() {
 417   return Function::getBasicBlockListOffset();
 418 }
 419
 420 inline int
 421 ilist_traits<Argument>::getListOffset() {
 422   return Function::getArgumentListOffset();
 423 }
 424
 425
 426 } // End llvm namespace
 427
 428 #endif