This instruction compares its operands according to the predicate given to the constructor. More...

#include "llvm/IR/Instructions.h"

Inheritance diagram for llvm::ICmpInst:

[legend]

Collaboration diagram for llvm::ICmpInst:

[legend]

Public Member Functions
	ICmpInst (Instruction InsertBefore, Predicate pred, Value LHS, Value *RHS, const Twine &NameStr="")
	Constructor with insert-before-instruction semantics. More...

	ICmpInst (BasicBlock &InsertAtEnd, Predicate pred, Value LHS, Value RHS, const Twine &NameStr="")
	Constructor with insert-at-end semantics. More...

	ICmpInst (Predicate pred, Value LHS, Value RHS, const Twine &NameStr="")
	Constructor with no-insertion semantics. More...

Predicate	getSignedPredicate () const
	For example, EQ->EQ, SLE->SLE, UGT->SGT, etc. More...

Predicate	getUnsignedPredicate () const
	For example, EQ->EQ, SLE->ULE, UGT->UGT, etc. More...

bool	isEquality () const
	Return true if this predicate is either EQ or NE. More...

bool	isCommutative () const

bool	isRelational () const
	Return true if the predicate is relational (not EQ or NE). More...

void	swapOperands ()
	Exchange the two operands to this instruction in such a way that it does not modify the semantics of the instruction. More...

Public Member Functions inherited from llvm::CmpInst
void *	operator new (size_t s)

OtherOps	getOpcode () const
	Get the opcode casted to the right type. More...

Predicate	getPredicate () const
	Return the predicate for this instruction. More...

void	setPredicate (Predicate P)
	Set the predicate for this instruction to the specified value. More...

bool	isFPPredicate () const

bool	isIntPredicate () const

Predicate	getInversePredicate () const
	For example, EQ -> NE, UGT -> ULE, SLT -> SGE, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc. More...

Predicate	getSwappedPredicate () const
	For example, EQ->EQ, SLE->SGE, ULT->UGT, OEQ->OEQ, ULE->UGE, OLT->OGT, etc. More...

Predicate	getFlippedStrictnessPredicate () const
	For predicate of kind "is X or equal to 0" returns the predicate "is X". More...

Predicate	getNonStrictPredicate () const
	For example, SGT -> SGE, SLT -> SLE, ULT -> ULE, UGT -> UGE. More...

	DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value)
	Provide more efficient getOperand methods. More...

void	swapOperands ()
	This is just a convenience that dispatches to the subclasses. More...

bool	isCommutative () const
	This is just a convenience that dispatches to the subclasses. More...

bool	isEquality () const
	This is just a convenience that dispatches to the subclasses. More...

bool	isSigned () const

bool	isUnsigned () const

Predicate	getSignedPredicate ()
	For example, ULT->SLT, ULE->SLE, UGT->SGT, UGE->SGE, SLT->Failed assert. More...

bool	isTrueWhenEqual () const
	This is just a convenience. More...

bool	isFalseWhenEqual () const
	This is just a convenience. More...

Public Member Functions inherited from llvm::Instruction
	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. More...

const Instruction *	user_back () const

const BasicBlock *	getParent () const

BasicBlock *	getParent ()

const Module *	getModule () const
	Return the module owning the function this instruction belongs to or nullptr it the function does not have a module. More...

Module *	getModule ()

const Function *	getFunction () const
	Return the function this instruction belongs to. More...

Function *	getFunction ()

void	removeFromParent ()
	This method unlinks 'this' from the containing basic block, but does not delete it. More...

SymbolTableList< Instruction >::iterator	eraseFromParent ()
	This method unlinks 'this' from the containing basic block and deletes it. More...

void	insertBefore (Instruction *InsertPos)
	Insert an unlinked instruction into a basic block immediately before the specified instruction. More...

void	insertAfter (Instruction *InsertPos)
	Insert an unlinked instruction into a basic block immediately after the specified instruction. More...

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. More...

void	moveBefore (BasicBlock &BB, SymbolTableList< Instruction >::iterator I)
	Unlink this instruction and insert into BB before I. More...

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. More...

unsigned	getOpcode () const
	Returns a member of one of the enums like Instruction::Add. More...

const char *	getOpcodeName () const

bool	isTerminator () const

bool	isUnaryOp () const

bool	isBinaryOp () const

bool	isIntDivRem () const

bool	isShift ()

bool	isCast () const

bool	isFuncletPad () const

bool	isExceptionalTerminator () const

bool	isLogicalShift () const
	Return true if this is a logical shift left or a logical shift right. More...

bool	isArithmeticShift () const
	Return true if this is an arithmetic shift right. More...

bool	isBitwiseLogicOp () const
	Return true if this is and/or/xor. More...

bool	hasMetadata () const
	Return true if this instruction has any metadata attached to it. More...

bool	hasMetadataOtherThanDebugLoc () const
	Return true if this instruction has metadata attached to it other than a debug location. More...

MDNode *	getMetadata (unsigned KindID) const
	Get the metadata of given kind attached to this Instruction. More...

MDNode *	getMetadata (StringRef Kind) const
	Get the metadata of given kind attached to this Instruction. More...

void	getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode *>> &MDs) const
	Get all metadata attached to this Instruction. More...

void	getAllMetadataOtherThanDebugLoc (SmallVectorImpl< std::pair< unsigned, MDNode *>> &MDs) const
	This does the same thing as getAllMetadata, except that it filters out the debug location. More...

void	getAAMetadata (AAMDNodes &N, bool Merge=false) const
	Fills the AAMDNodes structure with AA metadata from this instruction. More...

void	setMetadata (unsigned KindID, MDNode *Node)
	Set the metadata of the specified kind to the specified node. More...

void	setMetadata (StringRef Kind, MDNode *Node)

void	copyMetadata (const Instruction &SrcInst, ArrayRef< unsigned > WL=ArrayRef< unsigned >())
	Copy metadata from `SrcInst` to this instruction. More...

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. More...

void	setAAMetadata (const AAMDNodes &N)
	Sets the metadata on this instruction from the AAMDNodes structure. More...

bool	extractProfMetadata (uint64_t &TrueVal, uint64_t &FalseVal) const
	Retrieve the raw weight values of a conditional branch or select. More...

bool	extractProfTotalWeight (uint64_t &TotalVal) const
	Retrieve total raw weight values of a branch. More...

void	updateProfWeight (uint64_t S, uint64_t T)
	Updates branch_weights metadata by scaling it by `S` / `T`. More...

void	setProfWeight (uint64_t W)
	Sets the branch_weights metadata to `W` for CallInst. More...

void	setDebugLoc (DebugLoc Loc)
	Set the debug location information for this instruction. More...

const DebugLoc &	getDebugLoc () const
	Return the debug location for this node as a DebugLoc. More...

void	setHasNoUnsignedWrap (bool b=true)
	Set or clear the nuw flag on this instruction, which must be an operator which supports this flag. More...

void	setHasNoSignedWrap (bool b=true)
	Set or clear the nsw flag on this instruction, which must be an operator which supports this flag. More...

void	setIsExact (bool b=true)
	Set or clear the exact flag on this instruction, which must be an operator which supports this flag. More...

bool	hasNoUnsignedWrap () const
	Determine whether the no unsigned wrap flag is set. More...

bool	hasNoSignedWrap () const
	Determine whether the no signed wrap flag is set. More...

void	dropPoisonGeneratingFlags ()
	Drops flags that may cause this instruction to evaluate to poison despite having non-poison inputs. More...

bool	isExact () const
	Determine whether the exact flag is set. More...

void	setFast (bool B)
	Set or clear all fast-math-flags on this instruction, which must be an operator which supports this flag. More...

void	setHasAllowReassoc (bool B)
	Set or clear the reassociation flag on this instruction, which must be an operator which supports this flag. More...

void	setHasNoNaNs (bool B)
	Set or clear the no-nans flag on this instruction, which must be an operator which supports this flag. More...

void	setHasNoInfs (bool B)
	Set or clear the no-infs flag on this instruction, which must be an operator which supports this flag. More...

void	setHasNoSignedZeros (bool B)
	Set or clear the no-signed-zeros flag on this instruction, which must be an operator which supports this flag. More...

void	setHasAllowReciprocal (bool B)
	Set or clear the allow-reciprocal flag on this instruction, which must be an operator which supports this flag. More...

void	setHasApproxFunc (bool B)
	Set or clear the approximate-math-functions flag on this instruction, which must be an operator which supports this flag. More...

void	setFastMathFlags (FastMathFlags FMF)
	Convenience function for setting multiple fast-math flags on this instruction, which must be an operator which supports these flags. More...

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. More...

bool	isFast () const
	Determine whether all fast-math-flags are set. More...

bool	hasAllowReassoc () const
	Determine whether the allow-reassociation flag is set. More...

bool	hasNoNaNs () const
	Determine whether the no-NaNs flag is set. More...

bool	hasNoInfs () const
	Determine whether the no-infs flag is set. More...

bool	hasNoSignedZeros () const
	Determine whether the no-signed-zeros flag is set. More...

bool	hasAllowReciprocal () const
	Determine whether the allow-reciprocal flag is set. More...

bool	hasAllowContract () const
	Determine whether the allow-contract flag is set. More...

bool	hasApproxFunc () const
	Determine whether the approximate-math-functions flag is set. More...

FastMathFlags	getFastMathFlags () const
	Convenience function for getting all the fast-math flags, which must be an operator which supports these flags. More...

void	copyFastMathFlags (const Instruction *I)
	Copy I's fast-math flags. More...

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. More...

void	andIRFlags (const Value *V)
	Logical 'and' of any supported wrapping, exact, and fast-math flags of V and this instruction. More...

void	applyMergedLocation (const DILocation LocA, const DILocation LocB)
	Merge 2 debug locations and apply it to the Instruction. More...

bool	isAssociative () const LLVM_READONLY
	Return true if the instruction is associative: More...

bool	isCommutative () const
	Return true if the instruction is commutative: More...

bool	isIdempotent () const
	Return true if the instruction is idempotent: More...

bool	isNilpotent () const
	Return true if the instruction is nilpotent: More...

bool	mayWriteToMemory () const
	Return true if this instruction may modify memory. More...

bool	mayReadFromMemory () const
	Return true if this instruction may read memory. More...

bool	mayReadOrWriteMemory () const
	Return true if this instruction may read or write memory. More...

bool	isAtomic () const
	Return true if this instruction has an AtomicOrdering of unordered or higher. More...

bool	hasAtomicLoad () const
	Return true if this atomic instruction loads from memory. More...

bool	hasAtomicStore () const
	Return true if this atomic instruction stores to memory. More...

bool	mayThrow () const
	Return true if this instruction may throw an exception. More...

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. More...

bool	mayHaveSideEffects () const
	Return true if the instruction may have side effects. More...

bool	isSafeToRemove () const
	Return true if the instruction can be removed if the result is unused. More...

bool	isEHPad () const
	Return true if the instruction is a variety of EH-block. More...

bool	isLifetimeStartOrEnd () const
	Return true if the instruction is a llvm.lifetime.start or llvm.lifetime.end marker. More...

const Instruction *	getNextNonDebugInstruction () const
	Return a pointer to the next non-debug instruction in the same basic block as 'this', or nullptr if no such instruction exists. More...

Instruction *	getNextNonDebugInstruction ()

const Instruction *	getPrevNonDebugInstruction () const
	Return a pointer to the previous non-debug instruction in the same basic block as 'this', or nullptr if no such instruction exists. More...

Instruction *	getPrevNonDebugInstruction ()

Instruction *	clone () const
	Create a copy of 'this' instruction that is identical in all ways except the following: More...

bool	isIdenticalTo (const Instruction *I) const
	Return true if the specified instruction is exactly identical to the current one. More...

bool	isIdenticalToWhenDefined (const Instruction *I) const
	This is like isIdenticalTo, except that it ignores the SubclassOptionalData flags, which may specify conditions under which the instruction's result is undefined. More...

bool	isSameOperationAs (const Instruction *I, unsigned flags=0) const
	This function determines if the specified instruction executes the same operation as the current one. More...

bool	isUsedOutsideOfBlock (const BasicBlock *BB) const
	Return true if there are any uses of this instruction in blocks other than the specified block. More...

unsigned	getNumSuccessors () const
	Return the number of successors that this instruction has. More...

BasicBlock *	getSuccessor (unsigned Idx) const
	Return the specified successor. This instruction must be a terminator. More...

void	setSuccessor (unsigned Idx, BasicBlock *BB)
	Update the specified successor to point at the provided block. More...

void	dropUnknownNonDebugMetadata (ArrayRef< unsigned > KnownIDs)
	Drop all unknown metadata except for debug locations. More...

void	dropUnknownNonDebugMetadata ()

void	dropUnknownNonDebugMetadata (unsigned ID1)

void	dropUnknownNonDebugMetadata (unsigned ID1, unsigned ID2)

Public Member Functions inherited from llvm::User
	User (const User &)=delete

void	operator delete (void *Usr)
	Free memory allocated for User and Use objects. More...

void	operator delete (void *Usr, unsigned)
	Placement delete - required by std, called if the ctor throws. More...

void	operator delete (void *Usr, unsigned, bool)
	Placement delete - required by std, called if the ctor throws. More...

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

ArrayRef< const uint8_t >	getDescriptor () const
	Returns the descriptor co-allocated with this User instance. More...

MutableArrayRef< uint8_t >	getDescriptor ()
	Returns the descriptor co-allocated with this User instance. More...

void	setGlobalVariableNumOperands (unsigned NumOps)
	Set the number of operands on a GlobalVariable. More...

void	setNumHungOffUseOperands (unsigned NumOps)
	Subclasses with hung off uses need to manage the operand count themselves. More...

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. More...

void	replaceUsesOfWith (Value From, Value To)
	Replace uses of one Value with another. More...

Public Member Functions inherited from llvm::Value
	Value (const Value &)=delete

Value &	operator= (const Value &)=delete

void	deleteValue ()
	Delete a pointer to a generic Value. More...

void	dump () const
	Support for debugging, callable in GDB: V->dump() More...

Type *	getType () const
	All values are typed, get the type of this value. More...

LLVMContext &	getContext () const
	All values hold a context through their type. More...

bool	hasName () const

ValueName *	getValueName () const

void	setValueName (ValueName *VN)

StringRef	getName () const
	Return a constant reference to the value's name. More...

void	setName (const Twine &Name)
	Change the name of the value. More...

void	takeName (Value *V)
	Transfer the name from V to this value. More...

void	replaceAllUsesWith (Value *V)
	Change all uses of this to point to a new Value. More...

void	replaceNonMetadataUsesWith (Value *V)
	Change non-metadata uses of this to point to a new Value. More...

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. More...

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_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 user of this value. More...

bool	hasNUses (unsigned N) const
	Return true if this Value has exactly N users. More...

bool	hasNUsesOrMore (unsigned N) const
	Return true if this value has N users or more. More...

bool	isUsedInBasicBlock (const BasicBlock *BB) const
	Check if this value is used in the specified basic block. More...

unsigned	getNumUses () const
	This method computes the number of uses of this Value. More...

void	addUse (Use &U)
	This method should only be used by the Use class. More...

unsigned	getValueID () const
	Return an ID for the concrete type of this object. More...

unsigned	getRawSubclassOptionalData () const
	Return the raw optional flags value contained in this value. More...

void	clearSubclassOptionalData ()
	Clear the optional flags contained in this value. More...

bool	hasSameSubclassOptionalData (const Value *V) const
	Check the optional flags for equality. More...

bool	hasValueHandle () const
	Return true if there is a value handle associated with this value. More...

bool	isUsedByMetadata () const
	Return true if there is metadata referencing this value. More...

bool	isSwiftError () const
	Return true if this value is a swifterror value. More...

const Value *	stripPointerCasts () const
	Strip off pointer casts, all-zero GEPs, and aliases. More...

Value *	stripPointerCasts ()

const Value *	stripPointerCastsAndInvariantGroups () const
	Strip off pointer casts, all-zero GEPs, aliases and invariant group info. More...

Value *	stripPointerCastsAndInvariantGroups ()

const Value *	stripPointerCastsNoFollowAliases () const
	Strip off pointer casts and all-zero GEPs. More...

Value *	stripPointerCastsNoFollowAliases ()

const Value *	stripInBoundsConstantOffsets () const
	Strip off pointer casts and all-constant inbounds GEPs. More...

Value *	stripInBoundsConstantOffsets ()

const Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
	Accumulate offsets from stripInBoundsConstantOffsets(). More...

Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)

const Value *	stripInBoundsOffsets () const
	Strip off pointer casts and inbounds GEPs. More...

Value *	stripInBoundsOffsets ()

uint64_t	getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull) const
	Returns the number of bytes known to be dereferenceable for the pointer value. More...

unsigned	getPointerAlignment (const DataLayout &DL) const
	Returns an alignment of the pointer value. More...

const Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB) const
	Translate PHI node to its predecessor from the given basic block. More...

Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB)

void	mutateType (Type *Ty)
	Mutate the type of this Value to be of the specified type. More...

template<class Compare >
void	sortUseList (Compare Cmp)
	Sort the use-list. More...

void	reverseUseList ()
	Reverse the use-list. More...

void	print (raw_ostream &O, bool IsForDebug=false) const
	Implement operator<< on Value. More...

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. More...

void	printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const

Public Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock >
Instruction *	getPrevNode ()

const Instruction *	getPrevNode () const
	Get the previous node, or `nullptr` for the list head. More...

Instruction *	getNextNode ()
	Get the next node, or `nullptr` for the list tail. More...

const Instruction *	getNextNode () const
	Get the next node, or `nullptr` for the list tail. More...

Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, 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. More...

Static Public Member Functions
static Predicate	getSignedPredicate (Predicate pred)
	This is a static version that you can use without an instruction. More...

static Predicate	getUnsignedPredicate (Predicate pred)
	This is a static version that you can use without an instruction. More...

static bool	isEquality (Predicate P)
	Return true if this predicate is either EQ or NE. More...

static bool	isRelational (Predicate P)
	Return true if the predicate is relational (not EQ or NE). More...

static bool	classof (const Instruction *I)

static bool	classof (const Value *V)

Static Public Member Functions inherited from llvm::CmpInst
static CmpInst *	Create (OtherOps Op, Predicate predicate, Value S1, Value S2, const Twine &Name="", Instruction *InsertBefore=nullptr)
	Construct a compare instruction, given the opcode, the predicate and the two operands. More...

static CmpInst *	Create (OtherOps Op, Predicate predicate, Value S1, Value S2, const Twine &Name, BasicBlock *InsertAtEnd)
	Construct a compare instruction, given the opcode, the predicate and the two operands. More...

static bool	isFPPredicate (Predicate P)

static bool	isIntPredicate (Predicate P)

static StringRef	getPredicateName (Predicate P)

static Predicate	getInversePredicate (Predicate pred)
	For example, EQ -> NE, UGT -> ULE, SLT -> SGE, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc. More...

static Predicate	getSwappedPredicate (Predicate pred)
	This is a static version that you can use without an instruction available. More...

static Predicate	getFlippedStrictnessPredicate (Predicate pred)
	This is a static version that you can use without an instruction available. More...

static Predicate	getNonStrictPredicate (Predicate pred)
	This is a static version that you can use without an instruction available. More...

static Predicate	getSignedPredicate (Predicate pred)
	For example, ULT->SLT, ULE->SLE, UGT->SGT, UGE->SGE, SLT->Failed assert. More...

static bool	isUnsigned (Predicate predicate)

static bool	isSigned (Predicate predicate)

static bool	isOrdered (Predicate predicate)
	Determine if the predicate is an ordered operation. More...

static bool	isUnordered (Predicate predicate)
	Determine if the predicate is an unordered operation. More...

static bool	isTrueWhenEqual (Predicate predicate)
	Determine if the predicate is true when comparing a value with itself. More...

static bool	isFalseWhenEqual (Predicate predicate)
	Determine if the predicate is false when comparing a value with itself. More...

static bool	isImpliedTrueByMatchingCmp (Predicate Pred1, Predicate Pred2)
	Determine if Pred1 implies Pred2 is true when two compares have matching operands. More...

static bool	isImpliedFalseByMatchingCmp (Predicate Pred1, Predicate Pred2)
	Determine if Pred1 implies Pred2 is false when two compares have matching operands. More...

static bool	classof (const Instruction *I)
	Methods for support type inquiry through isa, cast, and dyn_cast: More...

static bool	classof (const Value *V)

static Type *	makeCmpResultType (Type *opnd_type)
	Create a result type for fcmp/icmp. More...

Static Public Member Functions inherited from llvm::Instruction
static 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	isShift (unsigned Opcode)
	Determine if the Opcode is one of the shift instructions. More...

static bool	isBitwiseLogicOp (unsigned Opcode)
	Determine if the Opcode is and/or/xor. More...

static bool	isCast (unsigned OpCode)
	Determine if the OpCode is one of the CastInst instructions. More...

static bool	isFuncletPad (unsigned OpCode)
	Determine if the OpCode is one of the FuncletPadInst instructions. More...

static bool	isExceptionalTerminator (unsigned OpCode)
	Returns true if the OpCode is a terminator related to exception handling. More...

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: More...

Static Public Member Functions inherited from llvm::User
static bool	classof (const Value *V)

Protected Member Functions
ICmpInst *	cloneImpl () const
	Clone an identical ICmpInst. More...

Protected Member Functions inherited from llvm::CmpInst
	CmpInst (Type ty, Instruction::OtherOps op, Predicate pred, Value LHS, Value RHS, const Twine &Name="", Instruction InsertBefore=nullptr, Instruction *FlagsSource=nullptr)

	CmpInst (Type ty, Instruction::OtherOps op, Predicate pred, Value LHS, Value RHS, const Twine &Name, BasicBlock InsertAtEnd)

Protected Member Functions inherited from llvm::Instruction
	~Instruction ()

void	setInstructionSubclassData (unsigned short D)

unsigned	getSubclassDataFromInstruction () const

	Instruction (Type Ty, unsigned iType, Use Ops, unsigned NumOps, Instruction *InsertBefore=nullptr)

	Instruction (Type Ty, unsigned iType, Use Ops, unsigned NumOps, BasicBlock *InsertAtEnd)

Protected Member Functions inherited from llvm::User
void *	operator new (size_t Size)
	Allocate a User with an operand pointer co-allocated. More...

void *	operator new (size_t Size, unsigned Us)
	Allocate a User with the operands co-allocated. More...

void *	operator new (size_t Size, unsigned Us, unsigned DescBytes)
	Allocate a User with the operands co-allocated. More...

	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. More...

void	growHungoffUses (unsigned N, bool IsPhi=false)
	Grow the number of hung off uses. More...

	~User ()=default

template<int Idx>
Use &	Op ()

template<int Idx>
const Use &	Op () 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. More...

unsigned short	getSubclassDataFromValue () const

void	setValueSubclassData (unsigned short D)

Protected Member Functions inherited from llvm::ilist_node_with_parent< Instruction, 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

Additional Inherited Members
Public Types inherited from llvm::CmpInst
enum	Predicate { FCMP_FALSE = 0, FCMP_OEQ = 1, FCMP_OGT = 2, FCMP_OGE = 3, FCMP_OLT = 4, FCMP_OLE = 5, FCMP_ONE = 6, FCMP_ORD = 7, FCMP_UNO = 8, FCMP_UEQ = 9, FCMP_UGT = 10, FCMP_UGE = 11, FCMP_ULT = 12, FCMP_ULE = 13, FCMP_UNE = 14, FCMP_TRUE = 15, FIRST_FCMP_PREDICATE = FCMP_FALSE, LAST_FCMP_PREDICATE = FCMP_TRUE, BAD_FCMP_PREDICATE = FCMP_TRUE + 1, ICMP_EQ = 32, ICMP_NE = 33, ICMP_UGT = 34, ICMP_UGE = 35, ICMP_ULT = 36, ICMP_ULE = 37, ICMP_SGT = 38, ICMP_SGE = 39, ICMP_SLT = 40, ICMP_SLE = 41, FIRST_ICMP_PREDICATE = ICMP_EQ, LAST_ICMP_PREDICATE = ICMP_SLE, BAD_ICMP_PREDICATE = ICMP_SLE + 1 }
	This enumeration lists the possible predicates for CmpInst subclasses. More...

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

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 >

Static Public Attributes inherited from llvm::Value
static const unsigned	MaxAlignmentExponent = 29
	The maximum alignment for instructions. More...

static const unsigned	MaximumAlignment = 1u << MaxAlignmentExponent

Protected Types inherited from llvm::Value
enum	: unsigned { NumUserOperandsBits = 28 }
	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 = ilist_iterator< ilist_detail::compute_node_options< Instruction, Options... >::type, false, false >

using	const_self_iterator = ilist_iterator< ilist_detail::compute_node_options< Instruction, Options... >::type, false, true >

using	reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< Instruction, Options... >::type, true, false >

using	const_reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< Instruction, Options... >::type, true, true >

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. More...

unsigned	NumUserOperands: NumUserOperandsBits

unsigned	IsUsedByMD: 1

unsigned	HasName: 1

unsigned	HasHungOffUses: 1

unsigned	HasDescriptor: 1

Detailed Description

This instruction compares its operands according to the predicate given to the constructor.

It only operates on integers or pointers. The operands must be identical types. Represent an integer comparison operator.

Definition at line 1190 of file Instructions.h.

Constructor & Destructor Documentation

◆ ICmpInst() [1/3]

llvm::ICmpInst::ICmpInst	(	Instruction *	InsertBefore,
		Predicate	pred,
		Value *	LHS,
		Value *	RHS,
		const Twine &	NameStr = `""`
	)

inline

Constructor with insert-before-instruction semantics.

Parameters

InsertBefore	Where to insert
pred	The predicate to use for the comparison
LHS	The left-hand-side of the expression
RHS	The right-hand-side of the expression
NameStr	Name of the instruction

Definition at line 1211 of file Instructions.h.

◆ ICmpInst() [2/3]

llvm::ICmpInst::ICmpInst	(	BasicBlock &	InsertAtEnd,
		Predicate	pred,
		Value *	LHS,
		Value *	RHS,
		const Twine &	NameStr = `""`
	)

inline

Constructor with insert-at-end semantics.

Parameters

InsertAtEnd	Block to insert into.
pred	The predicate to use for the comparison
LHS	The left-hand-side of the expression
RHS	The right-hand-side of the expression
NameStr	Name of the instruction

Definition at line 1226 of file Instructions.h.

◆ ICmpInst() [3/3]

llvm::ICmpInst::ICmpInst	(	Predicate	pred,
		Value *	LHS,
		Value *	RHS,
		const Twine &	NameStr = `""`
	)

inline

Constructor with no-insertion semantics.

Parameters

pred	The predicate to use for the comparison
LHS	The left-hand-side of the expression
RHS	The right-hand-side of the expression
NameStr	Name of the instruction

Definition at line 1241 of file Instructions.h.

Member Function Documentation

◆ classof() [1/2]

static bool llvm::ICmpInst::classof ( const Instruction * I )

inlinestatic

Definition at line 1316 of file Instructions.h.

References llvm::Instruction::getOpcode().

◆ classof() [2/2]

static bool llvm::ICmpInst::classof ( const Value * V )

inlinestatic

Definition at line 1319 of file Instructions.h.

References llvm::AllocaInst::classof().

◆ cloneImpl()

ICmpInst * ICmpInst::cloneImpl ( ) const

protected

Clone an identical ICmpInst.

Definition at line 3819 of file Instructions.cpp.

References llvm::CmpInst::getPredicate().

◆ getSignedPredicate() [1/2]

Predicate llvm::ICmpInst::getSignedPredicate ( ) const

inline

For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.

Returns: the predicate that would be the result if the operand were regarded as signed. Return the signed version of the predicate

Definition at line 1257 of file Instructions.h.

References llvm::PPC::getPredicate(), and pred.

Referenced by canonicalizeCmpWithConstant(), computePointerICmp(), foldICmpWithTruncSignExtendedVal(), processUGT_ADDCST_ADD(), SimplifyBSwap(), SimplifyICmpInst(), and transformToIndexedCompare().

◆ getSignedPredicate() [2/2]

ICmpInst::Predicate ICmpInst::getSignedPredicate ( Predicate pred )

static

This is a static version that you can use without an instruction.

Return the signed version of the predicate.

Definition at line 3429 of file Instructions.cpp.

References llvm::CmpInst::ICMP_EQ, llvm::CmpInst::ICMP_NE, llvm::CmpInst::ICMP_SGE, llvm::CmpInst::ICMP_SGT, llvm::CmpInst::ICMP_SLE, llvm::CmpInst::ICMP_SLT, llvm::CmpInst::ICMP_UGE, llvm::CmpInst::ICMP_UGT, llvm::CmpInst::ICMP_ULE, llvm::CmpInst::ICMP_ULT, llvm_unreachable, and pred.

◆ getUnsignedPredicate() [1/2]

Predicate llvm::ICmpInst::getUnsignedPredicate ( ) const

inline

For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.

Returns: the predicate that would be the result if the operand were regarded as unsigned. Return the unsigned version of the predicate

Definition at line 1269 of file Instructions.h.

References llvm::PPC::getPredicate().

Referenced by foldICmpWithMinMax(), foldICmpWithTruncSignExtendedVal(), processUGT_ADDCST_ADD(), llvm::InstCombiner::replacedSelectWithOperand(), and SimplifyICmpInst().

◆ getUnsignedPredicate() [2/2]

ICmpInst::Predicate ICmpInst::getUnsignedPredicate ( Predicate pred )

static

This is a static version that you can use without an instruction.

Return the unsigned version of the predicate.

Definition at line 3442 of file Instructions.cpp.

References llvm::CmpInst::ICMP_EQ, llvm::CmpInst::ICMP_NE, llvm::CmpInst::ICMP_SGE, llvm::CmpInst::ICMP_SGT, llvm::CmpInst::ICMP_SLE, llvm::CmpInst::ICMP_SLT, llvm::CmpInst::ICMP_UGE, llvm::CmpInst::ICMP_UGT, llvm::CmpInst::ICMP_ULE, llvm::CmpInst::ICMP_ULT, llvm_unreachable, and pred.

◆ isCommutative()

bool llvm::ICmpInst::isCommutative ( ) const

inline

Returns: true if the predicate of this ICmpInst is commutative Determine if this relation is commutative.

Definition at line 1291 of file Instructions.h.

◆ isEquality() [1/2]

static bool llvm::ICmpInst::isEquality ( Predicate P )

inlinestatic

Return true if this predicate is either EQ or NE.

This also tests for commutativity.

Definition at line 1279 of file Instructions.h.

Referenced by canonicalizeSaturatedSubtract(), EqualityPropUnSafe(), foldICmpShlOne(), foldICmpWithMinMax(), foldICmpWithTruncSignExtendedVal(), foldSelectICmpAndOr(), getValueFromICmpCondition(), isAllocSiteRemovable(), processUGT_ADDCST_ADD(), ReplaceUsesOfWith(), transformToIndexedCompare(), TryToMergeLandingPad(), TypeSizeToSizeIndex(), llvm::InstCombiner::visitICmpInst(), llvm::InstCombiner::visitTrunc(), and llvm::InstCombiner::visitZExt().

◆ isEquality() [2/2]

bool llvm::ICmpInst::isEquality ( ) const

inline

Return true if this predicate is either EQ or NE.

This also tests for commutativity.

Definition at line 1285 of file Instructions.h.

References llvm::PPC::getPredicate().

Referenced by areInverseVectorBitmasks(), canonicalizeSaturatedSubtract(), llvm::ConstantFoldCompareInstruction(), foldICmpWithTruncSignExtendedVal(), foldLogOpOfMaskedICmps(), foldLogOpOfMaskedICmpsAsymmetric(), foldSelectBinOpIdentity(), foldSelectICmpAnd(), foldSignedTruncationCheck(), getMaskedTypeForICmpPair(), llvm::predicatesFoldable(), SimplifyICmpInst(), llvm::ScalarEvolution::SimplifyICmpOperands(), simplifyICmpWithBinOp(), simplifySelectWithICmpCond(), and simplifyUnsignedRangeCheck().

◆ isRelational() [1/2]

bool llvm::ICmpInst::isRelational ( ) const

inline

Return true if the predicate is relational (not EQ or NE).

Definition at line 1295 of file Instructions.h.

Referenced by IsKnownPredicateViaAddRecStart(), isSignTest(), and TypeSizeToSizeIndex().

◆ isRelational() [2/2]

static bool llvm::ICmpInst::isRelational ( Predicate P )

inlinestatic

Return true if the predicate is relational (not EQ or NE).

Definition at line 1301 of file Instructions.h.

◆ swapOperands()

void llvm::ICmpInst::swapOperands ( )

inline

Exchange the two operands to this instruction in such a way that it does not modify the semantics of the instruction.

The predicate value may be changed to retain the same result if the predicate is order dependent (e.g. ult). Swap operands and adjust predicate.

Definition at line 1310 of file Instructions.h.

References llvm::PPC::getSwappedPredicate(), and std::swap().

Referenced by areInverseVectorBitmasks(), foldSignedTruncationCheck(), foldXorToXor(), and llvm::InstCombiner::visitICmpInst().

Friends And Related Function Documentation

◆ Instruction

friend class Instruction

friend

Definition at line 1204 of file Instructions.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ICmpInst() [1/3]

◆ ICmpInst() [2/3]

◆ ICmpInst() [3/3]

Member Function Documentation

◆ classof() [1/2]

◆ classof() [2/2]

◆ cloneImpl()

◆ getSignedPredicate() [1/2]

◆ getSignedPredicate() [2/2]

◆ getUnsignedPredicate() [1/2]

◆ getUnsignedPredicate() [2/2]

◆ isCommutative()

◆ isEquality() [1/2]

◆ isEquality() [2/2]

◆ isRelational() [1/2]

◆ isRelational() [2/2]

◆ swapOperands()

Friends And Related Function Documentation

◆ Instruction