llvm::sandboxir::CallBase Class Reference

#include "llvm/SandboxIR/SandboxIR.h"

Inheritance diagram for llvm::sandboxir::CallBase:

Public Member Functions
FunctionType *	getFunctionType () const
op_iterator	data_operands_begin ()
const_op_iterator	data_operands_begin () const
op_iterator	data_operands_end ()
const_op_iterator	data_operands_end () const
iterator_range< op_iterator >	data_ops ()
iterator_range< const_op_iterator >	data_ops () const
bool	data_operands_empty () const
unsigned	data_operands_size () const
bool	isDataOperand (Use U) const
unsigned	getDataOperandNo (Use U) const
unsigned	getNumTotalBundleOperands () const
	Return the total number operands (not operand bundles) used by every operand bundle in this OperandBundleUser.
op_iterator	arg_begin ()
const_op_iterator	arg_begin () const
op_iterator	arg_end ()
const_op_iterator	arg_end () const
iterator_range< op_iterator >	args ()
iterator_range< const_op_iterator >	args () const
bool	arg_empty () const
unsigned	arg_size () const
Value *	getArgOperand (unsigned OpIdx) const
void	setArgOperand (unsigned OpIdx, Value *NewOp)
Use	getArgOperandUse (unsigned Idx) const
Use	getArgOperandUse (unsigned Idx)
bool	isArgOperand (Use U) const
unsigned	getArgOperandNo (Use U) const
bool	hasArgument (const Value *V) const
Value *	getCalledOperand () const
Use	getCalledOperandUse () const
Function *	getCalledFunction () const
bool	isIndirectCall () const
bool	isCallee (Use U) const
Function *	getCaller ()
const Function *	getCaller () const
bool	isMustTailCall () const
bool	isTailCall () const
Intrinsic::ID	getIntrinsicID () const
void	setCalledOperand (Value *V)
void	setCalledFunction (Function *F)
CallingConv::ID	getCallingConv () const
bool	isInlineAsm () const
Public Member Functions inherited from llvm::sandboxir::SingleLLVMInstructionImpl< llvm::CallBase >
unsigned	getUseOperandNo (const Use &Use) const final
	\Returns the operand index of Use.
unsigned	getNumOfIRInstrs () const final
	This is used by BasicBlock::iterator.
void	verify () const final
	Should crash if there is something wrong with the instruction.
void	dumpOS (raw_ostream &OS) const override
Public Member Functions inherited from llvm::sandboxir::Instruction
virtual unsigned	getNumOfIRInstrs () const =0
	This is used by BasicBlock::iterator.
BBIterator	getIterator () const
	\Returns a BasicBlock::iterator for this Instruction.
Instruction *	getNextNode () const
	\Returns the next sandboxir::Instruction in the block, or nullptr if at the end of the block.
Instruction *	getPrevNode () const
	\Returns the previous sandboxir::Instruction in the block, or nullptr if at the beginning of the block.
Opcode	getOpcode () const
	\Returns this Instruction's opcode.
void	removeFromParent ()
	Detach this from its parent BasicBlock without deleting it.
void	eraseFromParent ()
	Detach this Value from its parent and delete it.
void	insertBefore (Instruction *BeforeI)
	Insert this detached instruction before BeforeI.
void	insertAfter (Instruction *AfterI)
	Insert this detached instruction after AfterI.
void	insertInto (BasicBlock *BB, const BBIterator &WhereIt)
	Insert this detached instruction into BB at WhereIt.
void	moveBefore (BasicBlock &BB, const BBIterator &WhereIt)
	Move this instruction to WhereIt.
void	moveBefore (Instruction *Before)
	Move this instruction before Before.
void	moveAfter (Instruction *After)
	Move this instruction after After.
BasicBlock *	getParent () const
	\Returns the BasicBlock containing this Instruction, or null if it is detached.
void	dumpOS (raw_ostream &OS) const override
Public Member Functions inherited from llvm::sandboxir::User
virtual op_iterator	op_begin ()
virtual op_iterator	op_end ()
virtual const_op_iterator	op_begin () const
virtual const_op_iterator	op_end () const
op_range	operands ()
const_op_range	operands () const
Value *	getOperand (unsigned OpIdx) const
Use	getOperandUse (unsigned OpIdx) const
	\Returns the operand edge for OpIdx.
virtual unsigned	getNumOperands () const
virtual void	setOperand (unsigned OperandIdx, Value *Operand)
bool	replaceUsesOfWith (Value *FromV, Value *ToV)
	Replaces any operands that match FromV with ToV.
void	verify () const override
	Should crash if there is something wrong with the instruction.
void	dumpCommonHeader (raw_ostream &OS) const final
void	dumpOS (raw_ostream &OS) const override
Public Member Functions inherited from llvm::sandboxir::Value
virtual	~Value ()=default
ClassID	getSubclassID () const
use_iterator	use_begin ()
const_use_iterator	use_begin () const
use_iterator	use_end ()
const_use_iterator	use_end () const
iterator_range< use_iterator >	uses ()
iterator_range< const_use_iterator >	uses () const
user_iterator	user_begin ()
user_iterator	user_end ()
const_user_iterator	user_begin () const
const_user_iterator	user_end () const
iterator_range< user_iterator >	users ()
iterator_range< const_user_iterator >	users () const
unsigned	getNumUses () const
	\Returns the number of user edges (not necessarily to unique users).
bool	hasNUsesOrMore (unsigned Num) const
	Return true if this value has N uses or more.
bool	hasNUses (unsigned Num) const
	Return true if this Value has exactly N uses.
Type *	getType () const
Context &	getContext () const
void	replaceUsesWithIf (Value *OtherV, llvm::function_ref< bool(const Use &)> ShouldReplace)
void	replaceAllUsesWith (Value *Other)
StringRef	getName () const
	\Returns the LLVM IR name of the bottom-most LLVM value.
virtual void	verify () const =0
	Should crash if there is something wrong with the instruction.
std::string	getUid () const
	Returns the unique id in the form 'SB<number>.' like 'SB1.'.
virtual void	dumpCommonHeader (raw_ostream &OS) const
void	dumpCommonFooter (raw_ostream &OS) const
void	dumpCommonPrefix (raw_ostream &OS) const
void	dumpCommonSuffix (raw_ostream &OS) const
void	printAsOperandCommon (raw_ostream &OS) const
virtual void	dumpOS (raw_ostream &OS) const =0
LLVM_DUMP_METHOD void	dump () const

Static Public Member Functions
static bool	classof (const Value *From)
Static Public Member Functions inherited from llvm::sandboxir::Instruction
static const char *	getOpcodeName (Opcode Opc)
static bool	classof (const sandboxir::Value *From)
	For isa/dyn_cast.
Static Public Member Functions inherited from llvm::sandboxir::User
static bool	classof (const Value *From)
	For isa/dyn_cast.

Friends
class	CallInst
class	InvokeInst
class	CallBrInst

Additional Inherited Members
Public Types inherited from llvm::sandboxir::Instruction
enum class	Opcode { OP , OPCODES , DEF_INSTR }
Public Types inherited from llvm::sandboxir::User
using	op_iterator = OperandUseIterator
using	const_op_iterator = OperandUseIterator
using	op_range = iterator_range< op_iterator >
using	const_op_range = iterator_range< const_op_iterator >
Public Types inherited from llvm::sandboxir::Value
enum class	ClassID : unsigned { DEF_VALUE , DEF_USER , DEF_INSTR }
using	use_iterator = UserUseIterator
using	const_use_iterator = UserUseIterator
using	user_iterator = mapped_iterator< sandboxir::UserUseIterator, UseToUser >
using	const_user_iterator = user_iterator
Protected Member Functions inherited from llvm::sandboxir::Instruction
	Instruction (ClassID ID, Opcode Opc, llvm::Instruction *I, sandboxir::Context &SBCtx)
llvm::Instruction *	getTopmostLLVMInstruction () const
	A SandboxIR Instruction may map to multiple LLVM IR Instruction.
virtual SmallVector< llvm::Instruction *, 1 >	getLLVMInstrs () const =0
	\Returns the LLVM IR Instructions that this SandboxIR maps to in program order.
Protected Member Functions inherited from llvm::sandboxir::User
	User (ClassID ID, llvm::Value *V, Context &Ctx)
Use	getOperandUseDefault (unsigned OpIdx, bool Verify) const
	\Returns the Use edge that corresponds to OpIdx.
virtual Use	getOperandUseInternal (unsigned OpIdx, bool Verify) const =0
	\Returns the Use for the OpIdx'th operand.
unsigned	getUseOperandNoDefault (const Use &Use) const
	The default implementation works only for single-LLVMIR-instruction Users and only if they match exactly the LLVM instruction.
virtual unsigned	getUseOperandNo (const Use &Use) const =0
	\Returns the operand index of Use.
void	swapOperandsInternal (unsigned OpIdxA, unsigned OpIdxB)
void	verifyUserOfLLVMUse (const llvm::Use &Use) const
Protected Member Functions inherited from llvm::sandboxir::Value
void	clearValue ()
	Value (ClassID SubclassID, llvm::Value *Val, Context &Ctx)
	Value (const Value &)=delete
	Disable copies.
Value &	operator= (const Value &)=delete
Static Protected Member Functions inherited from llvm::sandboxir::Value
static const char *	getSubclassIDStr (ClassID ID)
Protected Attributes inherited from llvm::sandboxir::Instruction
Opcode	Opc
Protected Attributes inherited from llvm::sandboxir::Value
ClassID	SubclassID
	For isa/dyn_cast.
unsigned	UID
	A unique ID used for forming the name (used for debugging).
llvm::Value *	Val = nullptr
	The LLVM Value that corresponds to this SandboxIR Value.
Context &	Ctx
	All values point to the context.

Detailed Description

Definition at line 1006 of file SandboxIR.h.

Member Function Documentation

arg_begin() [1/2]

op_iterator llvm::sandboxir::CallBase::arg_begin ( )

inline

Definition at line 1067 of file SandboxIR.h.

References llvm::sandboxir::User::op_begin().

Referenced by arg_empty(), arg_size(), and args().

arg_begin() [2/2]

const_op_iterator llvm::sandboxir::CallBase::arg_begin ( ) const

inline

Definition at line 1068 of file SandboxIR.h.

References llvm::sandboxir::User::op_begin().

arg_empty()

bool llvm::sandboxir::CallBase::arg_empty ( ) const

inline

Definition at line 1081 of file SandboxIR.h.

References arg_begin(), and arg_end().

arg_end() [1/2]

op_iterator llvm::sandboxir::CallBase::arg_end ( )

inline

Definition at line 1069 of file SandboxIR.h.

References data_operands_end(), and getNumTotalBundleOperands().

Referenced by arg_empty(), arg_end(), arg_size(), and args().

arg_end() [2/2]

const_op_iterator llvm::sandboxir::CallBase::arg_end ( ) const

inline

Definition at line 1072 of file SandboxIR.h.

References arg_end().

arg_size()

unsigned llvm::sandboxir::CallBase::arg_size ( ) const

inline

Definition at line 1082 of file SandboxIR.h.

References arg_begin(), and arg_end().

Referenced by getArgOperand(), getArgOperandUse(), and setArgOperand().

args() [1/2]

iterator_range< op_iterator > llvm::sandboxir::CallBase::args ( )

inline

Definition at line 1075 of file SandboxIR.h.

References arg_begin(), arg_end(), and llvm::make_range().

Referenced by hasArgument().

args() [2/2]

iterator_range< const_op_iterator > llvm::sandboxir::CallBase::args ( ) const

inline

Definition at line 1078 of file SandboxIR.h.

References arg_begin(), arg_end(), and llvm::make_range().

classof()

static bool llvm::sandboxir::CallBase::classof ( const Value *  From )

inlinestatic

Definition at line 1014 of file SandboxIR.h.

References From, and llvm::sandboxir::Instruction::Opc.

data_operands_begin() [1/2]

op_iterator llvm::sandboxir::CallBase::data_operands_begin ( )

inline

Definition at line 1025 of file SandboxIR.h.

References llvm::sandboxir::User::op_begin().

Referenced by data_operands_begin(), data_operands_empty(), data_operands_size(), and data_ops().

data_operands_begin() [2/2]

const_op_iterator llvm::sandboxir::CallBase::data_operands_begin ( ) const

inline

Definition at line 1026 of file SandboxIR.h.

References data_operands_begin().

data_operands_empty()

bool llvm::sandboxir::CallBase::data_operands_empty ( ) const

inline

Definition at line 1045 of file SandboxIR.h.

References data_operands_begin(), and data_operands_end().

data_operands_end() [1/2]

op_iterator llvm::sandboxir::CallBase::data_operands_end ( )

inline

Definition at line 1029 of file SandboxIR.h.

References llvm::sandboxir::User::op_begin(), and llvm::sandboxir::Value::Val.

Referenced by arg_end(), data_operands_empty(), data_operands_size(), and data_ops().

data_operands_end() [2/2]

const_op_iterator llvm::sandboxir::CallBase::data_operands_end ( ) const

inline

Definition at line 1034 of file SandboxIR.h.

References llvm::sandboxir::User::op_begin(), and llvm::sandboxir::Value::Val.

data_operands_size()

unsigned llvm::sandboxir::CallBase::data_operands_size ( ) const

inline

Definition at line 1048 of file SandboxIR.h.

References data_operands_begin(), and data_operands_end().

data_ops() [1/2]

iterator_range< op_iterator > llvm::sandboxir::CallBase::data_ops ( )

inline

Definition at line 1039 of file SandboxIR.h.

References data_operands_begin(), data_operands_end(), and llvm::make_range().

data_ops() [2/2]

iterator_range< const_op_iterator > llvm::sandboxir::CallBase::data_ops ( ) const

inline

Definition at line 1042 of file SandboxIR.h.

References data_operands_begin(), data_operands_end(), and llvm::make_range().

getArgOperand()

Value * llvm::sandboxir::CallBase::getArgOperand ( unsigned  OpIdx ) const

inline

Definition at line 1084 of file SandboxIR.h.

References arg_size(), assert(), and llvm::sandboxir::User::getOperand().

getArgOperandNo()

unsigned llvm::sandboxir::CallBase::getArgOperandNo ( Use  U ) const

inline

Definition at line 1105 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

getArgOperandUse() [1/2]

Use llvm::sandboxir::CallBase::getArgOperandUse ( unsigned  Idx )

inline

Definition at line 1097 of file SandboxIR.h.

References arg_size(), assert(), llvm::sandboxir::User::getOperandUse(), and Idx.

getArgOperandUse() [2/2]

Use llvm::sandboxir::CallBase::getArgOperandUse ( unsigned  Idx ) const

inline

Definition at line 1093 of file SandboxIR.h.

References arg_size(), assert(), llvm::sandboxir::User::getOperandUse(), and Idx.

getCalledFunction()

Function * CallBase::getCalledFunction

(

)

const

Definition at line 746 of file SandboxIR.cpp.

References llvm::sandboxir::Value::Ctx, llvm::sandboxir::Context::getValue(), and llvm::sandboxir::Value::Val.

getCalledOperand()

Value * CallBase::getCalledOperand

(

)

const

Definition at line 737 of file SandboxIR.cpp.

References llvm::sandboxir::Value::Ctx, getCalledOperand(), llvm::sandboxir::Context::getValue(), and llvm::sandboxir::Value::Val.

Referenced by getCalledOperand().

getCalledOperandUse()

Use CallBase::getCalledOperandUse

(

)

const

Definition at line 741 of file SandboxIR.cpp.

References llvm::sandboxir::Value::Ctx, llvm::sandboxir::Context::getValue(), and llvm::sandboxir::Value::Val.

Referenced by setCalledOperand().

getCaller() [1/2]

Function * CallBase::getCaller

(

)

Definition at line 750 of file SandboxIR.cpp.

References llvm::sandboxir::Value::Ctx, llvm::sandboxir::Context::getValue(), and llvm::sandboxir::Value::Val.

Referenced by getCaller().

getCaller() [2/2]

const Function * llvm::sandboxir::CallBase::getCaller ( ) const

inline

Definition at line 1121 of file SandboxIR.h.

References getCaller().

getCallingConv()

CallingConv::ID llvm::sandboxir::CallBase::getCallingConv ( ) const

inline

Definition at line 1133 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

getDataOperandNo()

unsigned llvm::sandboxir::CallBase::getDataOperandNo ( Use  U ) const

inline

Definition at line 1056 of file SandboxIR.h.

References assert(), isDataOperand(), and llvm::sandboxir::Value::Val.

getFunctionType()

FunctionType * llvm::sandboxir::CallBase::getFunctionType ( ) const

inline

Definition at line 1021 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

getIntrinsicID()

Intrinsic::ID llvm::sandboxir::CallBase::getIntrinsicID ( ) const

inline

Definition at line 1128 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

getNumTotalBundleOperands()

unsigned llvm::sandboxir::CallBase::getNumTotalBundleOperands ( ) const

inline

Return the total number operands (not operand bundles) used by every operand bundle in this OperandBundleUser.

Definition at line 1063 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

Referenced by arg_end().

hasArgument()

bool llvm::sandboxir::CallBase::hasArgument ( const Value *  V ) const

inline

Definition at line 1108 of file SandboxIR.h.

References args(), and llvm::is_contained().

isArgOperand()

bool llvm::sandboxir::CallBase::isArgOperand ( Use  U ) const

inline

Definition at line 1102 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

isCallee()

bool llvm::sandboxir::CallBase::isCallee ( Use  U ) const

inline

Definition at line 1117 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

isDataOperand()

bool llvm::sandboxir::CallBase::isDataOperand ( Use  U ) const

inline

Definition at line 1051 of file SandboxIR.h.

References assert(), and llvm::sandboxir::Value::Val.

Referenced by getDataOperandNo().

isIndirectCall()

bool llvm::sandboxir::CallBase::isIndirectCall ( ) const

inline

Definition at line 1114 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

isInlineAsm()

bool llvm::sandboxir::CallBase::isInlineAsm ( ) const

inline

Definition at line 1136 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

isMustTailCall()

bool llvm::sandboxir::CallBase::isMustTailCall ( ) const

inline

Definition at line 1124 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

isTailCall()

bool llvm::sandboxir::CallBase::isTailCall ( ) const

inline

Definition at line 1127 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

setArgOperand()

void llvm::sandboxir::CallBase::setArgOperand ( unsigned  OpIdx, Value *  NewOp  )

inline

Definition at line 1088 of file SandboxIR.h.

References arg_size(), assert(), and llvm::sandboxir::User::setOperand().

setCalledFunction()

void CallBase::setCalledFunction

(

Function *

F

)

Definition at line 754 of file SandboxIR.cpp.

References F, setCalledOperand(), and llvm::sandboxir::Value::Val.

setCalledOperand()

void llvm::sandboxir::CallBase::setCalledOperand ( Value *  V )

inline

Definition at line 1131 of file SandboxIR.h.

References getCalledOperandUse(), and llvm::sandboxir::Use::set().

Referenced by setCalledFunction().

Friends And Related Function Documentation

CallBrInst

friend class CallBrInst

friend

Definition at line 1011 of file SandboxIR.h.

CallInst

friend class CallInst

friend

Definition at line 1009 of file SandboxIR.h.

InvokeInst

friend class InvokeInst

friend

Definition at line 1010 of file SandboxIR.h.

---

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

• include/llvm/SandboxIR/SandboxIR.h
• lib/SandboxIR/SandboxIR.cpp