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