#include "llvm/SandboxIR/SandboxIR.h"

Inheritance diagram for llvm::sandboxir::InvokeInst:

[legend]

Public Member Functions
BasicBlock *	getNormalDest () const

BasicBlock *	getUnwindDest () const

void	setNormalDest (BasicBlock *BB)

void	setUnwindDest (BasicBlock *BB)

Instruction *	getLandingPadInst () const

BasicBlock *	getSuccessor (unsigned SuccIdx) const

void	setSuccessor (unsigned SuccIdx, BasicBlock *NewSucc)

unsigned	getNumSuccessors () const

Public Member Functions inherited from llvm::sandboxir::CallBase
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 InvokeInst *	create (FunctionType FTy, Value Func, BasicBlock IfNormal, BasicBlock IfException, ArrayRef< Value * > Args, BBIterator WhereIt, BasicBlock *WhereBB, Context &Ctx, const Twine &NameStr="")

static InvokeInst *	create (FunctionType FTy, Value Func, BasicBlock IfNormal, BasicBlock IfException, ArrayRef< Value * > Args, Instruction *InsertBefore, Context &Ctx, const Twine &NameStr="")

static InvokeInst *	create (FunctionType FTy, Value Func, BasicBlock IfNormal, BasicBlock IfException, ArrayRef< Value * > Args, BasicBlock *InsertAtEnd, Context &Ctx, const Twine &NameStr="")

static bool	classof (const Value *From)

Static Public Member Functions inherited from llvm::sandboxir::CallBase
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	Context

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 1164 of file SandboxIR.h.

Member Function Documentation

◆ classof()

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

inlinestatic

Definition at line 1187 of file SandboxIR.h.

References From.

◆ create() [1/3]

InvokeInst * InvokeInst::create	(	FunctionType *	FTy,
		Value *	Func,
		BasicBlock *	IfNormal,
		BasicBlock *	IfException,
		ArrayRef< Value * >	Args,
		BasicBlock *	InsertAtEnd,
		Context &	Ctx,
		const Twine &	NameStr = `""`
	)

static

Definition at line 827 of file SandboxIR.cpp.

References create(), llvm::sandboxir::Value::Ctx, and llvm::sandboxir::BasicBlock::end().

◆ create() [2/3]

InvokeInst * InvokeInst::create	(	FunctionType *	FTy,
		Value *	Func,
		BasicBlock *	IfNormal,
		BasicBlock *	IfException,
		ArrayRef< Value * >	Args,
		BBIterator	WhereIt,
		BasicBlock *	WhereBB,
		Context &	Ctx,
		const Twine &	NameStr = `""`
	)

static

Definition at line 797 of file SandboxIR.cpp.

References llvm::IRBuilderBase::CreateInvoke(), llvm::sandboxir::Context::createInvokeInst(), llvm::sandboxir::Value::Ctx, llvm::sandboxir::BasicBlock::end(), llvm::sandboxir::Context::getLLVMIRBuilder(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::SmallVectorImpl< T >::reserve(), llvm::IRBuilderBase::SetInsertPoint(), and llvm::sandboxir::Value::Val.

Referenced by create().

◆ create() [3/3]

InvokeInst * InvokeInst::create	(	FunctionType *	FTy,
		Value *	Func,
		BasicBlock *	IfNormal,
		BasicBlock *	IfException,
		ArrayRef< Value * >	Args,
		Instruction *	InsertBefore,
		Context &	Ctx,
		const Twine &	NameStr = `""`
	)