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

#include "llvm/IR/Function.h"

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

Classes

class  ProfileCount
 Class to represent profile counts. More...
 

Public Types

enum  ProfileCountType { PCT_Invalid, PCT_Real, PCT_Synthetic }
 
using BasicBlockListType = SymbolTableList< BasicBlock >
 
using iterator = BasicBlockListType::iterator
 
using const_iterator = BasicBlockListType::const_iterator
 
using arg_iterator = Argument *
 
using const_arg_iterator = const Argument *
 
- Public Types inherited from llvm::GlobalObject
enum  VCallVisibility { VCallVisibilityPublic = 0, VCallVisibilityLinkageUnit = 1, VCallVisibilityTranslationUnit = 2 }
 
- 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
}
 
enum  UnnamedAddr { UnnamedAddr::None, UnnamedAddr::Local, UnnamedAddr::Global }
 
using GUID = uint64_t
 Declare a type to represent a global unique identifier for a global value. More...
 
- Public Types inherited from llvm::User
using op_iterator = Use *
 
using const_op_iterator = const Use *
 
using op_range = iterator_range< op_iterator >
 
using const_op_range = iterator_range< const_op_iterator >
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
using use_iterator = use_iterator_impl< Use >
 
using const_use_iterator = use_iterator_impl< const Use >
 
using user_iterator = user_iterator_impl< User >
 
using const_user_iterator = user_iterator_impl< const User >
 

Public Member Functions

bool hasLazyArguments () const
 hasLazyArguments/CheckLazyArguments - The argument list of a function is built on demand, so that the list isn't allocated until the first client needs it. More...
 
 Function (const Function &)=delete
 
void operator= (const Function &)=delete
 
 ~Function ()
 
const FunctiongetFunction () const
 
 DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value)
 
unsigned getInstructionCount () const
 Returns the number of non-debug IR instructions in this function. More...
 
FunctionTypegetFunctionType () const
 Returns the FunctionType for me. More...
 
TypegetReturnType () const
 Returns the type of the ret val. More...
 
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
 isIntrinsic - Returns true if the function's name starts with "llvm.". More...
 
bool isTargetIntrinsic () const
 isTargetIntrinsic - Returns true if this function is an intrinsic and the intrinsic is specific to a certain target. More...
 
bool isConstrainedFPIntrinsic () const
 Returns true if the function is one of the "Constrained Floating-Point Intrinsics". More...
 
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)
 
void setEntryCount (ProfileCount Count, const DenseSet< GlobalValue::GUID > *Imports=nullptr)
 Set the entry count for this function. More...
 
void setEntryCount (uint64_t Count, ProfileCountType Type=PCT_Real, const DenseSet< GlobalValue::GUID > *Imports=nullptr)
 A convenience wrapper for setting entry count. More...
 
ProfileCount getEntryCount (bool AllowSynthetic=false) const
 Get the entry count for this function. More...
 
bool hasProfileData (bool IncludeSynthetic=false) const
 Return true if the function is annotated with profile data. More...
 
DenseSet< GlobalValue::GUIDgetImportGUIDs () const
 Returns the set of GUIDs that needs to be imported to the function for sample PGO, to enable the same inlines as the profiled optimized binary. More...
 
void setSectionPrefix (StringRef Prefix)
 Set the section prefix for this function. More...
 
Optional< StringRefgetSectionPrefix () const
 Get the section prefix for this function. More...
 
bool hasGC () const
 hasGC/getGC/setGC/clearGC - The name of the garbage collection algorithm to use during code generation. More...
 
const std::string & getGC () const
 
void setGC (std::string Str)
 
void clearGC ()
 
AttributeList getAttributes () const
 Return the attribute list for this Function. More...
 
void setAttributes (AttributeList Attrs)
 Set the attribute list for this Function. More...
 
void addAttributeAtIndex (unsigned i, Attribute Attr)
 adds the attribute to the list of attributes. More...
 
void addFnAttr (Attribute::AttrKind Kind)
 Add function attributes to this function. More...
 
void addFnAttr (StringRef Kind, StringRef Val=StringRef())
 Add function attributes to this function. More...
 
void addFnAttr (Attribute Attr)
 Add function attributes to this function. More...
 
void addFnAttrs (const AttrBuilder &Attrs)
 Add function attributes to this function. More...
 
void addRetAttr (Attribute::AttrKind Kind)
 Add return value attributes to this function. More...
 
void addRetAttr (Attribute Attr)
 Add return value attributes to this function. More...
 
void addRetAttrs (const AttrBuilder &Attrs)
 Add return value attributes to this function. More...
 
void addParamAttr (unsigned ArgNo, Attribute::AttrKind Kind)
 adds the attribute to the list of attributes for the given arg. More...
 
void addParamAttr (unsigned ArgNo, Attribute Attr)
 adds the attribute to the list of attributes for the given arg. More...
 
void addParamAttrs (unsigned ArgNo, const AttrBuilder &Attrs)
 adds the attributes to the list of attributes for the given arg. More...
 
void removeAttributeAtIndex (unsigned i, Attribute::AttrKind Kind)
 removes the attribute from the list of attributes. More...
 
void removeAttributeAtIndex (unsigned i, StringRef Kind)
 removes the attribute from the list of attributes. More...
 
void removeFnAttr (Attribute::AttrKind Kind)
 Remove function attributes from this function. More...
 
void removeFnAttr (StringRef Kind)
 Remove function attribute from this function. More...
 
void removeFnAttrs (const AttrBuilder &Attrs)
 
void removeRetAttr (Attribute::AttrKind Kind)
 removes the attribute from the return value list of attributes. More...
 
void removeRetAttr (StringRef Kind)
 removes the attribute from the return value list of attributes. More...
 
void removeRetAttrs (const AttrBuilder &Attrs)
 removes the attributes from the return value list of attributes. More...
 
void removeParamAttr (unsigned ArgNo, Attribute::AttrKind Kind)
 removes the attribute from the list of attributes. More...
 
void removeParamAttr (unsigned ArgNo, StringRef Kind)
 removes the attribute from the list of attributes. More...
 
void removeParamAttrs (unsigned ArgNo, const AttrBuilder &Attrs)
 removes the attribute from the list of attributes. More...
 
bool hasFnAttribute (Attribute::AttrKind Kind) const
 Return true if the function has the attribute. More...
 
bool hasFnAttribute (StringRef Kind) const
 Return true if the function has the attribute. More...
 
bool hasRetAttribute (Attribute::AttrKind Kind) const
 check if an attribute is in the list of attributes for the return value. More...
 
bool hasParamAttribute (unsigned ArgNo, Attribute::AttrKind Kind) const
 check if an attributes is in the list of attributes. More...
 
Attribute getAttributeAtIndex (unsigned i, Attribute::AttrKind Kind) const
 gets the attribute from the list of attributes. More...
 
Attribute getAttributeAtIndex (unsigned i, StringRef Kind) const
 gets the attribute from the list of attributes. More...
 
Attribute getFnAttribute (Attribute::AttrKind Kind) const
 Return the attribute for the given attribute kind. More...
 
Attribute getFnAttribute (StringRef Kind) const
 Return the attribute for the given attribute kind. More...
 
Attribute getParamAttribute (unsigned ArgNo, Attribute::AttrKind Kind) const
 gets the specified attribute from the list of attributes. More...
 
void removeParamUndefImplyingAttrs (unsigned ArgNo)
 removes noundef and other attributes that imply undefined behavior if a undef or poison value is passed from the list of attributes. More...
 
MaybeAlign getFnStackAlign () const
 Return the stack alignment for the function. More...
 
bool hasStackProtectorFnAttr () const
 Returns true if the function has ssp, sspstrong, or sspreq fn attrs. More...
 
void addDereferenceableParamAttr (unsigned ArgNo, uint64_t Bytes)
 adds the dereferenceable attribute to the list of attributes for the given arg. More...
 
void addDereferenceableOrNullParamAttr (unsigned ArgNo, uint64_t Bytes)
 adds the dereferenceable_or_null attribute to the list of attributes for the given arg. More...
 
uint64_t getParamAlignment (unsigned ArgNo) const
 Extract the alignment for a call or parameter (0=unknown). More...
 
MaybeAlign getParamAlign (unsigned ArgNo) const
 
MaybeAlign getParamStackAlign (unsigned ArgNo) const
 
TypegetParamByValType (unsigned ArgNo) const
 Extract the byval type for a parameter. More...
 
TypegetParamStructRetType (unsigned ArgNo) const
 Extract the sret type for a parameter. More...
 
TypegetParamInAllocaType (unsigned ArgNo) const
 Extract the inalloca type for a parameter. More...
 
TypegetParamByRefType (unsigned ArgNo) const
 Extract the byref type for a parameter. More...
 
TypegetParamPreallocatedType (unsigned ArgNo) const
 Extract the preallocated type for a parameter. More...
 
uint64_t getParamDereferenceableBytes (unsigned ArgNo) const
 Extract the number of dereferenceable bytes for a parameter. More...
 
uint64_t getParamDereferenceableOrNullBytes (unsigned ArgNo) const
 Extract the number of dereferenceable_or_null bytes for a parameter. More...
 
bool isPresplitCoroutine () const
 A function will have the "coroutine.presplit" attribute if it's a coroutine and has not gone through full CoroSplit pass. 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 doesNotReadMemory () const
 Determine if the function does not access or only writes memory. More...
 
void setDoesNotReadMemory ()
 
bool onlyAccessesArgMemory () const
 Determine if the call can access memmory only using pointers based on its arguments. More...
 
void setOnlyAccessesArgMemory ()
 
bool onlyAccessesInaccessibleMemory () const
 Determine if the function may only access memory that is inaccessible from the IR. More...
 
void setOnlyAccessesInaccessibleMemory ()
 
bool onlyAccessesInaccessibleMemOrArgMem () const
 Determine if the function may only access memory that is either inaccessible from the IR or pointed to by its arguments. More...
 
void setOnlyAccessesInaccessibleMemOrArgMem ()
 
bool doesNotReturn () const
 Determine if the function cannot return. More...
 
void setDoesNotReturn ()
 
bool doesNoCfCheck () const
 Determine if the function should not perform indirect branch tracking. More...
 
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 ()
 
void setNotConvergent ()
 
bool isSpeculatable () const
 Determine if the call has sideeffects. More...
 
void setSpeculatable ()
 
bool doesNotFreeMemory () const
 Determine if the call might deallocate memory. More...
 
void setDoesNotFreeMemory ()
 
bool hasNoSync () const
 Determine if the call can synchroize with other threads. More...
 
void setNoSync ()
 
bool doesNotRecurse () const
 Determine if the function is known not to recurse, directly or indirectly. More...
 
void setDoesNotRecurse ()
 
bool mustProgress () const
 Determine if the function is required to make forward progress. More...
 
void setMustProgress ()
 
bool willReturn () const
 Determine if the function will return. More...
 
void setWillReturn ()
 
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 or second pointer argument. More...
 
bool returnDoesNotAlias () const
 Determine if the parameter or return value is marked with NoAlias attribute. More...
 
void setReturnDoesNotAlias ()
 
bool hasOptNone () const
 Do not optimize this function (-O0). More...
 
bool hasMinSize () const
 Optimize this function for minimum size (-Oz). More...
 
bool hasOptSize () const
 Optimize this function for size (-Os) or minimum size (-Oz). More...
 
DenormalMode getDenormalMode (const fltSemantics &FPType) const
 Returns the denormal handling type for the default rounding mode of the function. More...
 
void copyAttributesFrom (const Function *Src)
 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 ()
 removeFromParent - This method unlinks 'this' from the containing module, but does not delete it. More...
 
void eraseFromParent ()
 eraseFromParent - This method unlinks 'this' from the containing module and deletes it. More...
 
void stealArgumentListFrom (Function &Src)
 Steal arguments from another function. More...
 
const BasicBlockListTypegetBasicBlockList () const
 Get the underlying elements of the Function... More...
 
BasicBlockListTypegetBasicBlockList ()
 
const BasicBlockgetEntryBlock () const
 
BasicBlockgetEntryBlock ()
 
ValueSymbolTablegetValueSymbolTable ()
 getSymbolTable() - Return the symbol table if any, otherwise nullptr. 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 hasPersonalityFn () const
 Check whether this function has a personality function. More...
 
ConstantgetPersonalityFn () const
 Get the personality function associated with this function. More...
 
void setPersonalityFn (Constant *Fn)
 
bool hasPrefixData () const
 Check whether this function has prefix data. More...
 
ConstantgetPrefixData () const
 Get the prefix data associated with this function. More...
 
void setPrefixData (Constant *PrefixData)
 
bool hasPrologueData () const
 Check whether this function has prologue data. More...
 
ConstantgetPrologueData () const
 Get the prologue data associated with this function. More...
 
void setPrologueData (Constant *PrologueData)
 
void print (raw_ostream &OS, AssemblyAnnotationWriter *AAW=nullptr, bool ShouldPreserveUseListOrder=false, bool IsForDebug=false) 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 viewCFG (bool ViewCFGOnly, const BlockFrequencyInfo *BFI, const BranchProbabilityInfo *BPI) const
 Extended form to print edge weights. More...
 
void viewCFGOnly () const
 viewCFGOnly - This function is meant for use from the debugger. More...
 
void viewCFGOnly (const BlockFrequencyInfo *BFI, const BranchProbabilityInfo *BPI) const
 Extended form to print edge weights. 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, bool IgnoreCallbackUses=false, bool IgnoreAssumeLikeCalls=true, bool IngoreLLVMUsed=false, bool IgnoreARCAttachedCall=false) 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...
 
void setSubprogram (DISubprogram *SP)
 Set the attached subprogram. More...
 
DISubprogramgetSubprogram () const
 Get the attached subprogram. More...
 
bool isDebugInfoForProfiling () const
 Returns true if we should emit debug info for profiling. More...
 
bool nullPointerIsDefined () const
 Check if null pointer dereferencing is considered undefined behavior for the function. More...
 
Function Argument Iteration
arg_iterator arg_begin ()
 
const_arg_iterator arg_begin () const
 
arg_iterator arg_end ()
 
const_arg_iterator arg_end () const
 
ArgumentgetArg (unsigned i) const
 
iterator_range< arg_iteratorargs ()
 
iterator_range< const_arg_iteratorargs () const
 
- Public Member Functions inherited from llvm::GlobalObject
 GlobalObject (const GlobalObject &)=delete
 
uint64_t getAlignment () const
 FIXME: Remove this function once transition to Align is over. More...
 
MaybeAlign getAlign () const
 Returns the alignment of the given variable or function. More...
 
void setAlignment (MaybeAlign Align)
 
unsigned getGlobalObjectSubClassData () const
 
void setGlobalObjectSubClassData (unsigned Val)
 
bool hasSection () const
 Check if this global has a custom object file section. More...
 
StringRef getSection () const
 Get the custom section of this global if it has one. More...
 
void setSection (StringRef S)
 Change the section for this global. More...
 
bool hasComdat () const
 
const ComdatgetComdat () const
 
ComdatgetComdat ()
 
void setComdat (Comdat *C)
 
void copyMetadata (const GlobalObject *Src, unsigned Offset)
 Copy metadata from Src, adjusting offsets by Offset. More...
 
void addTypeMetadata (unsigned Offset, Metadata *TypeID)
 
void setVCallVisibilityMetadata (VCallVisibility Visibility)
 
VCallVisibility getVCallVisibility () const
 
bool canIncreaseAlignment () const
 Returns true if the alignment of the value can be unilaterally increased. More...
 
void addMetadata (unsigned KindID, MDNode &MD)
 Add a metadata attachment. More...
 
void addMetadata (StringRef Kind, MDNode &MD)
 
void clearMetadata ()
 Erase all metadata attached to this Value. More...
 
bool eraseMetadata (unsigned KindID)
 Erase all metadata attachments with the given kind. More...
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * >> &MDs) const
 Appends all metadata attached to this value to MDs, sorting by KindID. More...
 
MDNodegetMetadata (unsigned KindID) const
 Get the current metadata attachments for the given kind, if any. More...
 
MDNodegetMetadata (StringRef Kind) const
 
void getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
 Appends all attachments with the given ID to MDs in insertion order. More...
 
void getMetadata (StringRef Kind, SmallVectorImpl< MDNode * > &MDs) const
 
bool hasMetadata () const
 Return true if this value has any metadata attached to it. More...
 
bool hasMetadata (unsigned KindID) const
 Return true if this value has the given type of metadata attached. More...
 
bool hasMetadata (StringRef Kind) const
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set a particular kind of metadata attachment. More...
 
void setMetadata (StringRef Kind, MDNode *Node)
 
- Public Member Functions inherited from llvm::GlobalValue
 GlobalValue (const GlobalValue &)=delete
 
unsigned getAddressSpace () const
 
bool hasGlobalUnnamedAddr () const
 
bool hasAtLeastLocalUnnamedAddr () const
 Returns true if this value's address is not significant in this module. More...
 
UnnamedAddr getUnnamedAddr () const
 
void setUnnamedAddr (UnnamedAddr Val)
 
bool hasComdat () const
 
const ComdatgetComdat () const
 
ComdatgetComdat ()
 
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
 
StringRef getSection () const
 
PointerTypegetType () const
 Global values are always pointers. More...
 
TypegetValueType () const
 
bool isImplicitDSOLocal () const
 
void setDSOLocal (bool Local)
 
bool isDSOLocal () const
 
bool hasPartition () const
 
StringRef getPartition () const
 
void setPartition (StringRef Part)
 
bool isDefinitionExact () const
 Return true if the currently visible definition of this global (if any) is exactly the definition we will see at runtime. More...
 
bool hasExactDefinition () const
 Return true if this global has an exact defintion. More...
 
bool isInterposable () const
 Return true if this global's definition can be substituted with an arbitrary definition at link time or load time. More...
 
bool canBenefitFromLocalAlias () const
 
bool hasExternalLinkage () const
 
bool hasAvailableExternallyLinkage () const
 
bool hasLinkOnceLinkage () const
 
bool hasLinkOnceAnyLinkage () 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
 
bool hasValidDeclarationLinkage () const
 
void setLinkage (LinkageTypes LT)
 
LinkageTypes getLinkage () const
 
bool isDiscardableIfUnused () const
 
bool isWeakForLinker () const
 
std::string getGlobalIdentifier () const
 Return the modified name for this global value suitable to be used as the key for a global lookup (e.g. More...
 
GUID getGUID () const
 Return a 64-bit global unique ID constructed from global value name (i.e. More...
 
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...
 
const GlobalObjectgetAliaseeObject () const
 
GlobalObjectgetAliaseeObject ()
 
bool isAbsoluteSymbolRef () const
 Returns whether this is a reference to an absolute symbol. More...
 
Optional< ConstantRangegetAbsoluteSymbolRange () const
 If this is an absolute symbol reference, returns the range of the symbol, otherwise returns None. More...
 
void removeFromParent ()
 This method unlinks 'this' from the containing module, but does not delete it. More...
 
void eraseFromParent ()
 This method unlinks 'this' from the containing module and deletes it. More...
 
ModulegetParent ()
 Get the module that this global value is contained inside of... More...
 
const ModulegetParent () const
 
bool canBeOmittedFromSymbolTable () const
 True if GV can be left out of the object symbol table. More...
 
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...
 
Error materialize ()
 Make sure this GlobalValue is fully read. More...
 
- Public Member Functions inherited from llvm::Constant
void operator= (const Constant &)=delete
 
 Constant (const Constant &)=delete
 
bool isNullValue () const
 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 isNotOneValue () const
 Return true if the value is not the one value, or, for vectors, does not contain one value elements. More...
 
bool isAllOnesValue () const
 Return true if this is the value that would be returned by getAllOnesValue. More...
 
bool isNegativeZeroValue () const
 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, or, for vectors, does not contain smallest signed value elements. More...
 
bool isMinSignedValue () const
 Return true if the value is the smallest signed value. More...
 
bool isFiniteNonZeroFP () const
 Return true if this is a finite and non-zero floating-point scalar constant or a fixed width vector constant with all finite and non-zero elements. More...
 
bool isNormalFP () const
 Return true if this is a normal (as opposed to denormal, infinity, nan, or zero) floating-point scalar constant or a vector constant with all normal elements. More...
 
bool hasExactInverseFP () const
 Return true if this scalar has an exact multiplicative inverse or this vector has an exact multiplicative inverse for each element in the vector. More...
 
bool isNaN () const
 Return true if this is a floating-point NaN constant or a vector floating-point constant with all NaN elements. More...
 
bool isElementWiseEqual (Value *Y) const
 Return true if this constant and a constant 'Y' are element-wise equal. More...
 
bool containsUndefOrPoisonElement () const
 Return true if this is a vector constant that includes any undef or poison elements. More...
 
bool containsPoisonElement () const
 Return true if this is a vector constant that includes any poison elements. More...
 
bool containsConstantExpression () const
 Return true if this is a fixed width vector constant that includes any constant expressions. More...
 
bool canTrap () const
 Return true if evaluation of this constant could trap. More...
 
bool isThreadDependent () const
 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
 Return true if the constant has users other than constant expressions and other dangling things. More...
 
bool needsRelocation () const
 This method classifies the entry according to whether or not it may generate a relocation entry (either static or dynamic). More...
 
bool needsDynamicRelocation () const
 
ConstantgetAggregateElement (unsigned Elt) const
 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 (bool AllowUndefs=false) const
 If all elements of the vector constant 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 *)
 This method is a special form of User::replaceUsesOfWith (which does not work on constants) that does work on constants. More...
 
void removeDeadConstantUsers () const
 If there are any dead constant users dangling off of this constant, remove them. More...
 
bool hasOneLiveUse () const
 Return true if the constant has exactly one live use. More...
 
const ConstantstripPointerCasts () const
 
ConstantstripPointerCasts ()
 
bool isManifestConstant () const
 Return true if a constant is ConstantData or a ConstantAggregate or ConstantExpr that contain only ConstantData. More...
 
- Public Member Functions inherited from llvm::User
 User (const User &)=delete
 
void operator delete (void *Usr)
 Free memory allocated for User and Use objects. More...
 
void operator delete (void *Usr, unsigned)
 Placement delete - required by std, called if the ctor throws. More...
 
void operator delete (void *Usr, unsigned, unsigned)
 Placement delete - required by std, called if the ctor throws. More...
 
const UsegetOperandList () const
 
UsegetOperandList ()
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
ArrayRef< const uint8_t > getDescriptor () const
 Returns the descriptor co-allocated with this User instance. More...
 
MutableArrayRef< uint8_t > getDescriptor ()
 Returns the descriptor co-allocated with this User instance. More...
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable. More...
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves. More...
 
bool isDroppable () const
 A droppable user is a user for which uses can be dropped without affecting correctness and should be dropped rather than preventing a transformation from happening. 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 ()
 
const_value_op_iterator value_op_begin () const
 
const_value_op_iterator value_op_end () const
 
iterator_range< const_value_op_iteratoroperand_values () const
 
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
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value. More...
 
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...
 
std::string getNameOrAsOperand () const
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value. More...
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value. More...
 
void replaceUsesWithIf (Value *New, llvm::function_ref< bool(Use &U)> ShouldReplace)
 Go through the uses list for this definition and make each use point to "V" if the callback ShouldReplace returns true for the given Use. 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...
 
void assertModuleIsMaterializedImpl () const
 
void assertModuleIsMaterialized () const
 
bool use_empty () const
 
bool materialized_use_empty () const
 
use_iterator materialized_use_begin ()
 
const_use_iterator materialized_use_begin () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratormaterialized_uses ()
 
iterator_range< const_use_iteratormaterialized_uses () const
 
iterator_range< use_iteratoruses ()
 
iterator_range< const_use_iteratoruses () const
 
bool user_empty () const
 
user_iterator materialized_user_begin ()
 
const_user_iterator materialized_user_begin () 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_iteratormaterialized_users ()
 
iterator_range< const_user_iteratormaterialized_users () const
 
iterator_range< user_iteratorusers ()
 
iterator_range< const_user_iteratorusers () const
 
bool hasOneUse () const
 Return true if there is exactly one use of this value. More...
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N uses. More...
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N uses or more. More...
 
bool hasOneUser () const
 Return true if there is exactly one user of this value. More...
 
UsegetSingleUndroppableUse ()
 Return true if there is exactly one use of this value that cannot be dropped. More...
 
const UsegetSingleUndroppableUse () const
 
UsergetUniqueUndroppableUser ()
 Return true if there is exactly one unique user of this value that cannot be dropped (that user can have multiple uses of this value). More...
 
const UsergetUniqueUndroppableUser () const
 
bool hasNUndroppableUses (unsigned N) const
 Return true if there this value. More...
 
bool hasNUndroppableUsesOrMore (unsigned N) const
 Return true if this value has N uses or more. More...
 
void dropDroppableUses (llvm::function_ref< bool(const Use *)> ShouldDrop=[](const Use *) { return true;})
 Remove every uses that can safely be removed. More...
 
void dropDroppableUsesIn (User &Usr)
 Remove every use of this value in User that can safely be removed. 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...
 
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...
 
bool isTransitiveUsedByMetadataOnly () const
 
bool isSwiftError () const
 Return true if this value is a swifterror value. More...
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs and address space casts. More...
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndAliases () const
 Strip off pointer casts, all-zero GEPs, address space casts, and aliases. More...
 
ValuestripPointerCastsAndAliases ()
 
const ValuestripPointerCastsSameRepresentation () const
 Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same. More...
 
ValuestripPointerCastsSameRepresentation ()
 
const ValuestripPointerCastsForAliasAnalysis () const
 Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info. More...
 
ValuestripPointerCastsForAliasAnalysis ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr) const
 Accumulate the constant offset this value has compared to a base pointer. More...
 
ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds)
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false. More...
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) const
 Strip off pointer casts and inbounds GEPs. More...
 
ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {})
 
bool canBeFreed () const
 Return true if the memory object referred to by V can by freed in the scope for which the SSA value defining the allocation is statically defined. More...
 
uint64_t getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull, bool &CanBeFreed) const
 Returns the number of bytes known to be dereferenceable for the pointer value. More...
 
Align getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block. More...
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
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, bool IsForDebug=false) const
 Implement operator<< on Value. More...
 
void print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) 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_impl< ilist_detail::compute_node_options< Function, Options... >::type >
self_iterator getIterator ()
 
const_self_iterator getIterator () const
 
reverse_self_iterator getReverseIterator ()
 
const_reverse_self_iterator getReverseIterator () const
 
bool isSentinel () const
 Check whether this is the sentinel node. More...
 

Static Public Member Functions

static FunctionCreate (FunctionType *Ty, LinkageTypes Linkage, unsigned AddrSpace, const Twine &N="", Module *M=nullptr)
 
static FunctionCreate (FunctionType *Ty, LinkageTypes Linkage, const Twine &N="", Module *M=nullptr)
 
static FunctionCreate (FunctionType *Ty, LinkageTypes Linkage, const Twine &N, Module &M)
 Creates a new function and attaches it to a module. More...
 
static FunctioncreateWithDefaultAttr (FunctionType *Ty, LinkageTypes Linkage, unsigned AddrSpace, const Twine &N="", Module *M=nullptr)
 Creates a function with some attributes recorded in llvm.module.flags applied. More...
 
static bool isTargetIntrinsic (Intrinsic::ID IID)
 isTargetIntrinsic - Returns true if IID is an intrinsic specific to a certain target. More...
 
static Intrinsic::ID lookupIntrinsicID (StringRef Name)
 This does the actual lookup of an intrinsic ID which matches the given function name. More...
 
static BasicBlockListType 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 UnnamedAddr getMinUnnamedAddr (UnnamedAddr A, UnnamedAddr B)
 
static LinkageTypes getLinkOnceLinkage (bool ODR)
 
static LinkageTypes getWeakLinkage (bool ODR)
 
static bool isExternalLinkage (LinkageTypes Linkage)
 
static bool isAvailableExternallyLinkage (LinkageTypes Linkage)
 
static bool isLinkOnceAnyLinkage (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 isValidDeclarationLinkage (LinkageTypes Linkage)
 
static bool isInterposableLinkage (LinkageTypes Linkage)
 Whether the definition of this global may be replaced by something non-equivalent at link time. More...
 
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 isWeakForLinker (LinkageTypes Linkage)
 Whether the definition of this global may be replaced at link time. More...
 
static StringRef dropLLVMManglingEscape (StringRef Name)
 If the given string begins with the GlobalValue name mangling escape character '\1', drop it. More...
 
static std::string getGlobalIdentifier (StringRef Name, GlobalValue::LinkageTypes Linkage, StringRef FileName)
 Return the modified name for a global value suitable to be used as the key for a global lookup (e.g. More...
 
static GUID getGUID (StringRef GlobalName)
 Return a 64-bit global unique ID constructed from global value name (i.e. 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)
 Constructor to create a '0' constant of arbitrary type. More...
 
static ConstantgetAllOnesValue (Type *Ty)
 
static ConstantgetIntegerValue (Type *Ty, const APInt &V)
 Return the value for an integer or pointer constant, or a vector thereof, with the given scalar value. More...
 
static ConstantreplaceUndefsWith (Constant *C, Constant *Replacement)
 Try to replace undefined constant C or undefined elements in C with Replacement. More...
 
static ConstantmergeUndefsWith (Constant *C, Constant *Other)
 Merges undefs of a Constant with another Constant, along with the undefs already present. More...
 
- Static Public Member Functions inherited from llvm::User
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::Value
static void dropDroppableUse (Use &U)
 Remove the droppable use U. More...
 

Friends

class SymbolTableListTraits< Function >
 

Additional Inherited Members

- Static Public Attributes inherited from llvm::Value
static constexpr unsigned MaxAlignmentExponent = 32
 The maximum alignment for instructions. More...
 
static constexpr uint64_t MaximumAlignment = 1ULL << MaxAlignmentExponent
 
- Protected Types inherited from llvm::GlobalObject
enum  { LastAlignmentBit = 5, HasSectionHashEntryBit, GlobalObjectBits }
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 27 }
 The number of operands in the subclass. More...
 
- Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Function, Options... >::type >
using self_iterator = ilist_iterator< ilist_detail::compute_node_options< Function, Options... >::type, false, false >
 
using const_self_iterator = ilist_iterator< ilist_detail::compute_node_options< Function, Options... >::type, false, true >
 
using reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< Function, Options... >::type, true, false >
 
using const_reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< Function, Options... >::type, true, true >
 
- Protected Member Functions inherited from llvm::GlobalObject
 GlobalObject (Type *Ty, ValueTy VTy, Use *Ops, unsigned NumOps, LinkageTypes Linkage, const Twine &Name, unsigned AddressSpace=0)
 
void copyAttributesFrom (const GlobalObject *Src)
 
- Protected Member Functions inherited from llvm::GlobalValue
 GlobalValue (Type *Ty, ValueTy VTy, Use *Ops, unsigned NumOps, LinkageTypes Linkage, const Twine &Name, unsigned AddressSpace)
 
unsigned getGlobalValueSubClassData () const
 
void setGlobalValueSubClassData (unsigned V)
 
void setParent (Module *parent)
 
 ~GlobalValue ()
 
void copyAttributesFrom (const GlobalValue *Src)
 Copy all additional attributes (those not needed to create a GlobalValue) from the GlobalValue Src to this one. More...
 
- Protected Member Functions inherited from llvm::Constant
 Constant (Type *ty, ValueTy vty, Use *Ops, unsigned NumOps)
 
 ~Constant ()=default
 
- 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...
 
void * operator new (size_t Size, unsigned Us, unsigned DescBytes)
 Allocate a User with the operands co-allocated. More...
 
 User (Type *ty, unsigned vty, Use *, 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...
 
 ~User ()=default
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
 ~Value ()
 Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID. More...
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * >> &MDs) const
 Appends all metadata attached to this value to MDs, sorting by KindID. More...
 
bool hasMetadata () const
 Return true if this value has any metadata attached to it. More...
 
bool eraseMetadata (unsigned KindID)
 Erase all metadata attachments with the given kind. More...
 
void clearMetadata ()
 Erase all metadata attached to this Value. More...
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
MDNodegetMetadata (unsigned KindID) const
 Get the current metadata attachments for the given kind, if any. More...
 
MDNodegetMetadata (StringRef Kind) const
 
void getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
 Appends all attachments with the given ID to MDs in insertion order. More...
 
void getMetadata (StringRef Kind, SmallVectorImpl< MDNode * > &MDs) const
 
bool hasMetadata (unsigned KindID) const
 Return true if this value has the given type of metadata attached. More...
 
bool hasMetadata (StringRef Kind) const
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set a particular kind of metadata attachment. More...
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void addMetadata (unsigned KindID, MDNode &MD)
 Add a metadata attachment. More...
 
void addMetadata (StringRef Kind, MDNode &MD)
 
- Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Function, Options... >::type >
 ilist_node_impl ()=default
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (const U *that)
 
- Protected Attributes inherited from llvm::GlobalObject
ComdatObjComdat
 
- Protected Attributes inherited from llvm::GlobalValue
TypeValueType
 
unsigned Linkage: 4
 
unsigned Visibility: 2
 
unsigned UnnamedAddrVal: 2
 
unsigned DllStorageClass: 2
 
unsigned ThreadLocal: 3
 
unsigned HasLLVMReservedName: 1
 True if the function's name starts with "llvm.". More...
 
unsigned IsDSOLocal: 1
 If true then there is a definition within the same linkage unit and that definition cannot be runtime preempted. More...
 
unsigned HasPartition: 1
 True if this symbol has a partition name assigned (see https://lld.llvm.org/Partitions.html). More...
 
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
 
unsigned IsUsedByMD: 1
 
unsigned HasName: 1
 
unsigned HasMetadata: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 
- Static Protected Attributes inherited from llvm::GlobalObject
static const unsigned GlobalObjectSubClassDataBits
 
- Static Protected Attributes inherited from llvm::GlobalValue
static const unsigned GlobalValueSubClassDataBits = 16
 

Detailed Description

Definition at line 62 of file Function.h.

Member Typedef Documentation

◆ arg_iterator

Definition at line 71 of file Function.h.

◆ BasicBlockListType

Definition at line 65 of file Function.h.

◆ const_arg_iterator

Definition at line 72 of file Function.h.

◆ const_iterator

Definition at line 69 of file Function.h.

◆ iterator

Definition at line 68 of file Function.h.

Member Enumeration Documentation

◆ ProfileCountType

Enumerator
PCT_Invalid 
PCT_Real 
PCT_Synthetic 

Definition at line 250 of file Function.h.

Constructor & Destructor Documentation

◆ Function()

llvm::Function::Function ( const Function )
delete

◆ ~Function()

Function::~Function ( )

Definition at line 410 of file Function.cpp.

References clearGC(), and dropAllReferences().

Member Function Documentation

◆ addAttributeAtIndex()

void Function::addAttributeAtIndex ( unsigned  i,
Attribute  Attr 
)

adds the attribute to the list of attributes.

Definition at line 532 of file Function.cpp.

References llvm::AttributeList::addAttributeAtIndex(), getContext(), and i.

Referenced by addIfNotExistent().

◆ addDereferenceableOrNullParamAttr()

void Function::addDereferenceableOrNullParamAttr ( unsigned  ArgNo,
uint64_t  Bytes 
)

adds the dereferenceable_or_null attribute to the list of attributes for the given arg.

Definition at line 666 of file Function.cpp.

References llvm::AttributeList::addDereferenceableOrNullParamAttr(), and getContext().

Referenced by tryToMoveFreeBeforeNullTest().

◆ addDereferenceableParamAttr()

void Function::addDereferenceableParamAttr ( unsigned  ArgNo,
uint64_t  Bytes 
)

adds the dereferenceable attribute to the list of attributes for the given arg.

Definition at line 621 of file Function.cpp.

References llvm::AttributeList::addDereferenceableParamAttr(), and getContext().

◆ addFnAttr() [1/3]

void Function::addFnAttr ( Attribute  Attr)

Add function attributes to this function.

Definition at line 544 of file Function.cpp.

References llvm::AttributeList::addFnAttribute(), and getContext().

◆ addFnAttr() [2/3]

void Function::addFnAttr ( Attribute::AttrKind  Kind)

◆ addFnAttr() [3/3]

void Function::addFnAttr ( StringRef  Kind,
StringRef  Val = StringRef() 
)

Add function attributes to this function.

Definition at line 540 of file Function.cpp.

References llvm::AttributeList::addFnAttribute(), and getContext().

◆ addFnAttrs()

void Function::addFnAttrs ( const AttrBuilder Attrs)

Add function attributes to this function.

Definition at line 548 of file Function.cpp.

References llvm::AttributeList::addFnAttributes(), Attrs, and getContext().

◆ addParamAttr() [1/2]

void Function::addParamAttr ( unsigned  ArgNo,
Attribute  Attr 
)

adds the attribute to the list of attributes for the given arg.

Definition at line 568 of file Function.cpp.

References llvm::AttributeList::addParamAttribute(), and getContext().

◆ addParamAttr() [2/2]

void Function::addParamAttr ( unsigned  ArgNo,
Attribute::AttrKind  Kind 
)

adds the attribute to the list of attributes for the given arg.

Definition at line 564 of file Function.cpp.

References llvm::AttributeList::addParamAttribute(), and getContext().

Referenced by llvm::Argument::addAttr(), and createCloneDeclaration().

◆ addParamAttrs()

void Function::addParamAttrs ( unsigned  ArgNo,
const AttrBuilder Attrs 
)

adds the attributes to the list of attributes for the given arg.

Definition at line 572 of file Function.cpp.

References llvm::AttributeList::addParamAttributes(), Attrs, and getContext().

◆ addRetAttr() [1/2]

void Function::addRetAttr ( Attribute  Attr)

Add return value attributes to this function.

Definition at line 556 of file Function.cpp.

References llvm::AttributeList::addRetAttribute(), and getContext().

◆ addRetAttr() [2/2]

void Function::addRetAttr ( Attribute::AttrKind  Kind)

Add return value attributes to this function.

Definition at line 552 of file Function.cpp.

References llvm::AttributeList::addRetAttribute(), and getContext().

◆ addRetAttrs()

void Function::addRetAttrs ( const AttrBuilder Attrs)

Add return value attributes to this function.

Definition at line 560 of file Function.cpp.

References llvm::AttributeList::addRetAttributes(), Attrs, and getContext().

◆ arg_begin() [1/2]

arg_iterator llvm::Function::arg_begin ( )
inline

◆ arg_begin() [2/2]

const_arg_iterator llvm::Function::arg_begin ( ) const
inline

Definition at line 753 of file Function.h.

References Arguments.

◆ arg_empty()

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

Definition at line 783 of file Function.h.

◆ arg_end() [1/2]

arg_iterator llvm::Function::arg_end ( )
inline

◆ arg_end() [2/2]

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

Definition at line 762 of file Function.h.

References Arguments.

◆ arg_size()

size_t llvm::Function::arg_size ( ) const
inline

◆ args() [1/2]

iterator_range<arg_iterator> llvm::Function::args ( )
inline

◆ args() [2/2]

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

Definition at line 776 of file Function.h.

References llvm::make_range().

◆ back() [1/2]

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

Definition at line 744 of file Function.h.

◆ back() [2/2]

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

Definition at line 743 of file Function.h.

Referenced by llvm::AttributeList::get(), and llvm::OutlinableRegion::splitCandidate().

◆ begin() [1/2]

iterator llvm::Function::begin ( )
inline

◆ begin() [2/2]

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

Definition at line 735 of file Function.h.

◆ callsFunctionThatReturnsTwice()

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 1814 of file Function.cpp.

References I, and llvm::instructions().

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

◆ cannotDuplicate()

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

Determine if the call cannot be duplicated.

Definition at line 575 of file Function.h.

◆ classof()

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

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

Definition at line 842 of file Function.h.

References llvm::Value::getValueID().

◆ clearGC()

void Function::clearGC ( )

Definition at line 697 of file Function.cpp.

References llvm::LLVMContext::deleteGC(), getContext(), and hasGC().

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

◆ copyAttributesFrom()

void Function::copyAttributesFrom ( const Function Src)

copyAttributesFrom - copy all additional attributes (those not needed to create a Function) from the Function Src to this one.

Copy all additional attributes (those not needed to create a Function) from the Function Src to this one.

Definition at line 712 of file Function.cpp.

References clearGC(), llvm::GlobalObject::copyAttributesFrom(), setAttributes(), setCallingConv(), setGC(), setPersonalityFn(), setPrefixData(), and setPrologueData().

Referenced by addVariantDeclaration(), llvm::orc::cloneFunctionDecl(), llvm::CloneFunctionInto(), llvm::CloneModule(), doPromotion(), and replaceWithTLIFunction().

◆ Create() [1/3]

Function * Function::Create ( FunctionType Ty,
LinkageTypes  Linkage,
const Twine N,
Module M 
)
static

Creates a new function and attaches it to a module.

Places the function in the program address space as specified by the module's data layout.

Definition at line 333 of file Function.cpp.

References Create(), llvm::GlobalValue::Linkage, M, and N.

◆ Create() [2/3]

static Function* llvm::Function::Create ( FunctionType Ty,
LinkageTypes  Linkage,
const Twine N = "",
Module M = nullptr 
)
inlinestatic

Definition at line 146 of file Function.h.

References M, and N.

◆ Create() [3/3]

static Function* llvm::Function::Create ( FunctionType Ty,
LinkageTypes  Linkage,
unsigned  AddrSpace,
const Twine N = "",
Module M = nullptr 
)
inlinestatic

◆ createWithDefaultAttr()

Function * Function::createWithDefaultAttr ( FunctionType Ty,
LinkageTypes  Linkage,
unsigned  AddrSpace,
const Twine N = "",
Module M = nullptr 
)
static

Creates a function with some attributes recorded in llvm.module.flags applied.

Use this when synthesizing new functions that need attributes that would have been set by command line options.

Definition at line 338 of file Function.cpp.

References llvm::All, B, F, llvm::GlobalValue::Linkage, M, N, llvm::None, and llvm::NonLeaf.

Referenced by llvm::createSanitizerCtor().

◆ DECLARE_TRANSPARENT_OPERAND_ACCESSORS()

llvm::Function::DECLARE_TRANSPARENT_OPERAND_ACCESSORS ( Value  )

◆ deleteBody()

void llvm::Function::deleteBody ( )
inline

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

Definition at line 687 of file Function.h.

Referenced by llvm::CallGraphUpdater::removeFunction().

◆ doesNoCfCheck()

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

Determine if the function should not perform indirect branch tracking.

Definition at line 564 of file Function.h.

◆ doesNotAccessMemory()

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

Determine if the function does not access memory.

Definition at line 507 of file Function.h.

◆ doesNotFreeMemory()

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

Determine if the call might deallocate memory.

Definition at line 602 of file Function.h.

◆ doesNotReadMemory()

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

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

Definition at line 523 of file Function.h.

◆ doesNotRecurse()

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

Determine if the function is known not to recurse, directly or indirectly.

Definition at line 619 of file Function.h.

Referenced by addNoRecurseAttrsTopDown().

◆ doesNotReturn()

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

Determine if the function cannot return.

Definition at line 556 of file Function.h.

◆ doesNotThrow()

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

Determine if the function cannot unwind.

Definition at line 567 of file Function.h.

Referenced by llvm::EscapeEnumerator::Next(), and llvm::InstCombinerImpl::visitCallInst().

◆ dropAllReferences()

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 510 of file Function.cpp.

References BB, llvm::Value::clearMetadata(), llvm::User::dropAllReferences(), llvm::User::getNumOperands(), llvm::Value::getSubclassDataFromValue(), setIsMaterializable(), and llvm::User::setNumHungOffUseOperands().

Referenced by ~Function().

◆ empty()

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

◆ end() [1/2]

iterator llvm::Function::end ( )
inline

◆ end() [2/2]

const_iterator llvm::Function::end ( ) const
inline

Definition at line 737 of file Function.h.

◆ eraseFromParent()

void Function::eraseFromParent ( )

◆ front() [1/2]

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

Definition at line 742 of file Function.h.

◆ front() [2/2]

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

◆ getArg()

Argument* llvm::Function::getArg ( unsigned  i) const
inline

◆ getAttributeAtIndex() [1/2]

Attribute Function::getAttributeAtIndex ( unsigned  i,
Attribute::AttrKind  Kind 
) const

gets the attribute from the list of attributes.

Definition at line 643 of file Function.cpp.

References llvm::AttributeList::getAttributeAtIndex(), and i.

Referenced by addIfNotExistent().

◆ getAttributeAtIndex() [2/2]

Attribute Function::getAttributeAtIndex ( unsigned  i,
StringRef  Kind 
) const

gets the attribute from the list of attributes.

Definition at line 648 of file Function.cpp.

References llvm::AttributeList::getAttributeAtIndex(), and i.

◆ getAttributes()

AttributeList llvm::Function::getAttributes ( ) const
inline

Return the attribute list for this Function.

Definition at line 327 of file Function.h.

Referenced by llvm::OpenMPIRBuilder::addAttributes(), llvm::Argument::addAttrs(), llvm::TargetLowering::BuildSDIVPow2(), llvm::CloneFunctionInto(), llvm::FunctionComparator::compareSignature(), llvm::XCoreFrameLowering::emitPrologue(), llvm::X86FrameLowering::emitPrologue(), fillOverallFunction(), llvm::AArch64RegisterInfo::getCalleeSavedRegs(), llvm::SystemZELFRegisters::getCalleeSavedRegs(), llvm::AArch64RegisterInfo::getCallPreservedMask(), llvm::SystemZELFRegisters::getCallPreservedMask(), llvm::ARMBaseRegisterInfo::getCallPreservedMask(), llvm::AArch64RegisterInfo::getDarwinCalleeSavedRegs(), llvm::AArch64RegisterInfo::getDarwinCallPreservedMask(), getMemcpyLoadsAndStores(), getMemmoveLoadsAndStores(), getMemsetStores(), llvm::Argument::getPassPointeeByValueCopySize(), llvm::Argument::getPointeeInMemoryValueType(), llvm::Argument::hasPassPointeeByValueCopyAttr(), llvm::Argument::hasPointeeInMemoryValueAttr(), insertSinCosCall(), IsCallReturnTwice(), llvm::PPCInstrInfo::isSignOrZeroExtended(), llvm::Attributor::isValidFunctionSignatureRewrite(), llvm::IRAttributeManifest::manifestAttrs(), llvm::Argument::onlyReadsMemory(), optimizeDoubleFP(), produceCompactUnwindFrame(), llvm::Argument::removeAttrs(), llvm::IRPosition::removeAttrs(), llvm::TargetLoweringObjectFile::SectionForGlobal(), llvm::FunctionLoweringInfo::set(), llvm::CallLowering::setArgFlags(), llvm::TargetLowering::SimplifySetCC(), and llvm::InstCombinerImpl::visitFDiv().

◆ getBasicBlockList() [1/2]

BasicBlockListType& llvm::Function::getBasicBlockList ( )
inline

Definition at line 712 of file Function.h.

◆ getBasicBlockList() [2/2]

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

◆ getCallingConv()

CallingConv::ID llvm::Function::getCallingConv ( ) const
inline

getCallingConv()/setCallingConv(CC) - These method get and set the calling convention of this function.

The enum values for the known calling conventions are defined in CallingConv.h.

Definition at line 240 of file Function.h.

References llvm::CallingConv::MaxID.

Referenced by llvm::SIMachineFunctionInfo::allocateVGPRSpillToAGPR(), llvm::AMDGPUTargetLowering::analyzeFormalArgumentsCompute(), llvm::AMDGPUCallLowering::areCalleeOutgoingArgsTailCallable(), llvm::AVRMachineFunctionInfo::AVRMachineFunctionInfo(), llvm::FunctionComparator::compareSignature(), computeCalleeSaveRegisterPairs(), llvm::computeSignatureVTs(), llvm::coro::createMustTailCall(), llvm::AArch64FrameLowering::determineCalleeSaves(), llvm::AMDGPUCallLowering::doCallerAndCalleePassArgsTheSameWay(), llvm::ARMFrameLowering::emitEpilogue(), llvm::RISCVFrameLowering::emitEpilogue(), llvm::AArch64FrameLowering::emitEpilogue(), llvm::SystemZELFFrameLowering::emitEpilogue(), llvm::PPCFrameLowering::emitEpilogue(), llvm::ARMFrameLowering::emitPrologue(), llvm::RISCVFrameLowering::emitPrologue(), llvm::AArch64FrameLowering::emitPrologue(), llvm::SystemZELFFrameLowering::emitPrologue(), llvm::X86FrameLowering::emitPrologue(), llvm::X86FrameLowering::enableShrinkWrapping(), llvm::VERegisterInfo::getCalleeSavedRegs(), llvm::RISCVRegisterInfo::getCalleeSavedRegs(), llvm::AArch64RegisterInfo::getCalleeSavedRegs(), llvm::SIRegisterInfo::getCalleeSavedRegs(), llvm::PPCRegisterInfo::getCalleeSavedRegs(), llvm::SystemZELFRegisters::getCalleeSavedRegs(), llvm::AArch64RegisterInfo::getCalleeSavedRegsViaCopy(), llvm::X86RegisterInfo::getCalleeSavedRegsViaCopy(), llvm::ARMBaseRegisterInfo::getCalleeSavedRegsViaCopy(), llvm::AArch64RegisterInfo::getDarwinCalleeSavedRegs(), llvm::SIInstrInfo::getDSShaderTypeValue(), getFPOffset(), llvm::X86FrameLowering::getFrameIndexReference(), llvm::SIMachineFunctionInfo::getGITPtrLoReg(), llvm::Mangler::getNameWithPrefix(), llvm::M68kRegisterInfo::getReservedRegs(), llvm::X86RegisterInfo::getReservedRegs(), GetScratchRegister(), llvm::TargetFrameLowering::getStackAlignmentSkew(), llvm::X86FrameLowering::has128ByteRedZone(), llvm::InlineFunction(), isCallableFunction(), llvm::TargetRegisterInfo::isCalleeSavedPhysReg(), llvm::AArch64CallLowering::isEligibleForTailCallOptimization(), llvm::AMDGPUCallLowering::isEligibleForTailCallOptimization(), llvm::HexagonTargetLowering::IsEligibleForTailCallOptimization(), llvm::SITargetLowering::isEligibleForTailCallOptimization(), llvm::SIInstrInfo::legalizeOperands(), llvm::SITargetLowering::LowerCall(), LowerVACOPY(), llvm::SITargetLowering::mayBeEmittedAsTailCall(), AMDGPUInformationCache::needsQueuePtr(), produceCompactUnwindFrame(), reservePrivateMemoryRegs(), llvm::AArch64FrameLowering::resolveFrameOffsetReference(), llvm::FunctionLoweringInfo::set(), llvm::AArch64TargetLowering::supportSplitCSR(), llvm::SystemZELFFrameLowering::usePackedStack(), llvm::R600InstrInfo::usesTextureCache(), and llvm::R600InstrInfo::usesVertexCache().

◆ getContext()

LLVMContext & Function::getContext ( ) const

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

Definition at line 321 of file Function.cpp.

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

Referenced by AddAliasScopeMetadata(), addAttributeAtIndex(), llvm::OpenMPIRBuilder::addAttributes(), llvm::Argument::addAttrs(), addBoundsChecking(), addDereferenceableOrNullParamAttr(), addDereferenceableParamAttr(), addFnAttr(), addFnAttrs(), addParamAttr(), addParamAttrs(), addRetAttr(), addRetAttrs(), llvm::ARMFrameLowering::adjustForSegmentedStacks(), llvm::SIMachineFunctionInfo::allocateSGPRSpillToVGPR(), llvm::MachineOptimizationRemarkEmitter::allowExtraAnalysis(), llvm::CombinerHelper::applyCombineConstantFoldFpUnary(), llvm::AMDGPUCallLowering::areCalleeOutgoingArgsTailCallable(), llvm::MachineIRBuilder::buildFConstant(), clearGC(), llvm::CloneFunctionInto(), collectCallSiteParameters(), llvm::SITargetLowering::computeKnownAlignForTargetInstr(), convertImplicitDefToConstZero(), createAndInsertBasicBlocks(), createFPFnStub(), llvm::createMemLibcall(), llvm::TargetInstrInfo::describeLoadedValue(), duplicateCPV(), llvm::OptimizationRemarkEmitter::emit(), llvm::MachineOptimizationRemarkEmitter::emit(), llvm::ARMBaseRegisterInfo::emitLoadConstPool(), llvm::RISCVFrameLowering::emitPrologue(), emitSCSEpilogue(), emitSCSPrologue(), emitThumb1LoadConstPool(), emitThumb2LoadConstPool(), llvm::OptimizationRemarkEmitter::enabled(), llvm::FastISel::fastEmit_ri_(), fixupDebugInfoPostExtraction(), fixupLineNumbers(), llvm::X86InstrInfo::foldMemoryOperandImpl(), getDefaultInlineAdvice(), getFunctionTypeFromAsyncSuspend(), getGC(), llvm::OpenMPIRBuilder::getOrCreateRuntimeFunction(), getRegistersForValue(), llvm::FunctionLoweringInfo::getValueFromVirtualReg(), llvm::RISCVInstrInfo::getVLENFactoredAmount(), llvm::SelectionDAG::init(), interpretValues(), llvm::MachineOptimizationRemark::isEnabled(), llvm::MachineOptimizationRemarkMissed::isEnabled(), llvm::MachineOptimizationRemarkAnalysis::isEnabled(), llvm::OptimizationRemark::isEnabled(), llvm::OptimizationRemarkMissed::isEnabled(), llvm::OptimizationRemarkAnalysis::isEnabled(), llvm::PPCTargetLowering::isFMAFasterThanFMulAndFAdd(), llvm::ARMLegalizerInfo::legalizeCustom(), llvm::AMDGPULegalizerInfo::legalizeGlobalValue(), llvm::LegalizerHelper::libcall(), llvm::XCoreInstrInfo::loadImmediate(), llvm::AArch64CallLowering::lowerCall(), llvm::RISCVTargetLowering::LowerCall(), llvm::LegalizerHelper::lowerLoad(), llvm::lowerObjectSizeCall(), llvm::RISCVTargetLowering::LowerReturn(), llvm::LegalizerHelper::lowerStore(), llvm::CombinerHelper::matchLoadOrCombine(), llvm::MIPrinter::print(), llvm::MachineInstr::print(), removeAttributeAtIndex(), llvm::Argument::removeAttrs(), removeFnAttr(), removeFnAttrs(), removeParamAttr(), removeParamAttrs(), removeRetAttr(), removeRetAttrs(), replaceAsyncResumeFunction(), reportIllegalCopy(), llvm::ExecutionEngine::runFunctionAsMain(), llvm::OptimizationRemarkEmitterWrapperPass::runOnFunction(), llvm::SelectionDAGISel::runOnMachineFunction(), llvm::MachineOptimizationRemarkEmitterPass::runOnMachineFunction(), llvm::FunctionLoweringInfo::set(), setEntryCount(), setGC(), setSectionPrefix(), llvm::SITargetLowering::shouldExpandAtomicRMWInIR(), and llvm::LegalizerHelper::widenScalar().

◆ getDenormalMode()

DenormalMode Function::getDenormalMode ( const fltSemantics FPType) const

Returns the denormal handling type for the default rounding mode of the function.

Definition at line 672 of file Function.cpp.

References llvm::StringRef::empty(), getFnAttribute(), llvm::Attribute::getValueAsString(), llvm::APFloatBase::IEEEsingle(), and llvm::parseDenormalFPAttribute().

Referenced by fpModeMatchesGlobalFPAtomicMode(), and llvm::MachineFunction::getDenormalMode().

◆ getEntryBlock() [1/2]

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

Definition at line 719 of file Function.h.

◆ getEntryBlock() [2/2]

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

◆ getEntryCount()

ProfileCount Function::getEntryCount ( bool  AllowSynthetic = false) const

Get the entry count for this function.

Entry count is the number of times the function was executed. When AllowSynthetic is false, only pgo_data will be returned.

Definition at line 1910 of file Function.cpp.

References llvm::Function::ProfileCount::getInvalid(), llvm::Value::getMetadata(), llvm::MDNode::getOperand(), llvm::ConstantInt::getValue(), llvm::APInt::getZExtValue(), PCT_Real, and PCT_Synthetic.

Referenced by llvm::InlineFunction(), and setEntryCount().

◆ getFnAttribute() [1/2]

Attribute Function::getFnAttribute ( Attribute::AttrKind  Kind) const

◆ getFnAttribute() [2/2]

Attribute Function::getFnAttribute ( StringRef  Kind) const

Return the attribute for the given attribute kind.

Definition at line 656 of file Function.cpp.

References llvm::AttributeList::getFnAttr().

◆ getFnStackAlign()

MaybeAlign llvm::Function::getFnStackAlign ( ) const
inline

Return the stack alignment for the function.

Definition at line 430 of file Function.h.

References llvm::AttributeList::getFnStackAlignment().

◆ getFunction()

const Function& llvm::Function::getFunction ( ) const
inline

Definition at line 137 of file Function.h.

Referenced by llvm::OpenMPIRBuilder::finalize().

◆ getFunctionType()

FunctionType* llvm::Function::getFunctionType ( ) const
inline

◆ getGC()

const std::string & Function::getGC ( ) const

◆ getImportGUIDs()

DenseSet< GlobalValue::GUID > Function::getImportGUIDs ( ) const

Returns the set of GUIDs that needs to be imported to the function for sample PGO, to enable the same inlines as the profiled optimized binary.

Definition at line 1932 of file Function.cpp.

References llvm::Value::getMetadata(), and i.

Referenced by setEntryCount().

◆ getInstructionCount()

unsigned Function::getInstructionCount ( ) const

Returns the number of non-debug IR instructions in this function.

This is equivalent to the sum of the sizes of each basic block contained within this function.

Definition at line 325 of file Function.cpp.

References BB.

◆ getIntrinsicID()

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 207 of file Function.h.

Referenced by addIntrinsicToSummary(), llvm::findDevirtualizableCallsForTypeCheckedLoad(), llvm::findDevirtualizableCallsForTypeTest(), FindPreallocatedCall(), llvm::IntrinsicInst::getIntrinsicID(), handleBrSelExpect(), handlePhiDef(), handleSwitchExpect(), hasOnlyColdCalls(), isConstrainedFPIntrinsic(), lowerExpectIntrinsic(), optimizeDoubleFP(), and replaceWithCallToVeclib().

◆ getParamAlign()

MaybeAlign llvm::Function::getParamAlign ( unsigned  ArgNo) const
inline

◆ getParamAlignment()

uint64_t llvm::Function::getParamAlignment ( unsigned  ArgNo) const
inline

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

FIXME: Remove this function once transition to Align is over. Use getParamAlign() instead.

Definition at line 448 of file Function.h.

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

◆ getParamAttribute()

Attribute Function::getParamAttribute ( unsigned  ArgNo,
Attribute::AttrKind  Kind 
) const

gets the specified attribute from the list of attributes.

Definition at line 661 of file Function.cpp.

References llvm::AttributeList::getParamAttr().

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

◆ getParamByRefType()

Type* llvm::Function::getParamByRefType ( unsigned  ArgNo) const
inline

Extract the byref type for a parameter.

Definition at line 478 of file Function.h.

References llvm::AttributeList::getParamByRefType().

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

◆ getParamByValType()

Type* llvm::Function::getParamByValType ( unsigned  ArgNo) const
inline

Extract the byval type for a parameter.

Definition at line 463 of file Function.h.

References llvm::AttributeList::getParamByValType().

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

◆ getParamDereferenceableBytes()

uint64_t llvm::Function::getParamDereferenceableBytes ( unsigned  ArgNo) const
inline

Extract the number of dereferenceable bytes for a parameter.

Parameters
ArgNoIndex of an argument, with 0 being the first function arg.

Definition at line 489 of file Function.h.

References llvm::AttributeList::getParamDereferenceableBytes().

Referenced by llvm::Argument::getDereferenceableBytes(), and getFrameLayout().

◆ getParamDereferenceableOrNullBytes()

uint64_t llvm::Function::getParamDereferenceableOrNullBytes ( unsigned  ArgNo) const
inline

Extract the number of dereferenceable_or_null bytes for a parameter.

Parameters
ArgNoAttributeList ArgNo, referring to an argument.

Definition at line 496 of file Function.h.

References llvm::AttributeList::getParamDereferenceableOrNullBytes().

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

◆ getParamInAllocaType()

Type* llvm::Function::getParamInAllocaType ( unsigned  ArgNo) const
inline

Extract the inalloca type for a parameter.

Definition at line 473 of file Function.h.

References llvm::AttributeList::getParamInAllocaType().

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

◆ getParamPreallocatedType()

Type* llvm::Function::getParamPreallocatedType ( unsigned  ArgNo) const
inline

Extract the preallocated type for a parameter.

Definition at line 483 of file Function.h.

References llvm::AttributeList::getParamPreallocatedType().

◆ getParamStackAlign()

MaybeAlign llvm::Function::getParamStackAlign ( unsigned  ArgNo) const
inline

◆ getParamStructRetType()

Type* llvm::Function::getParamStructRetType ( unsigned  ArgNo) const
inline

Extract the sret type for a parameter.

Definition at line 468 of file Function.h.

References llvm::AttributeList::getParamStructRetType().

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

◆ getPersonalityFn()

Constant * Function::getPersonalityFn ( ) const

◆ getPrefixData()

Constant * Function::getPrefixData ( ) const

Get the prefix data associated with this function.

Definition at line 1833 of file Function.cpp.

References assert(), llvm::User::getNumOperands(), and hasPrefixData().

◆ getPrologueData()

Constant * Function::getPrologueData ( ) const

Get the prologue data associated with this function.

Definition at line 1843 of file Function.cpp.

References assert(), llvm::User::getNumOperands(), and hasPrologueData().

◆ getReturnType()

Type* llvm::Function::getReturnType ( ) const
inline

◆ getSectionPrefix()

Optional< StringRef > Function::getSectionPrefix ( ) const

Get the section prefix for this function.

Definition at line 1950 of file Function.cpp.

References assert(), llvm::Value::getMetadata(), and llvm::None.

◆ getSublistAccess()

static BasicBlockListType Function::* llvm::Function::getSublistAccess ( BasicBlock )
inlinestatic

Definition at line 714 of file Function.h.

◆ getSubprogram()

DISubprogram * Function::getSubprogram ( ) const

◆ getValueSymbolTable() [1/2]

ValueSymbolTable* llvm::Function::getValueSymbolTable ( )
inline

getSymbolTable() - Return the symbol table if any, otherwise nullptr.

Definition at line 726 of file Function.h.

Referenced by parseIRValue().

◆ getValueSymbolTable() [2/2]

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

Definition at line 727 of file Function.h.

◆ hasAddressTaken()

bool Function::hasAddressTaken ( const User **  PutOffender = nullptr,
bool  IgnoreCallbackUses = false,
bool  IgnoreAssumeLikeCalls = true,
bool  IgnoreLLVMUsed = false,
bool  IgnoreARCAttachedCall = false 
) 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, ignores callback uses, assume like pointer annotation calls, references in llvm.used and llvm.compiler.used variables, and operand bundle "clang.arc.attachedcall".

Optionally ignores callback uses, assume like pointer annotation calls, and references in llvm.used and llvm.compiler.used variables.

Definition at line 1738 of file Function.cpp.

References llvm::all_of(), llvm::Value::hasOneUse(), llvm::AbstractCallSite::isCallbackCall(), llvm::LLVMContext::OB_clang_arc_attachedcall, llvm::Value::user_begin(), llvm::Value::user_empty(), llvm::Value::users(), and llvm::Value::uses().

Referenced by hasOnlyColdCalls().

◆ hasFnAttribute() [1/2]

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

Return true if the function has the attribute.

Definition at line 626 of file Function.cpp.

References llvm::AttributeList::hasFnAttr().

Referenced by llvm::AArch64FunctionInfo::AArch64FunctionInfo(), llvm::SystemZXPLINKFrameLowering::assignCalleeSavedSpillSlots(), llvm::AVRMachineFunctionInfo::AVRMachineFunctionInfo(), llvm::CodeViewDebug::beginFunctionImpl(), llvm::AArch64TargetLowering::canMergeStoresTo(), llvm::X86TargetLowering::canMergeStoresTo(), llvm::TargetRegisterInfo::canRealignStack(), canTransformToMemCmp(), checkNumAlignedDPRCS2Regs(), computeCalleeSaveRegisterPairs(), llvm::RISCVFrameLowering::determineCalleeSaves(), llvm::TargetFrameLowering::determineCalleeSaves(), llvm::PPCFrameLowering::determineFrameLayout(), llvm::PPCRegisterInfo::eliminateFrameIndex(), llvm::PPCTargetLowering::emitEHSjLjSetJmp(), llvm::MipsSEFrameLowering::emitEpilogue(), llvm::MipsAsmPrinter::emitFunctionBodyStart(), llvm::MipsSEFrameLowering::emitPrologue(), llvm::SystemZELFFrameLowering::emitPrologue(), emitSCSEpilogue(), emitSCSPrologue(), llvm::ARMFrameLowering::enableCalleeSaveSkip(), llvm::TargetFrameLowering::enableCalleeSaveSkip(), llvm::X86FrameLowering::enableShrinkWrapping(), fixupLineNumbers(), llvm::RISCVRegisterInfo::getCalleeSavedRegs(), llvm::X86RegisterInfo::getCalleeSavedRegs(), llvm::AArch64RegisterInfo::getCallPreservedMask(), llvm::AArch64FrameLowering::getFrameIndexReference(), llvm::VNCoercion::getLoadLoadClobberFullWidthSize(), llvm::Attributor::getOrCreateAAFor(), llvm::SystemZELFFrameLowering::getRegSpillOffset(), llvm::MipsRegisterInfo::getReservedRegs(), llvm::AArch64RegisterInfo::getReservedRegs(), llvm::SystemZTargetLowering::getStackProbeSize(), llvm::PPCTargetLowering::getStackProbeSize(), llvm::X86TargetLowering::getStackProbeSize(), llvm::X86TargetLowering::getStackProbeSymbolName(), llvm::X86FrameLowering::has128ByteRedZone(), llvm::HexagonFrameLowering::hasFP(), llvm::SystemZTargetLowering::hasInlineStackProbe(), llvm::PPCTargetLowering::hasInlineStackProbe(), llvm::X86TargetLowering::hasInlineStackProbe(), hasReturnsTwiceAttr(), hasStackProtectorFnAttr(), llvm::SystemZELFFrameLowering::inlineStackProbe(), isNoReturnDef(), EnumAttr::isSet(), maybeEndlessLoop(), llvm::PPCFrameLowering::needsFP(), nullPointerIsDefined(), performBRCONDCombine(), llvm::SystemZELFFrameLowering::processFunctionBeforeFrameFinalized(), llvm::X86TargetLowering::ReplaceNodeResults(), llvm::PPCFrameLowering::restoreCalleeSavedRegisters(), llvm::MachineFunction::shouldSplitStack(), llvm::PPCFrameLowering::spillCalleeSavedRegisters(), llvm::AArch64TargetLowering::supportSplitCSR(), llvm::SystemZELFFrameLowering::usePackedStack(), llvm::RISCVMachineFunctionInfo::useSaveRestoreLibCalls(), llvm::InstCombinerImpl::visitCallInst(), llvm::InstCombinerImpl::visitSExt(), llvm::InstCombinerImpl::visitTrunc(), and llvm::InstCombinerImpl::visitZExt().

◆ hasFnAttribute() [2/2]

bool Function::hasFnAttribute ( StringRef  Kind) const

Return true if the function has the attribute.

Definition at line 630 of file Function.cpp.

References llvm::AttributeList::hasFnAttr().

◆ hasGC()

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

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

Definition at line 319 of file Function.h.

Referenced by clearGC(), llvm::FunctionComparator::compareSignature(), getGC(), llvm::InlineFunction(), and llvm::SelectionDAGISel::runOnMachineFunction().

◆ hasLazyArguments()

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

hasLazyArguments/CheckLazyArguments - The argument list of a function is built on demand, so that the list isn't allocated until the first client needs it.

The hasLazyArguments predicate returns true if the arg list hasn't been set up yet.

Definition at line 108 of file Function.h.

Referenced by stealArgumentListFrom().

◆ hasMinSize()

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

◆ hasNoSync()

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

Determine if the call can synchroize with other threads.

Definition at line 610 of file Function.h.

◆ hasOptNone()

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

◆ hasOptSize()

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

◆ hasParamAttribute()

bool Function::hasParamAttribute ( unsigned  ArgNo,
Attribute::AttrKind  Kind 
) const

check if an attributes is in the list of attributes.

Definition at line 638 of file Function.cpp.

References llvm::AttributeList::hasParamAttr().

Referenced by llvm::Argument::hasAttribute(), llvm::Argument::hasSwiftErrorAttr(), and llvm::Argument::hasSwiftSelfAttr().

◆ hasPersonalityFn()

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

◆ hasPrefixData()

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

Check whether this function has prefix data.

Definition at line 795 of file Function.h.

Referenced by getPrefixData().

◆ hasProfileData()

bool llvm::Function::hasProfileData ( bool  IncludeSynthetic = false) const
inline

Return true if the function is annotated with profile data.

Presence of entry counts from a profile run implies the function has profile annotations. If IncludeSynthetic is false, only return true when the profile data is real.

Definition at line 303 of file Function.h.

Referenced by llvm::CodeViewDebug::beginFunctionImpl(), llvm::computePeelCount(), llvm::computeUnrollCount(), llvm::ProfileSummaryInfo::isColdCallSite(), llvm::LoopSinkPass::run(), sinkLoopInvariantInstructions(), and worthSinkOrHoistInst().

◆ hasPrologueData()

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

Check whether this function has prologue data.

Definition at line 804 of file Function.h.

Referenced by getPrologueData().

◆ hasRetAttribute()

bool Function::hasRetAttribute ( Attribute::AttrKind  Kind) const

check if an attribute is in the list of attributes for the return value.

Definition at line 634 of file Function.cpp.

References llvm::AttributeList::hasRetAttr().

◆ hasStackProtectorFnAttr()

bool Function::hasStackProtectorFnAttr ( ) const

Returns true if the function has ssp, sspstrong, or sspreq fn attrs.

Definition at line 704 of file Function.cpp.

References hasFnAttribute().

◆ hasStructRetAttr()

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

Determine if the function returns a structure through first or second pointer argument.

Definition at line 653 of file Function.h.

References llvm::AttributeList::hasParamAttr().

Referenced by llvm::Mangler::getNameWithPrefix(), llvm::HexagonTargetLowering::LowerCall(), llvm::SparcTargetLowering::LowerFormalArguments_32(), and llvm::SparcTargetLowering::LowerReturn_32().

◆ hasUWTable()

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 639 of file Function.h.

◆ isConstrainedFPIntrinsic()

bool Function::isConstrainedFPIntrinsic ( ) const

Returns true if the function is one of the "Constrained Floating-Point Intrinsics".

Returns false if not, and returns false when getIntrinsicID() returns Intrinsic::not_intrinsic.

Definition at line 444 of file Function.cpp.

References getIntrinsicID().

◆ isConvergent()

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

Determine if the call is convergent.

Definition at line 583 of file Function.h.

References llvm::MCID::Convergent.

◆ isDebugInfoForProfiling()

bool Function::isDebugInfoForProfiling ( ) const

Returns true if we should emit debug info for profiling.

Definition at line 1545 of file Metadata.cpp.

References getSubprogram().

Referenced by llvm::UnrollAndJamLoop(), and llvm::UnrollLoop().

◆ isDefTriviallyDead()

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 1798 of file Function.cpp.

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

◆ isIntrinsic()

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

isIntrinsic - Returns true if the function's name starts with "llvm.".

It's possible for this function to return true while getIntrinsicID() returns Intrinsic::not_intrinsic!

Definition at line 212 of file Function.h.

Referenced by llvm::CloneAndPruneIntoFromInst(), llvm::TargetLibraryInfoImpl::getLibFunc(), llvm::InlineFunction(), and optimizeDoubleFP().

◆ isMaterializable()

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

Definition at line 192 of file Function.h.

◆ isPresplitCoroutine()

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

A function will have the "coroutine.presplit" attribute if it's a coroutine and has not gone through full CoroSplit pass.

Definition at line 502 of file Function.h.

◆ isSpeculatable()

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

Determine if the call has sideeffects.

Definition at line 594 of file Function.h.

◆ isTargetIntrinsic() [1/2]

bool Function::isTargetIntrinsic ( ) const

isTargetIntrinsic - Returns true if this function is an intrinsic and the intrinsic is specific to a certain target.

If this is not an intrinsic or a generic intrinsic, false is returned.

Definition at line 745 of file Function.cpp.

References llvm::GlobalValue::IntID.

Referenced by llvm::BasicTTIImplBase< AMDGPUTTIImpl >::getIntrinsicInstrCost().

◆ isTargetIntrinsic() [2/2]

bool Function::isTargetIntrinsic ( Intrinsic::ID  IID)
static

isTargetIntrinsic - Returns true if IID is an intrinsic specific to a certain target.

If it is a generic intrinsic false is returned.

Definition at line 741 of file Function.cpp.

Referenced by llvm::InstCombiner::targetInstCombineIntrinsic(), llvm::InstCombiner::targetSimplifyDemandedUseBitsIntrinsic(), and llvm::InstCombiner::targetSimplifyDemandedVectorEltsIntrinsic().

◆ isVarArg()

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

◆ lookupIntrinsicID()

Intrinsic::ID Function::lookupIntrinsicID ( StringRef  Name)
static

This does the actual lookup of an intrinsic ID which matches the given function name.

Definition at line 770 of file Function.cpp.

References assert(), llvm::ArrayRef< T >::data(), findTargetSubtable(), IntrinsicNameTable, llvm::Intrinsic::isOverloaded(), llvm::Intrinsic::lookupLLVMIntrinsicByName(), and llvm::Intrinsic::not_intrinsic.

Referenced by LLVMLookupIntrinsicID(), and recalculateIntrinsicID().

◆ mustProgress()

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

Determine if the function is required to make forward progress.

Definition at line 627 of file Function.h.

Referenced by isLoopDead(), and llvm::isMustProgress().

◆ needsUnwindTableEntry()

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

◆ nullPointerIsDefined()

bool Function::nullPointerIsDefined ( ) const

Check if null pointer dereferencing is considered undefined behavior for the function.

Return value: false => null pointer dereference is undefined. Return value: true => null pointer dereference is not undefined.

Definition at line 1961 of file Function.cpp.

References hasFnAttribute().

◆ onlyAccessesArgMemory()

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

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

Definition at line 532 of file Function.h.

◆ onlyAccessesInaccessibleMemOrArgMem()

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

Determine if the function may only access memory that is either inaccessible from the IR or pointed to by its arguments.

Definition at line 548 of file Function.h.

◆ onlyAccessesInaccessibleMemory()

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

Determine if the function may only access memory that is inaccessible from the IR.

Definition at line 539 of file Function.h.

◆ onlyReadsMemory()

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

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

Definition at line 515 of file Function.h.

Referenced by HandleByValArgument().

◆ operator=()

void llvm::Function::operator= ( const Function )
delete

◆ print()

void Function::print ( raw_ostream OS,
AssemblyAnnotationWriter AAW = nullptr,
bool  ShouldPreserveUseListOrder = false,
bool  IsForDebug = false 
) const

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

Definition at line 4462 of file AsmWriter.cpp.

References llvm::GlobalValue::getParent(), and llvm::RISCVFenceField::W.

Referenced by llvm::StackLifetime::print().

◆ recalculateIntrinsicID()

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 790 of file Function.cpp.

References llvm::Value::getName(), llvm::GlobalValue::HasLLVMReservedName, llvm::GlobalValue::IntID, lookupIntrinsicID(), and llvm::Intrinsic::not_intrinsic.

◆ removeAttributeAtIndex() [1/2]

void Function::removeAttributeAtIndex ( unsigned  i,
Attribute::AttrKind  Kind 
)

removes the attribute from the list of attributes.

Definition at line 576 of file Function.cpp.

References getContext(), i, and llvm::AttributeList::removeAttributeAtIndex().

Referenced by addIfNotExistent(), and StripAttr().

◆ removeAttributeAtIndex() [2/2]

void Function::removeAttributeAtIndex ( unsigned  i,
StringRef  Kind 
)

removes the attribute from the list of attributes.

Definition at line 580 of file Function.cpp.

References getContext(), i, and llvm::AttributeList::removeAttributeAtIndex().

◆ removeFnAttr() [1/2]

void Function::removeFnAttr ( Attribute::AttrKind  Kind)

Remove function attributes from this function.

Definition at line 584 of file Function.cpp.

References getContext(), and llvm::AttributeList::removeFnAttribute().

Referenced by EnumAttr::set().

◆ removeFnAttr() [2/2]

void Function::removeFnAttr ( StringRef  Kind)

Remove function attribute from this function.

Definition at line 588 of file Function.cpp.

References getContext(), and llvm::AttributeList::removeFnAttribute().

◆ removeFnAttrs()

void Function::removeFnAttrs ( const AttrBuilder Attrs)

Definition at line 592 of file Function.cpp.

References Attrs, getContext(), and llvm::AttributeList::removeFnAttributes().

◆ removeFromParent()

void Function::removeFromParent ( )

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

Definition at line 361 of file Function.cpp.

References llvm::Module::getFunctionList(), llvm::ilist_node_impl< ilist_detail::compute_node_options< Function, Options... >::type >::getIterator(), and llvm::GlobalValue::getParent().

Referenced by llvm::OpenMPIRBuilder::finalize().

◆ removeParamAttr() [1/2]

void Function::removeParamAttr ( unsigned  ArgNo,
Attribute::AttrKind  Kind 
)

removes the attribute from the list of attributes.

Definition at line 608 of file Function.cpp.

References getContext(), and llvm::AttributeList::removeParamAttribute().

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

◆ removeParamAttr() [2/2]

void Function::removeParamAttr ( unsigned  ArgNo,
StringRef  Kind 
)

removes the attribute from the list of attributes.

Definition at line 612 of file Function.cpp.

References getContext(), and llvm::AttributeList::removeParamAttribute().

◆ removeParamAttrs()

void Function::removeParamAttrs ( unsigned  ArgNo,
const AttrBuilder Attrs 
)

removes the attribute from the list of attributes.

Definition at line 616 of file Function.cpp.

References Attrs, getContext(), and llvm::AttributeList::removeParamAttributes().

◆ removeParamUndefImplyingAttrs()

void llvm::Function::removeParamUndefImplyingAttrs ( unsigned  ArgNo)

removes noundef and other attributes that imply undefined behavior if a undef or poison value is passed from the list of attributes.

◆ removeRetAttr() [1/2]

void Function::removeRetAttr ( Attribute::AttrKind  Kind)

removes the attribute from the return value list of attributes.

Definition at line 596 of file Function.cpp.

References getContext(), and llvm::AttributeList::removeRetAttribute().

◆ removeRetAttr() [2/2]

void Function::removeRetAttr ( StringRef  Kind)

removes the attribute from the return value list of attributes.

Definition at line 600 of file Function.cpp.

References getContext(), and llvm::AttributeList::removeRetAttribute().

◆ removeRetAttrs()

void Function::removeRetAttrs ( const AttrBuilder Attrs)

removes the attributes from the return value list of attributes.

Definition at line 604 of file Function.cpp.

References Attrs, getContext(), and llvm::AttributeList::removeRetAttributes().

◆ returnDoesNotAlias()

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

Determine if the parameter or return value is marked with NoAlias attribute.

Definition at line 660 of file Function.h.

References llvm::AttributeList::hasRetAttr().

◆ setAttributes()

void llvm::Function::setAttributes ( AttributeList  Attrs)
inline

◆ setCallingConv()

void llvm::Function::setCallingConv ( CallingConv::ID  CC)
inline

◆ setCannotDuplicate()

void llvm::Function::setCannotDuplicate ( )
inline

Definition at line 578 of file Function.h.

◆ setConvergent()

void llvm::Function::setConvergent ( )
inline

Definition at line 586 of file Function.h.

References llvm::MCID::Convergent.

◆ setDoesNotAccessMemory()

void llvm::Function::setDoesNotAccessMemory ( )
inline

Definition at line 510 of file Function.h.

◆ setDoesNotFreeMemory()

void llvm::Function::setDoesNotFreeMemory ( )
inline

Definition at line 605 of file Function.h.

◆ setDoesNotReadMemory()

void llvm::Function::setDoesNotReadMemory ( )
inline

Definition at line 526 of file Function.h.

◆ setDoesNotRecurse()

void llvm::Function::setDoesNotRecurse ( )
inline

Definition at line 622 of file Function.h.

◆ setDoesNotReturn()

void llvm::Function::setDoesNotReturn ( )
inline

Definition at line 559 of file Function.h.

◆ setDoesNotThrow()

void llvm::Function::setDoesNotThrow ( )
inline

Definition at line 570 of file Function.h.

◆ setEntryCount() [1/2]

void Function::setEntryCount ( ProfileCount  Count,
const DenseSet< GlobalValue::GUID > *  Imports = nullptr 
)

Set the entry count for this function.

Entry count is the number of times this function was executed based on pgo data. Imports points to a set of GUIDs that needs to be imported by the function for sample PGO, to enable the same inlines as the profiled optimized binary.

Definition at line 1887 of file Function.cpp.

References assert(), llvm::MDBuilder::createFunctionEntryCount(), getContext(), llvm::Function::ProfileCount::getCount(), getEntryCount(), getImportGUIDs(), llvm::Function::ProfileCount::getType(), llvm::Function::ProfileCount::hasValue(), llvm::Function::ProfileCount::isSynthetic(), S, and llvm::Value::setMetadata().

Referenced by setEntryCount().

◆ setEntryCount() [2/2]

void Function::setEntryCount ( uint64_t  Count,
Function::ProfileCountType  Type = PCT_Real,
const DenseSet< GlobalValue::GUID > *  Imports = nullptr 
)

A convenience wrapper for setting entry count.

Definition at line 1905 of file Function.cpp.

References setEntryCount().

◆ setGC()

void Function::setGC ( std::string  Str)

Definition at line 692 of file Function.cpp.

References getContext(), move, and llvm::LLVMContext::setGC().

Referenced by copyAttributesFrom().

◆ setHasUWTable()

void llvm::Function::setHasUWTable ( )
inline

Definition at line 642 of file Function.h.

◆ setIsMaterializable()

void llvm::Function::setIsMaterializable ( bool  V)
inline

Definition at line 195 of file Function.h.

References llvm::BitmaskEnumDetail::Mask().

Referenced by dropAllReferences().

◆ setMustProgress()

void llvm::Function::setMustProgress ( )
inline

Definition at line 631 of file Function.h.

◆ setNoSync()

void llvm::Function::setNoSync ( )
inline

Definition at line 613 of file Function.h.

◆ setNotConvergent()

void llvm::Function::setNotConvergent ( )
inline

Definition at line 589 of file Function.h.

References llvm::MCID::Convergent.

◆ setOnlyAccessesArgMemory()

void llvm::Function::setOnlyAccessesArgMemory ( )
inline

Definition at line 535 of file Function.h.

◆ setOnlyAccessesInaccessibleMemOrArgMem()

void llvm::Function::setOnlyAccessesInaccessibleMemOrArgMem ( )
inline

Definition at line 551 of file Function.h.

◆ setOnlyAccessesInaccessibleMemory()

void llvm::Function::setOnlyAccessesInaccessibleMemory ( )
inline

Definition at line 542 of file Function.h.

◆ setOnlyReadsMemory()

void llvm::Function::setOnlyReadsMemory ( )
inline

Definition at line 518 of file Function.h.

◆ setPersonalityFn()

void Function::setPersonalityFn ( Constant Fn)

Definition at line 1828 of file Function.cpp.

Referenced by llvm::CloneFunctionInto(), and copyAttributesFrom().

◆ setPrefixData()

void Function::setPrefixData ( Constant PrefixData)

Definition at line 1838 of file Function.cpp.

Referenced by copyAttributesFrom().

◆ setPrologueData()

void Function::setPrologueData ( Constant PrologueData)

Definition at line 1848 of file Function.cpp.

Referenced by copyAttributesFrom().

◆ setReturnDoesNotAlias()

void llvm::Function::setReturnDoesNotAlias ( )
inline

Definition at line 663 of file Function.h.

◆ setSectionPrefix()

void Function::setSectionPrefix ( StringRef  Prefix)

Set the section prefix for this function.

Definition at line 1944 of file Function.cpp.

References llvm::MDBuilder::createFunctionSectionPrefix(), getContext(), llvm::cl::Prefix, and llvm::Value::setMetadata().

◆ setSpeculatable()

void llvm::Function::setSpeculatable ( )
inline

Definition at line 597 of file Function.h.

◆ setSubprogram()

void Function::setSubprogram ( DISubprogram SP)

Set the attached subprogram.

Calls setMetadata() with LLVMContext::MD_dbg.

Definition at line 1537 of file Metadata.cpp.

References llvm::Value::setMetadata().

Referenced by fixupDebugInfoPostExtraction().

◆ setWillReturn()

void llvm::Function::setWillReturn ( )
inline

Definition at line 635 of file Function.h.

◆ size()

size_t llvm::Function::size ( ) const
inline

◆ stealArgumentListFrom()

void Function::stealArgumentListFrom ( Function Src)

Steal arguments from another function.

Drop this function's arguments and splice in the ones from Src. Requires that this has no function body.

Definition at line 465 of file Function.cpp.

References llvm::all_of(), arg_size(), assert(), llvm::Value::getSubclassDataFromValue(), hasLazyArguments(), llvm::GlobalValue::isDeclaration(), and makeArgArray().

◆ viewCFG() [1/2]

void 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.

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

Definition at line 263 of file CFGPrinter.cpp.

Referenced by viewCFGOnly().

◆ viewCFG() [2/2]

void Function::viewCFG ( bool  ViewCFGOnly,
const BlockFrequencyInfo BFI,
const BranchProbabilityInfo BPI 
) const

Extended form to print edge weights.

Definition at line 265 of file CFGPrinter.cpp.

References llvm::AMDGPUISD::BFI, CFGFuncName, contains(), llvm::getMaxFreq(), llvm::Value::getName(), and llvm::ViewGraph().

◆ viewCFGOnly() [1/2]

void 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.

Definition at line 278 of file CFGPrinter.cpp.

◆ viewCFGOnly() [2/2]

void Function::viewCFGOnly ( const BlockFrequencyInfo BFI,
const BranchProbabilityInfo BPI 
) const

Extended form to print edge weights.

Definition at line 280 of file CFGPrinter.cpp.

References llvm::AMDGPUISD::BFI, and viewCFG().

◆ willReturn()

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

Determine if the function will return.

Definition at line 634 of file Function.h.

Friends And Related Function Documentation

◆ SymbolTableListTraits< Function >

friend class SymbolTableListTraits< Function >
friend

Definition at line 101 of file Function.h.


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