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