LLVM  4.0.0
Macros | Functions
InstCombineCompares.cpp File Reference
#include "InstCombineInternal.h"
#include "llvm/ADT/APSInt.h"
#include "llvm/ADT/SetVector.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/Analysis/ConstantFolding.h"
#include "llvm/Analysis/InstructionSimplify.h"
#include "llvm/Analysis/MemoryBuiltins.h"
#include "llvm/Analysis/TargetLibraryInfo.h"
#include "llvm/Analysis/VectorUtils.h"
#include "llvm/IR/ConstantRange.h"
#include "llvm/IR/DataLayout.h"
#include "llvm/IR/GetElementPtrTypeIterator.h"
#include "llvm/IR/IntrinsicInst.h"
#include "llvm/IR/PatternMatch.h"
#include "llvm/Support/Debug.h"
Include dependency graph for InstCombineCompares.cpp:

Go to the source code of this file.

Macros

#define DEBUG_TYPE   "instcombine"
 

Functions

 STATISTIC (NumSel,"Number of select opts")
 
static ConstantIntextractElement (Constant *V, Constant *Idx)
 
static bool hasAddOverflow (ConstantInt *Result, ConstantInt *In1, ConstantInt *In2, bool IsSigned)
 
static bool addWithOverflow (Constant *&Result, Constant *In1, Constant *In2, bool IsSigned=false)
 Compute Result = In1+In2, returning true if the result overflowed for this type. More...
 
static bool hasSubOverflow (ConstantInt *Result, ConstantInt *In1, ConstantInt *In2, bool IsSigned)
 
static bool subWithOverflow (Constant *&Result, Constant *In1, Constant *In2, bool IsSigned=false)
 Compute Result = In1-In2, returning true if the result overflowed for this type. More...
 
static bool isBranchOnSignBitCheck (ICmpInst &I, bool isSignBit)
 Given an icmp instruction, return true if any use of this comparison is a branch on sign bit comparison. More...
 
static bool isSignBitCheck (ICmpInst::Predicate Pred, const APInt &RHS, bool &TrueIfSigned)
 Given an exploded icmp instruction, return true if the comparison only checks the sign bit. More...
 
static bool isSignTest (ICmpInst::Predicate &Pred, const APInt &C)
 Returns true if the exploded icmp can be expressed as a signed comparison to zero and updates the predicate accordingly. More...
 
static void computeSignedMinMaxValuesFromKnownBits (const APInt &KnownZero, const APInt &KnownOne, APInt &Min, APInt &Max)
 Given a signed integer type and a set of known zero and one bits, compute the maximum and minimum values that could have the specified known zero and known one bits, returning them in Min/Max. More...
 
static void computeUnsignedMinMaxValuesFromKnownBits (const APInt &KnownZero, const APInt &KnownOne, APInt &Min, APInt &Max)
 Given an unsigned integer type and a set of known zero and one bits, compute the maximum and minimum values that could have the specified known zero and known one bits, returning them in Min/Max. More...
 
static ValueevaluateGEPOffsetExpression (User *GEP, InstCombiner &IC, const DataLayout &DL)
 Return a value that can be used to compare the offset implied by a GEP to zero. More...
 
static bool canRewriteGEPAsOffset (Value *Start, Value *Base, const DataLayout &DL, SetVector< Value * > &Explored)
 Returns true if we can rewrite Start as a GEP with pointer Base and some integer offset. More...
 
static void setInsertionPoint (IRBuilder<> &Builder, Value *V, bool Before=true)
 
static ValuerewriteGEPAsOffset (Value *Start, Value *Base, const DataLayout &DL, SetVector< Value * > &Explored)
 Returns a re-written value of Start as an indexed GEP using Base as a pointer. More...
 
static std::pair< Value
*, Value * > 
getAsConstantIndexedAddress (Value *V, const DataLayout &DL)
 Looks through GEPs, IntToPtrInsts and PtrToIntInsts in order to express the input Value as a constant indexed GEP. More...
 
static InstructiontransformToIndexedCompare (GEPOperator *GEPLHS, Value *RHS, ICmpInst::Predicate Cond, const DataLayout &DL)
 Converts (CMP GEPLHS, RHS) if this change would make RHS a constant. More...
 
static InstructionprocessUGT_ADDCST_ADD (ICmpInst &I, Value *A, Value *B, ConstantInt *CI2, ConstantInt *CI1, InstCombiner &IC)
 The caller has matched a pattern of the form: I = icmp ugt (add (add A, B), CI2), CI1 If this is of the form: sum = a + b if (sum+128 >u 255) Then replace it with llvm.sadd.with.overflow.i8. More...
 
static InstructionfoldICmpShlOne (ICmpInst &Cmp, Instruction *Shl, const APInt *C)
 Fold icmp (shl 1, Y), C. More...
 
static InstructionfoldICmpWithMinMax (ICmpInst &Cmp)
 Fold icmp Pred min|max(X, Y), X. More...
 
static InstructionprocessUMulZExtIdiom (ICmpInst &I, Value *MulVal, Value *OtherVal, InstCombiner &IC)
 Recognize and process idiom involving test for multiplication overflow. More...
 
static APInt getDemandedBitsLHSMask (ICmpInst &I, unsigned BitWidth, bool isSignCheck)
 When performing a comparison against a constant, it is possible that not all the bits in the LHS are demanded. More...
 
static bool swapMayExposeCSEOpportunities (const Value *Op0, const Value *Op1)
 Check if the order of Op0 and Op1 as operand in an ICmpInst should be swapped. More...
 
static bool isChainSelectCmpBranch (const SelectInst *SI)
 Return true when the instruction sequence within a block is select-cmp-br. More...
 
static ICmpInstcanonicalizeCmpWithConstant (ICmpInst &I)
 If we have an icmp le or icmp ge instruction with a constant operand, turn it into the appropriate icmp lt or icmp gt instruction. More...
 

Macro Definition Documentation

#define DEBUG_TYPE   "instcombine"

Definition at line 33 of file InstCombineCompares.cpp.

Function Documentation

static bool addWithOverflow ( Constant *&  Result,
Constant In1,
Constant In2,
bool  IsSigned = false 
)
static

Compute Result = In1+In2, returning true if the result overflowed for this type.

Definition at line 56 of file InstCombineCompares.cpp.

References extractElement(), llvm::ConstantInt::get(), llvm::ConstantExpr::getAdd(), llvm::Value::getContext(), llvm::Type::getInt32Ty(), llvm::Value::getType(), hasAddOverflow(), and i.

static ICmpInst* canonicalizeCmpWithConstant ( ICmpInst I)
static
static bool canRewriteGEPAsOffset ( Value Start,
Value Base,
const DataLayout DL,
SetVector< Value * > &  Explored 
)
static
static void computeSignedMinMaxValuesFromKnownBits ( const APInt KnownZero,
const APInt KnownOne,
APInt Min,
APInt Max 
)
static

Given a signed integer type and a set of known zero and one bits, compute the maximum and minimum values that could have the specified known zero and known one bits, returning them in Min/Max.

Definition at line 178 of file InstCombineCompares.cpp.

References assert(), llvm::APInt::clearBit(), llvm::APInt::getBitWidth(), and llvm::APInt::setBit().

static void computeUnsignedMinMaxValuesFromKnownBits ( const APInt KnownZero,
const APInt KnownOne,
APInt Min,
APInt Max 
)
static

Given an unsigned integer type and a set of known zero and one bits, compute the maximum and minimum values that could have the specified known zero and known one bits, returning them in Min/Max.

Definition at line 201 of file InstCombineCompares.cpp.

References assert(), and llvm::APInt::getBitWidth().

static Value* evaluateGEPOffsetExpression ( User GEP,
InstCombiner IC,
const DataLayout DL 
)
static

Return a value that can be used to compare the offset implied by a GEP to zero.

For example, if we have &A[i], we want to return 'i' for "icmp ne i, 0". Note that, in general, indices can be complex, and scales are involved. The above expression would also be legal to codegen as "icmp ne (i*4), 0" (assuming A is a pointer to i32). This latter form is less amenable to optimization though, and we are allowed to generate the first by knowing that pointer arithmetic doesn't overflow.

If we can't emit an optimized form for this expression, this returns null.

Definition at line 503 of file InstCombineCompares.cpp.

References llvm::InstCombiner::Builder, llvm::IRBuilder< T, Inserter >::CreateAdd(), llvm::IRBuilder< T, Inserter >::CreateIntCast(), llvm::IRBuilder< T, Inserter >::CreateTrunc(), llvm::dyn_cast(), llvm::gep_type_begin(), llvm::ConstantInt::get(), llvm::StructLayout::getElementOffset(), llvm::generic_gep_type_iterator< ItTy >::getIndexedType(), llvm::Type::getIntegerBitWidth(), llvm::DataLayout::getIntPtrType(), llvm::User::getNumOperands(), llvm::User::getOperand(), llvm::Type::getPrimitiveSizeInBits(), llvm::ConstantInt::getSExtValue(), llvm::DataLayout::getStructLayout(), llvm::generic_gep_type_iterator< ItTy >::getStructTypeOrNull(), llvm::Value::getType(), llvm::DataLayout::getTypeAllocSize(), llvm::ConstantInt::getZExtValue(), i, llvm::ConstantInt::isZero(), and Offset.

static ConstantInt* extractElement ( Constant V,
Constant Idx 
)
static

Definition at line 39 of file InstCombineCompares.cpp.

References llvm::ConstantExpr::getExtractElement().

Referenced by addWithOverflow(), and subWithOverflow().

static Instruction* foldICmpShlOne ( ICmpInst Cmp,
Instruction Shl,
const APInt C 
)
static
static Instruction* foldICmpWithMinMax ( ICmpInst Cmp)
static
static std::pair<Value *, Value *> getAsConstantIndexedAddress ( Value V,
const DataLayout DL 
)
static
static APInt getDemandedBitsLHSMask ( ICmpInst I,
unsigned  BitWidth,
bool  isSignCheck 
)
static

When performing a comparison against a constant, it is possible that not all the bits in the LHS are demanded.

This helper method computes the mask that IS demanded.

Definition at line 3725 of file InstCombineCompares.cpp.

References llvm::APInt::countTrailingOnes(), llvm::APInt::countTrailingZeros(), llvm::dyn_cast(), llvm::APInt::getAllOnesValue(), llvm::APInt::getLowBitsSet(), llvm::User::getOperand(), llvm::CmpInst::getPredicate(), llvm::APInt::getSignBit(), llvm::ConstantInt::getValue(), llvm::CmpInst::ICMP_UGT, and llvm::CmpInst::ICMP_ULT.

static bool hasAddOverflow ( ConstantInt Result,
ConstantInt In1,
ConstantInt In2,
bool  IsSigned 
)
static
static bool hasSubOverflow ( ConstantInt Result,
ConstantInt In1,
ConstantInt In2,
bool  IsSigned 
)
static
static bool isBranchOnSignBitCheck ( ICmpInst I,
bool  isSignBit 
)
static

Given an icmp instruction, return true if any use of this comparison is a branch on sign bit comparison.

Definition at line 114 of file InstCombineCompares.cpp.

References llvm::Value::users().

static bool isChainSelectCmpBranch ( const SelectInst SI)
static

Return true when the instruction sequence within a block is select-cmp-br.

Definition at line 3831 of file InstCombineCompares.cpp.

References llvm::dyn_cast(), llvm::User::getOperand(), llvm::Instruction::getParent(), and llvm::BasicBlock::getTerminator().

Referenced by llvm::InstCombiner::replacedSelectWithOperand().

static bool isSignBitCheck ( ICmpInst::Predicate  Pred,
const APInt RHS,
bool TrueIfSigned 
)
static

Given an exploded icmp instruction, return true if the comparison only checks the sign bit.

If it only checks the sign bit, set TrueIfSigned if the result of the comparison is true when the input value is signed.

Definition at line 124 of file InstCombineCompares.cpp.

References llvm::CmpInst::ICMP_SGT, llvm::CmpInst::ICMP_SLE, llvm::CmpInst::ICMP_SLT, llvm::CmpInst::ICMP_UGE, llvm::CmpInst::ICMP_UGT, llvm::APInt::isAllOnesValue(), llvm::APInt::isMaxSignedValue(), and llvm::APInt::isSignBit().

static bool isSignTest ( ICmpInst::Predicate &  Pred,
const APInt C 
)
static

Returns true if the exploded icmp can be expressed as a signed comparison to zero and updates the predicate accordingly.

The signedness of the comparison is preserved. TODO: Refactor with decomposeBitTestICmp()?

Definition at line 153 of file InstCombineCompares.cpp.

References llvm::CmpInst::ICMP_SGE, llvm::CmpInst::ICMP_SGT, llvm::CmpInst::ICMP_SLE, llvm::CmpInst::ICMP_SLT, llvm::APInt::isAllOnesValue(), llvm::ICmpInst::isRelational(), and llvm::CmpInst::isSigned().

static Instruction* processUGT_ADDCST_ADD ( ICmpInst I,
Value A,
Value B,
ConstantInt CI2,
ConstantInt CI1,
InstCombiner IC 
)
static
static Instruction* processUMulZExtIdiom ( ICmpInst I,
Value MulVal,
Value OtherVal,
InstCombiner IC 
)
static

Recognize and process idiom involving test for multiplication overflow.

The caller has matched a pattern of the form: I = cmp u (mul(zext A, zext B), V The function checks if this is a test for overflow and if so replaces multiplication with call to 'mul.with.overflow' intrinsic.

Parameters
ICompare instruction.
MulValResult of 'mult' instruction. It is one of the arguments of the compare instruction. Must be of integer type.
OtherValThe other argument of compare instruction.
Returns
Instruction which must replace the compare instruction, NULL if no replacement required.

Definition at line 3501 of file InstCombineCompares.cpp.

References A, llvm::InstCombineWorklist::Add(), llvm::APIntOps::And(), assert(), B, llvm::InstCombiner::Builder, llvm::Call, llvm::APInt::countLeadingZeros(), llvm::ExtractValueInst::Create(), llvm::IRBuilder< T, Inserter >::CreateAnd(), llvm::IRBuilder< T, Inserter >::CreateCall(), llvm::IRBuilder< T, Inserter >::CreateExtractValue(), llvm::BinaryOperator::CreateNot(), llvm::IRBuilder< T, Inserter >::CreateZExt(), llvm::dyn_cast(), llvm::APInt::eq(), F, llvm::ConstantInt::getBitWidth(), llvm::APInt::getBitWidth(), llvm::Intrinsic::getDeclaration(), llvm::APInt::getMaxValue(), llvm::Instruction::getModule(), llvm::APInt::getOneBitSet(), llvm::BinaryOperator::getOpcode(), llvm::User::getOperand(), llvm::CmpInst::getPredicate(), llvm::Type::getPrimitiveSizeInBits(), llvm::Value::getType(), llvm::ConstantInt::getValue(), llvm::Value::hasNUsesOrMore(), llvm::CmpInst::ICMP_EQ, llvm::CmpInst::ICMP_UGE, llvm::CmpInst::ICMP_UGT, llvm::CmpInst::ICMP_ULE, llvm::CmpInst::ICMP_ULT, llvm::APInt::isPowerOf2(), llvm_unreachable, llvm::APInt::logBase2(), llvm::PatternMatch::m_And(), llvm::PatternMatch::m_ConstantInt(), llvm::PatternMatch::m_Value(), llvm::PatternMatch::match(), llvm::InstCombiner::replaceInstUsesWith(), llvm::IRBuilderBase::SetInsertPoint(), llvm::User::setOperand(), llvm::APInt::trunc(), llvm::Value::users(), llvm::InstCombiner::Worklist, and llvm::APInt::zext().

Referenced by llvm::InstCombiner::visitICmpInst().

static Value* rewriteGEPAsOffset ( Value Start,
Value Base,
const DataLayout DL,
SetVector< Value * > &  Explored 
)
static
static void setInsertionPoint ( IRBuilder<> &  Builder,
Value V,
bool  Before = true 
)
static
STATISTIC ( NumSel  ,
"Number of select opts"   
)
static bool subWithOverflow ( Constant *&  Result,
Constant In1,
Constant In2,
bool  IsSigned = false 
)
static

Compute Result = In1-In2, returning true if the result overflowed for this type.

Definition at line 91 of file InstCombineCompares.cpp.

References extractElement(), llvm::ConstantInt::get(), llvm::Value::getContext(), llvm::Type::getInt32Ty(), llvm::ConstantExpr::getSub(), llvm::Value::getType(), hasSubOverflow(), and i.

static bool swapMayExposeCSEOpportunities ( const Value Op0,
const Value Op1 
)
static

Check if the order of Op0 and Op1 as operand in an ICmpInst should be swapped.

The decision is based on how many times these two operands are reused as subtract operands and their positions in those instructions. The rational is that several architectures use the same instruction for both subtract and cmp, thus it is better if the order of those operands match.

Returns
true if Op0 and Op1 should be swapped.

Definition at line 3766 of file InstCombineCompares.cpp.

References llvm::dyn_cast(), llvm::BinaryOperator::getOpcode(), llvm::User::getOperand(), llvm::Value::getType(), llvm::Type::isPointerTy(), and llvm::Value::users().

Referenced by llvm::InstCombiner::visitICmpInst().

static Instruction* transformToIndexedCompare ( GEPOperator GEPLHS,
Value RHS,
ICmpInst::Predicate  Cond,
const DataLayout DL 
)
static

Converts (CMP GEPLHS, RHS) if this change would make RHS a constant.

We can look through PHIs, GEPs and casts in order to determine a common base between GEPLHS and RHS.

Definition at line 881 of file InstCombineCompares.cpp.

References canRewriteGEPAsOffset(), getAsConstantIndexedAddress(), llvm::ICmpInst::getSignedPredicate(), llvm::Value::getType(), llvm::GEPOperator::hasAllConstantIndices(), and rewriteGEPAsOffset().