LLVM 20.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
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:
Inheritance graph
[legend]

Public Member Functions

 ShuffleVectorInst (Value *V1, Value *Mask, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
 
 ShuffleVectorInst (Value *V1, ArrayRef< int > Mask, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
 
 ShuffleVectorInst (Value *V1, Value *V2, Value *Mask, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
 
 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)
 
void commute ()
 Swap the operands and adjust the mask to preserve the semantics of the instruction.
 
VectorTypegetType () 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.
 
ConstantgetShuffleMaskForBitcode () const
 Return the mask for this instruction, for use in bitcode.
 
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.
 
bool isIdentityWithPadding () const
 Return true if this shuffle lengthens exactly one source vector with undefs in the high elements.
 
bool isIdentityWithExtract () const
 Return true if this shuffle extracts the first N elements of exactly one source vector.
 
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.
 
bool isReplicationMask (int &ReplicationFactor, int &VF) const
 Return true if this shuffle mask is a replication mask.
 
bool isOneUseSingleSourceMask (int VF) const
 Return true if this shuffle mask is a one-use-single-source("clustered") mask.
 
bool isInterleave (unsigned Factor)
 Return if this shuffle interleaves its two input vectors together.
 
- Public Member Functions inherited from llvm::Instruction
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.
 
std::optional< simple_ilist< DbgRecord >::iterator > getDbgReinsertionPosition ()
 Return an iterator to the position of the "Next" DbgRecord after this instruction, or std::nullopt.
 
bool hasDbgRecords () const
 Returns true if any DbgRecords are attached to this instruction.
 
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.
 
void dropDbgRecords ()
 Erase any DbgRecords attached to this instruction.
 
void dropOneDbgRecord (DbgRecord *I)
 Erase a single DbgRecord I that is attached to this instruction.
 
void handleMarkerRemoval ()
 Handle the debug-info implications of this instruction being removed.
 
 Instruction (const Instruction &)=delete
 
Instructionoperator= (const Instruction &)=delete
 
Instructionuser_back ()
 Specialize the methods defined in Value, as we know that an instruction can only be used by other instructions.
 
const Instructionuser_back () const
 
const ModulegetModule () const
 Return the module owning the function this instruction belongs to or nullptr it the function does not have a module.
 
ModulegetModule ()
 
const FunctiongetFunction () const
 Return the function this instruction belongs to.
 
FunctiongetFunction ()
 
const DataLayoutgetDataLayout () const
 Get the data layout of the module this instruction belongs to.
 
void removeFromParent ()
 This method unlinks 'this' from the containing basic block, but does not delete it.
 
InstListType::iterator eraseFromParent ()
 This method unlinks 'this' from the containing basic block and deletes it.
 
void insertBefore (Instruction *InsertPos)
 Insert an unlinked instruction into a basic block immediately before the specified instruction.
 
void insertBefore (InstListType::iterator InsertPos)
 Insert an unlinked instruction into a basic block immediately before the specified instruction.
 
void insertAfter (Instruction *InsertPos)
 Insert an unlinked instruction into a basic block immediately after the specified instruction.
 
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.
 
void insertBefore (BasicBlock &BB, InstListType::iterator InsertPos)
 
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.
 
void moveBeforePreserving (Instruction *MovePos)
 Perform a moveBefore operation, while signalling that the caller intends to preserve the original ordering of instructions.
 
void moveBefore (BasicBlock &BB, InstListType::iterator I)
 Unlink this instruction and insert into BB before I.
 
void moveBeforePreserving (BasicBlock &BB, InstListType::iterator I)
 (See other overload for moveBeforePreserving).
 
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.
 
void moveAfterPreserving (Instruction *MovePos)
 See moveBeforePreserving .
 
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.
 
std::optional< InstListType::iteratorgetInsertionPointAfterDef ()
 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 chargetOpcodeName () const
 
bool isTerminator () const
 
bool isUnaryOp () const
 
bool isBinaryOp () const
 
bool isIntDivRem () const
 
bool isShift () const
 
bool isCast () const
 
bool isFuncletPad () const
 
bool isSpecialTerminator () const
 
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.
 
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.
 
MDNodegetMetadata (unsigned KindID) const
 Get the metadata of given kind attached to this Instruction.
 
MDNodegetMetadata (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.
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set the metadata of the specified kind to the specified node.
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void copyMetadata (const Instruction &SrcInst, ArrayRef< unsigned > WL=ArrayRef< unsigned >())
 Copy metadata from SrcInst to this instruction.
 
void eraseMetadataIf (function_ref< bool(unsigned, MDNode *)> Pred)
 Erase all metadata that matches the predicate.
 
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.
 
void addAnnotationMetadata (StringRef Annotation)
 Adds an !annotation metadata node with Annotation to this instruction.
 
void addAnnotationMetadata (SmallVector< StringRef > Annotations)
 Adds an !annotation metadata node with an array of Annotations as a tuple to this instruction.
 
AAMDNodes getAAMetadata () const
 Returns the AA metadata for this instruction.
 
void setAAMetadata (const AAMDNodes &N)
 Sets the AA metadata on this instruction from the AAMDNodes structure.
 
void setNoSanitizeMetadata ()
 Sets the nosanitize metadata on this instruction.
 
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 DebugLocgetDebugLoc () const
 Return the debug location for this node as a DebugLoc.
 
const DebugLocgetStableDebugLoc () 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.
 
void setHasNoUnsignedWrap (bool b=true)
 Set or clear the nuw flag on this instruction, which must be an operator which supports this flag.
 
void setHasNoSignedWrap (bool b=true)
 Set or clear the nsw flag on this instruction, which must be an operator which supports this flag.
 
void setIsExact (bool b=true)
 Set or clear the exact flag on this instruction, which must be an operator which supports this flag.
 
void setNonNeg (bool b=true)
 Set or clear the nneg flag on this instruction, which must be a zext instruction.
 
bool hasNoUnsignedWrap () const LLVM_READONLY
 Determine whether the no unsigned wrap flag is set.
 
bool hasNoSignedWrap () const LLVM_READONLY
 Determine whether the no signed wrap flag is set.
 
bool hasNonNeg () const LLVM_READONLY
 Determine whether the the nneg flag is set.
 
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.
 
void dropPoisonGeneratingFlags ()
 Drops flags that may cause this instruction to evaluate to poison despite having non-poison inputs.
 
bool hasPoisonGeneratingMetadata () const LLVM_READONLY
 Return true if this instruction has poison-generating metadata.
 
void dropPoisonGeneratingMetadata ()
 Drops metadata that may generate poison.
 
bool hasPoisonGeneratingReturnAttributes () const LLVM_READONLY
 Return true if this instruction has poison-generating attribute.
 
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.
 
void dropUBImplyingAttrsAndUnknownMetadata (ArrayRef< unsigned > KnownIDs={})
 This function drops non-debug unknown metadata (through dropUnknownNonDebugMetadata).
 
void dropUBImplyingAttrsAndMetadata ()
 Drop any attributes or metadata that can cause immediate undefined behavior.
 
bool isExact () const LLVM_READONLY
 Determine whether the exact flag is set.
 
void setFast (bool B)
 Set or clear all fast-math-flags on this instruction, which must be an operator which supports this flag.
 
void setHasAllowReassoc (bool B)
 Set or clear the reassociation flag on this instruction, which must be an operator which supports this flag.
 
void setHasNoNaNs (bool B)
 Set or clear the no-nans flag on this instruction, which must be an operator which supports this flag.
 
void setHasNoInfs (bool B)
 Set or clear the no-infs flag on this instruction, which must be an operator which supports this flag.
 
void setHasNoSignedZeros (bool B)
 Set or clear the no-signed-zeros flag on this instruction, which must be an operator which supports this flag.
 
void setHasAllowReciprocal (bool B)
 Set or clear the allow-reciprocal flag on this instruction, which must be an operator which supports this flag.
 
void setHasAllowContract (bool B)
 Set or clear the allow-contract flag on this instruction, which must be an operator which supports this flag.
 
void setHasApproxFunc (bool B)
 Set or clear the approximate-math-functions flag on this instruction, which must be an operator which supports this flag.
 
void setFastMathFlags (FastMathFlags FMF)
 Convenience function for setting multiple fast-math flags on this instruction, which must be an operator which supports these flags.
 
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.
 
bool isFast () const LLVM_READONLY
 Determine whether all fast-math-flags are set.
 
bool hasAllowReassoc () const LLVM_READONLY
 Determine whether the allow-reassociation flag is set.
 
bool hasNoNaNs () const LLVM_READONLY
 Determine whether the no-NaNs flag is set.
 
bool hasNoInfs () const LLVM_READONLY
 Determine whether the no-infs flag is set.
 
bool hasNoSignedZeros () const LLVM_READONLY
 Determine whether the no-signed-zeros flag is set.
 
bool hasAllowReciprocal () const LLVM_READONLY
 Determine whether the allow-reciprocal flag is set.
 
bool hasAllowContract () const LLVM_READONLY
 Determine whether the allow-contract flag is set.
 
bool hasApproxFunc () const LLVM_READONLY
 Determine whether the approximate-math-functions flag is set.
 
FastMathFlags getFastMathFlags () const LLVM_READONLY
 Convenience function for getting all the fast-math flags, which must be an operator which supports these flags.
 
void copyFastMathFlags (const Instruction *I)
 Copy I's fast-math flags.
 
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.
 
void andIRFlags (const Value *V)
 Logical 'and' of any supported wrapping, exact, and fast-math flags of V and this instruction.
 
void applyMergedLocation (DILocation *LocA, DILocation *LocB)
 Merge 2 debug locations and apply it to the Instruction.
 
void updateLocationAfterHoist ()
 Updates the debug location given that the instruction has been hoisted from a block to a predecessor of that block.
 
void dropLocation ()
 Drop the instruction's debug location.
 
void mergeDIAssignID (ArrayRef< const Instruction * > SourceInstructions)
 Merge the DIAssignID metadata from this instruction and those attached to instructions in SourceInstructions.
 
bool isAssociative () const LLVM_READONLY
 Return true if the instruction is associative:
 
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:
 
bool mayWriteToMemory () const LLVM_READONLY
 Return true if this instruction may modify memory.
 
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.
 
bool isAtomic () const LLVM_READONLY
 Return true if this instruction has an AtomicOrdering of unordered or higher.
 
bool hasAtomicLoad () const LLVM_READONLY
 Return true if this atomic instruction loads from memory.
 
bool hasAtomicStore () const LLVM_READONLY
 Return true if this atomic instruction stores to memory.
 
bool isVolatile () const LLVM_READONLY
 Return true if this instruction has a volatile memory access.
 
TypegetAccessType () const LLVM_READONLY
 Return the type this instruction accesses in memory, if any.
 
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.
 
bool mayHaveSideEffects () const LLVM_READONLY
 Return true if the instruction may have side effects.
 
bool isSafeToRemove () const LLVM_READONLY
 Return true if the instruction can be removed if the result is unused.
 
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.
 
bool isLifetimeStartOrEnd () const LLVM_READONLY
 Return true if the instruction is a llvm.lifetime.start or llvm.lifetime.end marker.
 
bool isLaunderOrStripInvariantGroup () const LLVM_READONLY
 Return true if the instruction is a llvm.launder.invariant.group or llvm.strip.invariant.group.
 
bool isDebugOrPseudoInst () const LLVM_READONLY
 Return true if the instruction is a DbgInfoIntrinsic or PseudoProbeInst.
 
const InstructiongetNextNonDebugInstruction (bool SkipPseudoOp=false) const
 Return a pointer to the next non-debug instruction in the same basic block as 'this', or nullptr if no such instruction exists.
 
InstructiongetNextNonDebugInstruction (bool SkipPseudoOp=false)
 
const InstructiongetPrevNonDebugInstruction (bool SkipPseudoOp=false) const
 Return a pointer to the previous non-debug instruction in the same basic block as 'this', or nullptr if no such instruction exists.
 
InstructiongetPrevNonDebugInstruction (bool SkipPseudoOp=false)
 
Instructionclone () const
 Create a copy of 'this' instruction that is identical in all ways except the following:
 
bool isIdenticalTo (const Instruction *I) const LLVM_READONLY
 Return true if the specified instruction is exactly identical to the current one.
 
bool isIdenticalToWhenDefined (const Instruction *I) 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.
 
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.
 
bool hasSameSpecialState (const Instruction *I2, bool IgnoreAlignment=false) const LLVM_READONLY
 This function determines if the speficied instruction has the same "special" characteristics as the current one.
 
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.
 
unsigned getNumSuccessors () const LLVM_READONLY
 Return the number of successors that this instruction has.
 
BasicBlockgetSuccessor (unsigned Idx) const LLVM_READONLY
 Return the specified successor. This instruction must be a terminator.
 
void setSuccessor (unsigned Idx, BasicBlock *BB)
 Update the specified successor to point at the provided block.
 
void replaceSuccessorWith (BasicBlock *OldBB, BasicBlock *NewBB)
 Replace specified successor OldBB to point at the provided block.
 
void dropUnknownNonDebugMetadata (ArrayRef< unsigned > KnownIDs=std::nullopt)
 Drop all unknown metadata except for debug locations.
 
- Public Member Functions inherited from llvm::User
 User (const User &)=delete
 
void operator delete (void *Usr)
 Free memory allocated for User and Use objects.
 
void operator delete (void *Usr, unsigned)
 Placement delete - required by std, called if the ctor throws.
 
void operator delete (void *Usr, unsigned, unsigned)
 Placement delete - required by std, called if the ctor throws.
 
const UsegetOperandList () const
 
UsegetOperandList ()
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
ArrayRef< const uint8_t > getDescriptor () const
 Returns the descriptor co-allocated with this User instance.
 
MutableArrayRef< uint8_t > getDescriptor ()
 Returns the descriptor co-allocated with this User instance.
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable.
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves.
 
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_iteratoroperand_values ()
 
const_value_op_iterator value_op_begin () const
 
const_value_op_iterator value_op_end () const
 
iterator_range< const_value_op_iteratoroperand_values () const
 
void dropAllReferences ()
 Drop all references to operands.
 
bool replaceUsesOfWith (Value *From, Value *To)
 Replace uses of one Value with another.
 
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value.
 
void dump () const
 Support for debugging, callable in GDB: V->dump()
 
TypegetType () const
 All values are typed, get the type of this value.
 
LLVMContextgetContext () const
 All values hold a context through their type.
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name.
 
void setName (const Twine &Name)
 Change the name of the value.
 
void takeName (Value *V)
 Transfer the name from V to this value.
 
std::string getNameOrAsOperand () const
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value.
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value.
 
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.
 
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.
 
void assertModuleIsMaterializedImpl () const
 
void assertModuleIsMaterialized () const
 
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_iteratormaterialized_uses ()
 
iterator_range< const_use_iteratormaterialized_uses () const
 
iterator_range< use_iteratoruses ()
 
iterator_range< const_use_iteratoruses () 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
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratormaterialized_users ()
 
iterator_range< const_user_iteratormaterialized_users () const
 
iterator_range< user_iteratorusers ()
 
iterator_range< const_user_iteratorusers () const
 
bool hasOneUse () const
 Return true if there is exactly one use of this value.
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N uses.
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N uses or more.
 
bool hasOneUser () const
 Return true if there is exactly one user of this value.
 
UsegetSingleUndroppableUse ()
 Return true if there is exactly one use of this value that cannot be dropped.
 
const UsegetSingleUndroppableUse () const
 
UsergetUniqueUndroppableUser ()
 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 UsergetUniqueUndroppableUser () const
 
bool hasNUndroppableUses (unsigned N) const
 Return true if there this value.
 
bool hasNUndroppableUsesOrMore (unsigned N) const
 Return true if this value has N uses or more.
 
void dropDroppableUses (llvm::function_ref< bool(const Use *)> ShouldDrop=[](const Use *) { return true;})
 Remove every uses that can safely be removed.
 
void dropDroppableUsesIn (User &Usr)
 Remove every use of this value in User that can safely be removed.
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block.
 
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.
 
bool isSwiftError () const
 Return true if this value is a swifterror value.
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs and address space casts.
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndAliases () const
 Strip off pointer casts, all-zero GEPs, address space casts, and aliases.
 
ValuestripPointerCastsAndAliases ()
 
const ValuestripPointerCastsSameRepresentation () const
 Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same.
 
ValuestripPointerCastsSameRepresentation ()
 
const ValuestripPointerCastsForAliasAnalysis () const
 Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info.
 
ValuestripPointerCastsForAliasAnalysis ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs.
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr) const
 Accumulate the constant offset this value has compared to a base pointer.
 
ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false)
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false.
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) const
 Strip off pointer casts and inbounds GEPs.
 
ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {})
 
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.
 
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.
 
uint64_t getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull, bool &CanBeFreed) const
 Returns the number of bytes known to be dereferenceable for the pointer value.
 
Align getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value.
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block.
 
ValueDoPHITranslation (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.
 
void reverseUseList ()
 Reverse the use-list.
 
void print (raw_ostream &O, bool IsForDebug=false) const
 Implement operator<< on Value.
 
void print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const
 
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.
 
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 > >
InstructiongetPrevNode ()
 
const InstructiongetPrevNode () const
 Get the previous node, or nullptr for the list head.
 
InstructiongetNextNode ()
 Get the next node, or nullptr for the list tail.
 
const InstructiongetNextNode () const
 Get the next node, or nullptr for the list tail.
 
- Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
self_iterator getIterator ()
 
const_self_iterator getIterator () const
 
reverse_self_iterator getReverseIterator ()
 
const_reverse_self_iterator getReverseIterator () const
 
bool isSentinel () const
 Check whether this is the sentinel node.
 
- Public Member Functions inherited from llvm::ilist_detail::node_parent_access< NodeTy, ParentTy >
const ParentTy * getParent () const
 
ParentTy * getParent ()
 
void setParent (ParentTy *Parent)
 

Static Public Member Functions

static 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 bool isValidOperands (const Value *V1, const Value *V2, ArrayRef< int > Mask)
 
static void getShuffleMask (const Constant *Mask, SmallVectorImpl< int > &Result)
 Convert the input shuffle mask operand to a vector of integers.
 
static ConstantconvertShuffleMaskForBitcode (ArrayRef< int > Mask, Type *ResultTy)
 
static 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 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 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 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 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 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 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 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 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 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 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 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 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 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 const chargetOpcodeName (unsigned Opcode)
 
static bool isTerminator (unsigned Opcode)
 
static bool isUnaryOp (unsigned Opcode)
 
static bool isBinaryOp (unsigned Opcode)
 
static bool isIntDivRem (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 void dropDroppableUse (Use &U)
 Remove the droppable use U.
 

Protected Member Functions

ShuffleVectorInstcloneImpl () const
 
- Protected Member Functions inherited from llvm::Instruction
 ~Instruction ()
 
template<typename BitfieldElement >
BitfieldElement::Type getSubclassData () const
 
template<typename BitfieldElement >
void setSubclassData (typename BitfieldElement::Type Value)
 
 Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, InsertPosition InsertBefore=nullptr)
 
- Protected Member Functions inherited from llvm::User
void * operator new (size_t Size)
 Allocate a User with an operand pointer co-allocated.
 
void * operator new (size_t Size, unsigned Us)
 Allocate a User with the operands co-allocated.
 
void * operator new (size_t Size, unsigned Us, unsigned DescBytes)
 Allocate a User with the operands co-allocated.
 
 User (Type *ty, unsigned vty, Use *, unsigned NumOps)
 
void allocHungoffUses (unsigned N, bool IsPhi=false)
 Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User.
 
void growHungoffUses (unsigned N, bool IsPhi=false)
 Grow the number of hung off uses.
 
 ~User ()=default
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
 ~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.
 
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.
 
bool eraseMetadata (unsigned KindID)
 Erase all metadata attachments with the given kind.
 
void eraseMetadataIf (function_ref< bool(unsigned, MDNode *)> Pred)
 Erase all metadata attachments matching the given predicate.
 
void clearMetadata ()
 Erase all metadata attached to this Value.
 
MDNodegetMetadataImpl (unsigned KindID) const
 Get metadata for the given kind, if any.
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
MDNodegetMetadata (unsigned KindID) const
 Get the current metadata attachments for the given kind, if any.
 
MDNodegetMetadata (StringRef Kind) const
 
void getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
 Appends all attachments with the given ID to MDs in insertion order.
 
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
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set a particular kind of metadata attachment.
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void addMetadata (unsigned KindID, MDNode &MD)
 Add a metadata attachment.
 
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< T, Options... >::type >
 ilist_node_impl ()=default
 

Friends

class Instruction
 

Additional Inherited Members

- Public Types inherited from llvm::Instruction
enum  OperationEquivalenceFlags { CompareIgnoringAlignment = 1<<0 , CompareUsingScalarTypes = 1<<1 }
 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 = SymbolTableList< Instruction, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >
 
- 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
DbgMarkerDebugMarker = 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 = typename Bitfield::Element< unsigned, Offset, 6, Value::MaxAlignmentExponent >
 
template<unsigned Offset>
using BoolBitfieldElementT = typename Bitfield::Element< bool, Offset, 1 >
 
template<unsigned Offset>
using AtomicOrderingBitfieldElementT = typename Bitfield::Element< AtomicOrdering, Offset, 3, AtomicOrdering::LAST >
 
- 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< T, Options... >::type >
using self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, false, false >::type
 
using const_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, false, true >::type
 
using reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, true, false >::type
 
using const_reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, true, true >::type
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (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 1808 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 1661 of file Instructions.cpp.

◆ ShuffleVectorInst() [2/4]

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

Definition at line 1666 of file Instructions.cpp.

◆ ShuffleVectorInst() [3/4]

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

◆ ShuffleVectorInst() [4/4]

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

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 1885 of file Instructions.h.

References getType(), and llvm::SmallVectorBase< Size_T >::size().

Referenced by foldTruncShuffle().

◆ classof() [1/2]

static bool llvm::ShuffleVectorInst::classof ( const Instruction I)
inlinestatic

Definition at line 2281 of file Instructions.h.

References I.

◆ classof() [2/2]

static bool llvm::ShuffleVectorInst::classof ( const Value V)
inlinestatic

Definition at line 2284 of file Instructions.h.

◆ cloneImpl()

ShuffleVectorInst * ShuffleVectorInst::cloneImpl ( ) const
protected

Definition at line 4326 of file Instructions.cpp.

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

◆ commute()

void ShuffleVectorInst::commute ( )

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

Definition at line 1707 of file Instructions.cpp.

References assert(), getMaskValue(), getType(), llvm::PoisonMaskElem, setShuffleMask(), and llvm::SmallVectorBase< Size_T >::size().

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

◆ commuteShuffleMask()

static 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 2213 of file Instructions.h.

References assert(), and Idx.

Referenced by foldSelectShuffleOfSelectShuffle(), foldShuffleWithInsert(), and simplifyShuffleVectorInst().

◆ convertShuffleMaskForBitcode()

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

◆ 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 1855 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

◆ getShuffleMask() [2/3]

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

◆ 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 1864 of file Instructions.h.

References llvm::SmallVectorTemplateCommon< T, typename >::begin(), and llvm::SmallVectorTemplateCommon< T, typename >::end().

◆ 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 1872 of file Instructions.h.

◆ getType()

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

◆ 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 1896 of file Instructions.h.

References getType(), and llvm::SmallVectorBase< Size_T >::size().

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 2425 of file Instructions.cpp.

References matchShuffleAsBitRotate().

Referenced by 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 2149 of file Instructions.cpp.

References getShuffleMask(), getType(), and isIdentityMaskImpl().

◆ isDeInterleaveMaskOfFactor() [1/2]

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

Definition at line 2260 of file Instructions.h.

◆ 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 2378 of file Instructions.cpp.

References I, and Idx.

Referenced by llvm::AArch64TTIImpl::getShuffleCost(), and isDeInterleaveMask().

◆ 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 2009 of file Instructions.cpp.

References isSingleSourceMaskImpl(), and llvm::Offset.

Referenced by areExtractShuffleVectors(), and llvm::BasicTTIImplBase< T >::improveShuffleKindFromMask().

◆ isExtractSubvectorMask() [2/3]

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

Definition at line 2121 of file Instructions.h.

References assert().

◆ 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 2134 of file Instructions.h.

References getType().

◆ 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 1949 of file Instructions.h.

References getType(), and llvm::SmallVectorBase< Size_T >::size().

◆ 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 1882 of file Instructions.cpp.

References isIdentityMaskImpl().

Referenced by foldExtractSubvectorFromShuffleVector(), foldSelectShuffleOfSelectShuffle(), llvm::X86TTIImpl::getShuffleCost(), isRepeatedNonIdentityClusteredMask(), llvm::ARMTargetLowering::isShuffleMaskLegal(), lowerVECTOR_SHUFFLE(), and reorderOrder().

◆ isIdentityMask() [2/2]

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

Definition at line 1932 of file Instructions.h.

References assert().

◆ isIdentityWithExtract()

bool ShuffleVectorInst::isIdentityWithExtract ( ) const

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

Definition at line 2135 of file Instructions.cpp.

References getShuffleMask(), getType(), and isIdentityMaskImpl().

Referenced by 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 2111 of file Instructions.cpp.

References getShuffleMask(), getType(), 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 2038 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 getShuffleCost(), llvm::BasicTTIImplBase< T >::improveShuffleKindFromMask(), and lowerVECTOR_SHUFFLEAsVSlideup().

◆ isInsertSubvectorMask() [2/3]

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

Definition at line 2151 of file Instructions.h.

References assert().

◆ 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 2164 of file Instructions.h.

References getType().

◆ isInterleave()

bool ShuffleVectorInst::isInterleave ( unsigned  Factor)

Return if this shuffle interleaves its two input vectors together.

Definition at line 2283 of file Instructions.cpp.

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

Referenced by isReInterleaveMask().

◆ isInterleaveMask() [1/2]

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

Definition at line 2249 of file Instructions.h.

◆ 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 2294 of file Instructions.cpp.

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

Referenced by llvm::AArch64TTIImpl::getShuffleCost(), llvm::RISCVTTIImpl::getShuffleCost(), isInterleave(), 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 2252 of file Instructions.cpp.

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

Referenced by llvm::slpvectorizer::BoUpSLP::getReorderingData(), 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 2272 of file Instructions.cpp.

References getType(), 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 2191 of file Instructions.cpp.

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

◆ isReplicationMask() [2/3]

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

Definition at line 2181 of file Instructions.h.

References assert().

◆ isReplicationMask() [3/3]

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

Return true if this shuffle mask is a replication mask.

Definition at line 2237 of file Instructions.cpp.

References getType(), isReplicationMaskWithParams(), and llvm::SmallVectorBase< Size_T >::size().

◆ 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 2016 of file Instructions.h.

References isReverseMask(), and llvm::SmallVectorBase< Size_T >::size().

◆ 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 1890 of file Instructions.cpp.

References I, and isSingleSourceMask().

Referenced by llvm::BasicTTIImplBase< T >::improveShuffleKindFromMask(), and lowerBitreverseShuffle().

◆ isReverseMask() [2/2]

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

Definition at line 2005 of file Instructions.h.

References assert(), 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 1995 of file Instructions.h.

References llvm::SmallVectorBase< Size_T >::size().

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 1924 of file Instructions.cpp.

References I, and isSingleSourceMask().

Referenced by foldSelectShuffleOfSelectShuffle(), and llvm::BasicTTIImplBase< T >::improveShuffleKindFromMask().

◆ isSelectMask() [2/2]

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

Definition at line 1980 of file Instructions.h.

References assert().

◆ 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 1921 of file Instructions.h.

References llvm::SmallVectorBase< Size_T >::size().

◆ 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 1864 of file Instructions.cpp.

References isSingleSourceMaskImpl().

Referenced by GenerateFixedLengthSVETBL(), isOneUseSingleSourceMask(), isReverseMask(), isSelectMask(), and isZeroEltSplatMask().

◆ isSingleSourceMask() [2/2]

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

Definition at line 1910 of file Instructions.h.

References assert().

◆ 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 2111 of file Instructions.h.

References llvm::SmallVectorBase< Size_T >::size().

◆ 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 1975 of file Instructions.cpp.

References I.

Referenced by llvm::BasicTTIImplBase< T >::improveShuffleKindFromMask().

◆ isSpliceMask() [2/2]

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

Definition at line 2100 of file Instructions.h.

References assert().

◆ 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 2089 of file Instructions.h.

References llvm::SmallVectorBase< Size_T >::size().

◆ 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 1939 of file Instructions.cpp.

References I, and llvm::isPowerOf2_32().

Referenced by llvm::BasicTTIImplBase< T >::improveShuffleKindFromMask().

◆ isTransposeMask() [2/2]

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

Definition at line 2077 of file Instructions.h.

References assert().

◆ isValidOperands() [1/2]

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

◆ 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 1745 of file Instructions.cpp.

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

Referenced by llvm::ConstantExpr::getShuffleVector(), llvm::ShuffleVectorConstantExpr::ShuffleVectorConstantExpr(), 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 2039 of file Instructions.h.

References llvm::SmallVectorBase< Size_T >::size().

◆ 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 1910 of file Instructions.cpp.

References I, and isSingleSourceMask().

Referenced by llvm::BasicTTIImplBase< T >::improveShuffleKindFromMask().

◆ isZeroEltSplatMask() [2/2]

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

Definition at line 2026 of file Instructions.h.

References assert().

◆ operator delete()

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

Definition at line 1831 of file Instructions.h.

References Ptr.

◆ operator new()

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

Definition at line 1830 of file Instructions.h.

◆ setShuffleMask()

void ShuffleVectorInst::setShuffleMask ( ArrayRef< int >  Mask)

Friends And Related Function Documentation

◆ Instruction

friend class Instruction
friend

Definition at line 1814 of file Instructions.h.


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