lib/Transforms/InstCombine/InstCombineShifts.cpp

   1 //===- InstCombineShifts.cpp ----------------------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the visitShl, visitLShr, and visitAShr functions.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "InstCombine.h"
  15 #include "llvm/Analysis/ConstantFolding.h"
  16 #include "llvm/Analysis/InstructionSimplify.h"
  17 #include "llvm/IR/IntrinsicInst.h"
  18 #include "llvm/IR/PatternMatch.h"
  19 using namespace llvm;
  20 using namespace PatternMatch;
  21
  22 Instruction *InstCombiner::commonShiftTransforms(BinaryOperator &I) {
  23   assert(I.getOperand(1)->getType() == I.getOperand(0)->getType());
  24   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
  25
  26   // See if we can fold away this shift.
  27   if (SimplifyDemandedInstructionBits(I))
  28     return &I;
  29
  30   // Try to fold constant and into select arguments.
  31   if (isa<Constant>(Op0))
  32     if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
  33       if (Instruction *R = FoldOpIntoSelect(I, SI))
  34         return R;
  35
  36   if (Constant *CUI = dyn_cast<Constant>(Op1))
  37     if (Instruction *Res = FoldShiftByConstant(Op0, CUI, I))
  38       return Res;
  39
  40   // X shift (A srem B) -> X shift (A and B-1) iff B is a power of 2.
  41   // Because shifts by negative values (which could occur if A were negative)
  42   // are undefined.
  43   Value *A; const APInt *B;
  44   if (Op1->hasOneUse() && match(Op1, m_SRem(m_Value(A), m_Power2(B)))) {
  45     // FIXME: Should this get moved into SimplifyDemandedBits by saying we don't
  46     // demand the sign bit (and many others) here??
  47     Value *Rem = Builder->CreateAnd(A, ConstantInt::get(I.getType(), *B-1),
  48                                     Op1->getName());
  49     I.setOperand(1, Rem);
  50     return &I;
  51   }
  52
  53   return 0;
  54 }
  55
  56 /// CanEvaluateShifted - See if we can compute the specified value, but shifted
  57 /// logically to the left or right by some number of bits.  This should return
  58 /// true if the expression can be computed for the same cost as the current
  59 /// expression tree.  This is used to eliminate extraneous shifting from things
  60 /// like:
  61 ///      %C = shl i128 %A, 64
  62 ///      %D = shl i128 %B, 96
  63 ///      %E = or i128 %C, %D
  64 ///      %F = lshr i128 %E, 64
  65 /// where the client will ask if E can be computed shifted right by 64-bits.  If
  66 /// this succeeds, the GetShiftedValue function will be called to produce the
  67 /// value.
  68 static bool CanEvaluateShifted(Value *V, unsigned NumBits, bool isLeftShift,
  69                                InstCombiner &IC) {
  70   // We can always evaluate constants shifted.
  71   if (isa<Constant>(V))
  72     return true;
  73
  74   Instruction *I = dyn_cast<Instruction>(V);
  75   if (!I) return false;
  76
  77   // If this is the opposite shift, we can directly reuse the input of the shift
  78   // if the needed bits are already zero in the input.  This allows us to reuse
  79   // the value which means that we don't care if the shift has multiple uses.
  80   //  TODO:  Handle opposite shift by exact value.
  81   ConstantInt *CI = 0;
  82   if ((isLeftShift && match(I, m_LShr(m_Value(), m_ConstantInt(CI)))) ||
  83       (!isLeftShift && match(I, m_Shl(m_Value(), m_ConstantInt(CI))))) {
  84     if (CI->getZExtValue() == NumBits) {
  85       // TODO: Check that the input bits are already zero with MaskedValueIsZero
  86 #if 0
  87       // If this is a truncate of a logical shr, we can truncate it to a smaller
  88       // lshr iff we know that the bits we would otherwise be shifting in are
  89       // already zeros.
  90       uint32_t OrigBitWidth = OrigTy->getScalarSizeInBits();
  91       uint32_t BitWidth = Ty->getScalarSizeInBits();
  92       if (MaskedValueIsZero(I->getOperand(0),
  93             APInt::getHighBitsSet(OrigBitWidth, OrigBitWidth-BitWidth)) &&
  94           CI->getLimitedValue(BitWidth) < BitWidth) {
  95         return CanEvaluateTruncated(I->getOperand(0), Ty);
  96       }
  97 #endif
  98
  99     }
 100   }
 101
 102   // We can't mutate something that has multiple uses: doing so would
 103   // require duplicating the instruction in general, which isn't profitable.
 104   if (!I->hasOneUse()) return false;
 105
 106   switch (I->getOpcode()) {
 107   default: return false;
 108   case Instruction::And:
 109   case Instruction::Or:
 110   case Instruction::Xor:
 111     // Bitwise operators can all arbitrarily be arbitrarily evaluated shifted.
 112     return CanEvaluateShifted(I->getOperand(0), NumBits, isLeftShift, IC) &&
 113            CanEvaluateShifted(I->getOperand(1), NumBits, isLeftShift, IC);
 114
 115   case Instruction::Shl: {
 116     // We can often fold the shift into shifts-by-a-constant.
 117     CI = dyn_cast<ConstantInt>(I->getOperand(1));
 118     if (CI == 0) return false;
 119
 120     // We can always fold shl(c1)+shl(c2) -> shl(c1+c2).
 121     if (isLeftShift) return true;
 122
 123     // We can always turn shl(c)+shr(c) -> and(c2).
 124     if (CI->getValue() == NumBits) return true;
 125
 126     unsigned TypeWidth = I->getType()->getScalarSizeInBits();
 127
 128     // We can turn shl(c1)+shr(c2) -> shl(c3)+and(c4), but it isn't
 129     // profitable unless we know the and'd out bits are already zero.
 130     if (CI->getZExtValue() > NumBits) {
 131       unsigned LowBits = TypeWidth - CI->getZExtValue();
 132       if (MaskedValueIsZero(I->getOperand(0),
 133                        APInt::getLowBitsSet(TypeWidth, NumBits) << LowBits))
 134         return true;
 135     }
 136
 137     return false;
 138   }
 139   case Instruction::LShr: {
 140     // We can often fold the shift into shifts-by-a-constant.
 141     CI = dyn_cast<ConstantInt>(I->getOperand(1));
 142     if (CI == 0) return false;
 143
 144     // We can always fold lshr(c1)+lshr(c2) -> lshr(c1+c2).
 145     if (!isLeftShift) return true;
 146
 147     // We can always turn lshr(c)+shl(c) -> and(c2).
 148     if (CI->getValue() == NumBits) return true;
 149
 150     unsigned TypeWidth = I->getType()->getScalarSizeInBits();
 151
 152     // We can always turn lshr(c1)+shl(c2) -> lshr(c3)+and(c4), but it isn't
 153     // profitable unless we know the and'd out bits are already zero.
 154     if (CI->getValue().ult(TypeWidth) && CI->getZExtValue() > NumBits) {
 155       unsigned LowBits = CI->getZExtValue() - NumBits;
 156       if (MaskedValueIsZero(I->getOperand(0),
 157                           APInt::getLowBitsSet(TypeWidth, NumBits) << LowBits))
 158         return true;
 159     }
 160
 161     return false;
 162   }
 163   case Instruction::Select: {
 164     SelectInst *SI = cast<SelectInst>(I);
 165     return CanEvaluateShifted(SI->getTrueValue(), NumBits, isLeftShift, IC) &&
 166            CanEvaluateShifted(SI->getFalseValue(), NumBits, isLeftShift, IC);
 167   }
 168   case Instruction::PHI: {
 169     // We can change a phi if we can change all operands.  Note that we never
 170     // get into trouble with cyclic PHIs here because we only consider
 171     // instructions with a single use.
 172     PHINode *PN = cast<PHINode>(I);
 173     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 174       if (!CanEvaluateShifted(PN->getIncomingValue(i), NumBits, isLeftShift,IC))
 175         return false;
 176     return true;
 177   }
 178   }
 179 }
 180
 181 /// GetShiftedValue - When CanEvaluateShifted returned true for an expression,
 182 /// this value inserts the new computation that produces the shifted value.
 183 static Value *GetShiftedValue(Value *V, unsigned NumBits, bool isLeftShift,
 184                               InstCombiner &IC) {
 185   // We can always evaluate constants shifted.
 186   if (Constant *C = dyn_cast<Constant>(V)) {
 187     if (isLeftShift)
 188       V = IC.Builder->CreateShl(C, NumBits);
 189     else
 190       V = IC.Builder->CreateLShr(C, NumBits);
 191     // If we got a constantexpr back, try to simplify it with TD info.
 192     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
 193       V = ConstantFoldConstantExpression(CE, IC.getDataLayout(),
 194                                          IC.getTargetLibraryInfo());
 195     return V;
 196   }
 197
 198   Instruction *I = cast<Instruction>(V);
 199   IC.Worklist.Add(I);
 200
 201   switch (I->getOpcode()) {
 202   default: llvm_unreachable("Inconsistency with CanEvaluateShifted");
 203   case Instruction::And:
 204   case Instruction::Or:
 205   case Instruction::Xor:
 206     // Bitwise operators can all arbitrarily be arbitrarily evaluated shifted.
 207     I->setOperand(0, GetShiftedValue(I->getOperand(0), NumBits,isLeftShift,IC));
 208     I->setOperand(1, GetShiftedValue(I->getOperand(1), NumBits,isLeftShift,IC));
 209     return I;
 210
 211   case Instruction::Shl: {
 212     BinaryOperator *BO = cast<BinaryOperator>(I);
 213     unsigned TypeWidth = BO->getType()->getScalarSizeInBits();
 214
 215     // We only accept shifts-by-a-constant in CanEvaluateShifted.
 216     ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1));
 217
 218     // We can always fold shl(c1)+shl(c2) -> shl(c1+c2).
 219     if (isLeftShift) {
 220       // If this is oversized composite shift, then unsigned shifts get 0.
 221       unsigned NewShAmt = NumBits+CI->getZExtValue();
 222       if (NewShAmt >= TypeWidth)
 223         return Constant::getNullValue(I->getType());
 224
 225       BO->setOperand(1, ConstantInt::get(BO->getType(), NewShAmt));
 226       BO->setHasNoUnsignedWrap(false);
 227       BO->setHasNoSignedWrap(false);
 228       return I;
 229     }
 230
 231     // We turn shl(c)+lshr(c) -> and(c2) if the input doesn't already have
 232     // zeros.
 233     if (CI->getValue() == NumBits) {
 234       APInt Mask(APInt::getLowBitsSet(TypeWidth, TypeWidth - NumBits));
 235       V = IC.Builder->CreateAnd(BO->getOperand(0),
 236                                 ConstantInt::get(BO->getContext(), Mask));
 237       if (Instruction *VI = dyn_cast<Instruction>(V)) {
 238         VI->moveBefore(BO);
 239         VI->takeName(BO);
 240       }
 241       return V;
 242     }
 243
 244     // We turn shl(c1)+shr(c2) -> shl(c3)+and(c4), but only when we know that
 245     // the and won't be needed.
 246     assert(CI->getZExtValue() > NumBits);
 247     BO->setOperand(1, ConstantInt::get(BO->getType(),
 248                                        CI->getZExtValue() - NumBits));
 249     BO->setHasNoUnsignedWrap(false);
 250     BO->setHasNoSignedWrap(false);
 251     return BO;
 252   }
 253   case Instruction::LShr: {
 254     BinaryOperator *BO = cast<BinaryOperator>(I);
 255     unsigned TypeWidth = BO->getType()->getScalarSizeInBits();
 256     // We only accept shifts-by-a-constant in CanEvaluateShifted.
 257     ConstantInt *CI = cast<ConstantInt>(BO->getOperand(1));
 258
 259     // We can always fold lshr(c1)+lshr(c2) -> lshr(c1+c2).
 260     if (!isLeftShift) {
 261       // If this is oversized composite shift, then unsigned shifts get 0.
 262       unsigned NewShAmt = NumBits+CI->getZExtValue();
 263       if (NewShAmt >= TypeWidth)
 264         return Constant::getNullValue(BO->getType());
 265
 266       BO->setOperand(1, ConstantInt::get(BO->getType(), NewShAmt));
 267       BO->setIsExact(false);
 268       return I;
 269     }
 270
 271     // We turn lshr(c)+shl(c) -> and(c2) if the input doesn't already have
 272     // zeros.
 273     if (CI->getValue() == NumBits) {
 274       APInt Mask(APInt::getHighBitsSet(TypeWidth, TypeWidth - NumBits));
 275       V = IC.Builder->CreateAnd(I->getOperand(0),
 276                                 ConstantInt::get(BO->getContext(), Mask));
 277       if (Instruction *VI = dyn_cast<Instruction>(V)) {
 278         VI->moveBefore(I);
 279         VI->takeName(I);
 280       }
 281       return V;
 282     }
 283
 284     // We turn lshr(c1)+shl(c2) -> lshr(c3)+and(c4), but only when we know that
 285     // the and won't be needed.
 286     assert(CI->getZExtValue() > NumBits);
 287     BO->setOperand(1, ConstantInt::get(BO->getType(),
 288                                        CI->getZExtValue() - NumBits));
 289     BO->setIsExact(false);
 290     return BO;
 291   }
 292
 293   case Instruction::Select:
 294     I->setOperand(1, GetShiftedValue(I->getOperand(1), NumBits,isLeftShift,IC));
 295     I->setOperand(2, GetShiftedValue(I->getOperand(2), NumBits,isLeftShift,IC));
 296     return I;
 297   case Instruction::PHI: {
 298     // We can change a phi if we can change all operands.  Note that we never
 299     // get into trouble with cyclic PHIs here because we only consider
 300     // instructions with a single use.
 301     PHINode *PN = cast<PHINode>(I);
 302     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 303       PN->setIncomingValue(i, GetShiftedValue(PN->getIncomingValue(i),
 304                                               NumBits, isLeftShift, IC));
 305     return PN;
 306   }
 307   }
 308 }
 309
 310
 311
 312 Instruction *InstCombiner::FoldShiftByConstant(Value *Op0, Constant *Op1,
 313                                                BinaryOperator &I) {
 314   bool isLeftShift = I.getOpcode() == Instruction::Shl;
 315
 316   ConstantInt *COp1 = nullptr;
 317   if (ConstantDataVector *CV = dyn_cast<ConstantDataVector>(Op1))
 318     COp1 = dyn_cast_or_null<ConstantInt>(CV->getSplatValue());
 319   else if (ConstantVector *CV = dyn_cast<ConstantVector>(Op1))
 320     COp1 = dyn_cast_or_null<ConstantInt>(CV->getSplatValue());
 321   else
 322     COp1 = dyn_cast<ConstantInt>(Op1);
 323
 324   if (!COp1)
 325     return nullptr;
 326
 327   // See if we can propagate this shift into the input, this covers the trivial
 328   // cast of lshr(shl(x,c1),c2) as well as other more complex cases.
 329   if (I.getOpcode() != Instruction::AShr &&
 330       CanEvaluateShifted(Op0, COp1->getZExtValue(), isLeftShift, *this)) {
 331     DEBUG(dbgs() << "ICE: GetShiftedValue propagating shift through expression"
 332               " to eliminate shift:\n  IN: " << *Op0 << "\n  SH: " << I <<"\n");
 333
 334     return ReplaceInstUsesWith(I,
 335                  GetShiftedValue(Op0, COp1->getZExtValue(), isLeftShift, *this));
 336   }
 337
 338
 339   // See if we can simplify any instructions used by the instruction whose sole
 340   // purpose is to compute bits we don't care about.
 341   uint32_t TypeBits = Op0->getType()->getScalarSizeInBits();
 342
 343   // shl i32 X, 32 = 0 and srl i8 Y, 9 = 0, ... just don't eliminate
 344   // a signed shift.
 345   //
 346   if (COp1->uge(TypeBits)) {
 347     if (I.getOpcode() != Instruction::AShr)
 348       return ReplaceInstUsesWith(I, Constant::getNullValue(Op0->getType()));
 349     // ashr i32 X, 32 --> ashr i32 X, 31
 350     I.setOperand(1, ConstantInt::get(I.getType(), TypeBits-1));
 351     return &I;
 352   }
 353
 354   // ((X*C1) << C2) == (X * (C1 << C2))
 355   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Op0))
 356     if (BO->getOpcode() == Instruction::Mul && isLeftShift)
 357       if (Constant *BOOp = dyn_cast<Constant>(BO->getOperand(1)))
 358         return BinaryOperator::CreateMul(BO->getOperand(0),
 359                                         ConstantExpr::getShl(BOOp, Op1));
 360
 361   // Try to fold constant and into select arguments.
 362   if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
 363     if (Instruction *R = FoldOpIntoSelect(I, SI))
 364       return R;
 365   if (isa<PHINode>(Op0))
 366     if (Instruction *NV = FoldOpIntoPhi(I))
 367       return NV;
 368
 369   // Fold shift2(trunc(shift1(x,c1)), c2) -> trunc(shift2(shift1(x,c1),c2))
 370   if (TruncInst *TI = dyn_cast<TruncInst>(Op0)) {
 371     Instruction *TrOp = dyn_cast<Instruction>(TI->getOperand(0));
 372     // If 'shift2' is an ashr, we would have to get the sign bit into a funny
 373     // place.  Don't try to do this transformation in this case.  Also, we
 374     // require that the input operand is a shift-by-constant so that we have
 375     // confidence that the shifts will get folded together.  We could do this
 376     // xform in more cases, but it is unlikely to be profitable.
 377     if (TrOp && I.isLogicalShift() && TrOp->isShift() &&
 378         isa<ConstantInt>(TrOp->getOperand(1))) {
 379       // Okay, we'll do this xform.  Make the shift of shift.
 380       Constant *ShAmt = ConstantExpr::getZExt(COp1, TrOp->getType());
 381       // (shift2 (shift1 & 0x00FF), c2)
 382       Value *NSh = Builder->CreateBinOp(I.getOpcode(), TrOp, ShAmt,I.getName());
 383
 384       // For logical shifts, the truncation has the effect of making the high
 385       // part of the register be zeros.  Emulate this by inserting an AND to
 386       // clear the top bits as needed.  This 'and' will usually be zapped by
 387       // other xforms later if dead.
 388       unsigned SrcSize = TrOp->getType()->getScalarSizeInBits();
 389       unsigned DstSize = TI->getType()->getScalarSizeInBits();
 390       APInt MaskV(APInt::getLowBitsSet(SrcSize, DstSize));
 391
 392       // The mask we constructed says what the trunc would do if occurring
 393       // between the shifts.  We want to know the effect *after* the second
 394       // shift.  We know that it is a logical shift by a constant, so adjust the
 395       // mask as appropriate.
 396       if (I.getOpcode() == Instruction::Shl)
 397         MaskV <<= COp1->getZExtValue();
 398       else {
 399         assert(I.getOpcode() == Instruction::LShr && "Unknown logical shift");
 400         MaskV = MaskV.lshr(COp1->getZExtValue());
 401       }
 402
 403       // shift1 & 0x00FF
 404       Value *And = Builder->CreateAnd(NSh,
 405                                       ConstantInt::get(I.getContext(), MaskV),
 406                                       TI->getName());
 407
 408       // Return the value truncated to the interesting size.
 409       return new TruncInst(And, I.getType());
 410     }
 411   }
 412
 413   if (Op0->hasOneUse()) {
 414     if (BinaryOperator *Op0BO = dyn_cast<BinaryOperator>(Op0)) {
 415       // Turn ((X >> C) + Y) << C  ->  (X + (Y << C)) & (~0 << C)
 416       Value *V1, *V2;
 417       ConstantInt *CC;
 418       switch (Op0BO->getOpcode()) {
 419       default: break;
 420       case Instruction::Add:
 421       case Instruction::And:
 422       case Instruction::Or:
 423       case Instruction::Xor: {
 424         // These operators commute.
 425         // Turn (Y + (X >> C)) << C  ->  (X + (Y << C)) & (~0 << C)
 426         if (isLeftShift && Op0BO->getOperand(1)->hasOneUse() &&
 427             match(Op0BO->getOperand(1), m_Shr(m_Value(V1),
 428                   m_Specific(Op1)))) {
 429           Value *YS =         // (Y << C)
 430             Builder->CreateShl(Op0BO->getOperand(0), Op1, Op0BO->getName());
 431           // (X + (Y << C))
 432           Value *X = Builder->CreateBinOp(Op0BO->getOpcode(), YS, V1,
 433                                           Op0BO->getOperand(1)->getName());
 434           uint32_t Op1Val = COp1->getLimitedValue(TypeBits);
 435
 436           APInt Bits = APInt::getHighBitsSet(TypeBits, TypeBits - Op1Val);
 437           Constant *Mask = ConstantInt::get(I.getContext(), Bits);
 438           if (VectorType *VT = dyn_cast<VectorType>(X->getType()))
 439             Mask = ConstantVector::getSplat(VT->getNumElements(), Mask);
 440           return BinaryOperator::CreateAnd(X, Mask);
 441         }
 442
 443         // Turn (Y + ((X >> C) & CC)) << C  ->  ((X & (CC << C)) + (Y << C))
 444         Value *Op0BOOp1 = Op0BO->getOperand(1);
 445         if (isLeftShift && Op0BOOp1->hasOneUse() &&
 446             match(Op0BOOp1,
 447                   m_And(m_OneUse(m_Shr(m_Value(V1), m_Specific(Op1))),
 448                         m_ConstantInt(CC)))) {
 449           Value *YS =   // (Y << C)
 450             Builder->CreateShl(Op0BO->getOperand(0), Op1,
 451                                          Op0BO->getName());
 452           // X & (CC << C)
 453           Value *XM = Builder->CreateAnd(V1, ConstantExpr::getShl(CC, Op1),
 454                                          V1->getName()+".mask");
 455           return BinaryOperator::Create(Op0BO->getOpcode(), YS, XM);
 456         }
 457       }
 458
 459       // FALL THROUGH.
 460       case Instruction::Sub: {
 461         // Turn ((X >> C) + Y) << C  ->  (X + (Y << C)) & (~0 << C)
 462         if (isLeftShift && Op0BO->getOperand(0)->hasOneUse() &&
 463             match(Op0BO->getOperand(0), m_Shr(m_Value(V1),
 464                   m_Specific(Op1)))) {
 465           Value *YS =  // (Y << C)
 466             Builder->CreateShl(Op0BO->getOperand(1), Op1, Op0BO->getName());
 467           // (X + (Y << C))
 468           Value *X = Builder->CreateBinOp(Op0BO->getOpcode(), V1, YS,
 469                                           Op0BO->getOperand(0)->getName());
 470           uint32_t Op1Val = COp1->getLimitedValue(TypeBits);
 471
 472           APInt Bits = APInt::getHighBitsSet(TypeBits, TypeBits - Op1Val);
 473           Constant *Mask = ConstantInt::get(I.getContext(), Bits);
 474           if (VectorType *VT = dyn_cast<VectorType>(X->getType()))
 475             Mask = ConstantVector::getSplat(VT->getNumElements(), Mask);
 476           return BinaryOperator::CreateAnd(X, Mask);
 477         }
 478
 479         // Turn (((X >> C)&CC) + Y) << C  ->  (X + (Y << C)) & (CC << C)
 480         if (isLeftShift && Op0BO->getOperand(0)->hasOneUse() &&
 481             match(Op0BO->getOperand(0),
 482                   m_And(m_OneUse(m_Shr(m_Value(V1), m_Value(V2))),
 483                         m_ConstantInt(CC))) && V2 == Op1) {
 484           Value *YS = // (Y << C)
 485             Builder->CreateShl(Op0BO->getOperand(1), Op1, Op0BO->getName());
 486           // X & (CC << C)
 487           Value *XM = Builder->CreateAnd(V1, ConstantExpr::getShl(CC, Op1),
 488                                          V1->getName()+".mask");
 489
 490           return BinaryOperator::Create(Op0BO->getOpcode(), XM, YS);
 491         }
 492
 493         break;
 494       }
 495       }
 496
 497
 498       // If the operand is an bitwise operator with a constant RHS, and the
 499       // shift is the only use, we can pull it out of the shift.
 500       if (ConstantInt *Op0C = dyn_cast<ConstantInt>(Op0BO->getOperand(1))) {
 501         bool isValid = true;     // Valid only for And, Or, Xor
 502         bool highBitSet = false; // Transform if high bit of constant set?
 503
 504         switch (Op0BO->getOpcode()) {
 505         default: isValid = false; break;   // Do not perform transform!
 506         case Instruction::Add:
 507           isValid = isLeftShift;
 508           break;
 509         case Instruction::Or:
 510         case Instruction::Xor:
 511           highBitSet = false;
 512           break;
 513         case Instruction::And:
 514           highBitSet = true;
 515           break;
 516         }
 517
 518         // If this is a signed shift right, and the high bit is modified
 519         // by the logical operation, do not perform the transformation.
 520         // The highBitSet boolean indicates the value of the high bit of
 521         // the constant which would cause it to be modified for this
 522         // operation.
 523         //
 524         if (isValid && I.getOpcode() == Instruction::AShr)
 525           isValid = Op0C->getValue()[TypeBits-1] == highBitSet;
 526
 527         if (isValid) {
 528           Constant *NewRHS = ConstantExpr::get(I.getOpcode(), Op0C, Op1);
 529
 530           Value *NewShift =
 531             Builder->CreateBinOp(I.getOpcode(), Op0BO->getOperand(0), Op1);
 532           NewShift->takeName(Op0BO);
 533
 534           return BinaryOperator::Create(Op0BO->getOpcode(), NewShift,
 535                                         NewRHS);
 536         }
 537       }
 538     }
 539   }
 540
 541   // Find out if this is a shift of a shift by a constant.
 542   BinaryOperator *ShiftOp = dyn_cast<BinaryOperator>(Op0);
 543   if (ShiftOp && !ShiftOp->isShift())
 544     ShiftOp = 0;
 545
 546   if (ShiftOp && isa<ConstantInt>(ShiftOp->getOperand(1))) {
 547
 548     // This is a constant shift of a constant shift. Be careful about hiding
 549     // shl instructions behind bit masks. They are used to represent multiplies
 550     // by a constant, and it is important that simple arithmetic expressions
 551     // are still recognizable by scalar evolution.
 552     //
 553     // The transforms applied to shl are very similar to the transforms applied
 554     // to mul by constant. We can be more aggressive about optimizing right
 555     // shifts.
 556     //
 557     // Combinations of right and left shifts will still be optimized in
 558     // DAGCombine where scalar evolution no longer applies.
 559
 560     ConstantInt *ShiftAmt1C = cast<ConstantInt>(ShiftOp->getOperand(1));
 561     uint32_t ShiftAmt1 = ShiftAmt1C->getLimitedValue(TypeBits);
 562     uint32_t ShiftAmt2 = COp1->getLimitedValue(TypeBits);
 563     assert(ShiftAmt2 != 0 && "Should have been simplified earlier");
 564     if (ShiftAmt1 == 0) return 0;  // Will be simplified in the future.
 565     Value *X = ShiftOp->getOperand(0);
 566
 567     IntegerType *Ty = cast<IntegerType>(I.getType());
 568
 569     // Check for (X << c1) << c2  and  (X >> c1) >> c2
 570     if (I.getOpcode() == ShiftOp->getOpcode()) {
 571       uint32_t AmtSum = ShiftAmt1+ShiftAmt2;   // Fold into one big shift.
 572       // If this is oversized composite shift, then unsigned shifts get 0, ashr
 573       // saturates.
 574       if (AmtSum >= TypeBits) {
 575         if (I.getOpcode() != Instruction::AShr)
 576           return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
 577         AmtSum = TypeBits-1;  // Saturate to 31 for i32 ashr.
 578       }
 579
 580       return BinaryOperator::Create(I.getOpcode(), X,
 581                                     ConstantInt::get(Ty, AmtSum));
 582     }
 583
 584     if (ShiftAmt1 == ShiftAmt2) {
 585       // If we have ((X << C) >>u C), turn this into X & (-1 >>u C).
 586       if (I.getOpcode() == Instruction::LShr &&
 587           ShiftOp->getOpcode() == Instruction::Shl) {
 588         APInt Mask(APInt::getLowBitsSet(TypeBits, TypeBits - ShiftAmt1));
 589         return BinaryOperator::CreateAnd(X,
 590                                         ConstantInt::get(I.getContext(), Mask));
 591       }
 592     } else if (ShiftAmt1 < ShiftAmt2) {
 593       uint32_t ShiftDiff = ShiftAmt2-ShiftAmt1;
 594
 595       // (X >>?,exact C1) << C2 --> X << (C2-C1)
 596       // The inexact version is deferred to DAGCombine so we don't hide shl
 597       // behind a bit mask.
 598       if (I.getOpcode() == Instruction::Shl &&
 599           ShiftOp->getOpcode() != Instruction::Shl &&
 600           ShiftOp->isExact()) {
 601         assert(ShiftOp->getOpcode() == Instruction::LShr ||
 602                ShiftOp->getOpcode() == Instruction::AShr);
 603         ConstantInt *ShiftDiffCst = ConstantInt::get(Ty, ShiftDiff);
 604         BinaryOperator *NewShl = BinaryOperator::Create(Instruction::Shl,
 605                                                         X, ShiftDiffCst);
 606         NewShl->setHasNoUnsignedWrap(I.hasNoUnsignedWrap());
 607         NewShl->setHasNoSignedWrap(I.hasNoSignedWrap());
 608         return NewShl;
 609       }
 610
 611       // (X << C1) >>u C2  --> X >>u (C2-C1) & (-1 >> C2)
 612       if (I.getOpcode() == Instruction::LShr &&
 613           ShiftOp->getOpcode() == Instruction::Shl) {
 614         ConstantInt *ShiftDiffCst = ConstantInt::get(Ty, ShiftDiff);
 615         // (X <<nuw C1) >>u C2 --> X >>u (C2-C1)
 616         if (ShiftOp->hasNoUnsignedWrap()) {
 617           BinaryOperator *NewLShr = BinaryOperator::Create(Instruction::LShr,
 618                                                            X, ShiftDiffCst);
 619           NewLShr->setIsExact(I.isExact());
 620           return NewLShr;
 621         }
 622         Value *Shift = Builder->CreateLShr(X, ShiftDiffCst);
 623
 624         APInt Mask(APInt::getLowBitsSet(TypeBits, TypeBits - ShiftAmt2));
 625         return BinaryOperator::CreateAnd(Shift,
 626                                          ConstantInt::get(I.getContext(),Mask));
 627       }
 628
 629       // We can't handle (X << C1) >>s C2, it shifts arbitrary bits in. However,
 630       // we can handle (X <<nsw C1) >>s C2 since it only shifts in sign bits.
 631       if (I.getOpcode() == Instruction::AShr &&
 632           ShiftOp->getOpcode() == Instruction::Shl) {
 633         if (ShiftOp->hasNoSignedWrap()) {
 634           // (X <<nsw C1) >>s C2 --> X >>s (C2-C1)
 635           ConstantInt *ShiftDiffCst = ConstantInt::get(Ty, ShiftDiff);
 636           BinaryOperator *NewAShr = BinaryOperator::Create(Instruction::AShr,
 637                                                            X, ShiftDiffCst);
 638           NewAShr->setIsExact(I.isExact());
 639           return NewAShr;
 640         }
 641       }
 642     } else {
 643       assert(ShiftAmt2 < ShiftAmt1);
 644       uint32_t ShiftDiff = ShiftAmt1-ShiftAmt2;
 645
 646       // (X >>?exact C1) << C2 --> X >>?exact (C1-C2)
 647       // The inexact version is deferred to DAGCombine so we don't hide shl
 648       // behind a bit mask.
 649       if (I.getOpcode() == Instruction::Shl &&
 650           ShiftOp->getOpcode() != Instruction::Shl &&
 651           ShiftOp->isExact()) {
 652         ConstantInt *ShiftDiffCst = ConstantInt::get(Ty, ShiftDiff);
 653         BinaryOperator *NewShr = BinaryOperator::Create(ShiftOp->getOpcode(),
 654                                                         X, ShiftDiffCst);
 655         NewShr->setIsExact(true);
 656         return NewShr;
 657       }
 658
 659       // (X << C1) >>u C2  --> X << (C1-C2) & (-1 >> C2)
 660       if (I.getOpcode() == Instruction::LShr &&
 661           ShiftOp->getOpcode() == Instruction::Shl) {
 662         ConstantInt *ShiftDiffCst = ConstantInt::get(Ty, ShiftDiff);
 663         if (ShiftOp->hasNoUnsignedWrap()) {
 664           // (X <<nuw C1) >>u C2 --> X <<nuw (C1-C2)
 665           BinaryOperator *NewShl = BinaryOperator::Create(Instruction::Shl,
 666                                                           X, ShiftDiffCst);
 667           NewShl->setHasNoUnsignedWrap(true);
 668           return NewShl;
 669         }
 670         Value *Shift = Builder->CreateShl(X, ShiftDiffCst);
 671
 672         APInt Mask(APInt::getLowBitsSet(TypeBits, TypeBits - ShiftAmt2));
 673         return BinaryOperator::CreateAnd(Shift,
 674                                          ConstantInt::get(I.getContext(),Mask));
 675       }
 676
 677       // We can't handle (X << C1) >>s C2, it shifts arbitrary bits in. However,
 678       // we can handle (X <<nsw C1) >>s C2 since it only shifts in sign bits.
 679       if (I.getOpcode() == Instruction::AShr &&
 680           ShiftOp->getOpcode() == Instruction::Shl) {
 681         if (ShiftOp->hasNoSignedWrap()) {
 682           // (X <<nsw C1) >>s C2 --> X <<nsw (C1-C2)
 683           ConstantInt *ShiftDiffCst = ConstantInt::get(Ty, ShiftDiff);
 684           BinaryOperator *NewShl = BinaryOperator::Create(Instruction::Shl,
 685                                                           X, ShiftDiffCst);
 686           NewShl->setHasNoSignedWrap(true);
 687           return NewShl;
 688         }
 689       }
 690     }
 691   }
 692   return 0;
 693 }
 694
 695 Instruction *InstCombiner::visitShl(BinaryOperator &I) {
 696   if (Value *V = SimplifyShlInst(I.getOperand(0), I.getOperand(1),
 697                                  I.hasNoSignedWrap(), I.hasNoUnsignedWrap(),
 698                                  DL))
 699     return ReplaceInstUsesWith(I, V);
 700
 701   if (Instruction *V = commonShiftTransforms(I))
 702     return V;
 703
 704   if (ConstantInt *Op1C = dyn_cast<ConstantInt>(I.getOperand(1))) {
 705     unsigned ShAmt = Op1C->getZExtValue();
 706
 707     // If the shifted-out value is known-zero, then this is a NUW shift.
 708     if (!I.hasNoUnsignedWrap() &&
 709         MaskedValueIsZero(I.getOperand(0),
 710                           APInt::getHighBitsSet(Op1C->getBitWidth(), ShAmt))) {
 711           I.setHasNoUnsignedWrap();
 712           return &I;
 713         }
 714
 715     // If the shifted out value is all signbits, this is a NSW shift.
 716     if (!I.hasNoSignedWrap() &&
 717         ComputeNumSignBits(I.getOperand(0)) > ShAmt) {
 718       I.setHasNoSignedWrap();
 719       return &I;
 720     }
 721   }
 722
 723   // (C1 << A) << C2 -> (C1 << C2) << A
 724   Constant *C1, *C2;
 725   Value *A;
 726   if (match(I.getOperand(0), m_OneUse(m_Shl(m_Constant(C1), m_Value(A)))) &&
 727       match(I.getOperand(1), m_Constant(C2)))
 728     return BinaryOperator::CreateShl(ConstantExpr::getShl(C1, C2), A);
 729
 730   return 0;
 731 }
 732
 733 Instruction *InstCombiner::visitLShr(BinaryOperator &I) {
 734   if (Value *V = SimplifyLShrInst(I.getOperand(0), I.getOperand(1),
 735                                   I.isExact(), DL))
 736     return ReplaceInstUsesWith(I, V);
 737
 738   if (Instruction *R = commonShiftTransforms(I))
 739     return R;
 740
 741   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 742
 743   if (ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
 744     unsigned ShAmt = Op1C->getZExtValue();
 745
 746     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Op0)) {
 747       unsigned BitWidth = Op0->getType()->getScalarSizeInBits();
 748       // ctlz.i32(x)>>5  --> zext(x == 0)
 749       // cttz.i32(x)>>5  --> zext(x == 0)
 750       // ctpop.i32(x)>>5 --> zext(x == -1)
 751       if ((II->getIntrinsicID() == Intrinsic::ctlz ||
 752            II->getIntrinsicID() == Intrinsic::cttz ||
 753            II->getIntrinsicID() == Intrinsic::ctpop) &&
 754           isPowerOf2_32(BitWidth) && Log2_32(BitWidth) == ShAmt) {
 755         bool isCtPop = II->getIntrinsicID() == Intrinsic::ctpop;
 756         Constant *RHS = ConstantInt::getSigned(Op0->getType(), isCtPop ? -1:0);
 757         Value *Cmp = Builder->CreateICmpEQ(II->getArgOperand(0), RHS);
 758         return new ZExtInst(Cmp, II->getType());
 759       }
 760     }
 761
 762     // If the shifted-out value is known-zero, then this is an exact shift.
 763     if (!I.isExact() &&
 764         MaskedValueIsZero(Op0,APInt::getLowBitsSet(Op1C->getBitWidth(),ShAmt))){
 765       I.setIsExact();
 766       return &I;
 767     }
 768   }
 769
 770   return 0;
 771 }
 772
 773 Instruction *InstCombiner::visitAShr(BinaryOperator &I) {
 774   if (Value *V = SimplifyAShrInst(I.getOperand(0), I.getOperand(1),
 775                                   I.isExact(), DL))
 776     return ReplaceInstUsesWith(I, V);
 777
 778   if (Instruction *R = commonShiftTransforms(I))
 779     return R;
 780
 781   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
 782
 783   if (ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
 784     unsigned ShAmt = Op1C->getZExtValue();
 785
 786     // If the input is a SHL by the same constant (ashr (shl X, C), C), then we
 787     // have a sign-extend idiom.
 788     Value *X;
 789     if (match(Op0, m_Shl(m_Value(X), m_Specific(Op1)))) {
 790       // If the left shift is just shifting out partial signbits, delete the
 791       // extension.
 792       if (cast<OverflowingBinaryOperator>(Op0)->hasNoSignedWrap())
 793         return ReplaceInstUsesWith(I, X);
 794
 795       // If the input is an extension from the shifted amount value, e.g.
 796       //   %x = zext i8 %A to i32
 797       //   %y = shl i32 %x, 24
 798       //   %z = ashr %y, 24
 799       // then turn this into "z = sext i8 A to i32".
 800       if (ZExtInst *ZI = dyn_cast<ZExtInst>(X)) {
 801         uint32_t SrcBits = ZI->getOperand(0)->getType()->getScalarSizeInBits();
 802         uint32_t DestBits = ZI->getType()->getScalarSizeInBits();
 803         if (Op1C->getZExtValue() == DestBits-SrcBits)
 804           return new SExtInst(ZI->getOperand(0), ZI->getType());
 805       }
 806     }
 807
 808     // If the shifted-out value is known-zero, then this is an exact shift.
 809     if (!I.isExact() &&
 810         MaskedValueIsZero(Op0,APInt::getLowBitsSet(Op1C->getBitWidth(),ShAmt))){
 811       I.setIsExact();
 812       return &I;
 813     }
 814   }
 815
 816   // See if we can turn a signed shr into an unsigned shr.
 817   if (MaskedValueIsZero(Op0,
 818                         APInt::getSignBit(I.getType()->getScalarSizeInBits())))
 819     return BinaryOperator::CreateLShr(Op0, Op1);
 820
 821   // Arithmetic shifting an all-sign-bit value is a no-op.
 822   unsigned NumSignBits = ComputeNumSignBits(Op0);
 823   if (NumSignBits == Op0->getType()->getScalarSizeInBits())
 824     return ReplaceInstUsesWith(I, Op0);
 825
 826   return 0;
 827 }