#include "llvm/SandboxIR/SandboxIR.h"

Inheritance diagram for llvm::sandboxir::GetElementPtrInst:

[legend]

Public Member Functions
Type *	getSourceElementType () const

Type *	getResultElementType () const

unsigned	getAddressSpace () const

op_iterator	idx_begin ()

const_op_iterator	idx_begin () const

op_iterator	idx_end ()

const_op_iterator	idx_end () const

iterator_range< op_iterator >	indices ()

iterator_range< const_op_iterator >	indices () const

Value *	getPointerOperand () const

Type *	getPointerOperandType () const

unsigned	getPointerAddressSpace () const

unsigned	getNumIndices () const

bool	hasIndices () const

bool	hasAllConstantIndices () const

GEPNoWrapFlags	getNoWrapFlags () const

bool	isInBounds () const

bool	hasNoUnsignedSignedWrap () const

bool	hasNoUnsignedWrap () const

bool	accumulateConstantOffset (const DataLayout &DL, APInt &Offset) const

Public Member Functions inherited from llvm::sandboxir::SingleLLVMInstructionImpl< llvm::GetElementPtrInst >
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 Value *	create (Type Ty, Value Ptr, ArrayRef< Value * > IdxList, BBIterator WhereIt, BasicBlock *WhereBB, Context &Ctx, const Twine &NameStr="")

static Value *	create (Type Ty, Value Ptr, ArrayRef< Value * > IdxList, Instruction *InsertBefore, Context &Ctx, const Twine &NameStr="")

static Value *	create (Type Ty, Value Ptr, ArrayRef< Value * > IdxList, BasicBlock *InsertAtEnd, Context &Ctx, const Twine &NameStr="")

static bool	classof (const Value *From)

static unsigned	getPointerOperandIndex ()

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

Member Function Documentation

◆ accumulateConstantOffset()

bool llvm::sandboxir::GetElementPtrInst::accumulateConstantOffset	(	const DataLayout &	DL,
		APInt &	Offset
	)		const

inline

Definition at line 1336 of file SandboxIR.h.

References DL, llvm::Offset, and llvm::sandboxir::Value::Val.

◆ classof()

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

inlinestatic

Definition at line 1276 of file SandboxIR.h.

References From.

◆ create() [1/3]

Value * GetElementPtrInst::create	(	Type *	Ty,
		Value *	Ptr,
		ArrayRef< Value * >	IdxList,
		BasicBlock *	InsertAtEnd,
		Context &	Ctx,
		const Twine &	NameStr = `""`
	)

static

Definition at line 976 of file SandboxIR.cpp.

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

◆ create() [2/3]

static Value * llvm::sandboxir::GetElementPtrInst::create	(	Type *	Ty,
		Value *	Ptr,
		ArrayRef< Value * >	IdxList,
		BBIterator	WhereIt,
		BasicBlock *	WhereBB,
		Context &	Ctx,
		const Twine &	NameStr = `""`
	)

static

Referenced by create().

◆ create() [3/3]

Value * GetElementPtrInst::create	(	Type *	Ty,
		Value *	Ptr,
		ArrayRef< Value * >	IdxList,
		Instruction *	InsertBefore,
		Context &	Ctx,
		const Twine &	NameStr = `""`
	)

static

Definition at line 967 of file SandboxIR.cpp.

References create(), llvm::sandboxir::Value::Ctx, llvm::sandboxir::Instruction::getIterator(), llvm::sandboxir::Instruction::getParent(), and Ptr.

◆ getAddressSpace()

unsigned llvm::sandboxir::GetElementPtrInst::getAddressSpace ( ) const

inline

Definition at line 1286 of file SandboxIR.h.

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

◆ getNoWrapFlags()

GEPNoWrapFlags llvm::sandboxir::GetElementPtrInst::getNoWrapFlags ( ) const

inline

Definition at line 1324 of file SandboxIR.h.

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

◆ getNumIndices()

unsigned llvm::sandboxir::GetElementPtrInst::getNumIndices ( ) const

inline

Definition at line 1315 of file SandboxIR.h.

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

◆ getPointerAddressSpace()

unsigned llvm::sandboxir::GetElementPtrInst::getPointerAddressSpace ( ) const

inline

Definition at line 1312 of file SandboxIR.h.

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

◆ getPointerOperand()

Value * GetElementPtrInst::getPointerOperand ( ) const

Definition at line 984 of file SandboxIR.cpp.

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

Referenced by getPointerOperand().

◆ getPointerOperandIndex()

static unsigned llvm::sandboxir::GetElementPtrInst::getPointerOperandIndex ( )

inlinestatic

Definition at line 1306 of file SandboxIR.h.

References llvm::GetElementPtrInst::getPointerOperandIndex().

◆ getPointerOperandType()

Type * llvm::sandboxir::GetElementPtrInst::getPointerOperandType ( ) const

inline

Definition at line 1309 of file SandboxIR.h.

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

◆ getResultElementType()

Type * llvm::sandboxir::GetElementPtrInst::getResultElementType ( ) const

inline

Definition at line 1283 of file SandboxIR.h.

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

◆ getSourceElementType()

Type * llvm::sandboxir::GetElementPtrInst::getSourceElementType ( ) const

inline

Definition at line 1280 of file SandboxIR.h.

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

◆ hasAllConstantIndices()

bool llvm::sandboxir::GetElementPtrInst::hasAllConstantIndices ( ) const

inline

Definition at line 1321 of file SandboxIR.h.

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

◆ hasIndices()

bool llvm::sandboxir::GetElementPtrInst::hasIndices ( ) const

inline

Definition at line 1318 of file SandboxIR.h.

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

◆ hasNoUnsignedSignedWrap()

bool llvm::sandboxir::GetElementPtrInst::hasNoUnsignedSignedWrap ( ) const

inline

Definition at line 1330 of file SandboxIR.h.

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

◆ hasNoUnsignedWrap()

bool llvm::sandboxir::GetElementPtrInst::hasNoUnsignedWrap ( ) const

inline

Definition at line 1333 of file SandboxIR.h.

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

◆ idx_begin() [1/2]

op_iterator llvm::sandboxir::GetElementPtrInst::idx_begin ( )

inline

Definition at line 1290 of file SandboxIR.h.

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

Referenced by idx_begin(), and indices().

◆ idx_begin() [2/2]

const_op_iterator llvm::sandboxir::GetElementPtrInst::idx_begin ( ) const

inline

Definition at line 1291 of file SandboxIR.h.

References idx_begin().

◆ idx_end() [1/2]

op_iterator llvm::sandboxir::GetElementPtrInst::idx_end ( )

inline

Definition at line 1294 of file SandboxIR.h.

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

Referenced by idx_end(), and indices().

◆ idx_end() [2/2]

const_op_iterator llvm::sandboxir::GetElementPtrInst::idx_end ( ) const

inline

Definition at line 1295 of file SandboxIR.h.

References idx_end().

◆ indices() [1/2]

iterator_range< op_iterator > llvm::sandboxir::GetElementPtrInst::indices ( )

inline

Definition at line 1298 of file SandboxIR.h.

References idx_begin(), idx_end(), and llvm::make_range().

Referenced by indices().

◆ indices() [2/2]

iterator_range< const_op_iterator > llvm::sandboxir::GetElementPtrInst::indices ( ) const

inline

Definition at line 1301 of file SandboxIR.h.

References indices().

◆ isInBounds()

bool llvm::sandboxir::GetElementPtrInst::isInBounds ( ) const

inline

Definition at line 1327 of file SandboxIR.h.

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

Friends And Related Function Documentation

◆ Context

friend class Context

friend

Definition at line 1262 of file SandboxIR.h.

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

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

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ accumulateConstantOffset()

◆ classof()

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ getAddressSpace()

◆ getNoWrapFlags()

◆ getNumIndices()

◆ getPointerAddressSpace()

◆ getPointerOperand()

◆ getPointerOperandIndex()

◆ getPointerOperandType()

◆ getResultElementType()

◆ getSourceElementType()

◆ hasAllConstantIndices()

◆ hasIndices()

◆ hasNoUnsignedSignedWrap()

◆ hasNoUnsignedWrap()

◆ idx_begin() [1/2]

◆ idx_begin() [2/2]

◆ idx_end() [1/2]

◆ idx_end() [2/2]

◆ indices() [1/2]

◆ indices() [2/2]

◆ isInBounds()

Friends And Related Function Documentation

◆ Context