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