llvm::ShuffleVectorInst Class Reference

This instruction constructs a fixed permutation of two input vectors. More...

#include "llvm/IR/Instructions.h"

Inheritance diagram for llvm::ShuffleVectorInst:

Public Member Functions
LLVM_ABI	ShuffleVectorInst (Value *V1, Value *Mask, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
LLVM_ABI	ShuffleVectorInst (Value *V1, ArrayRef< int > Mask, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
LLVM_ABI	ShuffleVectorInst (Value *V1, Value *V2, Value *Mask, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
LLVM_ABI	ShuffleVectorInst (Value *V1, Value *V2, ArrayRef< int > Mask, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
void *	operator new (size_t S)
void	operator delete (void *Ptr)
LLVM_ABI void	commute ()
	Swap the operands and adjust the mask to preserve the semantics of the instruction.
VectorType *	getType () const
	Overload to return most specific vector type.
	DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value)
	Transparently provide more efficient getOperand methods.
int	getMaskValue (unsigned Elt) const
	Return the shuffle mask value of this instruction for the given element index.
void	getShuffleMask (SmallVectorImpl< int > &Result) const
	Return the mask for this instruction as a vector of integers.
Constant *	getShuffleMaskForBitcode () const
	Return the mask for this instruction, for use in bitcode.
LLVM_ABI void	setShuffleMask (ArrayRef< int > Mask)
ArrayRef< int >	getShuffleMask () const
bool	changesLength () const
	Return true if this shuffle returns a vector with a different number of elements than its source vectors.
bool	increasesLength () const
	Return true if this shuffle returns a vector with a greater number of elements than its source vectors.
bool	isSingleSource () const
	Return true if this shuffle chooses elements from exactly one source vector without changing the length of that vector.
bool	isIdentity () const
	Return true if this shuffle chooses elements from exactly one source vector without lane crossings and does not change the number of elements from its input vectors.
LLVM_ABI bool	isIdentityWithPadding () const
	Return true if this shuffle lengthens exactly one source vector with undefs in the high elements.
LLVM_ABI bool	isIdentityWithExtract () const
	Return true if this shuffle extracts the first N elements of exactly one source vector.
LLVM_ABI bool	isConcat () const
	Return true if this shuffle concatenates its 2 source vectors.
bool	isSelect () const
	Return true if this shuffle chooses elements from its source vectors without lane crossings and all operands have the same number of elements.
bool	isReverse () const
	Return true if this shuffle swaps the order of elements from exactly one source vector.
bool	isZeroEltSplat () const
	Return true if all elements of this shuffle are the same value as the first element of exactly one source vector without changing the length of that vector.
bool	isTranspose () const
	Return true if this shuffle transposes the elements of its inputs without changing the length of the vectors.
bool	isSplice (int &Index) const
	Return true if this shuffle splices two inputs without changing the length of the vectors.
bool	isExtractSubvectorMask (int &Index) const
	Return true if this shuffle mask is an extract subvector mask.
bool	isInsertSubvectorMask (int &NumSubElts, int &Index) const
	Return true if this shuffle mask is an insert subvector mask.
LLVM_ABI bool	isReplicationMask (int &ReplicationFactor, int &VF) const
	Return true if this shuffle mask is a replication mask.
LLVM_ABI bool	isOneUseSingleSourceMask (int VF) const
	Return true if this shuffle mask is a one-use-single-source("clustered") mask.
LLVM_ABI bool	isInterleave (unsigned Factor)
	Return if this shuffle interleaves its two input vectors together.
Public Member Functions inherited from llvm::Instruction
LLVM_ABI iterator_range< simple_ilist< DbgRecord >::iterator >	cloneDebugInfoFrom (const Instruction *From, std::optional< simple_ilist< DbgRecord >::iterator > FromHere=std::nullopt, bool InsertAtHead=false)
	Clone any debug-info attached to From onto this instruction.
iterator_range< simple_ilist< DbgRecord >::iterator >	getDbgRecordRange () const
	Return a range over the DbgRecords attached to this instruction.
LLVM_ABI std::optional< simple_ilist< DbgRecord >::iterator >	getDbgReinsertionPosition ()
	Return an iterator to the position of the "Next" DbgRecord after this instruction, or std::nullopt.
LLVM_ABI bool	hasDbgRecords () const
	Returns true if any DbgRecords are attached to this instruction.
LLVM_ABI void	adoptDbgRecords (BasicBlock *BB, InstListType::iterator It, bool InsertAtHead)
	Transfer any DbgRecords on the position It onto this instruction, by simply adopting the sequence of DbgRecords (which is efficient) if possible, by merging two sequences otherwise.
LLVM_ABI void	dropDbgRecords ()
	Erase any DbgRecords attached to this instruction.
LLVM_ABI void	dropOneDbgRecord (DbgRecord *I)
	Erase a single DbgRecord I that is attached to this instruction.
LLVM_ABI void	handleMarkerRemoval ()
	Handle the debug-info implications of this instruction being removed.
	Instruction (const Instruction &)=delete
Instruction &	operator= (const Instruction &)=delete
Instruction *	user_back ()
	Specialize the methods defined in Value, as we know that an instruction can only be used by other instructions.
const Instruction *	user_back () const
LLVM_ABI const Module *	getModule () const
	Return the module owning the function this instruction belongs to or nullptr it the function does not have a module.
Module *	getModule ()
LLVM_ABI const Function *	getFunction () const
	Return the function this instruction belongs to.
Function *	getFunction ()
LLVM_ABI const DataLayout &	getDataLayout () const
	Get the data layout of the module this instruction belongs to.
LLVM_ABI void	removeFromParent ()
	This method unlinks 'this' from the containing basic block, but does not delete it.
LLVM_ABI InstListType::iterator	eraseFromParent ()
	This method unlinks 'this' from the containing basic block and deletes it.
LLVM_ABI	LLVM_DEPRECATED ("Use iterators as instruction positions", "") void insertBefore(Instruction *InsertPos)
	Insert an unlinked instruction into a basic block immediately before the specified instruction.
LLVM_ABI void	insertBefore (InstListType::iterator InsertPos)
	Insert an unlinked instruction into a basic block immediately before the specified position.
LLVM_ABI void	insertAfter (Instruction *InsertPos)
	Insert an unlinked instruction into a basic block immediately after the specified instruction.
LLVM_ABI void	insertAfter (InstListType::iterator InsertPos)
	Insert an unlinked instruction into a basic block immediately after the specified position.
LLVM_ABI InstListType::iterator	insertInto (BasicBlock *ParentBB, InstListType::iterator It)
	Inserts an unlinked instruction into ParentBB at position It and returns the iterator of the inserted instruction.
LLVM_ABI void	insertBefore (BasicBlock &BB, InstListType::iterator InsertPos)
LLVM_ABI	LLVM_DEPRECATED ("Use iterators as instruction positions", "") void moveBefore(Instruction *MovePos)
	Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right before MovePos.
LLVM_ABI void	moveBefore (InstListType::iterator InsertPos)
	Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right before MovePos.
LLVM_ABI void	moveBeforePreserving (InstListType::iterator MovePos)
	Perform a moveBefore operation, while signalling that the caller intends to preserve the original ordering of instructions.
LLVM_ABI void	moveBeforePreserving (BasicBlock &BB, InstListType::iterator I)
	Perform a moveBefore operation, while signalling that the caller intends to preserve the original ordering of instructions.
LLVM_ABI	LLVM_DEPRECATED ("Use iterators as instruction positions", "") void moveBeforePreserving(Instruction *MovePos)
	Perform a moveBefore operation, while signalling that the caller intends to preserve the original ordering of instructions.
LLVM_ABI void	moveBefore (BasicBlock &BB, InstListType::iterator I)
	Unlink this instruction and insert into BB before I.
LLVM_ABI void	moveAfter (Instruction *MovePos)
	Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right after MovePos.
LLVM_ABI void	moveAfter (InstListType::iterator MovePos)
	Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right after MovePos.
LLVM_ABI void	moveAfterPreserving (Instruction *MovePos)
	See moveBeforePreserving .
LLVM_ABI bool	comesBefore (const Instruction *Other) const
	Given an instruction Other in the same basic block as this instruction, return true if this instruction comes before Other.
LLVM_ABI std::optional< InstListType::iterator >	getInsertionPointAfterDef ()
	Get the first insertion point at which the result of this instruction is defined.
unsigned	getOpcode () const
	Returns a member of one of the enums like Instruction::Add.
const char *	getOpcodeName () const
bool	isTerminator () const
bool	isUnaryOp () const
bool	isBinaryOp () const
bool	isIntDivRem () const
bool	isFPDivRem () const
bool	isShift () const
bool	isCast () const
bool	isFuncletPad () const
bool	isSpecialTerminator () const
LLVM_ABI bool	isOnlyUserOfAnyOperand ()
	It checks if this instruction is the only user of at least one of its operands.
bool	isLogicalShift () const
	Return true if this is a logical shift left or a logical shift right.
bool	isArithmeticShift () const
	Return true if this is an arithmetic shift right.
bool	isBitwiseLogicOp () const
	Return true if this is and/or/xor.
bool	hasMetadata () const
	Return true if this instruction has any metadata attached to it.
LLVM_ABI bool	hasNonDebugLocLoopMetadata () const
bool	hasMetadataOtherThanDebugLoc () const
	Return true if this instruction has metadata attached to it other than a debug location.
bool	hasMetadata (unsigned KindID) const
	Return true if this instruction has the given type of metadata attached.
bool	hasMetadata (StringRef Kind) const
	Return true if this instruction has the given type of metadata attached.
MDNode *	getMetadata (unsigned KindID) const
	Get the metadata of given kind attached to this Instruction.
MDNode *	getMetadata (StringRef Kind) const
	Get the metadata of given kind attached to this Instruction.
void	getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
	Get all metadata attached to this Instruction.
void	getAllMetadataOtherThanDebugLoc (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
	This does the same thing as getAllMetadata, except that it filters out the debug location.
LLVM_ABI void	setMetadata (unsigned KindID, MDNode *Node)
	Set the metadata of the specified kind to the specified node.
LLVM_ABI void	setMetadata (StringRef Kind, MDNode *Node)
LLVM_ABI void	copyMetadata (const Instruction &SrcInst, ArrayRef< unsigned > WL=ArrayRef< unsigned >())
	Copy metadata from SrcInst to this instruction.
LLVM_ABI void	eraseMetadataIf (function_ref< bool(unsigned, MDNode *)> Pred)
	Erase all metadata that matches the predicate.
LLVM_ABI void	swapProfMetadata ()
	If the instruction has "branch_weights" MD_prof metadata and the MDNode has three operands (including name string), swap the order of the metadata.
LLVM_ABI void	addAnnotationMetadata (StringRef Annotation)
	Adds an !annotation metadata node with Annotation to this instruction.
LLVM_ABI void	addAnnotationMetadata (SmallVector< StringRef > Annotations)
	Adds an !annotation metadata node with an array of Annotations as a tuple to this instruction.
LLVM_ABI AAMDNodes	getAAMetadata () const
	Returns the AA metadata for this instruction.
LLVM_ABI void	setAAMetadata (const AAMDNodes &N)
	Sets the AA metadata on this instruction from the AAMDNodes structure.
LLVM_ABI void	setNoSanitizeMetadata ()
	Sets the nosanitize metadata on this instruction.
LLVM_ABI bool	extractProfTotalWeight (uint64_t &TotalVal) const
	Retrieve total raw weight values of a branch.
void	setDebugLoc (DebugLoc Loc)
	Set the debug location information for this instruction.
const DebugLoc &	getDebugLoc () const
	Return the debug location for this node as a DebugLoc.
LLVM_ABI const DebugLoc &	getStableDebugLoc () const
	Fetch the debug location for this node, unless this is a debug intrinsic, in which case fetch the debug location of the next non-debug node.
LLVM_ABI void	setHasNoUnsignedWrap (bool b=true)
	Set or clear the nuw flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasNoSignedWrap (bool b=true)
	Set or clear the nsw flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setIsExact (bool b=true)
	Set or clear the exact flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setNonNeg (bool b=true)
	Set or clear the nneg flag on this instruction, which must be a zext instruction.
LLVM_ABI bool	hasNoUnsignedWrap () const LLVM_READONLY
	Determine whether the no unsigned wrap flag is set.
LLVM_ABI bool	hasNoSignedWrap () const LLVM_READONLY
	Determine whether the no signed wrap flag is set.
LLVM_ABI bool	hasNonNeg () const LLVM_READONLY
	Determine whether the the nneg flag is set.
LLVM_ABI bool	hasPoisonGeneratingFlags () const LLVM_READONLY
	Return true if this operator has flags which may cause this instruction to evaluate to poison despite having non-poison inputs.
LLVM_ABI void	dropPoisonGeneratingFlags ()
	Drops flags that may cause this instruction to evaluate to poison despite having non-poison inputs.
LLVM_ABI bool	hasPoisonGeneratingMetadata () const LLVM_READONLY
	Return true if this instruction has poison-generating metadata.
LLVM_ABI void	dropPoisonGeneratingMetadata ()
	Drops metadata that may generate poison.
LLVM_ABI bool	hasPoisonGeneratingReturnAttributes () const LLVM_READONLY
	Return true if this instruction has poison-generating attribute.
LLVM_ABI void	dropPoisonGeneratingReturnAttributes ()
	Drops return attributes that may generate poison.
bool	hasPoisonGeneratingAnnotations () const
	Return true if this instruction has poison-generating flags, return attributes or metadata.
void	dropPoisonGeneratingAnnotations ()
	Drops flags, return attributes and metadata that may generate poison.
LLVM_ABI void	dropUBImplyingAttrsAndUnknownMetadata (ArrayRef< unsigned > KnownIDs={})
	This function drops non-debug unknown metadata (through dropUnknownNonDebugMetadata).
LLVM_ABI void	dropUBImplyingAttrsAndMetadata (ArrayRef< unsigned > Keep={})
	Drop any attributes or metadata that can cause immediate undefined behavior.
LLVM_ABI bool	hasUBImplyingAttrs () const LLVM_READONLY
	Return true if this instruction has UB-implying attributes that can cause immediate undefined behavior.
LLVM_ABI bool	isExact () const LLVM_READONLY
	Determine whether the exact flag is set.
LLVM_ABI void	setFast (bool B)
	Set or clear all fast-math-flags on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasAllowReassoc (bool B)
	Set or clear the reassociation flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasNoNaNs (bool B)
	Set or clear the no-nans flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasNoInfs (bool B)
	Set or clear the no-infs flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasNoSignedZeros (bool B)
	Set or clear the no-signed-zeros flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasAllowReciprocal (bool B)
	Set or clear the allow-reciprocal flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasAllowContract (bool B)
	Set or clear the allow-contract flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setHasApproxFunc (bool B)
	Set or clear the approximate-math-functions flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI void	setFastMathFlags (FastMathFlags FMF)
	Convenience function for setting multiple fast-math flags on this instruction, which must be an operator which supports these flags.
LLVM_ABI void	copyFastMathFlags (FastMathFlags FMF)
	Convenience function for transferring all fast-math flag values to this instruction, which must be an operator which supports these flags.
LLVM_ABI bool	isFast () const LLVM_READONLY
	Determine whether all fast-math-flags are set.
LLVM_ABI bool	hasAllowReassoc () const LLVM_READONLY
	Determine whether the allow-reassociation flag is set.
LLVM_ABI bool	hasNoNaNs () const LLVM_READONLY
	Determine whether the no-NaNs flag is set.
LLVM_ABI bool	hasNoInfs () const LLVM_READONLY
	Determine whether the no-infs flag is set.
LLVM_ABI bool	hasNoSignedZeros () const LLVM_READONLY
	Determine whether the no-signed-zeros flag is set.
LLVM_ABI bool	hasAllowReciprocal () const LLVM_READONLY
	Determine whether the allow-reciprocal flag is set.
LLVM_ABI bool	hasAllowContract () const LLVM_READONLY
	Determine whether the allow-contract flag is set.
LLVM_ABI bool	hasApproxFunc () const LLVM_READONLY
	Determine whether the approximate-math-functions flag is set.
LLVM_ABI FastMathFlags	getFastMathFlags () const LLVM_READONLY
	Convenience function for getting all the fast-math flags, which must be an operator which supports these flags.
LLVM_ABI void	copyFastMathFlags (const Instruction *I)
	Copy I's fast-math flags.
LLVM_ABI void	copyIRFlags (const Value *V, bool IncludeWrapFlags=true)
	Convenience method to copy supported exact, fast-math, and (optionally) wrapping flags from V to this instruction.
LLVM_ABI void	andIRFlags (const Value *V)
	Logical 'and' of any supported wrapping, exact, and fast-math flags of V and this instruction.
LLVM_ABI void	applyMergedLocation (DebugLoc LocA, DebugLoc LocB)
	Merge 2 debug locations and apply it to the Instruction.
LLVM_ABI void	updateLocationAfterHoist ()
	Updates the debug location given that the instruction has been hoisted from a block to a predecessor of that block.
LLVM_ABI void	dropLocation ()
	Drop the instruction's debug location.
LLVM_ABI void	mergeDIAssignID (ArrayRef< const Instruction * > SourceInstructions)
	Merge the DIAssignID metadata from this instruction and those attached to instructions in SourceInstructions.
LLVM_ABI bool	isAssociative () const LLVM_READONLY
	Return true if the instruction is associative:
LLVM_ABI bool	isCommutative () const LLVM_READONLY
	Return true if the instruction is commutative:
bool	isIdempotent () const
	Return true if the instruction is idempotent:
bool	isNilpotent () const
	Return true if the instruction is nilpotent:
LLVM_ABI bool	mayWriteToMemory () const LLVM_READONLY
	Return true if this instruction may modify memory.
LLVM_ABI bool	mayReadFromMemory () const LLVM_READONLY
	Return true if this instruction may read memory.
bool	mayReadOrWriteMemory () const
	Return true if this instruction may read or write memory.
LLVM_ABI bool	isAtomic () const LLVM_READONLY
	Return true if this instruction has an AtomicOrdering of unordered or higher.
LLVM_ABI bool	hasAtomicLoad () const LLVM_READONLY
	Return true if this atomic instruction loads from memory.
LLVM_ABI bool	hasAtomicStore () const LLVM_READONLY
	Return true if this atomic instruction stores to memory.
LLVM_ABI bool	isVolatile () const LLVM_READONLY
	Return true if this instruction has a volatile memory access.
LLVM_ABI Type *	getAccessType () const LLVM_READONLY
	Return the type this instruction accesses in memory, if any.
LLVM_ABI bool	mayThrow (bool IncludePhaseOneUnwind=false) const LLVM_READONLY
	Return true if this instruction may throw an exception.
bool	isFenceLike () const
	Return true if this instruction behaves like a memory fence: it can load or store to memory location without being given a memory location.
LLVM_ABI bool	mayHaveSideEffects () const LLVM_READONLY
	Return true if the instruction may have side effects.
LLVM_ABI bool	isSafeToRemove () const LLVM_READONLY
	Return true if the instruction can be removed if the result is unused.
LLVM_ABI bool	willReturn () const LLVM_READONLY
	Return true if the instruction will return (unwinding is considered as a form of returning control flow here).
bool	isEHPad () const
	Return true if the instruction is a variety of EH-block.
LLVM_ABI bool	isLifetimeStartOrEnd () const LLVM_READONLY
	Return true if the instruction is a llvm.lifetime.start or llvm.lifetime.end marker.
LLVM_ABI bool	isLaunderOrStripInvariantGroup () const LLVM_READONLY
	Return true if the instruction is a llvm.launder.invariant.group or llvm.strip.invariant.group.
LLVM_ABI bool	isDebugOrPseudoInst () const LLVM_READONLY
	Return true if the instruction is a DbgInfoIntrinsic or PseudoProbeInst.
LLVM_ABI Instruction *	clone () const
	Create a copy of 'this' instruction that is identical in all ways except the following:
LLVM_ABI bool	isIdenticalTo (const Instruction *I) const LLVM_READONLY
	Return true if the specified instruction is exactly identical to the current one.
LLVM_ABI bool	isIdenticalToWhenDefined (const Instruction *I, bool IntersectAttrs=false) const LLVM_READONLY
	This is like isIdenticalTo, except that it ignores the SubclassOptionalData flags, which may specify conditions under which the instruction's result is undefined.
LLVM_ABI bool	isSameOperationAs (const Instruction *I, unsigned flags=0) const LLVM_READONLY
	This function determines if the specified instruction executes the same operation as the current one.
LLVM_ABI bool	hasSameSpecialState (const Instruction *I2, bool IgnoreAlignment=false, bool IntersectAttrs=false) const LLVM_READONLY
	This function determines if the speficied instruction has the same "special" characteristics as the current one.
LLVM_ABI bool	isUsedOutsideOfBlock (const BasicBlock *BB) const LLVM_READONLY
	Return true if there are any uses of this instruction in blocks other than the specified block.
LLVM_ABI unsigned	getNumSuccessors () const LLVM_READONLY
	Return the number of successors that this instruction has.
LLVM_ABI BasicBlock *	getSuccessor (unsigned Idx) const LLVM_READONLY
	Return the specified successor. This instruction must be a terminator.
LLVM_ABI void	setSuccessor (unsigned Idx, BasicBlock *BB)
	Update the specified successor to point at the provided block.
LLVM_ABI void	replaceSuccessorWith (BasicBlock *OldBB, BasicBlock *NewBB)
	Replace specified successor OldBB to point at the provided block.
LLVM_ABI void	dropUnknownNonDebugMetadata (ArrayRef< unsigned > KnownIDs={})
	Drop all unknown metadata except for debug locations.
Public Member Functions inherited from llvm::User
	User (const User &)=delete
LLVM_ABI void	operator delete (void *Usr)
	Free memory allocated for User and Use objects.
void	operator delete (void *Usr, HungOffOperandsAllocMarker)
	Placement delete - required by std, called if the ctor throws.
void	operator delete (void *Usr, IntrusiveOperandsAllocMarker)
	Placement delete - required by std, called if the ctor throws.
void	operator delete (void *Usr, IntrusiveOperandsAndDescriptorAllocMarker)
	Placement delete - required by std, called if the ctor throws.
const Use *	getOperandList () const
Use *	getOperandList ()
Value *	getOperand (unsigned i) const
void	setOperand (unsigned i, Value *Val)
const Use &	getOperandUse (unsigned i) const
Use &	getOperandUse (unsigned i)
unsigned	getNumOperands () const
LLVM_ABI ArrayRef< const uint8_t >	getDescriptor () const
	Returns the descriptor co-allocated with this User instance.
LLVM_ABI MutableArrayRef< uint8_t >	getDescriptor ()
	Returns the descriptor co-allocated with this User instance.
void	setNumHungOffUseOperands (unsigned NumOps)
	Subclasses with hung off uses need to manage the operand count themselves.
LLVM_ABI 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.
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_iterator >	operand_values ()
const_value_op_iterator	value_op_begin () const
const_value_op_iterator	value_op_end () const
iterator_range< const_value_op_iterator >	operand_values () const
void	dropAllReferences ()
	Drop all references to operands.
LLVM_ABI bool	replaceUsesOfWith (Value *From, Value *To)
	Replace uses of one Value with another.
Public Member Functions inherited from llvm::Value
	Value (const Value &)=delete
Value &	operator= (const Value &)=delete
LLVM_ABI void	deleteValue ()
	Delete a pointer to a generic Value.
LLVM_ABI void	dump () const
	Support for debugging, callable in GDB: V->dump()
Type *	getType () const
	All values are typed, get the type of this value.
LLVM_ABI LLVMContext &	getContext () const
	All values hold a context through their type.
bool	hasName () const
LLVM_ABI ValueName *	getValueName () const
LLVM_ABI void	setValueName (ValueName *VN)
LLVM_ABI StringRef	getName () const
	Return a constant reference to the value's name.
LLVM_ABI void	setName (const Twine &Name)
	Change the name of the value.
LLVM_ABI void	takeName (Value *V)
	Transfer the name from V to this value.
LLVM_ABI std::string	getNameOrAsOperand () const
LLVM_ABI void	replaceAllUsesWith (Value *V)
	Change all uses of this to point to a new Value.
LLVM_ABI void	replaceNonMetadataUsesWith (Value *V)
	Change non-metadata uses of this to point to a new Value.
LLVM_ABI 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.
LLVM_ABI 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.
LLVM_ABI void	assertModuleIsMaterializedImpl () const
void	assertModuleIsMaterialized () const
bool	hasUseList () const
	Check if this Value has a use-list.
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_iterator >	materialized_uses ()
iterator_range< const_use_iterator >	materialized_uses () const
iterator_range< use_iterator >	uses ()
iterator_range< const_use_iterator >	uses () 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
User *	user_back ()
const User *	user_back () const
iterator_range< user_iterator >	materialized_users ()
iterator_range< const_user_iterator >	materialized_users () const
iterator_range< user_iterator >	users ()
iterator_range< const_user_iterator >	users () const
bool	hasOneUse () const
	Return true if there is exactly one use of this value.
LLVM_ABI bool	hasNUses (unsigned N) const
	Return true if this Value has exactly N uses.
LLVM_ABI bool	hasNUsesOrMore (unsigned N) const
	Return true if this value has N uses or more.
LLVM_ABI bool	hasOneUser () const
	Return true if there is exactly one user of this value.
LLVM_ABI Use *	getSingleUndroppableUse ()
	Return true if there is exactly one use of this value that cannot be dropped.
const Use *	getSingleUndroppableUse () const
LLVM_ABI User *	getUniqueUndroppableUser ()
	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).
const User *	getUniqueUndroppableUser () const
LLVM_ABI bool	hasNUndroppableUses (unsigned N) const
	Return true if there this value.
LLVM_ABI bool	hasNUndroppableUsesOrMore (unsigned N) const
	Return true if this value has N uses or more.
LLVM_ABI void	dropDroppableUses (llvm::function_ref< bool(const Use *)> ShouldDrop=[](const Use *) { return true;})
	Remove every uses that can safely be removed.
LLVM_ABI void	dropDroppableUsesIn (User &Usr)
	Remove every use of this value in User that can safely be removed.
LLVM_ABI bool	isUsedInBasicBlock (const BasicBlock *BB) const
	Check if this value is used in the specified basic block.
LLVM_ABI unsigned	getNumUses () const
	This method computes the number of uses of this Value.
void	addUse (Use &U)
	This method should only be used by the Use class.
unsigned	getValueID () const
	Return an ID for the concrete type of this object.
unsigned	getRawSubclassOptionalData () const
	Return the raw optional flags value contained in this value.
void	clearSubclassOptionalData ()
	Clear the optional flags contained in this value.
bool	hasSameSubclassOptionalData (const Value *V) const
	Check the optional flags for equality.
bool	hasValueHandle () const
	Return true if there is a value handle associated with this value.
bool	isUsedByMetadata () const
	Return true if there is metadata referencing this value.
LLVM_ABI bool	isSwiftError () const
	Return true if this value is a swifterror value.
LLVM_ABI const Value *	stripPointerCasts () const
	Strip off pointer casts, all-zero GEPs and address space casts.
Value *	stripPointerCasts ()
LLVM_ABI const Value *	stripPointerCastsAndAliases () const
	Strip off pointer casts, all-zero GEPs, address space casts, and aliases.
Value *	stripPointerCastsAndAliases ()
LLVM_ABI const Value *	stripPointerCastsSameRepresentation () const
	Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same.
Value *	stripPointerCastsSameRepresentation ()
LLVM_ABI const Value *	stripPointerCastsForAliasAnalysis () const
	Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info.
Value *	stripPointerCastsForAliasAnalysis ()
LLVM_ABI const Value *	stripInBoundsConstantOffsets () const
	Strip off pointer casts and all-constant inbounds GEPs.
Value *	stripInBoundsConstantOffsets ()
LLVM_ABI const Value *	stripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr, bool LookThroughIntToPtr=false) const
	Accumulate the constant offset this value has compared to a base pointer.
Value *	stripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr, bool LookThroughIntToPtr=false)
const Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
	This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false.
Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
LLVM_ABI const Value *	stripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) const
	Strip off pointer casts and inbounds GEPs.
Value *	stripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {})
LLVM_ABI std::optional< int64_t >	getPointerOffsetFrom (const Value *Other, const DataLayout &DL) const
	If this ptr is provably equal to Other plus a constant offset, return that offset in bytes.
LLVM_ABI 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.
LLVM_ABI uint64_t	getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull, bool &CanBeFreed) const
	Returns the number of bytes known to be dereferenceable for the pointer value.
LLVM_ABI Align	getPointerAlignment (const DataLayout &DL) const
	Returns an alignment of the pointer value.
LLVM_ABI const Value *	DoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
	Translate PHI node to its predecessor from the given basic block.
Value *	DoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
void	mutateType (Type *Ty)
	Mutate the type of this Value to be of the specified type.
template<class Compare>
void	sortUseList (Compare Cmp)
	Sort the use-list.
LLVM_ABI void	reverseUseList ()
	Reverse the use-list.
LLVM_ABI void	print (raw_ostream &O, bool IsForDebug=false) const
	Implement operator<< on Value.
LLVM_ABI void	print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const
LLVM_ABI 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.
LLVM_ABI void	printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
Public Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >
Instruction *	getPrevNode ()
Instruction *	getNextNode ()
	Get the next node, or nullptr for the list tail.
Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type >
self_iterator	getIterator ()
reverse_self_iterator	getReverseIterator ()
std::enable_if_t< T::is_sentinel_tracking_explicit, bool >	isSentinel () const
	Check whether this is the sentinel node.
Public Member Functions inherited from llvm::ilist_detail::node_parent_access< ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type >, ilist_detail::compute_node_options< Instruction, Options... >::type::parent_ty >
const ilist_detail::compute_node_options< Instruction, Options... >::type::parent_ty *	getParent () const
void	setParent (ilist_detail::compute_node_options< Instruction, Options... >::type::parent_ty *Parent)

Static Public Member Functions
static LLVM_ABI bool	isValidOperands (const Value *V1, const Value *V2, const Value *Mask)
	Return true if a shufflevector instruction can be formed with the specified operands.
static LLVM_ABI bool	isValidOperands (const Value *V1, const Value *V2, ArrayRef< int > Mask)
static LLVM_ABI void	getShuffleMask (const Constant *Mask, SmallVectorImpl< int > &Result)
	Convert the input shuffle mask operand to a vector of integers.
static LLVM_ABI Constant *	convertShuffleMaskForBitcode (ArrayRef< int > Mask, Type *ResultTy)
static LLVM_ABI bool	isSingleSourceMask (ArrayRef< int > Mask, int NumSrcElts)
	Return true if this shuffle mask chooses elements from exactly one source vector.
static bool	isSingleSourceMask (const Constant *Mask, int NumSrcElts)
static LLVM_ABI bool	isIdentityMask (ArrayRef< int > Mask, int NumSrcElts)
	Return true if this shuffle mask chooses elements from exactly one source vector without lane crossings.
static bool	isIdentityMask (const Constant *Mask, int NumSrcElts)
static LLVM_ABI bool	isSelectMask (ArrayRef< int > Mask, int NumSrcElts)
	Return true if this shuffle mask chooses elements from its source vectors without lane crossings.
static bool	isSelectMask (const Constant *Mask, int NumSrcElts)
static LLVM_ABI bool	isReverseMask (ArrayRef< int > Mask, int NumSrcElts)
	Return true if this shuffle mask swaps the order of elements from exactly one source vector.
static bool	isReverseMask (const Constant *Mask, int NumSrcElts)
static LLVM_ABI bool	isZeroEltSplatMask (ArrayRef< int > Mask, int NumSrcElts)
	Return true if this shuffle mask chooses all elements with the same value as the first element of exactly one source vector.
static bool	isZeroEltSplatMask (const Constant *Mask, int NumSrcElts)
static LLVM_ABI bool	isTransposeMask (ArrayRef< int > Mask, int NumSrcElts)
	Return true if this shuffle mask is a transpose mask.
static bool	isTransposeMask (const Constant *Mask, int NumSrcElts)
static LLVM_ABI bool	isSpliceMask (ArrayRef< int > Mask, int NumSrcElts, int &Index)
	Return true if this shuffle mask is a splice mask, concatenating the two inputs together and then extracts an original width vector starting from the splice index.
static bool	isSpliceMask (const Constant *Mask, int NumSrcElts, int &Index)
static LLVM_ABI bool	isExtractSubvectorMask (ArrayRef< int > Mask, int NumSrcElts, int &Index)
	Return true if this shuffle mask is an extract subvector mask.
static bool	isExtractSubvectorMask (const Constant *Mask, int NumSrcElts, int &Index)
static LLVM_ABI bool	isInsertSubvectorMask (ArrayRef< int > Mask, int NumSrcElts, int &NumSubElts, int &Index)
	Return true if this shuffle mask is an insert subvector mask.
static bool	isInsertSubvectorMask (const Constant *Mask, int NumSrcElts, int &NumSubElts, int &Index)
static LLVM_ABI bool	isReplicationMask (ArrayRef< int > Mask, int &ReplicationFactor, int &VF)
	Return true if this shuffle mask replicates each of the VF elements in a vector ReplicationFactor times.
static bool	isReplicationMask (const Constant *Mask, int &ReplicationFactor, int &VF)
static LLVM_ABI bool	isOneUseSingleSourceMask (ArrayRef< int > Mask, int VF)
	Return true if this shuffle mask represents "clustered" mask of size VF, i.e.
static void	commuteShuffleMask (MutableArrayRef< int > Mask, unsigned InVecNumElts)
	Change values in a shuffle permute mask assuming the two vector operands of length InVecNumElts have swapped position.
static LLVM_ABI bool	isInterleaveMask (ArrayRef< int > Mask, unsigned Factor, unsigned NumInputElts, SmallVectorImpl< unsigned > &StartIndexes)
	Return true if the mask interleaves one or more input vectors together.
static bool	isInterleaveMask (ArrayRef< int > Mask, unsigned Factor, unsigned NumInputElts)
static LLVM_ABI bool	isDeInterleaveMaskOfFactor (ArrayRef< int > Mask, unsigned Factor, unsigned &Index)
	Check if the mask is a DE-interleave mask of the given factor Factor like: <Index, Index+Factor, ..., Index+(NumElts-1)*Factor>
static bool	isDeInterleaveMaskOfFactor (ArrayRef< int > Mask, unsigned Factor)
static LLVM_ABI bool	isBitRotateMask (ArrayRef< int > Mask, unsigned EltSizeInBits, unsigned MinSubElts, unsigned MaxSubElts, unsigned &NumSubElts, unsigned &RotateAmt)
	Checks if the shuffle is a bit rotation of the first operand across multiple subelements, e.g:
static bool	classof (const Instruction *I)
static bool	classof (const Value *V)
Static Public Member Functions inherited from llvm::Instruction
static LLVM_ABI const char *	getOpcodeName (unsigned Opcode)
static bool	isTerminator (unsigned Opcode)
static bool	isUnaryOp (unsigned Opcode)
static bool	isBinaryOp (unsigned Opcode)
static bool	isIntDivRem (unsigned Opcode)
static bool	isFPDivRem (unsigned Opcode)
static bool	isShift (unsigned Opcode)
	Determine if the Opcode is one of the shift instructions.
static bool	isBitwiseLogicOp (unsigned Opcode)
	Determine if the Opcode is and/or/xor.
static bool	isCast (unsigned Opcode)
	Determine if the Opcode is one of the CastInst instructions.
static bool	isFuncletPad (unsigned Opcode)
	Determine if the Opcode is one of the FuncletPadInst instructions.
static bool	isSpecialTerminator (unsigned Opcode)
	Returns true if the Opcode is a "special" terminator that does more than branch to a successor (e.g.
static bool	isAssociative (unsigned Opcode)
static bool	isCommutative (unsigned Opcode)
static bool	isIdempotent (unsigned Opcode)
static bool	isNilpotent (unsigned Opcode)
static bool	classof (const Value *V)
	Methods for support type inquiry through isa, cast, and dyn_cast:
Static Public Member Functions inherited from llvm::User
static bool	classof (const Value *V)
Static Public Member Functions inherited from llvm::Value
static LLVM_ABI void	dropDroppableUse (Use &U)
	Remove the droppable use U.

Protected Member Functions
LLVM_ABI ShuffleVectorInst *	cloneImpl () const
Protected Member Functions inherited from llvm::Instruction
LLVM_ABI	~Instruction ()
template<typename BitfieldElement>
BitfieldElement::Type	getSubclassData () const
template<typename BitfieldElement>
void	setSubclassData (typename BitfieldElement::Type Value)
LLVM_ABI	Instruction (Type *Ty, unsigned iType, AllocInfo AllocInfo, InsertPosition InsertBefore=nullptr)
Protected Member Functions inherited from llvm::User
void *	operator new (size_t Size)=delete
LLVM_ABI void *	operator new (size_t Size, HungOffOperandsAllocMarker)
	Allocate a User with an operand pointer co-allocated.
LLVM_ABI void *	operator new (size_t Size, IntrusiveOperandsAllocMarker allocTrait)
	Allocate a User with the operands co-allocated.
LLVM_ABI void *	operator new (size_t Size, IntrusiveOperandsAndDescriptorAllocMarker allocTrait)
	Allocate a User with the operands co-allocated.
	User (Type *ty, unsigned vty, AllocInfo AllocInfo)
LLVM_ABI void	allocHungoffUses (unsigned N, bool IsPhi=false)
	Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User.
LLVM_ABI void	growHungoffUses (unsigned N, bool IsPhi=false)
	Grow the number of hung off uses.
	~User ()=default
template<int Idx>
Use &	Op ()
template<int Idx>
const Use &	Op () const
Protected Member Functions inherited from llvm::Value
LLVM_ABI	Value (Type *Ty, unsigned scid)
LLVM_ABI	~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.
LLVM_ABI void	getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
	Appends all metadata attached to this value to MDs, sorting by KindID.
bool	hasMetadata () const
	Return true if this value has any metadata attached to it.
LLVM_ABI bool	eraseMetadata (unsigned KindID)
	Erase all metadata attachments with the given kind.
LLVM_ABI void	eraseMetadataIf (function_ref< bool(unsigned, MDNode *)> Pred)
	Erase all metadata attachments matching the given predicate.
LLVM_ABI void	clearMetadata ()
	Erase all metadata attached to this Value.
LLVM_ABI MDNode *	getMetadataImpl (unsigned KindID) const
	Get metadata for the given kind, if any.
unsigned short	getSubclassDataFromValue () const
void	setValueSubclassData (unsigned short D)
MDNode *	getMetadata (unsigned KindID) const
	Get the current metadata attachments for the given kind, if any.
LLVM_ABI MDNode *	getMetadata (StringRef Kind) const
LLVM_ABI void	getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
	Appends all attachments with the given ID to MDs in insertion order.
LLVM_ABI 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.
bool	hasMetadata (StringRef Kind) const
LLVM_ABI void	setMetadata (unsigned KindID, MDNode *Node)
	Set a particular kind of metadata attachment.
LLVM_ABI void	setMetadata (StringRef Kind, MDNode *Node)
LLVM_ABI void	addMetadata (unsigned KindID, MDNode &MD)
	Add a metadata attachment.
LLVM_ABI void	addMetadata (StringRef Kind, MDNode &MD)
Protected Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >
	ilist_node_with_parent ()=default
Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type >
	ilist_node_impl ()=default

Friends
class	Instruction
	Iterator for Instructions in a `BasicBlock.

Additional Inherited Members
Public Types inherited from llvm::Instruction
enum	OperationEquivalenceFlags { CompareIgnoringAlignment = 1 << 0 , CompareUsingScalarTypes = 1 << 1 , CompareUsingIntersectedAttrs = 1 << 2 }
	When checking for operation equivalence (using isSameOperationAs) it is sometimes useful to ignore certain attributes. More...
enum	TermOps
enum	UnaryOps
enum	BinaryOps
enum	MemoryOps
enum	CastOps
enum	FuncletPadOps
enum	OtherOps
using	InstListType
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 Attributes inherited from llvm::Instruction
DbgMarker *	DebugMarker = nullptr
	Optional marker recording the position for debugging information that takes effect immediately before this instruction.
Static Public Attributes inherited from llvm::Value
static constexpr unsigned	MaxAlignmentExponent = 32
	The maximum alignment for instructions.
static constexpr uint64_t	MaximumAlignment = 1ULL << MaxAlignmentExponent
Protected Types inherited from llvm::Instruction
using	OpaqueField = Bitfield::Element<uint16_t, 0, 15>
template<unsigned Offset>
using	AlignmentBitfieldElementT
template<unsigned Offset>
using	BoolBitfieldElementT = typename Bitfield::Element<bool, Offset, 1>
template<unsigned Offset>
using	AtomicOrderingBitfieldElementT
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< Instruction, Options... >::type >
using	self_iterator
using	const_self_iterator
using	reverse_self_iterator
using	const_reverse_self_iterator
Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U>
static Use &	OpFrom (const U *that)
Protected Attributes inherited from llvm::Value
unsigned char	SubclassOptionalData: 7
	Hold subclass data that can be dropped.
unsigned	NumUserOperands: NumUserOperandsBits
unsigned	IsUsedByMD: 1
unsigned	HasName: 1
unsigned	HasMetadata: 1
unsigned	HasHungOffUses: 1
unsigned	HasDescriptor: 1

Detailed Description

This instruction constructs a fixed permutation of two input vectors.

For each element of the result vector, the shuffle mask selects an element from one of the input vectors to copy to the result. Non-negative elements in the mask represent an index into the concatenated pair of input vectors. PoisonMaskElem (-1) specifies that the result element is poison.

For scalable vectors, all the elements of the mask must be 0 or -1. This requirement may be relaxed in the future.

Definition at line 1934 of file Instructions.h.

Constructor & Destructor Documentation

ShuffleVectorInst() [1/4]

ShuffleVectorInst::ShuffleVectorInst	(	Value *	V1,
		Value *	Mask,
		const Twine &	NameStr = "",
		InsertPosition	InsertBefore = nullptr )

Definition at line 1729 of file Instructions.cpp.

References createPlaceholderForShuffleVector(), and ShuffleVectorInst().

Referenced by cloneImpl(), Instruction, ShuffleVectorInst(), and ShuffleVectorInst().

ShuffleVectorInst() [2/4]

ShuffleVectorInst::ShuffleVectorInst	(	Value *	V1,
		ArrayRef< int >	Mask,
		const Twine &	NameStr = "",
		InsertPosition	InsertBefore = nullptr )

Definition at line 1734 of file Instructions.cpp.

References createPlaceholderForShuffleVector(), and ShuffleVectorInst().

ShuffleVectorInst() [3/4]

ShuffleVectorInst::ShuffleVectorInst	(	Value *	V1,
		Value *	V2,
		Value *	Mask,
		const Twine &	NameStr = "",
		InsertPosition	InsertBefore = nullptr )

Definition at line 1740 of file Instructions.cpp.

References assert(), llvm::cast(), llvm::get(), getShuffleMask(), getType(), Instruction, isValidOperands(), llvm::Value::setName(), and setShuffleMask().

ShuffleVectorInst() [4/4]

ShuffleVectorInst::ShuffleVectorInst	(	Value *	V1,
		Value *	V2,
		ArrayRef< int >	Mask,
		const Twine &	NameStr = "",
		InsertPosition	InsertBefore = nullptr )

Definition at line 1758 of file Instructions.cpp.

References assert(), llvm::cast(), llvm::get(), getType(), Instruction, llvm::isa(), isValidOperands(), llvm::Value::setName(), setShuffleMask(), and llvm::size().

Member Function Documentation

changesLength()

bool llvm::ShuffleVectorInst::changesLength ( ) const

inline

Return true if this shuffle returns a vector with a different number of elements than its source vectors.

Examples: shufflevector <4 x n> A, <4 x n> B, <1,2,3> shufflevector <4 x n> A, <4 x n> B, <1,2,3,4,5>

Definition at line 2014 of file Instructions.h.

References llvm::cast(), and getType().

Referenced by foldTruncShuffle(), isIdentity(), isReverse(), isSelect(), isSingleSource(), isSplice(), isTranspose(), and isZeroEltSplat().

classof() [1/2]

bool llvm::ShuffleVectorInst::classof ( const Instruction * I )

inlinestatic

Definition at line 2414 of file Instructions.h.

References I, and Instruction.

Referenced by classof().

classof() [2/2]

bool llvm::ShuffleVectorInst::classof ( const Value * V )

inlinestatic

Definition at line 2417 of file Instructions.h.

References llvm::cast(), classof(), and llvm::isa().

cloneImpl()

ShuffleVectorInst * ShuffleVectorInst::cloneImpl ( ) const

protected

Definition at line 4489 of file Instructions.cpp.

References llvm::User::getOperand(), getShuffleMask(), and ShuffleVectorInst().

Referenced by Instruction.

commute()

void ShuffleVectorInst::commute

(

)

Swap the operands and adjust the mask to preserve the semantics of the instruction.

Definition at line 1773 of file Instructions.cpp.

References assert(), llvm::cast(), getMaskValue(), getType(), llvm::PoisonMaskElem, and setShuffleMask().

Referenced by llvm::InstCombinerImpl::foldSelectShuffle(), and llvm::InstCombinerImpl::visitShuffleVectorInst().

commuteShuffleMask()

void llvm::ShuffleVectorInst::commuteShuffleMask ( MutableArrayRef< int > Mask, unsigned InVecNumElts )

inlinestatic

Change values in a shuffle permute mask assuming the two vector operands of length InVecNumElts have swapped position.

Definition at line 2343 of file Instructions.h.

References assert().

Referenced by llvm::sandboxir::ShuffleVectorInst::commuteShuffleMask(), foldSelectShuffleOfSelectShuffle(), foldShuffleWithInsert(), and simplifyShuffleVectorInst().

convertShuffleMaskForBitcode()

Constant * ShuffleVectorInst::convertShuffleMaskForBitcode ( ArrayRef< int > Mask, Type * ResultTy )

static

Definition at line 1895 of file Instructions.cpp.

References llvm::all_equal(), assert(), llvm::ConstantVector::get(), llvm::PoisonValue::get(), llvm::VectorType::get(), llvm::Type::getContext(), llvm::Type::getInt32Ty(), llvm::Constant::getNullValue(), llvm::Int32Ty, llvm::isa(), llvm::PoisonMaskElem, and llvm::SmallVectorTemplateBase< T, bool >::push_back().

Referenced by llvm::sandboxir::ShuffleVectorInst::convertShuffleMaskForBitcode(), setShuffleMask(), and llvm::ShuffleVectorConstantExpr::ShuffleVectorConstantExpr().

DECLARE_TRANSPARENT_OPERAND_ACCESSORS()

llvm::ShuffleVectorInst::DECLARE_TRANSPARENT_OPERAND_ACCESSORS

(

Value

)

Transparently provide more efficient getOperand methods.

getMaskValue()

int llvm::ShuffleVectorInst::getMaskValue ( unsigned Elt ) const

inline

Return the shuffle mask value of this instruction for the given element index.

Return PoisonMaskElem if the element is undef.

Definition at line 1984 of file Instructions.h.

Referenced by commute(), findDemandedEltsBySingleUser(), llvm::findScalarElement(), foldIdentityExtractShuffle(), llvm::InstCombinerImpl::foldSelectShuffle(), and isShuffleEquivalentToSelect().

getShuffleMask() [1/3]

ArrayRef< int > llvm::ShuffleVectorInst::getShuffleMask ( ) const

inline

Definition at line 2008 of file Instructions.h.

Referenced by cloneImpl(), llvm::IRBuilderBase::CreateShuffleVector(), llvm::sandboxir::ShuffleVectorInst::getShuffleMask(), isConcat(), isIdentityWithExtract(), isIdentityWithPadding(), LLVMConstShuffleVector(), ShuffleVectorInst(), and upgradeX86IntrinsicCall().

getShuffleMask() [2/3]

void ShuffleVectorInst::getShuffleMask ( const Constant * Mask, SmallVectorImpl< int > & Result )

static

Convert the input shuffle mask operand to a vector of integers.

Undefined elements of the mask are returned as PoisonMaskElem.

Definition at line 1861 of file Instructions.cpp.

References assert(), llvm::CallingConv::C, llvm::cast(), llvm::dyn_cast(), and llvm::isa().

Referenced by canonicalizeInsertSplat(), foldCastShuffle(), foldIdentityPaddedShuffles(), llvm::InstCombinerImpl::foldSelectShuffle(), foldSelectShuffleOfSelectShuffle(), foldSelectShuffleWith1Binop(), foldShuffleOfUnaryOps(), foldShuffleWithInsert(), foldTruncShuffle(), getShuffleDemandedElts(), isExtractSubvectorMask(), isIdentityMask(), isInsertSubvectorMask(), isReInterleaveMask(), isReplicationMask(), isReverseMask(), isSelectMask(), isShuffleEquivalentToSelect(), isSingleSourceMask(), isSpliceMask(), isTransposeMask(), isZeroEltSplatMask(), llvm::AArch64TargetLowering::lowerInterleavedStore(), llvm::ARMTargetLowering::lowerInterleavedStore(), llvm::RISCVTargetLowering::lowerInterleavedStore(), llvm::X86TargetLowering::lowerInterleavedStore(), narrowVectorSelect(), llvm::InstCombinerImpl::simplifyBinOpSplats(), and llvm::InstCombinerImpl::visitShuffleVectorInst().

getShuffleMask() [3/3]

void llvm::ShuffleVectorInst::getShuffleMask ( SmallVectorImpl< int > & Result ) const

inline

Return the mask for this instruction as a vector of integers.

Undefined elements of the mask are returned as PoisonMaskElem.

Definition at line 1993 of file Instructions.h.

getShuffleMaskForBitcode()

Constant * llvm::ShuffleVectorInst::getShuffleMaskForBitcode ( ) const

inline

Return the mask for this instruction, for use in bitcode.

TODO: This is temporary until we decide a new bitcode encoding for shufflevector.

Definition at line 2001 of file Instructions.h.

getType()

VectorType * llvm::ShuffleVectorInst::getType ( ) const

inline

Overload to return most specific vector type.

Definition at line 1975 of file Instructions.h.

References llvm::cast(), and llvm::Value::getType().

Referenced by canonicalizeInsertSplat(), commute(), llvm::findScalarElement(), foldCastShuffle(), foldIdentityExtractShuffle(), foldIdentityPaddedShuffles(), llvm::InstCombinerImpl::foldSelectShuffle(), foldSelectShuffleWith1Binop(), foldShuffleOfUnaryOps(), foldTruncShuffle(), getShuffleDemandedElts(), isConcat(), isIdentityWithExtract(), isIdentityWithPadding(), isInterleave(), isOneUseSingleSourceMask(), isReplicationMask(), llvm::AArch64TargetLowering::lowerInterleavedLoad(), llvm::ARMTargetLowering::lowerInterleavedLoad(), llvm::AArch64TargetLowering::lowerInterleavedStore(), llvm::ARMTargetLowering::lowerInterleavedStore(), llvm::RISCVTargetLowering::lowerInterleavedStore(), llvm::X86TargetLowering::lowerInterleavedStore(), narrowVectorSelect(), setShuffleMask(), llvm::ARMTargetLowering::shouldConvertSplatType(), ShuffleVectorInst(), ShuffleVectorInst(), and llvm::InstCombinerImpl::visitShuffleVectorInst().

increasesLength()

bool llvm::ShuffleVectorInst::increasesLength ( ) const

inline

Return true if this shuffle returns a vector with a greater number of elements than its source vectors.

Example: shufflevector <2 x n> A, <2 x n> B, <1,2,3>

Definition at line 2025 of file Instructions.h.

References llvm::cast(), and getType().

Referenced by foldTruncShuffle().

isBitRotateMask()

bool ShuffleVectorInst::isBitRotateMask ( ArrayRef< int > Mask, unsigned EltSizeInBits, unsigned MinSubElts, unsigned MaxSubElts, unsigned & NumSubElts, unsigned & RotateAmt )

static

Checks if the shuffle is a bit rotation of the first operand across multiple subelements, e.g:

shuffle <8 x i8> a, <8 x i8> poison, <8 x i32> <1, 0, 3, 2, 5, 4, 7, 6>

could be expressed as

rotl <4 x i16> a, 8

If it can be expressed as a rotation, returns the number of subelements to group by in NumSubElts and the number of bits to rotate left in RotateAmt.

Definition at line 2494 of file Instructions.cpp.

References matchShuffleAsBitRotate().

Referenced by llvm::sandboxir::ShuffleVectorInst::isBitRotateMask(), isLegalBitRotate(), and matchShuffleAsBitRotate().

isConcat()

bool ShuffleVectorInst::isConcat

(

)

const

Return true if this shuffle concatenates its 2 source vectors.

This returns false if either input is undefined. In that case, the shuffle is is better classified as an identity with padding operation.

Definition at line 2218 of file Instructions.cpp.

References llvm::cast(), getShuffleMask(), getType(), llvm::isa(), and isIdentityMaskImpl().

isDeInterleaveMaskOfFactor() [1/2]

bool llvm::ShuffleVectorInst::isDeInterleaveMaskOfFactor ( ArrayRef< int > Mask, unsigned Factor )

inlinestatic

Definition at line 2391 of file Instructions.h.

References isDeInterleaveMaskOfFactor().

isDeInterleaveMaskOfFactor() [2/2]

bool ShuffleVectorInst::isDeInterleaveMaskOfFactor ( ArrayRef< int > Mask, unsigned Factor, unsigned & Index )

static

Check if the mask is a DE-interleave mask of the given factor Factor like: <Index, Index+Factor, ..., Index+(NumElts-1)*Factor>

Definition at line 2447 of file Instructions.cpp.

References I.

Referenced by llvm::AArch64TTIImpl::getShuffleCost(), llvm::ARMTTIImpl::getShuffleCost(), isDeInterleaveMask(), llvm::sandboxir::ShuffleVectorInst::isDeInterleaveMaskOfFactor(), llvm::sandboxir::ShuffleVectorInst::isDeInterleaveMaskOfFactor(), isDeInterleaveMaskOfFactor(), lowerVECTOR_SHUFFLE(), and performZExtDeinterleaveShuffleCombine().

isExtractSubvectorMask() [1/3]

bool ShuffleVectorInst::isExtractSubvectorMask ( ArrayRef< int > Mask, int NumSrcElts, int & Index )

static

Return true if this shuffle mask is an extract subvector mask.

A valid extract subvector mask returns a smaller vector from a single source operand. The base extraction index is returned as well.

Definition at line 2078 of file Instructions.cpp.

References isSingleSourceMaskImpl(), and llvm::Offset.

Referenced by areExtractShuffleVectors(), llvm::BasicTTIImplBase< BasicTTIImpl >::improveShuffleKindFromMask(), llvm::sandboxir::ShuffleVectorInst::isExtractSubvectorMask(), llvm::sandboxir::ShuffleVectorInst::isExtractSubvectorMask(), isExtractSubvectorMask(), and isExtractSubvectorMask().

isExtractSubvectorMask() [2/3]

bool llvm::ShuffleVectorInst::isExtractSubvectorMask ( const Constant * Mask, int NumSrcElts, int & Index )

inlinestatic

Definition at line 2251 of file Instructions.h.

References assert(), getShuffleMask(), llvm::isa(), and isExtractSubvectorMask().

isExtractSubvectorMask() [3/3]

bool llvm::ShuffleVectorInst::isExtractSubvectorMask ( int & Index ) const

inline

Return true if this shuffle mask is an extract subvector mask.

Definition at line 2264 of file Instructions.h.

References llvm::cast(), getType(), llvm::isa(), and isExtractSubvectorMask().

isIdentity()

bool llvm::ShuffleVectorInst::isIdentity ( ) const

inline

Return true if this shuffle chooses elements from exactly one source vector without lane crossings and does not change the number of elements from its input vectors.

Example: shufflevector <4 x n> A, <4 x n> B, <4,undef,6,undef>

Definition at line 2078 of file Instructions.h.

References changesLength(), getType(), llvm::isa(), and isIdentityMask().

isIdentityMask() [1/2]

bool ShuffleVectorInst::isIdentityMask ( ArrayRef< int > Mask, int NumSrcElts )

static

Return true if this shuffle mask chooses elements from exactly one source vector without lane crossings.

A shuffle using this mask is not necessarily a no-op because it may change the number of elements from its input vectors or it may provide demanded bits knowledge via undef lanes. Example: <undef,undef,2,3>

Definition at line 1951 of file Instructions.cpp.

References isIdentityMaskImpl().

Referenced by costShuffleViaSplitting(), costShuffleViaVRegSplitting(), foldExtractSubvectorFromShuffleVector(), foldSelectShuffleOfSelectShuffle(), llvm::X86TTIImpl::getShuffleCost(), llvm::slpvectorizer::BoUpSLP::getTreeCost(), isIdentity(), llvm::sandboxir::ShuffleVectorInst::isIdentityMask(), llvm::sandboxir::ShuffleVectorInst::isIdentityMask(), isIdentityMask(), isRepeatedNonIdentityClusteredMask(), llvm::ARMTargetLowering::isShuffleMaskLegal(), lowerVECTOR_SHUFFLE(), and reorderOrder().

isIdentityMask() [2/2]

bool llvm::ShuffleVectorInst::isIdentityMask ( const Constant * Mask, int NumSrcElts )

inlinestatic

Definition at line 2061 of file Instructions.h.

References assert(), getShuffleMask(), llvm::isa(), and isIdentityMask().

isIdentityWithExtract()

bool ShuffleVectorInst::isIdentityWithExtract

(

)

const

Return true if this shuffle extracts the first N elements of exactly one source vector.

Definition at line 2204 of file Instructions.cpp.

References llvm::cast(), getShuffleMask(), getType(), llvm::isa(), and isIdentityMaskImpl().

Referenced by foldCastShuffle(), foldIdentityExtractShuffle(), and narrowVectorSelect().

isIdentityWithPadding()

bool ShuffleVectorInst::isIdentityWithPadding

(

)

const

Return true if this shuffle lengthens exactly one source vector with undefs in the high elements.

Definition at line 2180 of file Instructions.cpp.

References llvm::cast(), getShuffleMask(), getType(), llvm::isa(), and isIdentityMaskImpl().

isInsertSubvectorMask() [1/3]

bool ShuffleVectorInst::isInsertSubvectorMask ( ArrayRef< int > Mask, int NumSrcElts, int & NumSubElts, int & Index )

static

Return true if this shuffle mask is an insert subvector mask.

A valid insert subvector mask inserts the lowest elements of a second source operand into an in-place first source operand. Both the sub vector width and the insertion index is returned.

Definition at line 2107 of file Instructions.cpp.

References assert(), llvm::APInt::countl_zero(), llvm::APInt::countr_zero(), llvm::APInt::getZero(), isIdentityMaskImpl(), isSingleSourceMaskImpl(), llvm::APInt::isZero(), and llvm::APInt::setBit().

Referenced by llvm::BasicTTIImplBase< BasicTTIImpl >::improveShuffleKindFromMask(), llvm::sandboxir::ShuffleVectorInst::isInsertSubvectorMask(), llvm::sandboxir::ShuffleVectorInst::isInsertSubvectorMask(), isInsertSubvectorMask(), isInsertSubvectorMask(), and lowerVECTOR_SHUFFLEAsVSlideup().

isInsertSubvectorMask() [2/3]

bool llvm::ShuffleVectorInst::isInsertSubvectorMask ( const Constant * Mask, int NumSrcElts, int & NumSubElts, int & Index )

inlinestatic

Definition at line 2281 of file Instructions.h.

References assert(), getShuffleMask(), llvm::isa(), and isInsertSubvectorMask().

isInsertSubvectorMask() [3/3]

bool llvm::ShuffleVectorInst::isInsertSubvectorMask ( int & NumSubElts, int & Index ) const

inline

Return true if this shuffle mask is an insert subvector mask.

Definition at line 2294 of file Instructions.h.

References llvm::cast(), getType(), llvm::isa(), and isInsertSubvectorMask().

isInterleave()

bool ShuffleVectorInst::isInterleave

(

unsigned

Factor

)

Return if this shuffle interleaves its two input vectors together.

Definition at line 2352 of file Instructions.cpp.

References llvm::dyn_cast(), llvm::FixedVectorType::getNumElements(), llvm::User::getOperand(), getType(), and isInterleaveMask().

Referenced by isReInterleaveMask().

isInterleaveMask() [1/2]

bool llvm::ShuffleVectorInst::isInterleaveMask ( ArrayRef< int > Mask, unsigned Factor, unsigned NumInputElts )

inlinestatic

Definition at line 2379 of file Instructions.h.

References isInterleaveMask().

isInterleaveMask() [2/2]

bool ShuffleVectorInst::isInterleaveMask ( ArrayRef< int > Mask, unsigned Factor, unsigned NumInputElts, SmallVectorImpl< unsigned > & StartIndexes )

static

Return true if the mask interleaves one or more input vectors together.

I.e. <0, LaneLen, ... , LaneLen*(Factor - 1), 1, LaneLen + 1, ...> E.g. For a Factor of 2 (LaneLen=4): <0, 4, 1, 5, 2, 6, 3, 7> E.g. For a Factor of 3 (LaneLen=4): <4, 0, 9, 5, 1, 10, 6, 2, 11, 7, 3, 12> E.g. For a Factor of 4 (LaneLen=2): <0, 2, 6, 4, 1, 3, 7, 5>

NumInputElts is the total number of elements in the input vectors.

StartIndexes are the first indexes of each vector being interleaved, substituting any indexes that were undef E.g. <4, -1, 2, 5, 1, 3> (Factor=3): StartIndexes=<4, 0, 2>

Note that this does not check if the input vectors are consecutive: It will return true for masks such as <0, 4, 6, 1, 5, 7> (Factor=3, LaneLen=2)

Definition at line 2363 of file Instructions.cpp.

References I, llvm::isPowerOf2_32(), and llvm::SmallVectorImpl< T >::resize().

Referenced by getMask(), llvm::AArch64TTIImpl::getShuffleCost(), llvm::ARMTTIImpl::getShuffleCost(), llvm::RISCVTTIImpl::getShuffleCost(), isInterleave(), llvm::sandboxir::ShuffleVectorInst::isInterleaveMask(), llvm::sandboxir::ShuffleVectorInst::isInterleaveMask(), isInterleaveMask(), and isInterleaveShuffle().

isOneUseSingleSourceMask() [1/2]

bool ShuffleVectorInst::isOneUseSingleSourceMask ( ArrayRef< int > Mask, int VF )

static

Return true if this shuffle mask represents "clustered" mask of size VF, i.e.

each index between [0..VF) is used exactly once in each submask of size VF. For example, the mask for VF=4 is: 0, 1, 2, 3, 3, 2, 0, 1 - "clustered", because each submask of size 4 (0,1,2,3 and 3,2,0,1) uses indices [0..VF) exactly one time. 0, 1, 2, 3, 3, 3, 1, 0 - not "clustered", because element 3 is used twice in the second submask (3,3,1,0) and index 2 is not used at all.

Definition at line 2321 of file Instructions.cpp.

References llvm::all_of(), and llvm::PoisonMaskElem.

Referenced by llvm::slpvectorizer::BoUpSLP::getReorderingData(), llvm::sandboxir::ShuffleVectorInst::isOneUseSingleSourceMask(), and isOneUseSingleSourceMask().

isOneUseSingleSourceMask() [2/2]

bool ShuffleVectorInst::isOneUseSingleSourceMask

(

int

VF

)

const

Return true if this shuffle mask is a one-use-single-source("clustered") mask.

Return true if this shuffle mask is a replication mask.

Definition at line 2341 of file Instructions.cpp.

References getType(), llvm::isa(), isOneUseSingleSourceMask(), and isSingleSourceMask().

isReplicationMask() [1/3]

bool ShuffleVectorInst::isReplicationMask ( ArrayRef< int > Mask, int & ReplicationFactor, int & VF )

static

Return true if this shuffle mask replicates each of the VF elements in a vector ReplicationFactor times.

For example, the mask for ReplicationFactor=3 and VF=4 is: <0,0,0,1,1,1,2,2,2,3,3,3>

Definition at line 2260 of file Instructions.cpp.

References llvm::is_contained(), isReplicationMaskWithParams(), llvm::PoisonMaskElem, llvm::reverse(), llvm::seq_inclusive(), and llvm::size().

Referenced by llvm::sandboxir::ShuffleVectorInst::isReplicationMask(), llvm::sandboxir::ShuffleVectorInst::isReplicationMask(), and isReplicationMask().

isReplicationMask() [2/3]

bool llvm::ShuffleVectorInst::isReplicationMask ( const Constant * Mask, int & ReplicationFactor, int & VF )

inlinestatic

Definition at line 2311 of file Instructions.h.

References assert(), getShuffleMask(), llvm::isa(), and isReplicationMask().

isReplicationMask() [3/3]

bool ShuffleVectorInst::isReplicationMask	(	int &	ReplicationFactor,
		int &	VF ) const

Return true if this shuffle mask is a replication mask.

Definition at line 2306 of file Instructions.cpp.

References llvm::cast(), getType(), llvm::isa(), and isReplicationMaskWithParams().

isReverse()

bool llvm::ShuffleVectorInst::isReverse ( ) const

inline

Return true if this shuffle swaps the order of elements from exactly one source vector.

Example: shufflevector <4 x n> A, <4 x n> B, <3,undef,1,undef> TODO: Optionally allow length-changing shuffles.

Definition at line 2145 of file Instructions.h.

References changesLength(), and isReverseMask().

isReverseMask() [1/2]

bool ShuffleVectorInst::isReverseMask ( ArrayRef< int > Mask, int NumSrcElts )

static

Return true if this shuffle mask swaps the order of elements from exactly one source vector.

Example: <7,6,undef,4> This assumes that vector operands (of length NumSrcElts) are the same length as the mask.

Definition at line 1959 of file Instructions.cpp.

References I, and isSingleSourceMask().

Referenced by llvm::BasicTTIImplBase< BasicTTIImpl >::improveShuffleKindFromMask(), llvm::sandboxir::ShuffleVectorInst::isReverseMask(), llvm::sandboxir::ShuffleVectorInst::isReverseMask(), llvm::RISCVTargetLowering::isShuffleMaskLegal(), lowerBitreverseShuffle(), and lowerVECTOR_SHUFFLE().

isReverseMask() [2/2]

bool llvm::ShuffleVectorInst::isReverseMask ( const Constant * Mask, int NumSrcElts )

inlinestatic

Definition at line 2134 of file Instructions.h.

References assert(), getShuffleMask(), and isReverseMask().

isSelect()

bool llvm::ShuffleVectorInst::isSelect ( ) const

inline

Return true if this shuffle chooses elements from its source vectors without lane crossings and all operands have the same number of elements.

In other words, this shuffle is equivalent to a vector select with a constant condition operand. Example: shufflevector <4 x n> A, <4 x n> B, <undef,1,6,3> This returns false if the mask does not choose from both input vectors. In that case, the shuffle is better classified as an identity shuffle. TODO: Optionally allow length-changing shuffles.

Definition at line 2124 of file Instructions.h.

References changesLength(), and isSelectMask().

Referenced by llvm::InstCombinerImpl::foldSelectShuffle(), foldSelectShuffleOfSelectShuffle(), and foldSelectShuffleWith1Binop().

isSelectMask() [1/2]

bool ShuffleVectorInst::isSelectMask ( ArrayRef< int > Mask, int NumSrcElts )

static

Return true if this shuffle mask chooses elements from its source vectors without lane crossings.

A shuffle using this mask would be equivalent to a vector select with a constant condition operand. Example: <4,1,6,undef> This returns false if the mask does not choose from both input vectors. In that case, the shuffle is better classified as an identity shuffle. This assumes that vector operands are the same length as the mask (a length-changing shuffle can never be equivalent to a vector select).

Definition at line 1993 of file Instructions.cpp.

References I, and isSingleSourceMask().

Referenced by foldSelectShuffleOfSelectShuffle(), llvm::BasicTTIImplBase< BasicTTIImpl >::improveShuffleKindFromMask(), isSelect(), llvm::sandboxir::ShuffleVectorInst::isSelectMask(), llvm::sandboxir::ShuffleVectorInst::isSelectMask(), isSelectMask(), and performVECTOR_SHUFFLECombine().

isSelectMask() [2/2]

bool llvm::ShuffleVectorInst::isSelectMask ( const Constant * Mask, int NumSrcElts )

inlinestatic

Definition at line 2109 of file Instructions.h.

References assert(), getShuffleMask(), and isSelectMask().

isSingleSource()

bool llvm::ShuffleVectorInst::isSingleSource ( ) const

inline

Return true if this shuffle chooses elements from exactly one source vector without changing the length of that vector.

Example: shufflevector <4 x n> A, <4 x n> B, <3,0,undef,3> TODO: Optionally allow length-changing shuffles.

Definition at line 2050 of file Instructions.h.

References changesLength(), and isSingleSourceMask().

isSingleSourceMask() [1/2]

bool ShuffleVectorInst::isSingleSourceMask ( ArrayRef< int > Mask, int NumSrcElts )

static

Return true if this shuffle mask chooses elements from exactly one source vector.

Example: <7,5,undef,7> This assumes that vector operands (of length NumSrcElts) are the same length as the mask.

Definition at line 1933 of file Instructions.cpp.

References isSingleSourceMaskImpl().

Referenced by GenerateFixedLengthSVETBL(), isOneUseSingleSourceMask(), isReverseMask(), isSelectMask(), isSingleSource(), llvm::sandboxir::ShuffleVectorInst::isSingleSourceMask(), llvm::sandboxir::ShuffleVectorInst::isSingleSourceMask(), isSingleSourceMask(), isZeroEltSplatMask(), and lowerVECTOR_SHUFFLE().

isSingleSourceMask() [2/2]

bool llvm::ShuffleVectorInst::isSingleSourceMask ( const Constant * Mask, int NumSrcElts )

inlinestatic

Definition at line 2039 of file Instructions.h.

References assert(), getShuffleMask(), and isSingleSourceMask().

isSplice()

bool llvm::ShuffleVectorInst::isSplice ( int & Index ) const

inline

Return true if this shuffle splices two inputs without changing the length of the vectors.

This operation concatenates the two inputs together and then extracts an original width vector starting from the splice index. Example: shufflevector <4 x n> A, <4 x n> B, <1,2,3,4>

Definition at line 2241 of file Instructions.h.

References changesLength(), and isSpliceMask().

isSpliceMask() [1/2]

bool ShuffleVectorInst::isSpliceMask ( ArrayRef< int > Mask, int NumSrcElts, int & Index )

static

Return true if this shuffle mask is a splice mask, concatenating the two inputs together and then extracts an original width vector starting from the splice index.

Example: shufflevector <4 x n> A, <4 x n> B, <1,2,3,4> This assumes that vector operands (of length NumSrcElts) are the same length as the mask.

Definition at line 2044 of file Instructions.cpp.

References I.

Referenced by llvm::BasicTTIImplBase< BasicTTIImpl >::improveShuffleKindFromMask(), isSplice(), llvm::sandboxir::ShuffleVectorInst::isSpliceMask(), llvm::sandboxir::ShuffleVectorInst::isSpliceMask(), and isSpliceMask().

isSpliceMask() [2/2]

bool llvm::ShuffleVectorInst::isSpliceMask ( const Constant * Mask, int NumSrcElts, int & Index )

inlinestatic

Definition at line 2230 of file Instructions.h.

References assert(), getShuffleMask(), and isSpliceMask().

isTranspose()

bool llvm::ShuffleVectorInst::isTranspose ( ) const

inline

Return true if this shuffle transposes the elements of its inputs without changing the length of the vectors.

This operation may also be known as a merge or interleave. See the description for isTransposeMask() for the exact specification. Example: shufflevector <4 x n> A, <4 x n> B, <0,4,2,6>

Definition at line 2218 of file Instructions.h.

References changesLength(), and isTransposeMask().

isTransposeMask() [1/2]

bool ShuffleVectorInst::isTransposeMask ( ArrayRef< int > Mask, int NumSrcElts )

static

Return true if this shuffle mask is a transpose mask.

Transpose vector masks transpose a 2xn matrix. They read corresponding even- or odd-numbered vector elements from two n-dimensional source vectors and write each result into consecutive elements of an n-dimensional destination vector. Two shuffles are necessary to complete the transpose, one for the even elements and another for the odd elements. This description closely follows how the TRN1 and TRN2 AArch64 instructions operate.

For example, a simple 2x2 matrix can be transposed with:

; Original matrix m0 = < a, b > m1 = < c, d >

; Transposed matrix t0 = < a, c > = shufflevector m0, m1, < 0, 2 > t1 = < b, d > = shufflevector m0, m1, < 1, 3 >

For matrices having greater than n columns, the resulting nx2 transposed matrix is stored in two result vectors such that one vector contains interleaved elements from all the even-numbered rows and the other vector contains interleaved elements from all the odd-numbered rows. For example, a 2x4 matrix can be transposed with:

; Original matrix m0 = < a, b, c, d > m1 = < e, f, g, h >

; Transposed matrix t0 = < a, e, c, g > = shufflevector m0, m1 < 0, 4, 2, 6 > t1 = < b, f, d, h > = shufflevector m0, m1 < 1, 5, 3, 7 >

Definition at line 2008 of file Instructions.cpp.

References I, and llvm::isPowerOf2_32().

Referenced by llvm::BasicTTIImplBase< BasicTTIImpl >::improveShuffleKindFromMask(), isTranspose(), llvm::sandboxir::ShuffleVectorInst::isTransposeMask(), llvm::sandboxir::ShuffleVectorInst::isTransposeMask(), and isTransposeMask().

isTransposeMask() [2/2]

bool llvm::ShuffleVectorInst::isTransposeMask ( const Constant * Mask, int NumSrcElts )

inlinestatic

Definition at line 2206 of file Instructions.h.

References assert(), getShuffleMask(), and isTransposeMask().

isValidOperands() [1/2]

bool ShuffleVectorInst::isValidOperands ( const Value * V1, const Value * V2, ArrayRef< int > Mask )

static

Definition at line 1791 of file Instructions.cpp.

References llvm::all_equal(), llvm::cast(), llvm::Value::getType(), llvm::isa(), and llvm::PoisonMaskElem.

isValidOperands() [2/2]

bool ShuffleVectorInst::isValidOperands ( const Value * V1, const Value * V2, const Value * Mask )

static

Return true if a shufflevector instruction can be formed with the specified operands.

Definition at line 1811 of file Instructions.cpp.

References llvm::cast(), llvm::dyn_cast(), getNumElements(), llvm::Value::getType(), llvm::isa(), and llvm::Type::isVectorTy().

Referenced by llvm::ConstantExpr::getShuffleVector(), llvm::sandboxir::ShuffleVectorInst::isValidOperands(), llvm::sandboxir::ShuffleVectorInst::isValidOperands(), llvm::ShuffleVectorConstantExpr::ShuffleVectorConstantExpr(), ShuffleVectorInst(), ShuffleVectorInst(), and validShuffleVectorIndex().

isZeroEltSplat()

bool llvm::ShuffleVectorInst::isZeroEltSplat ( ) const

inline

Return true if all elements of this shuffle are the same value as the first element of exactly one source vector without changing the length of that vector.

Example: shufflevector <4 x n> A, <4 x n> B, <undef,0,undef,0> TODO: Optionally allow length-changing shuffles. TODO: Optionally allow splats from other elements.

Definition at line 2168 of file Instructions.h.

References changesLength(), and isZeroEltSplatMask().

isZeroEltSplatMask() [1/2]

bool ShuffleVectorInst::isZeroEltSplatMask ( ArrayRef< int > Mask, int NumSrcElts )

static

Return true if this shuffle mask chooses all elements with the same value as the first element of exactly one source vector.

Example: <4,undef,undef,4> This assumes that vector operands (of length NumSrcElts) are the same length as the mask.

Definition at line 1979 of file Instructions.cpp.

References I, and isSingleSourceMask().

Referenced by llvm::BasicTTIImplBase< BasicTTIImpl >::improveShuffleKindFromMask(), isZeroEltSplat(), llvm::sandboxir::ShuffleVectorInst::isZeroEltSplatMask(), llvm::sandboxir::ShuffleVectorInst::isZeroEltSplatMask(), and isZeroEltSplatMask().

isZeroEltSplatMask() [2/2]

bool llvm::ShuffleVectorInst::isZeroEltSplatMask ( const Constant * Mask, int NumSrcElts )

inlinestatic

Definition at line 2155 of file Instructions.h.

References assert(), getShuffleMask(), and isZeroEltSplatMask().

operator delete()

void llvm::ShuffleVectorInst::operator delete ( void * Ptr )

inline

Definition at line 1960 of file Instructions.h.

References Ptr.

operator new()

void * llvm::ShuffleVectorInst::operator new ( size_t S )

inline

Definition at line 1959 of file Instructions.h.

setShuffleMask()

void ShuffleVectorInst::setShuffleMask

(

ArrayRef< int >

Mask

)

Definition at line 1890 of file Instructions.cpp.

References convertShuffleMaskForBitcode(), and getType().

Referenced by commute(), ShuffleVectorInst(), and ShuffleVectorInst().

Friends And Related Symbol Documentation

Instruction

friend class Instruction

friend

Iterator for Instructions in a `BasicBlock.

/ \Returns an sandboxir::Instruction & when derereferenced. class BBIterator { public: using difference_type = std::ptrdiff_t; using value_type = Instruction; using pointer = value_type *; using reference = value_type &; using iterator_category = std::bidirectional_iterator_tag;

private: llvm::BasicBlock *BB; llvm::BasicBlock::iterator It; Context *Ctx; LLVM_ABI pointer getInstr(llvm::BasicBlock::iterator It) const;

public: BBIterator() : BB(nullptr), Ctx(nullptr) {} BBIterator(llvm::BasicBlock <em>BB, llvm::BasicBlock::iterator It, Context *Ctx) : BB(BB), It(It), Ctx(Ctx) {} reference operator() const { return *getInstr(It); } LLVM_ABI BBIterator &operator++(); BBIterator operator++(int) { auto Copy = *this; ++*this; return Copy; } LLVM_ABI BBIterator &operator--(); BBIterator operator--(int) { auto Copy = *this; –*this; return Copy; } bool operator==(const BBIterator &Other) const { assert(Ctx == Other.Ctx && "BBIterators in different context!"); return It == Other.It; } bool operator!=(const BBIterator &Other) const { return !(*this == Other); } / \Returns the SBInstruction that corresponds to this iterator, or null if / the instruction is not found in the IR-to-SandboxIR tables. pointer get() const { return getInstr(It); } / \Returns the parent BB. LLVM_ABI BasicBlock *getNodeParent() const; };

/ Contains a list of sandboxir::Instruction's. class BasicBlock : public Value { / Builds a graph that contains all values in BB in their original form / i.e., no vectorization is taking place here. LLVM_ABI void buildBasicBlockFromLLVMIR(llvm::BasicBlock *LLVMBB); friend class Context; // For buildBasicBlockFromIR

Definition at line 1942 of file Instructions.h.

References cloneImpl(), Instruction, LLVM_ABI, and ShuffleVectorInst().

Referenced by classof(), Instruction, ShuffleVectorInst(), and ShuffleVectorInst().

---

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

• include/llvm/IR/Instructions.h
• lib/IR/Instructions.cpp