A sandboxir::User with operands and opcode. More...

#include "llvm/SandboxIR/SandboxIR.h"

Inheritance diagram for llvm::sandboxir::Instruction:

[legend]

Public Types
enum class	Opcode { DEF_VALUE , DEF_USER , OP , 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

Public Member Functions
virtual unsigned	getNumOfIRInstrs () const =0
	This is used by BasicBlock::iterator.

void	dump (raw_ostream &OS) const override

LLVM_DUMP_METHOD void	dump () 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	dump (raw_ostream &OS) const override

LLVM_DUMP_METHOD void	dump () 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)

virtual void	verify () const =0
	Should crash if there is something wrong with the instruction.

std::string	getName () const
	Returns the name 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	dump (raw_ostream &OS) const =0

virtual LLVM_DUMP_METHOD void	dump () const =0

Static Public Member Functions
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.

Protected Member Functions
	Instruction (ClassID ID, Opcode Opc, llvm::Instruction *I, sandboxir::Context &SBCtx)

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

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	verifyUserOfLLVMUse (const llvm::Use &Use) const

Protected Member Functions inherited from llvm::sandboxir::Value
void	clearValue ()

	Value (ClassID SubclassID, llvm::Value *Val, Context &Ctx)

Protected Attributes
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.

Friends
raw_ostream &	operator<< (raw_ostream &OS, Opcode Opc)

raw_ostream &	operator<< (raw_ostream &OS, const sandboxir::Instruction &SBI)

Additional Inherited Members
Static Protected Member Functions inherited from llvm::sandboxir::Value
static const char *	getSubclassIDStr (ClassID ID)

Detailed Description

A sandboxir::User with operands and opcode.

Definition at line 494 of file SandboxIR.h.

Member Enumeration Documentation

◆ Opcode

enum class llvm::sandboxir::Instruction::Opcode

strong

Enumerator
DEF_VALUE
DEF_USER
OP
DEF_INSTR

Definition at line 496 of file SandboxIR.h.

Constructor & Destructor Documentation

◆ Instruction()

llvm::sandboxir::Instruction::Instruction	(	ClassID	ID,
		Opcode	Opc,
		llvm::Instruction *	I,
		sandboxir::Context &	SBCtx
	)

inlineprotected

Definition at line 505 of file SandboxIR.h.

Member Function Documentation

◆ classof()

bool Instruction::classof ( const sandboxir::Value * From )

static

For isa/dyn_cast.

Definition at line 265 of file SandboxIR.cpp.

References From.

◆ dump() [1/2]

void Instruction::dump ( ) const

overridevirtual

Reimplemented from llvm::sandboxir::User.

Reimplemented in llvm::sandboxir::OpaqueInst.

Definition at line 280 of file SandboxIR.cpp.

References llvm::dbgs(), and dump().

Referenced by dump().

◆ dump() [2/2]

void Instruction::dump ( raw_ostream & OS ) const

overridevirtual

Reimplemented from llvm::sandboxir::User.

Reimplemented in llvm::sandboxir::OpaqueInst.

Definition at line 277 of file SandboxIR.cpp.

References OS.

◆ getNumOfIRInstrs()

virtual unsigned llvm::sandboxir::Instruction::getNumOfIRInstrs ( ) const

pure virtual

This is used by BasicBlock::iterator.

Implemented in llvm::sandboxir::OpaqueInst.

Referenced by llvm::sandboxir::BBIterator::operator++(), and llvm::sandboxir::BBIterator::operator--().

◆ getOpcodeName()

const char * Instruction::getOpcodeName ( Opcode Opc )

static

Definition at line 252 of file SandboxIR.cpp.

References llvm_unreachable, and Opc.

Friends And Related Function Documentation

◆ operator<< [1/2]

raw_ostream & operator<<	(	raw_ostream &	OS,
		const sandboxir::Instruction &	SBI
	)

friend

Definition at line 525 of file SandboxIR.h.

◆ operator<< [2/2]

raw_ostream & operator<<	(	raw_ostream &	OS,
		Opcode	Opc
	)

friend

Definition at line 514 of file SandboxIR.h.

Member Data Documentation

◆ Opc

Opcode llvm::sandboxir::Instruction::Opc

protected

Definition at line 509 of file SandboxIR.h.

Referenced by getOpcodeName().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members