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/ADT/iterator_range.h"
  22 #include "llvm/IR/Argument.h"
  23 #include "llvm/IR/Attributes.h"
  24 #include "llvm/IR/BasicBlock.h"
  25 #include "llvm/IR/CallingConv.h"
  26 #include "llvm/IR/GlobalObject.h"
  27 #include "llvm/Support/Compiler.h"
  28
  29 namespace llvm {
  30
  31 class FunctionType;
  32 class LLVMContext;
  33
  34 // Traits for intrusive list of basic blocks...
  35 template<> struct ilist_traits<BasicBlock>
  36   : public SymbolTableListTraits<BasicBlock, Function> {
  37
  38   // createSentinel is used to get hold of the node that marks the end of the
  39   // list... (same trick used here as in ilist_traits<Instruction>)
  40   BasicBlock *createSentinel() const {
  41     return static_cast<BasicBlock*>(&Sentinel);
  42   }
  43   static void destroySentinel(BasicBlock*) {}
  44
  45   BasicBlock *provideInitialHead() const { return createSentinel(); }
  46   BasicBlock *ensureHead(BasicBlock*) const { return createSentinel(); }
  47   static void noteHead(BasicBlock*, BasicBlock*) {}
  48
  49   static ValueSymbolTable *getSymTab(Function *ItemParent);
  50 private:
  51   mutable ilist_half_node<BasicBlock> Sentinel;
  52 };
  53
  54 template<> struct ilist_traits<Argument>
  55   : public SymbolTableListTraits<Argument, Function> {
  56
  57   Argument *createSentinel() const {
  58     return static_cast<Argument*>(&Sentinel);
  59   }
  60   static void destroySentinel(Argument*) {}
  61
  62   Argument *provideInitialHead() const { return createSentinel(); }
  63   Argument *ensureHead(Argument*) const { return createSentinel(); }
  64   static void noteHead(Argument*, Argument*) {}
  65
  66   static ValueSymbolTable *getSymTab(Function *ItemParent);
  67 private:
  68   mutable ilist_half_node<Argument> Sentinel;
  69 };
  70
  71 class Function : public GlobalObject, 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 = nullptr);
 126
 127 public:
 128   static Function *Create(FunctionType *Ty, LinkageTypes Linkage,
 129                           const Twine &N = "", Module *M = nullptr) {
 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() >> 2);
 163   }
 164   void setCallingConv(CallingConv::ID CC) {
 165     setValueSubclassData((getSubclassDataFromValue() & 3) |
 166                          (static_cast<unsigned>(CC) << 2));
 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   void addFnAttr(StringRef Kind, StringRef Value) {
 194     setAttributes(
 195       AttributeSets.addAttribute(getContext(),
 196                                  AttributeSet::FunctionIndex, Kind, Value));
 197   }
 198
 199   /// @brief Return true if the function has the attribute.
 200   bool hasFnAttribute(Attribute::AttrKind Kind) const {
 201     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex, Kind);
 202   }
 203   bool hasFnAttribute(StringRef Kind) const {
 204     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex, Kind);
 205   }
 206
 207   /// @brief Return the attribute for the given attribute kind.
 208   Attribute getFnAttribute(Attribute::AttrKind Kind) const {
 209     return AttributeSets.getAttribute(AttributeSet::FunctionIndex, Kind);
 210   }
 211   Attribute getFnAttribute(StringRef Kind) const {
 212     return AttributeSets.getAttribute(AttributeSet::FunctionIndex, Kind);
 213   }
 214
 215   /// hasGC/getGC/setGC/clearGC - The name of the garbage collection algorithm
 216   ///                             to use during code generation.
 217   bool hasGC() const;
 218   const char *getGC() const;
 219   void setGC(const char *Str);
 220   void clearGC();
 221
 222   /// @brief adds the attribute to the list of attributes.
 223   void addAttribute(unsigned i, Attribute::AttrKind attr);
 224
 225   /// @brief adds the attributes to the list of attributes.
 226   void addAttributes(unsigned i, AttributeSet attrs);
 227
 228   /// @brief removes the attributes from the list of attributes.
 229   void removeAttributes(unsigned i, AttributeSet attr);
 230
 231   /// @brief Extract the alignment for a call or parameter (0=unknown).
 232   unsigned getParamAlignment(unsigned i) const {
 233     return AttributeSets.getParamAlignment(i);
 234   }
 235
 236   /// @brief Extract the number of dereferenceable bytes for a call or
 237   /// parameter (0=unknown).
 238   uint64_t getDereferenceableBytes(unsigned i) const {
 239     return AttributeSets.getDereferenceableBytes(i);
 240   }
 241
 242   /// @brief Determine if the function does not access memory.
 243   bool doesNotAccessMemory() const {
 244     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 245                                       Attribute::ReadNone);
 246   }
 247   void setDoesNotAccessMemory() {
 248     addFnAttr(Attribute::ReadNone);
 249   }
 250
 251   /// @brief Determine if the function does not access or only reads memory.
 252   bool onlyReadsMemory() const {
 253     return doesNotAccessMemory() ||
 254       AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 255                                  Attribute::ReadOnly);
 256   }
 257   void setOnlyReadsMemory() {
 258     addFnAttr(Attribute::ReadOnly);
 259   }
 260
 261   /// @brief Determine if the function cannot return.
 262   bool doesNotReturn() const {
 263     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 264                                       Attribute::NoReturn);
 265   }
 266   void setDoesNotReturn() {
 267     addFnAttr(Attribute::NoReturn);
 268   }
 269
 270   /// @brief Determine if the function cannot unwind.
 271   bool doesNotThrow() const {
 272     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 273                                       Attribute::NoUnwind);
 274   }
 275   void setDoesNotThrow() {
 276     addFnAttr(Attribute::NoUnwind);
 277   }
 278
 279   /// @brief Determine if the call cannot be duplicated.
 280   bool cannotDuplicate() const {
 281     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 282                                       Attribute::NoDuplicate);
 283   }
 284   void setCannotDuplicate() {
 285     addFnAttr(Attribute::NoDuplicate);
 286   }
 287
 288   /// @brief True if the ABI mandates (or the user requested) that this
 289   /// function be in a unwind table.
 290   bool hasUWTable() const {
 291     return AttributeSets.hasAttribute(AttributeSet::FunctionIndex,
 292                                       Attribute::UWTable);
 293   }
 294   void setHasUWTable() {
 295     addFnAttr(Attribute::UWTable);
 296   }
 297
 298   /// @brief True if this function needs an unwind table.
 299   bool needsUnwindTableEntry() const {
 300     return hasUWTable() || !doesNotThrow();
 301   }
 302
 303   /// @brief Determine if the function returns a structure through first
 304   /// pointer argument.
 305   bool hasStructRetAttr() const {
 306     return AttributeSets.hasAttribute(1, Attribute::StructRet) ||
 307            AttributeSets.hasAttribute(2, Attribute::StructRet);
 308   }
 309
 310   /// @brief Determine if the parameter does not alias other parameters.
 311   /// @param n The parameter to check. 1 is the first parameter, 0 is the return
 312   bool doesNotAlias(unsigned n) const {
 313     return AttributeSets.hasAttribute(n, Attribute::NoAlias);
 314   }
 315   void setDoesNotAlias(unsigned n) {
 316     addAttribute(n, Attribute::NoAlias);
 317   }
 318
 319   /// @brief Determine if the parameter can be captured.
 320   /// @param n The parameter to check. 1 is the first parameter, 0 is the return
 321   bool doesNotCapture(unsigned n) const {
 322     return AttributeSets.hasAttribute(n, Attribute::NoCapture);
 323   }
 324   void setDoesNotCapture(unsigned n) {
 325     addAttribute(n, Attribute::NoCapture);
 326   }
 327
 328   bool doesNotAccessMemory(unsigned n) const {
 329     return AttributeSets.hasAttribute(n, Attribute::ReadNone);
 330   }
 331   void setDoesNotAccessMemory(unsigned n) {
 332     addAttribute(n, Attribute::ReadNone);
 333   }
 334
 335   bool onlyReadsMemory(unsigned n) const {
 336     return doesNotAccessMemory(n) ||
 337       AttributeSets.hasAttribute(n, Attribute::ReadOnly);
 338   }
 339   void setOnlyReadsMemory(unsigned n) {
 340     addAttribute(n, Attribute::ReadOnly);
 341   }
 342
 343   /// copyAttributesFrom - copy all additional attributes (those not needed to
 344   /// create a Function) from the Function Src to this one.
 345   void copyAttributesFrom(const GlobalValue *Src) override;
 346
 347   /// deleteBody - This method deletes the body of the function, and converts
 348   /// the linkage to external.
 349   ///
 350   void deleteBody() {
 351     dropAllReferences();
 352     setLinkage(ExternalLinkage);
 353   }
 354
 355   /// removeFromParent - This method unlinks 'this' from the containing module,
 356   /// but does not delete it.
 357   ///
 358   void removeFromParent() override;
 359
 360   /// eraseFromParent - This method unlinks 'this' from the containing module
 361   /// and deletes it.
 362   ///
 363   void eraseFromParent() override;
 364
 365
 366   /// Get the underlying elements of the Function... the basic block list is
 367   /// empty for external functions.
 368   ///
 369   const ArgumentListType &getArgumentList() const {
 370     CheckLazyArguments();
 371     return ArgumentList;
 372   }
 373   ArgumentListType &getArgumentList() {
 374     CheckLazyArguments();
 375     return ArgumentList;
 376   }
 377   static iplist<Argument> Function::*getSublistAccess(Argument*) {
 378     return &Function::ArgumentList;
 379   }
 380
 381   const BasicBlockListType &getBasicBlockList() const { return BasicBlocks; }
 382         BasicBlockListType &getBasicBlockList()       { return BasicBlocks; }
 383   static iplist<BasicBlock> Function::*getSublistAccess(BasicBlock*) {
 384     return &Function::BasicBlocks;
 385   }
 386
 387   const BasicBlock       &getEntryBlock() const   { return front(); }
 388         BasicBlock       &getEntryBlock()         { return front(); }
 389
 390   //===--------------------------------------------------------------------===//
 391   // Symbol Table Accessing functions...
 392
 393   /// getSymbolTable() - Return the symbol table...
 394   ///
 395   inline       ValueSymbolTable &getValueSymbolTable()       { return *SymTab; }
 396   inline const ValueSymbolTable &getValueSymbolTable() const { return *SymTab; }
 397
 398
 399   //===--------------------------------------------------------------------===//
 400   // BasicBlock iterator forwarding functions
 401   //
 402   iterator                begin()       { return BasicBlocks.begin(); }
 403   const_iterator          begin() const { return BasicBlocks.begin(); }
 404   iterator                end  ()       { return BasicBlocks.end();   }
 405   const_iterator          end  () const { return BasicBlocks.end();   }
 406
 407   size_t                   size() const { return BasicBlocks.size();  }
 408   bool                    empty() const { return BasicBlocks.empty(); }
 409   const BasicBlock       &front() const { return BasicBlocks.front(); }
 410         BasicBlock       &front()       { return BasicBlocks.front(); }
 411   const BasicBlock        &back() const { return BasicBlocks.back();  }
 412         BasicBlock        &back()       { return BasicBlocks.back();  }
 413
 414 /// @name Function Argument Iteration
 415 /// @{
 416
 417   arg_iterator arg_begin() {
 418     CheckLazyArguments();
 419     return ArgumentList.begin();
 420   }
 421   const_arg_iterator arg_begin() const {
 422     CheckLazyArguments();
 423     return ArgumentList.begin();
 424   }
 425   arg_iterator arg_end() {
 426     CheckLazyArguments();
 427     return ArgumentList.end();
 428   }
 429   const_arg_iterator arg_end() const {
 430     CheckLazyArguments();
 431     return ArgumentList.end();
 432   }
 433
 434   iterator_range<arg_iterator> args() {
 435     return iterator_range<arg_iterator>(arg_begin(), arg_end());
 436   }
 437
 438   iterator_range<const_arg_iterator> args() const {
 439     return iterator_range<const_arg_iterator>(arg_begin(), arg_end());
 440   }
 441
 442 /// @}
 443
 444   size_t arg_size() const;
 445   bool arg_empty() const;
 446
 447   bool hasPrefixData() const {
 448     return getSubclassDataFromValue() & 2;
 449   }
 450
 451   Constant *getPrefixData() const;
 452   void setPrefixData(Constant *PrefixData);
 453
 454   /// viewCFG - This function is meant for use from the debugger.  You can just
 455   /// say 'call F->viewCFG()' and a ghostview window should pop up from the
 456   /// program, displaying the CFG of the current function with the code for each
 457   /// basic block inside.  This depends on there being a 'dot' and 'gv' program
 458   /// in your path.
 459   ///
 460   void viewCFG() const;
 461
 462   /// viewCFGOnly - This function is meant for use from the debugger.  It works
 463   /// just like viewCFG, but it does not include the contents of basic blocks
 464   /// into the nodes, just the label.  If you are only interested in the CFG
 465   /// this can make the graph smaller.
 466   ///
 467   void viewCFGOnly() const;
 468
 469   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 470   static inline bool classof(const Value *V) {
 471     return V->getValueID() == Value::FunctionVal;
 472   }
 473
 474   /// dropAllReferences() - This method causes all the subinstructions to "let
 475   /// go" of all references that they are maintaining.  This allows one to
 476   /// 'delete' a whole module at a time, even though there may be circular
 477   /// references... first all references are dropped, and all use counts go to
 478   /// zero.  Then everything is deleted for real.  Note that no operations are
 479   /// valid on an object that has "dropped all references", except operator
 480   /// delete.
 481   ///
 482   /// Since no other object in the module can have references into the body of a
 483   /// function, dropping all references deletes the entire body of the function,
 484   /// including any contained basic blocks.
 485   ///
 486   void dropAllReferences();
 487
 488   /// hasAddressTaken - returns true if there are any uses of this function
 489   /// other than direct calls or invokes to it, or blockaddress expressions.
 490   /// Optionally passes back an offending user for diagnostic purposes.
 491   ///
 492   bool hasAddressTaken(const User** = nullptr) const;
 493
 494   /// isDefTriviallyDead - Return true if it is trivially safe to remove
 495   /// this function definition from the module (because it isn't externally
 496   /// visible, does not have its address taken, and has no callers).  To make
 497   /// this more accurate, call removeDeadConstantUsers first.
 498   bool isDefTriviallyDead() const;
 499
 500   /// callsFunctionThatReturnsTwice - Return true if the function has a call to
 501   /// setjmp or other function that gcc recognizes as "returning twice".
 502   bool callsFunctionThatReturnsTwice() const;
 503
 504 private:
 505   // Shadow Value::setValueSubclassData with a private forwarding method so that
 506   // subclasses cannot accidentally use it.
 507   void setValueSubclassData(unsigned short D) {
 508     Value::setValueSubclassData(D);
 509   }
 510 };
 511
 512 inline ValueSymbolTable *
 513 ilist_traits<BasicBlock>::getSymTab(Function *F) {
 514   return F ? &F->getValueSymbolTable() : nullptr;
 515 }
 516
 517 inline ValueSymbolTable *
 518 ilist_traits<Argument>::getSymTab(Function *F) {
 519   return F ? &F->getValueSymbolTable() : nullptr;
 520 }
 521
 522 } // End llvm namespace
 523
 524 #endif