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