LLVM  3.7.0
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::Function Class Reference

#include <Function.h>

Inheritance diagram for llvm::Function:
[legend]
Collaboration diagram for llvm::Function:
[legend]

Public Types

typedef iplist< ArgumentArgumentListType
 
typedef iplist< BasicBlockBasicBlockListType
 
typedef
BasicBlockListType::iterator 
iterator
 
typedef
BasicBlockListType::const_iterator 
const_iterator
 
typedef ArgumentListType::iterator arg_iterator
 
typedef
ArgumentListType::const_iterator 
const_arg_iterator
 
- Public Types inherited from llvm::GlobalValue
enum  LinkageTypes {
  ExternalLinkage = 0, AvailableExternallyLinkage, LinkOnceAnyLinkage, LinkOnceODRLinkage,
  WeakAnyLinkage, WeakODRLinkage, AppendingLinkage, InternalLinkage,
  PrivateLinkage, ExternalWeakLinkage, CommonLinkage
}
 An enumeration for the kinds of linkage for global values. More...
 
enum  VisibilityTypes { DefaultVisibility = 0, HiddenVisibility, ProtectedVisibility }
 An enumeration for the kinds of visibility of global values. More...
 
enum  DLLStorageClassTypes { DefaultStorageClass = 0, DLLImportStorageClass = 1, DLLExportStorageClass = 2 }
 Storage classes of global values for PE targets. More...
 
enum  ThreadLocalMode {
  NotThreadLocal = 0, GeneralDynamicTLSModel, LocalDynamicTLSModel, InitialExecTLSModel,
  LocalExecTLSModel
}
 
- Public Types inherited from llvm::Constant
enum  PossibleRelocationsTy { NoRelocation = 0, LocalRelocation = 1, GlobalRelocations = 2 }
 
- Public Types inherited from llvm::User
typedef Useop_iterator
 
typedef const Useconst_op_iterator
 
typedef iterator_range
< op_iterator
op_range
 
typedef iterator_range
< const_op_iterator
const_op_range
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
typedef use_iterator_impl< Useuse_iterator
 
typedef use_iterator_impl
< const Use
const_use_iterator
 
typedef user_iterator_impl< Useruser_iterator
 
typedef user_iterator_impl
< const User
const_user_iterator
 

Public Member Functions

 ~Function () override
 
 DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value)
 Provide fast operand accessors. More...
 
bool hasPersonalityFn () const
 Get the personality function associated with this function. More...
 
ConstantgetPersonalityFn () const
 
void setPersonalityFn (Constant *C)
 
TypegetReturnType () const
 
FunctionTypegetFunctionType () const
 
LLVMContextgetContext () const
 getContext - Return a reference to the LLVMContext associated with this function. More...
 
bool isVarArg () const
 isVarArg - Return true if this function takes a variable number of arguments. More...
 
bool isMaterializable () const
 
void setIsMaterializable (bool V)
 
Intrinsic::ID getIntrinsicID () const LLVM_READONLY
 getIntrinsicID - This method returns the ID number of the specified function, or Intrinsic::not_intrinsic if the function is not an intrinsic, or if the pointer is null. More...
 
bool isIntrinsic () const
 
void recalculateIntrinsicID ()
 Recalculate the ID for this function if it is an Intrinsic defined in llvm/Intrinsics.h. More...
 
CallingConv::ID getCallingConv () const
 getCallingConv()/setCallingConv(CC) - These method get and set the calling convention of this function. More...
 
void setCallingConv (CallingConv::ID CC)
 
AttributeSet getAttributes () const
 Return the attribute list for this Function. More...
 
void setAttributes (AttributeSet attrs)
 Set the attribute list for this Function. More...
 
void addFnAttr (Attribute::AttrKind N)
 Add function attributes to this function. More...
 
void removeFnAttr (Attribute::AttrKind N)
 Remove function attributes from this function. More...
 
void addFnAttr (StringRef Kind)
 Add function attributes to this function. More...
 
void addFnAttr (StringRef Kind, StringRef Value)
 
void setEntryCount (uint64_t Count)
 Set the entry count for this function. More...
 
Optional< uint64_t > getEntryCount () const
 Get the entry count for this function. More...
 
bool hasFnAttribute (Attribute::AttrKind Kind) const
 Return true if the function has the attribute. More...
 
bool hasFnAttribute (StringRef Kind) const
 
Attribute getFnAttribute (Attribute::AttrKind Kind) const
 Return the attribute for the given attribute kind. More...
 
Attribute getFnAttribute (StringRef Kind) const
 
unsigned getFnStackAlignment () const
 Return the stack alignment for the function. More...
 
bool hasGC () const
 hasGC/getGC/setGC/clearGC - The name of the garbage collection algorithm to use during code generation. More...
 
const char * getGC () const
 
void setGC (const char *Str)
 
void clearGC ()
 
void addAttribute (unsigned i, Attribute::AttrKind attr)
 adds the attribute to the list of attributes. More...
 
void addAttributes (unsigned i, AttributeSet attrs)
 adds the attributes to the list of attributes. More...
 
void removeAttributes (unsigned i, AttributeSet attr)
 removes the attributes from the list of attributes. More...
 
void addDereferenceableAttr (unsigned i, uint64_t Bytes)
 adds the dereferenceable attribute to the list of attributes. More...
 
void addDereferenceableOrNullAttr (unsigned i, uint64_t Bytes)
 adds the dereferenceable_or_null attribute to the list of attributes. More...
 
unsigned getParamAlignment (unsigned i) const
 Extract the alignment for a call or parameter (0=unknown). More...
 
uint64_t getDereferenceableBytes (unsigned i) const
 Extract the number of dereferenceable bytes for a call or parameter (0=unknown). More...
 
uint64_t getDereferenceableOrNullBytes (unsigned i) const
 Extract the number of dereferenceable_or_null bytes for a call or parameter (0=unknown). More...
 
bool doesNotAccessMemory () const
 Determine if the function does not access memory. More...
 
void setDoesNotAccessMemory ()
 
bool onlyReadsMemory () const
 Determine if the function does not access or only reads memory. More...
 
void setOnlyReadsMemory ()
 
bool onlyAccessesArgMemory () const
 Determine if the call can access memmory only using pointers based on its arguments. More...
 
void setOnlyAccessesArgMemory ()
 
bool doesNotReturn () const
 Determine if the function cannot return. More...
 
void setDoesNotReturn ()
 
bool doesNotThrow () const
 Determine if the function cannot unwind. More...
 
void setDoesNotThrow ()
 
bool cannotDuplicate () const
 Determine if the call cannot be duplicated. More...
 
void setCannotDuplicate ()
 
bool isConvergent () const
 Determine if the call is convergent. More...
 
void setConvergent ()
 
bool hasUWTable () const
 True if the ABI mandates (or the user requested) that this function be in a unwind table. More...
 
void setHasUWTable ()
 
bool needsUnwindTableEntry () const
 True if this function needs an unwind table. More...
 
bool hasStructRetAttr () const
 Determine if the function returns a structure through first pointer argument. More...
 
bool doesNotAlias (unsigned n) const
 Determine if the parameter does not alias other parameters. More...
 
void setDoesNotAlias (unsigned n)
 
bool doesNotCapture (unsigned n) const
 Determine if the parameter can be captured. More...
 
void setDoesNotCapture (unsigned n)
 
bool doesNotAccessMemory (unsigned n) const
 
void setDoesNotAccessMemory (unsigned n)
 
bool onlyReadsMemory (unsigned n) const
 
void setOnlyReadsMemory (unsigned n)
 
void copyAttributesFrom (const GlobalValue *Src) override
 copyAttributesFrom - copy all additional attributes (those not needed to create a Function) from the Function Src to this one. More...
 
void deleteBody ()
 deleteBody - This method deletes the body of the function, and converts the linkage to external. More...
 
void removeFromParent () override
 removeFromParent - This method unlinks 'this' from the containing module, but does not delete it. More...
 
void eraseFromParent () override
 eraseFromParent - This method unlinks 'this' from the containing module and deletes it. More...
 
const ArgumentListTypegetArgumentList () const
 Get the underlying elements of the Function... More...
 
ArgumentListTypegetArgumentList ()
 
const BasicBlockListTypegetBasicBlockList () const
 
BasicBlockListTypegetBasicBlockList ()
 
const BasicBlockgetEntryBlock () const
 
BasicBlockgetEntryBlock ()
 
ValueSymbolTablegetValueSymbolTable ()
 getSymbolTable() - Return the symbol table... More...
 
const ValueSymbolTablegetValueSymbolTable () const
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
size_t size () const
 
bool empty () const
 
const BasicBlockfront () const
 
BasicBlockfront ()
 
const BasicBlockback () const
 
BasicBlockback ()
 
size_t arg_size () const
 
bool arg_empty () const
 
bool hasPrefixData () const
 
ConstantgetPrefixData () const
 
void setPrefixData (Constant *PrefixData)
 
bool hasPrologueData () const
 
ConstantgetPrologueData () const
 
void setPrologueData (Constant *PrologueData)
 
void print (raw_ostream &OS, AssemblyAnnotationWriter *AAW=nullptr) const
 Print the function to an output stream with an optional AssemblyAnnotationWriter. More...
 
void viewCFG () const
 viewCFG - This function is meant for use from the debugger. More...
 
void viewCFGOnly () const
 viewCFGOnly - This function is meant for use from the debugger. More...
 
void dropAllReferences ()
 dropAllReferences() - This method causes all the subinstructions to "let go" of all references that they are maintaining. More...
 
bool hasAddressTaken (const User **=nullptr) const
 hasAddressTaken - returns true if there are any uses of this function other than direct calls or invokes to it, or blockaddress expressions. More...
 
bool isDefTriviallyDead () const
 isDefTriviallyDead - Return true if it is trivially safe to remove this function definition from the module (because it isn't externally visible, does not have its address taken, and has no callers). More...
 
bool callsFunctionThatReturnsTwice () const
 callsFunctionThatReturnsTwice - Return true if the function has a call to setjmp or other function that gcc recognizes as "returning twice". More...
 
bool hasMetadata () const
 Check if this has any metadata. More...
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * >> &MDs) const
 Get all current metadata attachments. More...
 
void dropUnknownMetadata (ArrayRef< unsigned > KnownIDs)
 Drop metadata not in the given list. More...
 
Function Argument Iteration
arg_iterator arg_begin ()
 
const_arg_iterator arg_begin () const
 
arg_iterator arg_end ()
 
const_arg_iterator arg_end () const
 
iterator_range< arg_iteratorargs ()
 
iterator_range
< const_arg_iterator
args () const
 
MDNodegetMetadata (unsigned KindID) const
 Get the current metadata attachment, if any. More...
 
MDNodegetMetadata (StringRef Kind) const
 
void setMetadata (unsigned KindID, MDNode *MD)
 Set a particular kind of metadata attachment. More...
 
void setMetadata (StringRef Kind, MDNode *MD)
 
- Public Member Functions inherited from llvm::GlobalObject
unsigned getAlignment () const
 
void setAlignment (unsigned Align)
 
unsigned getGlobalObjectSubClassData () const
 
void setGlobalObjectSubClassData (unsigned Val)
 
bool hasSection () const
 
const char * getSection () const
 
void setSection (StringRef S)
 
bool hasComdat () const
 
const ComdatgetComdat () const
 
ComdatgetComdat ()
 
void setComdat (Comdat *C)
 
void copyAttributesFrom (const GlobalValue *Src) override
 Copy all additional attributes (those not needed to create a GlobalValue) from the GlobalValue Src to this one. More...
 
- Public Member Functions inherited from llvm::GlobalValue
 ~GlobalValue () override
 
unsigned getAlignment () const
 
bool hasUnnamedAddr () const
 
void setUnnamedAddr (bool Val)
 
bool hasComdat () const
 
ComdatgetComdat ()
 
const ComdatgetComdat () const
 
VisibilityTypes getVisibility () const
 
bool hasDefaultVisibility () const
 
bool hasHiddenVisibility () const
 
bool hasProtectedVisibility () const
 
void setVisibility (VisibilityTypes V)
 
bool isThreadLocal () const
 If the value is "Thread Local", its value isn't shared by the threads. More...
 
void setThreadLocal (bool Val)
 
void setThreadLocalMode (ThreadLocalMode Val)
 
ThreadLocalMode getThreadLocalMode () const
 
DLLStorageClassTypes getDLLStorageClass () const
 
bool hasDLLImportStorageClass () const
 
bool hasDLLExportStorageClass () const
 
void setDLLStorageClass (DLLStorageClassTypes C)
 
bool hasSection () const
 
const char * getSection () const
 
PointerTypegetType () const
 Global values are always pointers. More...
 
TypegetValueType () const
 
bool hasExternalLinkage () const
 
bool hasAvailableExternallyLinkage () const
 
bool hasLinkOnceLinkage () const
 
bool hasLinkOnceODRLinkage () const
 
bool hasWeakLinkage () const
 
bool hasWeakAnyLinkage () const
 
bool hasWeakODRLinkage () const
 
bool hasAppendingLinkage () const
 
bool hasInternalLinkage () const
 
bool hasPrivateLinkage () const
 
bool hasLocalLinkage () const
 
bool hasExternalWeakLinkage () const
 
bool hasCommonLinkage () const
 
void setLinkage (LinkageTypes LT)
 
LinkageTypes getLinkage () const
 
bool isDiscardableIfUnused () const
 
bool mayBeOverridden () const
 
bool isWeakForLinker () const
 
bool isDeclaration () const
 Return true if the primary definition of this global value is outside of the current translation unit. More...
 
bool isDeclarationForLinker () const
 
bool isStrongDefinitionForLinker () const
 Returns true if this global's definition will be the one chosen by the linker. More...
 
ModulegetParent ()
 Get the module that this global value is contained inside of... More...
 
const ModulegetParent () const
 
bool isMaterializable () const
 If this function's Module is being lazily streamed in functions from disk or some other source, this method can be used to check to see if the function has been read in yet or not. More...
 
bool isDematerializable () const
 Returns true if this function was loaded from a GVMaterializer that's still attached to its Module and that knows how to dematerialize the function. More...
 
std::error_code materialize ()
 Make sure this GlobalValue is fully read. More...
 
void dematerialize ()
 If this GlobalValue is read in, and if the GVMaterializer supports it, release the memory for the function, and set it up to be materialized lazily. More...
 
- Public Member Functions inherited from llvm::Constant
bool isNullValue () const
 isNullValue - Return true if this is the value that would be returned by getNullValue. More...
 
bool isOneValue () const
 Returns true if the value is one. More...
 
bool isAllOnesValue () const
 isAllOnesValue - Return true if this is the value that would be returned by getAllOnesValue. More...
 
bool isNegativeZeroValue () const
 isNegativeZeroValue - Return true if the value is what would be returned by getZeroValueForNegation. More...
 
bool isZeroValue () const
 Return true if the value is negative zero or null value. More...
 
bool isNotMinSignedValue () const
 Return true if the value is not the smallest signed value. More...
 
bool isMinSignedValue () const
 Return true if the value is the smallest signed value. More...
 
bool canTrap () const
 canTrap - Return true if evaluation of this constant could trap. More...
 
bool isThreadDependent () const
 isThreadDependent - Return true if the value can vary between threads. More...
 
bool isDLLImportDependent () const
 Return true if the value is dependent on a dllimport variable. More...
 
bool isConstantUsed () const
 isConstantUsed - Return true if the constant has users other than constant exprs and other dangling things. More...
 
PossibleRelocationsTy getRelocationInfo () const
 getRelocationInfo - This method classifies the entry according to whether or not it may generate a relocation entry. More...
 
ConstantgetAggregateElement (unsigned Elt) const
 getAggregateElement - For aggregates (struct/array/vector) return the constant that corresponds to the specified element if possible, or null if not. More...
 
ConstantgetAggregateElement (Constant *Elt) const
 
ConstantgetSplatValue () const
 getSplatValue - If this is a splat vector constant, meaning that all of the elements have the same value, return that value. More...
 
const APIntgetUniqueInteger () const
 If C is a constant integer then return its value, otherwise C must be a vector of constant integers, all equal, and the common value is returned. More...
 
void destroyConstant ()
 Called if some element of this constant is no longer valid. More...
 
void handleOperandChange (Value *, Value *, Use *)
 This method is a special form of User::replaceUsesOfWith (which does not work on constants) that does work on constants. More...
 
void removeDeadConstantUsers () const
 removeDeadConstantUsers - If there are any dead constant users dangling off of this constant, remove them. More...
 
ConstantstripPointerCasts ()
 
const ConstantstripPointerCasts () const
 
- Public Member Functions inherited from llvm::User
 ~User () override
 
void operator delete (void *Usr)
 Free memory allocated for User and Use objects. More...
 
void operator delete (void *, unsigned)
 Placement delete - required by std, but never called. More...
 
void operator delete (void *, unsigned, bool)
 Placement delete - required by std, but never called. More...
 
UsegetOperandList ()
 
const UsegetOperandList () const
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable. More...
 
void setFunctionNumOperands (unsigned NumOps)
 Set the number of operands on a Function. More...
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves. More...
 
op_iterator op_begin ()
 
const_op_iterator op_begin () const
 
op_iterator op_end ()
 
const_op_iterator op_end () const
 
op_range operands ()
 
const_op_range operands () const
 
value_op_iterator value_op_begin ()
 
value_op_iterator value_op_end ()
 
iterator_range< value_op_iteratoroperand_values ()
 
void dropAllReferences ()
 Drop all references to operands. More...
 
void replaceUsesOfWith (Value *From, Value *To)
 Replace uses of one Value with another. More...
 
- Public Member Functions inherited from llvm::Value
virtual ~Value ()
 
void dump () const
 Support for debugging, callable in GDB: V->dump() More...
 
TypegetType () const
 All values are typed, get the type of this value. More...
 
LLVMContextgetContext () const
 All values hold a context through their type. More...
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name. More...
 
void setName (const Twine &Name)
 Change the name of the value. More...
 
void takeName (Value *V)
 Transfer the name from V to this value. More...
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value. More...
 
void replaceUsesOutsideBlock (Value *V, BasicBlock *BB)
 replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block. More...
 
bool use_empty () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratoruses ()
 
iterator_range
< const_use_iterator
uses () const
 
bool user_empty () const
 
user_iterator user_begin ()
 
const_user_iterator user_begin () const
 
user_iterator user_end ()
 
const_user_iterator user_end () const
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratorusers ()
 
iterator_range
< const_user_iterator
users () const
 
bool hasOneUse () const
 Return true if there is exactly one user of this value. More...
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N users. More...
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N users or more. More...
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block. More...
 
unsigned getNumUses () const
 This method computes the number of uses of this Value. More...
 
void addUse (Use &U)
 This method should only be used by the Use class. More...
 
unsigned getValueID () const
 Return an ID for the concrete type of this object. More...
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value. More...
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value. More...
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality. More...
 
void intersectOptionalDataWith (const Value *V)
 Clear any optional flags not set in the given Value. More...
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value. More...
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value. More...
 
ValuestripPointerCasts ()
 Strip off pointer casts, all-zero GEPs, and aliases. More...
 
const ValuestripPointerCasts () const
 
ValuestripPointerCastsNoFollowAliases ()
 Strip off pointer casts and all-zero GEPs. More...
 
const ValuestripPointerCastsNoFollowAliases () const
 
ValuestripInBoundsConstantOffsets ()
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
const ValuestripInBoundsConstantOffsets () const
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 Accumulate offsets from stripInBoundsConstantOffsets(). More...
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 
ValuestripInBoundsOffsets ()
 Strip off pointer casts and inbounds GEPs. More...
 
const ValuestripInBoundsOffsets () const
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 Translate PHI node to its predecessor from the given basic block. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type. More...
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list. More...
 
void reverseUseList ()
 Reverse the use-list. More...
 
void print (raw_ostream &O) const
 Implement operator<< on Value. More...
 
void print (raw_ostream &O, ModuleSlotTracker &MST) const
 
void printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
 Print the name of this Value out to the specified raw_ostream. More...
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 
- Public Member Functions inherited from llvm::ilist_node< Function >
FunctiongetPrevNode ()
 Get the previous node, or 0 for the list head. More...
 
const FunctiongetPrevNode () const
 Get the previous node, or 0 for the list head. More...
 
FunctiongetNextNode ()
 Get the next node, or 0 for the list tail. More...
 
const FunctiongetNextNode () const
 Get the next node, or 0 for the list tail. More...
 

Static Public Member Functions

static FunctionCreate (FunctionType *Ty, LinkageTypes Linkage, const Twine &N="", Module *M=nullptr)
 
static iplist< Argument >
Function::* 
getSublistAccess (Argument *)
 
static iplist< BasicBlock >
Function::* 
getSublistAccess (BasicBlock *)
 
static bool classof (const Value *V)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
- Static Public Member Functions inherited from llvm::GlobalObject
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::GlobalValue
static LinkageTypes getLinkOnceLinkage (bool ODR)
 
static LinkageTypes getWeakLinkage (bool ODR)
 
static bool isExternalLinkage (LinkageTypes Linkage)
 
static bool isAvailableExternallyLinkage (LinkageTypes Linkage)
 
static bool isLinkOnceODRLinkage (LinkageTypes Linkage)
 
static bool isLinkOnceLinkage (LinkageTypes Linkage)
 
static bool isWeakAnyLinkage (LinkageTypes Linkage)
 
static bool isWeakODRLinkage (LinkageTypes Linkage)
 
static bool isWeakLinkage (LinkageTypes Linkage)
 
static bool isAppendingLinkage (LinkageTypes Linkage)
 
static bool isInternalLinkage (LinkageTypes Linkage)
 
static bool isPrivateLinkage (LinkageTypes Linkage)
 
static bool isLocalLinkage (LinkageTypes Linkage)
 
static bool isExternalWeakLinkage (LinkageTypes Linkage)
 
static bool isCommonLinkage (LinkageTypes Linkage)
 
static bool isDiscardableIfUnused (LinkageTypes Linkage)
 Whether the definition of this global may be discarded if it is not used in its compilation unit. More...
 
static bool mayBeOverridden (LinkageTypes Linkage)
 Whether the definition of this global may be replaced by something non-equivalent at link time. More...
 
static bool isWeakForLinker (LinkageTypes Linkage)
 Whether the definition of this global may be replaced at link time. More...
 
static StringRef getRealLinkageName (StringRef Name)
 If special LLVM prefix that is used to inform the asm printer to not emit usual symbol prefix before the symbol name is used then return linkage name after skipping this special LLVM prefix. More...
 
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::Constant
static bool classof (const Value *V)
 
static ConstantgetNullValue (Type *Ty)
 
static ConstantgetAllOnesValue (Type *Ty)
 Get the all ones value. More...
 
static ConstantgetIntegerValue (Type *Ty, const APInt &V)
 getIntegerValue - Return the value for an integer or pointer constant, or a vector thereof, with the given scalar value. More...
 
- Static Public Member Functions inherited from llvm::User
static bool classof (const Value *V)
 

Friends

class SymbolTableListTraits< Function, Module >
 

Additional Inherited Members

- Static Public Attributes inherited from llvm::Value
static const unsigned MaxAlignmentExponent = 29
 The maximum alignment for instructions. More...
 
static const unsigned MaximumAlignment = 1u << MaxAlignmentExponent
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 29 }
 The number of operands in the subclass. More...
 
- Protected Member Functions inherited from llvm::GlobalObject
 GlobalObject (PointerType *Ty, ValueTy VTy, Use *Ops, unsigned NumOps, LinkageTypes Linkage, const Twine &Name)
 
- Protected Member Functions inherited from llvm::GlobalValue
 GlobalValue (PointerType *Ty, ValueTy VTy, Use *Ops, unsigned NumOps, LinkageTypes Linkage, const Twine &Name)
 
unsigned getGlobalValueSubClassData () const
 
void setGlobalValueSubClassData (unsigned V)
 
- Protected Member Functions inherited from llvm::Constant
 Constant (Type *ty, ValueTy vty, Use *Ops, unsigned NumOps)
 
- Protected Member Functions inherited from llvm::User
void * operator new (size_t Size)
 Allocate a User with an operand pointer co-allocated. More...
 
void * operator new (size_t Size, unsigned Us)
 Allocate a User with the operands co-allocated. More...
 
 User (Type *ty, unsigned vty, Use *OpList, unsigned NumOps)
 
void allocHungoffUses (unsigned N, bool IsPhi=false)
 Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User. More...
 
void growHungoffUses (unsigned N, bool IsPhi=false)
 Grow the number of hung off uses. More...
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
- Protected Member Functions inherited from llvm::ilist_node< Function >
 ilist_node ()
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (const U *that)
 
- Protected Attributes inherited from llvm::GlobalObject
std::string Section
 
ComdatObjComdat
 
- Protected Attributes inherited from llvm::GlobalValue
LinkageTypes Linkage: 5
 
unsigned Visibility: 2
 
unsigned UnnamedAddr: 1
 
unsigned DllStorageClass: 2
 
unsigned ThreadLocal: 3
 
Intrinsic::ID IntID
 The intrinsic ID for this subclass (which must be a Function). More...
 
ModuleParent
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped. More...
 
unsigned NumUserOperands: NumUserOperandsBits
 
bool IsUsedByMD: 1
 
bool HasName: 1
 
bool HasHungOffUses: 1
 
- Static Protected Attributes inherited from llvm::GlobalObject
static const unsigned AlignmentBits = 5
 
static const unsigned GlobalObjectSubClassDataBits
 
- Static Protected Attributes inherited from llvm::GlobalValue
static const unsigned GlobalValueSubClassDataBits = 19
 

Detailed Description

Definition at line 53 of file Function.h.

Member Typedef Documentation

Definition at line 62 of file Function.h.

Definition at line 55 of file Function.h.

Definition at line 56 of file Function.h.

Definition at line 63 of file Function.h.

Definition at line 60 of file Function.h.

Definition at line 59 of file Function.h.

Constructor & Destructor Documentation

Function::~Function ( )
override

Member Function Documentation

void Function::addAttribute ( unsigned  i,
Attribute::AttrKind  attr 
)

adds the attribute to the list of attributes.

Definition at line 341 of file Function.cpp.

References llvm::AttributeSet::addAttribute(), getAttributes(), getContext(), and setAttributes().

Referenced by setDoesNotAccessMemory(), setDoesNotAlias(), setDoesNotCapture(), and setOnlyReadsMemory().

void Function::addAttributes ( unsigned  i,
AttributeSet  attrs 
)

adds the attributes to the list of attributes.

Definition at line 347 of file Function.cpp.

References llvm::AttributeSet::addAttributes(), getAttributes(), getContext(), and setAttributes().

Referenced by llvm::Argument::addAttr(), LLVMAddTargetDependentFunctionAttr(), and removeUseSoftFloat().

void Function::addDereferenceableAttr ( unsigned  i,
uint64_t  Bytes 
)

adds the dereferenceable attribute to the list of attributes.

Definition at line 359 of file Function.cpp.

References llvm::AttributeSet::addDereferenceableAttr(), getAttributes(), getContext(), and setAttributes().

void Function::addDereferenceableOrNullAttr ( unsigned  i,
uint64_t  Bytes 
)

adds the dereferenceable_or_null attribute to the list of attributes.

Definition at line 365 of file Function.cpp.

References llvm::AttributeSet::addDereferenceableOrNullAttr(), getAttributes(), getContext(), and setAttributes().

void llvm::Function::addFnAttr ( Attribute::AttrKind  N)
inline
void llvm::Function::addFnAttr ( StringRef  Kind)
inline

Add function attributes to this function.

Definition at line 199 of file Function.h.

References llvm::AttributeSet::addAttribute(), llvm::AttributeSet::FunctionIndex, getContext(), and setAttributes().

void llvm::Function::addFnAttr ( StringRef  Kind,
StringRef  Value 
)
inline
arg_iterator llvm::Function::arg_begin ( )
inline
const_arg_iterator llvm::Function::arg_begin ( ) const
inline

Definition at line 476 of file Function.h.

References llvm::iplist< NodeTy, Traits >::begin().

bool Function::arg_empty ( ) const

Definition at line 304 of file Function.cpp.

References getFunctionType(), and llvm::FunctionType::getNumParams().

arg_iterator llvm::Function::arg_end ( )
inline
const_arg_iterator llvm::Function::arg_end ( ) const
inline

Definition at line 484 of file Function.h.

References llvm::iplist< NodeTy, Traits >::end().

size_t Function::arg_size ( ) const
iterator_range<arg_iterator> llvm::Function::args ( )
inline

Definition at line 489 of file Function.h.

References arg_begin(), and arg_end().

Referenced by buildSetsFrom(), llvm::CloneFunctionInto(), and llvm::orc::makeStub().

iterator_range<const_arg_iterator> llvm::Function::args ( ) const
inline

Definition at line 493 of file Function.h.

References arg_begin(), and arg_end().

const BasicBlock& llvm::Function::back ( ) const
inline

Definition at line 466 of file Function.h.

References llvm::iplist< NodeTy, Traits >::back().

Referenced by llvm::InlineFunction().

BasicBlock& llvm::Function::back ( )
inline

Definition at line 467 of file Function.h.

References llvm::iplist< NodeTy, Traits >::back().

iterator llvm::Function::begin ( )
inline
const_iterator llvm::Function::begin ( ) const
inline

Definition at line 458 of file Function.h.

References llvm::iplist< NodeTy, Traits >::begin().

bool Function::callsFunctionThatReturnsTwice ( ) const

callsFunctionThatReturnsTwice - Return true if the function has a call to setjmp or other function that gcc recognizes as "returning twice".

Definition at line 916 of file Function.cpp.

References llvm::CS, llvm::CallSiteBase< FunTy, BBTy, ValTy, UserTy, InstrTy, CallTy, InvokeTy, IterTy >::hasFnAttr(), I, llvm::inst_begin(), llvm::inst_end(), and llvm::Attribute::ReturnsTwice.

Referenced by llvm::SelectionDAGISel::runOnMachineFunction().

bool llvm::Function::cannotDuplicate ( ) const
inline

Determine if the call cannot be duplicated.

Definition at line 325 of file Function.h.

References llvm::AttributeSet::FunctionIndex, llvm::AttributeSet::hasAttribute(), and llvm::Attribute::NoDuplicate.

static bool llvm::Function::classof ( const Value V)
inlinestatic

Methods for support type inquiry through isa, cast, and dyn_cast:

Definition at line 536 of file Function.h.

References llvm::Value::getValueID().

void Function::clearGC ( )

Definition at line 399 of file Function.cpp.

References llvm::StringPool::empty(), GCLock, GCNamePool, and GCNames.

Referenced by copyAttributesFrom(), LLVMSetGC(), and ~Function().

void Function::copyAttributesFrom ( const GlobalValue Src)
overridevirtual
static Function* llvm::Function::Create ( FunctionType Ty,
LinkageTypes  Linkage,
const Twine N = "",
Module M = nullptr 
)
inlinestatic
llvm::Function::DECLARE_TRANSPARENT_OPERAND_ACCESSORS ( Value  )

Provide fast operand accessors.

void llvm::Function::deleteBody ( )
inline

deleteBody - This method deletes the body of the function, and converts the linkage to external.

Definition at line 405 of file Function.h.

References dropAllReferences(), llvm::GlobalValue::ExternalLinkage, and llvm::GlobalValue::setLinkage().

Referenced by llvm::orc::moveFunctionBody().

bool llvm::Function::doesNotAccessMemory ( ) const
inline

Determine if the function does not access memory.

Definition at line 278 of file Function.h.

References llvm::AttributeSet::FunctionIndex, llvm::AttributeSet::hasAttribute(), and llvm::Attribute::ReadNone.

Referenced by onlyReadsMemory().

bool llvm::Function::doesNotAccessMemory ( unsigned  n) const
inline

Definition at line 383 of file Function.h.

References llvm::AttributeSet::hasAttribute(), and llvm::Attribute::ReadNone.

bool llvm::Function::doesNotAlias ( unsigned  n) const
inline

Determine if the parameter does not alias other parameters.

Parameters
nThe parameter to check. 1 is the first parameter, 0 is the return

Definition at line 367 of file Function.h.

References llvm::AttributeSet::hasAttribute(), and llvm::Attribute::NoAlias.

bool llvm::Function::doesNotCapture ( unsigned  n) const
inline

Determine if the parameter can be captured.

Parameters
nThe parameter to check. 1 is the first parameter, 0 is the return

Definition at line 376 of file Function.h.

References llvm::AttributeSet::hasAttribute(), and llvm::Attribute::NoCapture.

bool llvm::Function::doesNotReturn ( ) const
inline

Determine if the function cannot return.

Definition at line 307 of file Function.h.

References llvm::AttributeSet::FunctionIndex, llvm::AttributeSet::hasAttribute(), and llvm::Attribute::NoReturn.

bool llvm::Function::doesNotThrow ( ) const
inline
void Function::dropAllReferences ( )

dropAllReferences() - This method causes all the subinstructions to "let go" of all references that they are maintaining.

This allows one to 'delete' a whole module at a time, even though there may be circular references... first all references are dropped, and all use counts go to zero. Then everything is deleted for real. Note that no operations are valid on an object that has "dropped all references", except operator delete.

Since no other object in the module can have references into the body of a function, dropping all references deletes the entire body of the function, including any contained basic blocks.

Definition at line 320 of file Function.cpp.

References llvm::iplist< NodeTy, Traits >::begin(), begin(), llvm::iplist< NodeTy, Traits >::empty(), end(), I, setIsMaterializable(), setPersonalityFn(), setPrefixData(), and setPrologueData().

Referenced by deleteBody(), llvm::Module::dropAllReferences(), and ~Function().

void Function::dropUnknownMetadata ( ArrayRef< unsigned KnownIDs)
bool llvm::Function::empty ( ) const
inline
iterator llvm::Function::end ( )
inline
const_iterator llvm::Function::end ( ) const
inline

Definition at line 460 of file Function.h.

References llvm::iplist< NodeTy, Traits >::end().

void Function::eraseFromParent ( )
overridevirtual

eraseFromParent - This method unlinks 'this' from the containing module and deletes it.

Implements llvm::GlobalValue.

Definition at line 241 of file Function.cpp.

References llvm::iplist< NodeTy, Traits >::erase(), llvm::Module::getFunctionList(), and llvm::GlobalValue::getParent().

Referenced by INITIALIZE_PASS(), and llvm::UpgradeCallsToIntrinsic().

const BasicBlock& llvm::Function::front ( ) const
inline
BasicBlock& llvm::Function::front ( )
inline

Definition at line 465 of file Function.h.

References llvm::iplist< NodeTy, Traits >::front().

void Function::getAllMetadata ( SmallVectorImpl< std::pair< unsigned, MDNode * >> &  MDs) const

Get all current metadata attachments.

Definition at line 1216 of file Metadata.cpp.

References llvm::LLVMContextImpl::FunctionMetadata, getContext(), hasMetadata(), and llvm::LLVMContext::pImpl.

Referenced by WriteMetadataAttachment().

const ArgumentListType& llvm::Function::getArgumentList ( ) const
inline

Get the underlying elements of the Function...

the basic block list is empty for external functions.

Definition at line 424 of file Function.h.

Referenced by llvm::Argument::Argument(), and needsFPFromSig().

ArgumentListType& llvm::Function::getArgumentList ( )
inline

Definition at line 428 of file Function.h.

AttributeSet llvm::Function::getAttributes ( ) const
inline
const BasicBlockListType& llvm::Function::getBasicBlockList ( ) const
inline
BasicBlockListType& llvm::Function::getBasicBlockList ( )
inline

Definition at line 437 of file Function.h.

CallingConv::ID llvm::Function::getCallingConv ( ) const
inline
LLVMContext & Function::getContext ( ) const

getContext - Return a reference to the LLVMContext associated with this function.

Definition at line 223 of file Function.cpp.

References llvm::Type::getContext(), and llvm::GlobalValue::getType().

Referenced by AddAliasScopeMetadata(), llvm::Argument::addAttr(), addAttribute(), addAttributes(), addDereferenceableAttr(), addDereferenceableOrNullAttr(), addFnAttr(), AdjustCallerSSPLevel(), llvm::ARMFrameLowering::adjustForSegmentedStacks(), checkStringCopyLibFuncSignature(), CloneAliasScopeMetadata(), llvm::CloneFunctionInto(), combineInstructionsOverFunction(), createFPFnStub(), createStubLandingPad(), dropUnknownMetadata(), duplicateCPV(), llvm::SIRegisterInfo::eliminateFrameIndex(), llvm::LoopAccessReport::emitAnalysis(), emitAnalysis(), llvm::ARMBaseRegisterInfo::emitLoadConstPool(), emitThumb1LoadConstPool(), emitThumb2LoadConstPool(), llvm::FastISel::fastEmit_ri_(), fixupLineNumbers(), llvm::X86InstrInfo::foldMemoryOperandImpl(), llvm::BlockAddress::get(), getAllMetadata(), llvm::ScalarEvolution::getContext(), getMetadata(), getPrefixData(), getPrologueData(), llvm::SelectionDAG::init(), INITIALIZE_PASS(), insertFastDiv(), llvm::isFreeCall(), LLVMAddFunctionAttr(), LLVMAddTargetDependentFunctionAttr(), LLVMRemoveFunctionAttr(), llvm::XCoreInstrInfo::loadImmediate(), llvm::SIInstrInfo::loadRegFromStackSlot(), llvm::BlockAddress::lookup(), llvm::AMDGPUMCInstLower::lower(), llvm::NVPTXTargetLowering::LowerCall(), llvm::NVPTXTargetLowering::LowerReturn(), llvm::Argument::removeAttr(), removeAttributes(), removeFnAttr(), RemoveNestAttribute(), removeUseSoftFloat(), llvm::legacy::FunctionPassManagerImpl::run(), llvm::ExecutionEngine::runFunctionAsMain(), llvm::UnifyFunctionExitNodes::runOnFunction(), llvm::LPPassManager::runOnFunction(), llvm::Inliner::runOnSCC(), llvm::FastISel::selectExtractValue(), llvm::FunctionLoweringInfo::set(), setEntryCount(), setMetadata(), setPrefixData(), setPrologueData(), llvm::SIInstrInfo::storeRegToStackSlot(), llvm::UnrollLoop(), llvm::UpgradeIntrinsicFunction(), UpgradeIntrinsicFunction1(), and UpgradeSSE41Function().

uint64_t llvm::Function::getDereferenceableBytes ( unsigned  i) const
inline

Extract the number of dereferenceable bytes for a call or parameter (0=unknown).

Definition at line 267 of file Function.h.

References llvm::AttributeSet::getDereferenceableBytes().

Referenced by llvm::Argument::getDereferenceableBytes().

uint64_t llvm::Function::getDereferenceableOrNullBytes ( unsigned  i) const
inline

Extract the number of dereferenceable_or_null bytes for a call or parameter (0=unknown).

Definition at line 273 of file Function.h.

References llvm::AttributeSet::getDereferenceableOrNullBytes().

Referenced by llvm::Argument::getDereferenceableOrNullBytes().

const BasicBlock& llvm::Function::getEntryBlock ( ) const
inline
BasicBlock& llvm::Function::getEntryBlock ( )
inline

Definition at line 443 of file Function.h.

References front().

Optional< uint64_t > Function::getEntryCount ( ) const
Attribute llvm::Function::getFnAttribute ( Attribute::AttrKind  Kind) const
inline
Attribute llvm::Function::getFnAttribute ( StringRef  Kind) const
inline
unsigned llvm::Function::getFnStackAlignment ( ) const
inline

Return the stack alignment for the function.

Definition at line 233 of file Function.h.

References llvm::AttributeSet::FunctionIndex, and llvm::AttributeSet::getStackAlignment().

Referenced by llvm::MachineFunction::MachineFunction().

FunctionType * Function::getFunctionType ( ) const
const char * Function::getGC ( ) const
Intrinsic::ID llvm::Function::getIntrinsicID ( ) const
inline

getIntrinsicID - This method returns the ID number of the specified function, or Intrinsic::not_intrinsic if the function is not an intrinsic, or if the pointer is null.

This value is always defined to be zero to allow easy checking for whether a function is intrinsic or not. The particular intrinsic functions which correspond to this value are defined in llvm/Intrinsics.h.

Definition at line 159 of file Function.h.

References llvm::GlobalValue::IntID.

Referenced by llvm::CallGraphNode::addCalledFunction(), llvm::canConstantFoldCallTo(), computeKnownBitsFromAssume(), llvm::ConstantFoldCall(), llvm::TargetTransformInfoImplCRTPBase< AMDGPUTTIImpl >::getCallCost(), llvm::IntrinsicInst::getIntrinsicID(), handleBranchExpect(), handleSwitchExpect(), llvm::InlineCostAnalysis::isInlineViable(), llvm::isStatepoint(), lowerExpectIntrinsic(), llvm::IntrinsicLowering::LowerIntrinsicCall(), llvm::FastISel::selectInstruction(), SimplifyIntrinsic(), llvm::UpgradeIntrinsicCall(), llvm::UpgradeIntrinsicFunction(), and llvm::Interpreter::visitCallSite().

MDNode * Function::getMetadata ( unsigned  KindID) const

Get the current metadata attachment, if any.

Returns nullptr if such an attachment is missing.

Definition at line 1179 of file Metadata.cpp.

References llvm::LLVMContextImpl::FunctionMetadata, getContext(), hasMetadata(), and llvm::LLVMContext::pImpl.

Referenced by getEntryCount(), and getMetadata().

MDNode * Function::getMetadata ( StringRef  Kind) const

Definition at line 1185 of file Metadata.cpp.

References getContext(), getMetadata(), and hasMetadata().

unsigned llvm::Function::getParamAlignment ( unsigned  i) const
inline

Extract the alignment for a call or parameter (0=unknown).

Definition at line 261 of file Function.h.

References llvm::AttributeSet::getParamAlignment().

Referenced by llvm::Argument::getParamAlignment(), INITIALIZE_PASS(), and llvm::InlineFunction().

Constant* llvm::Function::getPersonalityFn ( ) const
inline
Constant * Function::getPrefixData ( ) const
Constant * Function::getPrologueData ( ) const
Type * Function::getReturnType ( ) const
static iplist<Argument> Function::* llvm::Function::getSublistAccess ( Argument )
inlinestatic

Definition at line 432 of file Function.h.

static iplist<BasicBlock> Function::* llvm::Function::getSublistAccess ( BasicBlock )
inlinestatic

Definition at line 438 of file Function.h.

ValueSymbolTable& llvm::Function::getValueSymbolTable ( )
inline
const ValueSymbolTable& llvm::Function::getValueSymbolTable ( ) const
inline

Definition at line 451 of file Function.h.

bool Function::hasAddressTaken ( const User **  PutOffender = nullptr) const

hasAddressTaken - returns true if there are any uses of this function other than direct calls or invokes to it, or blockaddress expressions.

hasAddressTaken - returns true if there are any uses of this function other than direct calls or invokes to it.

Optionally passes back an offending user for diagnostic purposes.

Definition at line 886 of file Function.cpp.

References llvm::CS, and llvm::Value::uses().

bool llvm::Function::hasFnAttribute ( Attribute::AttrKind  Kind) const
inline

Return true if the function has the attribute.

Definition at line 217 of file Function.h.

References llvm::AttributeSet::FunctionIndex, and llvm::AttributeSet::hasAttribute().

Referenced by AdjustCallerSSPLevel(), llvm::NVPTXTargetLowering::allowFMA(), llvm::WinException::beginFunction(), llvm::WebAssemblyRegisterInfo::canRealignStack(), llvm::AArch64RegisterInfo::canRealignStack(), llvm::X86RegisterInfo::canRealignStack(), llvm::ARMBaseRegisterInfo::canRealignStack(), llvm::PPCRegisterInfo::canRealignStack(), llvm::AArch64FrameLowering::canUseRedZone(), checkNumAlignedDPRCS2Regs(), combineInstructionsOverFunction(), llvm::TargetFrameLowering::determineCalleeSaves(), llvm::PPCFrameLowering::determineFrameLayout(), llvm::TargetOptions::DisableFramePointerElim(), llvm::PPCRegisterInfo::eliminateFrameIndex(), llvm::PPCTargetLowering::emitEHSjLjSetJmp(), llvm::MipsAsmPrinter::EmitFunctionBodyStart(), llvm::X86FrameLowering::emitPrologue(), ExpandPowI(), llvm::X86InstrInfo::foldMemoryOperandImpl(), get64BitArgumentXMMs(), llvm::ARMBaseRegisterInfo::getCalleeSavedRegs(), llvm::InlineCostAnalysis::getInlineCost(), llvm::Inliner::getInlineThreshold(), llvm::MemoryDependenceAnalysis::getLoadLoadClobberFullWidthSize(), getMemcpyLoadsAndStores(), getMemmoveLoadsAndStores(), getMemsetStores(), llvm::ARMBaseInstrInfo::getOperandLatency(), llvm::MipsTargetLowering::getOpndList(), llvm::ARMTargetLowering::getOptimalMemOpType(), llvm::AArch64TargetLowering::getOptimalMemOpType(), llvm::PPCTargetLowering::getOptimalMemOpType(), llvm::X86TargetLowering::getOptimalMemOpType(), llvm::MipsRegisterInfo::getReservedRegs(), llvm::MipsCCState::getSpecialCallingConvForCallee(), llvm::X86TargetMachine::getSubtargetImpl(), llvm::ARMBaseTargetMachine::getSubtargetImpl(), llvm::MipsTargetMachine::getSubtargetImpl(), hasReturnsTwiceAttr(), llvm::InlineCostAnalysis::isInlineViable(), isNoReturnDef(), llvm::ARMBaseInstrInfo::isProfitableToIfCvt(), llvm::RecurrenceDescriptor::isReductionPHI(), llvm::isSafeToSpeculativelyExecute(), LowerVectorBroadcast(), llvm::MachineFunction::MachineFunction(), llvm::PPCFrameLowering::needsFP(), llvm::MipsRegisterInfo::needsStackRealignment(), llvm::X86RegisterInfo::needsStackRealignment(), llvm::ARMBaseRegisterInfo::needsStackRealignment(), llvm::PPCRegisterInfo::needsStackRealignment(), llvm::LibCallSimplifier::optimizeCall(), PerformOrCombine(), performSTORECombine(), PerformSTORECombine(), ProfitableToMerge(), llvm::Inliner::removeDeadFunctions(), removeUseSoftFloat(), llvm::SelectionDAGISel::runOnMachineFunction(), llvm::MachineFunction::shouldSplitStack(), llvm::LoopPass::skipOptnoneFunction(), llvm::FunctionPass::skipOptnoneFunction(), llvm::BasicBlockPass::skipOptnoneFunction(), llvm::tryFoldSPUpdateIntoPushPop(), llvm::ARMSubtarget::useMovt(), and WindowsRequiresStackProbe().

bool llvm::Function::hasFnAttribute ( StringRef  Kind) const
inline
bool Function::hasGC ( ) const

hasGC/getGC/setGC/clearGC - The name of the garbage collection algorithm to use during code generation.

Definition at line 379 of file Function.cpp.

References GCLock, and GCNames.

Referenced by copyAttributesFrom(), llvm::GCModuleInfo::getFunctionInfo(), getGC(), llvm::InlineFunction(), LLVMGetGC(), llvm::SelectionDAGISel::runOnMachineFunction(), shouldRewriteFunction(), and shouldRewriteStatepointsIn().

bool llvm::Function::hasMetadata ( ) const
inline

Check if this has any metadata.

Definition at line 571 of file Function.h.

Referenced by dropUnknownMetadata(), getAllMetadata(), getMetadata(), setMetadata(), and WriteFunction().

bool llvm::Function::hasPersonalityFn ( ) const
inline
bool llvm::Function::hasPrefixData ( ) const
inline

Definition at line 502 of file Function.h.

References llvm::Value::getSubclassDataFromValue().

Referenced by copyAttributesFrom(), getPrefixData(), and setPrefixData().

bool llvm::Function::hasPrologueData ( ) const
inline
bool llvm::Function::hasStructRetAttr ( ) const
inline
bool llvm::Function::hasUWTable ( ) const
inline

True if the ABI mandates (or the user requested) that this function be in a unwind table.

Definition at line 345 of file Function.h.

References llvm::AttributeSet::FunctionIndex, llvm::AttributeSet::hasAttribute(), and llvm::Attribute::UWTable.

Referenced by needsUnwindTableEntry().

bool llvm::Function::isConvergent ( ) const
inline

Determine if the call is convergent.

Definition at line 334 of file Function.h.

References llvm::Attribute::Convergent, llvm::AttributeSet::FunctionIndex, and llvm::AttributeSet::hasAttribute().

bool Function::isDefTriviallyDead ( ) const

isDefTriviallyDead - Return true if it is trivially safe to remove this function definition from the module (because it isn't externally visible, does not have its address taken, and has no callers).

To make this more accurate, call removeDeadConstantUsers first.

Definition at line 900 of file Function.cpp.

References llvm::GlobalValue::hasAvailableExternallyLinkage(), llvm::GlobalValue::hasLinkOnceLinkage(), llvm::GlobalValue::hasLocalLinkage(), and llvm::Value::users().

Referenced by llvm::Inliner::removeDeadFunctions().

bool llvm::Function::isIntrinsic ( ) const
inline
bool Function::isMaterializable ( ) const

Definition at line 215 of file Function.cpp.

References llvm::GlobalObject::getGlobalObjectSubClassData().

bool Function::isVarArg ( ) const
bool llvm::Function::needsUnwindTableEntry ( ) const
inline
bool llvm::Function::onlyAccessesArgMemory ( ) const
inline

Determine if the call can access memmory only using pointers based on its arguments.

Definition at line 298 of file Function.h.

References llvm::Attribute::ArgMemOnly, llvm::AttributeSet::FunctionIndex, and llvm::AttributeSet::hasAttribute().

bool llvm::Function::onlyReadsMemory ( ) const
inline

Determine if the function does not access or only reads memory.

Definition at line 287 of file Function.h.

References doesNotAccessMemory(), llvm::AttributeSet::FunctionIndex, llvm::AttributeSet::hasAttribute(), and llvm::Attribute::ReadOnly.

Referenced by HandleByValArgument().

bool llvm::Function::onlyReadsMemory ( unsigned  n) const
inline
void Function::print ( raw_ostream OS,
AssemblyAnnotationWriter AAW = nullptr 
) const

Print the function to an output stream with an optional AssemblyAnnotationWriter.

Definition at line 3139 of file AsmWriter.cpp.

References llvm::GlobalValue::getParent().

void Function::recalculateIntrinsicID ( )

Recalculate the ID for this function if it is an Intrinsic defined in llvm/Intrinsics.h.

Sets the intrinsic ID to Intrinsic::not_intrinsic if the name of this function does not match an intrinsic in that header. Note, this method does not need to be called directly, as it is called from Value::setName() whenever the name of this function changes.

Definition at line 453 of file Function.cpp.

References llvm::Value::getValueName(), llvm::GlobalValue::IntID, isIntrinsic(), lookupIntrinsicID(), and llvm::Intrinsic::not_intrinsic.

void Function::removeAttributes ( unsigned  i,
AttributeSet  attr 
)

removes the attributes from the list of attributes.

Definition at line 353 of file Function.cpp.

References getAttributes(), getContext(), llvm::AttributeSet::removeAttributes(), and setAttributes().

Referenced by AdjustCallerSSPLevel(), llvm::Argument::removeAttr(), and removeUseSoftFloat().

void llvm::Function::removeFnAttr ( Attribute::AttrKind  N)
inline

Remove function attributes from this function.

Definition at line 193 of file Function.h.

References llvm::AttributeSet::FunctionIndex, getContext(), llvm::AttributeSet::removeAttribute(), and setAttributes().

void Function::removeFromParent ( )
overridevirtual

removeFromParent - This method unlinks 'this' from the containing module, but does not delete it.

Implements llvm::GlobalValue.

Definition at line 237 of file Function.cpp.

References llvm::Module::getFunctionList(), llvm::GlobalValue::getParent(), and llvm::iplist< NodeTy, Traits >::remove().

void llvm::Function::setAttributes ( AttributeSet  attrs)
inline
void llvm::Function::setCallingConv ( CallingConv::ID  CC)
inline

Definition at line 175 of file Function.h.

References llvm::Value::getSubclassDataFromValue().

Referenced by copyAttributesFrom().

void llvm::Function::setCannotDuplicate ( )
inline

Definition at line 329 of file Function.h.

References addFnAttr(), and llvm::Attribute::NoDuplicate.

void llvm::Function::setConvergent ( )
inline

Definition at line 338 of file Function.h.

References addFnAttr(), and llvm::Attribute::Convergent.

void llvm::Function::setDoesNotAccessMemory ( )
inline

Definition at line 282 of file Function.h.

References addFnAttr(), and llvm::Attribute::ReadNone.

void llvm::Function::setDoesNotAccessMemory ( unsigned  n)
inline

Definition at line 386 of file Function.h.

References addAttribute(), and llvm::Attribute::ReadNone.

void llvm::Function::setDoesNotAlias ( unsigned  n)
inline

Definition at line 370 of file Function.h.

References addAttribute(), and llvm::Attribute::NoAlias.

void llvm::Function::setDoesNotCapture ( unsigned  n)
inline

Definition at line 379 of file Function.h.

References addAttribute(), and llvm::Attribute::NoCapture.

void llvm::Function::setDoesNotReturn ( )
inline

Definition at line 311 of file Function.h.

References addFnAttr(), and llvm::Attribute::NoReturn.

void llvm::Function::setDoesNotThrow ( )
inline

Definition at line 320 of file Function.h.

References addFnAttr(), and llvm::Attribute::NoUnwind.

void Function::setEntryCount ( uint64_t  Count)

Set the entry count for this function.

Definition at line 985 of file Function.cpp.

References llvm::MDBuilder::createFunctionEntryCount(), getContext(), llvm::LLVMContext::MD_prof, and setMetadata().

void Function::setGC ( const char *  Str)

Definition at line 390 of file Function.cpp.

References GCLock, GCNamePool, GCNames, and llvm::StringPool::intern().

Referenced by copyAttributesFrom(), llvm::InlineFunction(), and LLVMSetGC().

void llvm::Function::setHasUWTable ( )
inline

Definition at line 349 of file Function.h.

References addFnAttr(), and llvm::Attribute::UWTable.

void Function::setIsMaterializable ( bool  V)

Definition at line 219 of file Function.cpp.

Referenced by dropAllReferences().

void Function::setMetadata ( unsigned  KindID,
MDNode MD 
)

Set a particular kind of metadata attachment.

Sets the given attachment to MD, erasing it if MD is nullptr or replacing it if it already exists.

Definition at line 1191 of file Metadata.cpp.

References llvm::LLVMContextImpl::FunctionMetadata, getContext(), hasMetadata(), llvm::LLVMContext::pImpl, and llvm::SPII::Store.

Referenced by setEntryCount(), and setMetadata().

void Function::setMetadata ( StringRef  Kind,
MDNode MD 
)

Definition at line 1210 of file Metadata.cpp.

References getContext(), hasMetadata(), and setMetadata().

void llvm::Function::setOnlyAccessesArgMemory ( )
inline

Definition at line 302 of file Function.h.

References addFnAttr(), and llvm::Attribute::ArgMemOnly.

void llvm::Function::setOnlyReadsMemory ( )
inline

Definition at line 292 of file Function.h.

References addFnAttr(), and llvm::Attribute::ReadOnly.

void llvm::Function::setOnlyReadsMemory ( unsigned  n)
inline

Definition at line 394 of file Function.h.

References addAttribute(), and llvm::Attribute::ReadOnly.

void Function::setPersonalityFn ( Constant C)
void Function::setPrefixData ( Constant PrefixData)
void Function::setPrologueData ( Constant PrologueData)
size_t llvm::Function::size ( ) const
inline
void llvm::Function::viewCFG ( ) const

viewCFG - This function is meant for use from the debugger.

You can just say 'call F->viewCFG()' and a ghostview window should pop up from the program, displaying the CFG of the current function with the code for each basic block inside. This depends on there being a 'dot' and 'gv' program in your path.

Referenced by LLVMViewFunctionCFG().

void llvm::Function::viewCFGOnly ( ) const

viewCFGOnly - This function is meant for use from the debugger.

It works just like viewCFG, but it does not include the contents of basic blocks into the nodes, just the label. If you are only interested in the CFG this can make the graph smaller.

Referenced by LLVMViewFunctionCFGOnly().

Friends And Related Function Documentation

friend class SymbolTableListTraits< Function, Module >
friend

Definition at line 93 of file Function.h.


The documentation for this class was generated from the following files: