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   // HasLazyArguments is stored in Value::SubclassData.
  91   /*bool HasLazyArguments;*/
  92
  93   // The Calling Convention is stored in Value::SubclassData.
  94   /*CallingConv::ID CallingConvention;*/
  95
  96   friend class SymbolTableListTraits<Function, Module>;
  97
  98   void setParent(Module *parent);
  99
 100   /// hasLazyArguments/CheckLazyArguments - The argument list of a function is
 101   /// built on demand, so that the list isn't allocated until the first client
 102   /// needs it.  The hasLazyArguments predicate returns true if the arg list
 103   /// hasn't been set up yet.
 104   bool hasLazyArguments() const {
 105     return getSubclassDataFromValue() & 1;
 106   }
 107   void CheckLazyArguments() const {
 108     if (hasLazyArguments())
 109       BuildLazyArguments();
 110   }
 111   void BuildLazyArguments() const;
 112
 113   Function(const Function&) LLVM_DELETED_FUNCTION;
 114   void operator=(const Function&) LLVM_DELETED_FUNCTION;
 115
 116   /// Function ctor - If the (optional) Module argument is specified, the
 117   /// function is automatically inserted into the end of the function list for
 118   /// the module.
 119   ///
 120   Function(FunctionType *Ty, LinkageTypes Linkage,
 121            const Twine &N = "", Module *M = 0);
 122
 123 public:
 124   static Function *Create(FunctionType *Ty, LinkageTypes Linkage,
 125                           const Twine &N = "", Module *M = 0) {
 126     return new(0) Function(Ty, Linkage, N, M);
 127   }
 128
 129   ~Function();
 130
 131   Type *getReturnType() const;           // Return the type of the ret val
 132   FunctionType *getFunctionType() const; // Return the FunctionType for me
 133
 134   /// getContext - Return a pointer to the LLVMContext associated with this
 135   /// function, or NULL if this function is not bound to a context yet.
 136   LLVMContext &getContext() const;
 137
 138   /// isVarArg - Return true if this function takes a variable number of
 139   /// arguments.
 140   bool isVarArg() const;
 141
 142   /// getIntrinsicID - This method returns the ID number of the specified
 143   /// function, or Intrinsic::not_intrinsic if the function is not an
 144   /// instrinsic, or if the pointer is null.  This value is always defined to be
 145   /// zero to allow easy checking for whether a function is intrinsic or not.
 146   /// The particular intrinsic functions which correspond to this value are
 147   /// defined in llvm/Intrinsics.h.
 148   ///
 149   unsigned getIntrinsicID() const LLVM_READONLY;
 150   bool isIntrinsic() const { return getIntrinsicID() != 0; }
 151
 152   /// getCallingConv()/setCallingConv(CC) - These method get and set the
 153   /// calling convention of this function.  The enum values for the known
 154   /// calling conventions are defined in CallingConv.h.
 155   CallingConv::ID getCallingConv() const {
 156     return static_cast<CallingConv::ID>(getSubclassDataFromValue() >> 1);
 157   }
 158   void setCallingConv(CallingConv::ID CC) {
 159     setValueSubclassData((getSubclassDataFromValue() & 1) |
 160                          (static_cast<unsigned>(CC) << 1));
 161   }
 162
 163   /// getAttributes - Return the attribute list for this Function.
 164   ///
 165   const AttrListPtr &getAttributes() const { return AttributeList; }
 166
 167   /// setAttributes - Set the attribute list for this Function.
 168   ///
 169   void setAttributes(const AttrListPtr &attrs) { AttributeList = attrs; }
 170
 171   /// getFnAttributes - Return the function attributes for querying.
 172   ///
 173   Attributes getFnAttributes() const {
 174     return AttributeList.getFnAttributes();
 175   }
 176
 177   /// addFnAttr - Add function attributes to this function.
 178   ///
 179   void addFnAttr(Attributes N) {
 180     // Function Attributes are stored at ~0 index
 181     addAttribute(~0U, N);
 182   }
 183
 184   /// removeFnAttr - Remove function attributes from this function.
 185   ///
 186   void removeFnAttr(Attributes N) {
 187     // Function Attributes are stored at ~0 index
 188     removeAttribute(~0U, N);
 189   }
 190
 191   /// hasGC/getGC/setGC/clearGC - The name of the garbage collection algorithm
 192   ///                             to use during code generation.
 193   bool hasGC() const;
 194   const char *getGC() const;
 195   void setGC(const char *Str);
 196   void clearGC();
 197
 198   /// getParamAttributes - Return the parameter attributes for querying.
 199   Attributes getParamAttributes(unsigned Idx) const {
 200     return AttributeList.getParamAttributes(Idx);
 201   }
 202
 203   /// @brief Determine whether the function has the given attribute.
 204   bool paramHasAttr(unsigned i, Attributes attr) const {
 205     return AttributeList.paramHasAttr(i, attr);
 206   }
 207
 208   /// addAttribute - adds the attribute to the list of attributes.
 209   void addAttribute(unsigned i, Attributes attr);
 210
 211   /// removeAttribute - removes the attribute from the list of attributes.
 212   void removeAttribute(unsigned i, Attributes attr);
 213
 214   /// @brief Extract the alignment for a call or parameter (0=unknown).
 215   unsigned getParamAlignment(unsigned i) const {
 216     return AttributeList.getParamAlignment(i);
 217   }
 218
 219   /// @brief Determine if the function does not access memory.
 220   bool doesNotAccessMemory() const {
 221     return getFnAttributes().hasReadNoneAttr();
 222   }
 223   void setDoesNotAccessMemory(bool DoesNotAccessMemory = true) {
 224     if (DoesNotAccessMemory) addFnAttr(Attribute::ReadNone);
 225     else removeFnAttr(Attribute::ReadNone);
 226   }
 227
 228   /// @brief Determine if the function does not access or only reads memory.
 229   bool onlyReadsMemory() const {
 230     return doesNotAccessMemory() || getFnAttributes().hasReadOnlyAttr();
 231   }
 232   void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
 233     if (OnlyReadsMemory) addFnAttr(Attribute::ReadOnly);
 234     else removeFnAttr(Attribute::ReadOnly | Attribute::ReadNone);
 235   }
 236
 237   /// @brief Determine if the function cannot return.
 238   bool doesNotReturn() const {
 239     return getFnAttributes().hasNoReturnAttr();
 240   }
 241   void setDoesNotReturn(bool DoesNotReturn = true) {
 242     if (DoesNotReturn) addFnAttr(Attribute::NoReturn);
 243     else removeFnAttr(Attribute::NoReturn);
 244   }
 245
 246   /// @brief Determine if the function cannot unwind.
 247   bool doesNotThrow() const {
 248     return getFnAttributes().hasNoUnwindAttr();
 249   }
 250   void setDoesNotThrow(bool DoesNotThrow = true) {
 251     if (DoesNotThrow) addFnAttr(Attribute::NoUnwind);
 252     else removeFnAttr(Attribute::NoUnwind);
 253   }
 254
 255   /// @brief True if the ABI mandates (or the user requested) that this
 256   /// function be in a unwind table.
 257   bool hasUWTable() const {
 258     return getFnAttributes().hasUWTableAttr();
 259   }
 260   void setHasUWTable(bool HasUWTable = true) {
 261     if (HasUWTable)
 262       addFnAttr(Attribute::UWTable);
 263     else
 264       removeFnAttr(Attribute::UWTable);
 265   }
 266
 267   /// @brief True if this function needs an unwind table.
 268   bool needsUnwindTableEntry() const {
 269     return hasUWTable() || !doesNotThrow();
 270   }
 271
 272   /// @brief Determine if the function returns a structure through first
 273   /// pointer argument.
 274   bool hasStructRetAttr() const {
 275     return getParamAttributes(1).hasStructRetAttr();
 276   }
 277
 278   /// @brief Determine if the parameter does not alias other parameters.
 279   /// @param n The parameter to check. 1 is the first parameter, 0 is the return
 280   bool doesNotAlias(unsigned n) const {
 281     return getParamAttributes(n).hasNoAliasAttr();
 282   }
 283   void setDoesNotAlias(unsigned n, bool DoesNotAlias = true) {
 284     if (DoesNotAlias) addAttribute(n, Attribute::NoAlias);
 285     else removeAttribute(n, Attribute::NoAlias);
 286   }
 287
 288   /// @brief Determine if the parameter can be captured.
 289   /// @param n The parameter to check. 1 is the first parameter, 0 is the return
 290   bool doesNotCapture(unsigned n) const {
 291     return getParamAttributes(n).hasNoCaptureAttr();
 292   }
 293   void setDoesNotCapture(unsigned n, bool DoesNotCapture = true) {
 294     if (DoesNotCapture) addAttribute(n, Attribute::NoCapture);
 295     else removeAttribute(n, Attribute::NoCapture);
 296   }
 297
 298   /// copyAttributesFrom - copy all additional attributes (those not needed to
 299   /// create a Function) from the Function Src to this one.
 300   void copyAttributesFrom(const GlobalValue *Src);
 301
 302   /// deleteBody - This method deletes the body of the function, and converts
 303   /// the linkage to external.
 304   ///
 305   void deleteBody() {
 306     dropAllReferences();
 307     setLinkage(ExternalLinkage);
 308   }
 309
 310   /// removeFromParent - This method unlinks 'this' from the containing module,
 311   /// but does not delete it.
 312   ///
 313   virtual void removeFromParent();
 314
 315   /// eraseFromParent - This method unlinks 'this' from the containing module
 316   /// and deletes it.
 317   ///
 318   virtual void eraseFromParent();
 319
 320
 321   /// Get the underlying elements of the Function... the basic block list is
 322   /// empty for external functions.
 323   ///
 324   const ArgumentListType &getArgumentList() const {
 325     CheckLazyArguments();
 326     return ArgumentList;
 327   }
 328   ArgumentListType &getArgumentList() {
 329     CheckLazyArguments();
 330     return ArgumentList;
 331   }
 332   static iplist<Argument> Function::*getSublistAccess(Argument*) {
 333     return &Function::ArgumentList;
 334   }
 335
 336   const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
 337         BasicBlockListType &getBasicBlockList()       { return BasicBlocks; }
 338   static iplist<BasicBlock> Function::*getSublistAccess(BasicBlock*) {
 339     return &Function::BasicBlocks;
 340   }
 341
 342   const BasicBlock       &getEntryBlock() const   { return front(); }
 343         BasicBlock       &getEntryBlock()         { return front(); }
 344
 345   //===--------------------------------------------------------------------===//
 346   // Symbol Table Accessing functions...
 347
 348   /// getSymbolTable() - Return the symbol table...
 349   ///
 350   inline       ValueSymbolTable &getValueSymbolTable()       { return *SymTab; }
 351   inline const ValueSymbolTable &getValueSymbolTable() const { return *SymTab; }
 352
 353
 354   //===--------------------------------------------------------------------===//
 355   // BasicBlock iterator forwarding functions
 356   //
 357   iterator                begin()       { return BasicBlocks.begin(); }
 358   const_iterator          begin() const { return BasicBlocks.begin(); }
 359   iterator                end  ()       { return BasicBlocks.end();   }
 360   const_iterator          end  () const { return BasicBlocks.end();   }
 361
 362   size_t                   size() const { return BasicBlocks.size();  }
 363   bool                    empty() const { return BasicBlocks.empty(); }
 364   const BasicBlock       &front() const { return BasicBlocks.front(); }
 365         BasicBlock       &front()       { return BasicBlocks.front(); }
 366   const BasicBlock        &back() const { return BasicBlocks.back();  }
 367         BasicBlock        &back()       { return BasicBlocks.back();  }
 368
 369   //===--------------------------------------------------------------------===//
 370   // Argument iterator forwarding functions
 371   //
 372   arg_iterator arg_begin() {
 373     CheckLazyArguments();
 374     return ArgumentList.begin();
 375   }
 376   const_arg_iterator arg_begin() const {
 377     CheckLazyArguments();
 378     return ArgumentList.begin();
 379   }
 380   arg_iterator arg_end() {
 381     CheckLazyArguments();
 382     return ArgumentList.end();
 383   }
 384   const_arg_iterator arg_end() const {
 385     CheckLazyArguments();
 386     return ArgumentList.end();
 387   }
 388
 389   size_t arg_size() const;
 390   bool arg_empty() const;
 391
 392   /// viewCFG - This function is meant for use from the debugger.  You can just
 393   /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 394   /// program, displaying the CFG of the current function with the code for each
 395   /// basic block inside.  This depends on there being a 'dot' and 'gv' program
 396   /// in your path.
 397   ///
 398   void viewCFG() const;
 399
 400   /// viewCFGOnly - This function is meant for use from the debugger.  It works
 401   /// just like viewCFG, but it does not include the contents of basic blocks
 402   /// into the nodes, just the label.  If you are only interested in the CFG
 403   /// this can make the graph smaller.
 404   ///
 405   void viewCFGOnly() const;
 406
 407   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 408   static inline bool classof(const Function *) { return true; }
 409   static inline bool classof(const Value *V) {
 410     return V->getValueID() == Value::FunctionVal;
 411   }
 412
 413   /// dropAllReferences() - This method causes all the subinstructions to "let
 414   /// go" of all references that they are maintaining.  This allows one to
 415   /// 'delete' a whole module at a time, even though there may be circular
 416   /// references... first all references are dropped, and all use counts go to
 417   /// zero.  Then everything is deleted for real.  Note that no operations are
 418   /// valid on an object that has "dropped all references", except operator
 419   /// delete.
 420   ///
 421   /// Since no other object in the module can have references into the body of a
 422   /// function, dropping all references deletes the entire body of the function,
 423   /// including any contained basic blocks.
 424   ///
 425   void dropAllReferences();
 426
 427   /// hasAddressTaken - returns true if there are any uses of this function
 428   /// other than direct calls or invokes to it, or blockaddress expressions.
 429   /// Optionally passes back an offending user for diagnostic purposes.
 430   ///
 431   bool hasAddressTaken(const User** = 0) const;
 432
 433   /// isDefTriviallyDead - Return true if it is trivially safe to remove
 434   /// this function definition from the module (because it isn't externally
 435   /// visible, does not have its address taken, and has no callers).  To make
 436   /// this more accurate, call removeDeadConstantUsers first.
 437   bool isDefTriviallyDead() const;
 438
 439   /// callsFunctionThatReturnsTwice - Return true if the function has a call to
 440   /// setjmp or other function that gcc recognizes as "returning twice".
 441   bool callsFunctionThatReturnsTwice() const;
 442
 443 private:
 444   // Shadow Value::setValueSubclassData with a private forwarding method so that
 445   // subclasses cannot accidentally use it.
 446   void setValueSubclassData(unsigned short D) {
 447     Value::setValueSubclassData(D);
 448   }
 449 };
 450
 451 inline ValueSymbolTable *
 452 ilist_traits<BasicBlock>::getSymTab(Function *F) {
 453   return F ? &F->getValueSymbolTable() : 0;
 454 }
 455
 456 inline ValueSymbolTable *
 457 ilist_traits<Argument>::getSymTab(Function *F) {
 458   return F ? &F->getValueSymbolTable() : 0;
 459 }
 460
 461 } // End llvm namespace
 462
 463 #endif