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