lib/Analysis/ValueTracking.cpp

   1 //===- ValueTracking.cpp - Walk computations to compute properties --------===//
   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 contains routines that help analyze properties that chains of
  11 // computations have.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Analysis/ValueTracking.h"
  16 #include "llvm/ADT/SmallPtrSet.h"
  17 #include "llvm/Analysis/InstructionSimplify.h"
  18 #include "llvm/IR/Constants.h"
  19 #include "llvm/IR/DataLayout.h"
  20 #include "llvm/IR/GlobalAlias.h"
  21 #include "llvm/IR/GlobalVariable.h"
  22 #include "llvm/IR/Instructions.h"
  23 #include "llvm/IR/IntrinsicInst.h"
  24 #include "llvm/IR/LLVMContext.h"
  25 #include "llvm/IR/Metadata.h"
  26 #include "llvm/IR/Operator.h"
  27 #include "llvm/Support/ConstantRange.h"
  28 #include "llvm/Support/GetElementPtrTypeIterator.h"
  29 #include "llvm/Support/MathExtras.h"
  30 #include "llvm/Support/PatternMatch.h"
  31 #include <cstring>
  32 using namespace llvm;
  33 using namespace llvm::PatternMatch;
  34
  35 const unsigned MaxDepth = 6;
  36
  37 /// getBitWidth - Returns the bitwidth of the given scalar or pointer type (if
  38 /// unknown returns 0).  For vector types, returns the element type's bitwidth.
  39 static unsigned getBitWidth(Type *Ty, const DataLayout *TD) {
  40   if (unsigned BitWidth = Ty->getScalarSizeInBits())
  41     return BitWidth;
  42   assert(isa<PointerType>(Ty) && "Expected a pointer type!");
  43   return TD ? TD->getPointerSizeInBits() : 0;
  44 }
  45
  46 static void ComputeMaskedBitsAddSub(bool Add, Value *Op0, Value *Op1, bool NSW,
  47                                     APInt &KnownZero, APInt &KnownOne,
  48                                     APInt &KnownZero2, APInt &KnownOne2,
  49                                     const DataLayout *TD, unsigned Depth) {
  50   if (!Add) {
  51     if (ConstantInt *CLHS = dyn_cast<ConstantInt>(Op0)) {
  52       // We know that the top bits of C-X are clear if X contains less bits
  53       // than C (i.e. no wrap-around can happen).  For example, 20-X is
  54       // positive if we can prove that X is >= 0 and < 16.
  55       if (!CLHS->getValue().isNegative()) {
  56         unsigned BitWidth = KnownZero.getBitWidth();
  57         unsigned NLZ = (CLHS->getValue()+1).countLeadingZeros();
  58         // NLZ can't be BitWidth with no sign bit
  59         APInt MaskV = APInt::getHighBitsSet(BitWidth, NLZ+1);
  60         llvm::ComputeMaskedBits(Op1, KnownZero2, KnownOne2, TD, Depth+1);
  61
  62         // If all of the MaskV bits are known to be zero, then we know the
  63         // output top bits are zero, because we now know that the output is
  64         // from [0-C].
  65         if ((KnownZero2 & MaskV) == MaskV) {
  66           unsigned NLZ2 = CLHS->getValue().countLeadingZeros();
  67           // Top bits known zero.
  68           KnownZero = APInt::getHighBitsSet(BitWidth, NLZ2);
  69         }
  70       }
  71     }
  72   }
  73
  74   unsigned BitWidth = KnownZero.getBitWidth();
  75
  76   // If one of the operands has trailing zeros, then the bits that the
  77   // other operand has in those bit positions will be preserved in the
  78   // result. For an add, this works with either operand. For a subtract,
  79   // this only works if the known zeros are in the right operand.
  80   APInt LHSKnownZero(BitWidth, 0), LHSKnownOne(BitWidth, 0);
  81   llvm::ComputeMaskedBits(Op0, LHSKnownZero, LHSKnownOne, TD, Depth+1);
  82   assert((LHSKnownZero & LHSKnownOne) == 0 &&
  83          "Bits known to be one AND zero?");
  84   unsigned LHSKnownZeroOut = LHSKnownZero.countTrailingOnes();
  85
  86   llvm::ComputeMaskedBits(Op1, KnownZero2, KnownOne2, TD, Depth+1);
  87   assert((KnownZero2 & KnownOne2) == 0 && "Bits known to be one AND zero?");
  88   unsigned RHSKnownZeroOut = KnownZero2.countTrailingOnes();
  89
  90   // Determine which operand has more trailing zeros, and use that
  91   // many bits from the other operand.
  92   if (LHSKnownZeroOut > RHSKnownZeroOut) {
  93     if (Add) {
  94       APInt Mask = APInt::getLowBitsSet(BitWidth, LHSKnownZeroOut);
  95       KnownZero |= KnownZero2 & Mask;
  96       KnownOne  |= KnownOne2 & Mask;
  97     } else {
  98       // If the known zeros are in the left operand for a subtract,
  99       // fall back to the minimum known zeros in both operands.
 100       KnownZero |= APInt::getLowBitsSet(BitWidth,
 101                                         std::min(LHSKnownZeroOut,
 102                                                  RHSKnownZeroOut));
 103     }
 104   } else if (RHSKnownZeroOut >= LHSKnownZeroOut) {
 105     APInt Mask = APInt::getLowBitsSet(BitWidth, RHSKnownZeroOut);
 106     KnownZero |= LHSKnownZero & Mask;
 107     KnownOne  |= LHSKnownOne & Mask;
 108   }
 109
 110   // Are we still trying to solve for the sign bit?
 111   if (!KnownZero.isNegative() && !KnownOne.isNegative()) {
 112     if (NSW) {
 113       if (Add) {
 114         // Adding two positive numbers can't wrap into negative
 115         if (LHSKnownZero.isNegative() && KnownZero2.isNegative())
 116           KnownZero |= APInt::getSignBit(BitWidth);
 117         // and adding two negative numbers can't wrap into positive.
 118         else if (LHSKnownOne.isNegative() && KnownOne2.isNegative())
 119           KnownOne |= APInt::getSignBit(BitWidth);
 120       } else {
 121         // Subtracting a negative number from a positive one can't wrap
 122         if (LHSKnownZero.isNegative() && KnownOne2.isNegative())
 123           KnownZero |= APInt::getSignBit(BitWidth);
 124         // neither can subtracting a positive number from a negative one.
 125         else if (LHSKnownOne.isNegative() && KnownZero2.isNegative())
 126           KnownOne |= APInt::getSignBit(BitWidth);
 127       }
 128     }
 129   }
 130 }
 131
 132 static void ComputeMaskedBitsMul(Value *Op0, Value *Op1, bool NSW,
 133                                  APInt &KnownZero, APInt &KnownOne,
 134                                  APInt &KnownZero2, APInt &KnownOne2,
 135                                  const DataLayout *TD, unsigned Depth) {
 136   unsigned BitWidth = KnownZero.getBitWidth();
 137   ComputeMaskedBits(Op1, KnownZero, KnownOne, TD, Depth+1);
 138   ComputeMaskedBits(Op0, KnownZero2, KnownOne2, TD, Depth+1);
 139   assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
 140   assert((KnownZero2 & KnownOne2) == 0 && "Bits known to be one AND zero?");
 141
 142   bool isKnownNegative = false;
 143   bool isKnownNonNegative = false;
 144   // If the multiplication is known not to overflow, compute the sign bit.
 145   if (NSW) {
 146     if (Op0 == Op1) {
 147       // The product of a number with itself is non-negative.
 148       isKnownNonNegative = true;
 149     } else {
 150       bool isKnownNonNegativeOp1 = KnownZero.isNegative();
 151       bool isKnownNonNegativeOp0 = KnownZero2.isNegative();
 152       bool isKnownNegativeOp1 = KnownOne.isNegative();
 153       bool isKnownNegativeOp0 = KnownOne2.isNegative();
 154       // The product of two numbers with the same sign is non-negative.
 155       isKnownNonNegative = (isKnownNegativeOp1 && isKnownNegativeOp0) ||
 156         (isKnownNonNegativeOp1 && isKnownNonNegativeOp0);
 157       // The product of a negative number and a non-negative number is either
 158       // negative or zero.
 159       if (!isKnownNonNegative)
 160         isKnownNegative = (isKnownNegativeOp1 && isKnownNonNegativeOp0 &&
 161                            isKnownNonZero(Op0, TD, Depth)) ||
 162                           (isKnownNegativeOp0 && isKnownNonNegativeOp1 &&
 163                            isKnownNonZero(Op1, TD, Depth));
 164     }
 165   }
 166
 167   // If low bits are zero in either operand, output low known-0 bits.
 168   // Also compute a conserative estimate for high known-0 bits.
 169   // More trickiness is possible, but this is sufficient for the
 170   // interesting case of alignment computation.
 171   KnownOne.clearAllBits();
 172   unsigned TrailZ = KnownZero.countTrailingOnes() +
 173                     KnownZero2.countTrailingOnes();
 174   unsigned LeadZ =  std::max(KnownZero.countLeadingOnes() +
 175                              KnownZero2.countLeadingOnes(),
 176                              BitWidth) - BitWidth;
 177
 178   TrailZ = std::min(TrailZ, BitWidth);
 179   LeadZ = std::min(LeadZ, BitWidth);
 180   KnownZero = APInt::getLowBitsSet(BitWidth, TrailZ) |
 181               APInt::getHighBitsSet(BitWidth, LeadZ);
 182
 183   // Only make use of no-wrap flags if we failed to compute the sign bit
 184   // directly.  This matters if the multiplication always overflows, in
 185   // which case we prefer to follow the result of the direct computation,
 186   // though as the program is invoking undefined behaviour we can choose
 187   // whatever we like here.
 188   if (isKnownNonNegative && !KnownOne.isNegative())
 189     KnownZero.setBit(BitWidth - 1);
 190   else if (isKnownNegative && !KnownZero.isNegative())
 191     KnownOne.setBit(BitWidth - 1);
 192 }
 193
 194 void llvm::computeMaskedBitsLoad(const MDNode &Ranges, APInt &KnownZero) {
 195   unsigned BitWidth = KnownZero.getBitWidth();
 196   unsigned NumRanges = Ranges.getNumOperands() / 2;
 197   assert(NumRanges >= 1);
 198
 199   // Use the high end of the ranges to find leading zeros.
 200   unsigned MinLeadingZeros = BitWidth;
 201   for (unsigned i = 0; i < NumRanges; ++i) {
 202     ConstantInt *Lower = cast<ConstantInt>(Ranges.getOperand(2*i + 0));
 203     ConstantInt *Upper = cast<ConstantInt>(Ranges.getOperand(2*i + 1));
 204     ConstantRange Range(Lower->getValue(), Upper->getValue());
 205     if (Range.isWrappedSet())
 206       MinLeadingZeros = 0; // -1 has no zeros
 207     unsigned LeadingZeros = (Upper->getValue() - 1).countLeadingZeros();
 208     MinLeadingZeros = std::min(LeadingZeros, MinLeadingZeros);
 209   }
 210
 211   KnownZero = APInt::getHighBitsSet(BitWidth, MinLeadingZeros);
 212 }
 213 /// ComputeMaskedBits - Determine which of the bits are known to be either zero
 214 /// or one and return them in the KnownZero/KnownOne bit sets.
 215 ///
 216 /// NOTE: we cannot consider 'undef' to be "IsZero" here.  The problem is that
 217 /// we cannot optimize based on the assumption that it is zero without changing
 218 /// it to be an explicit zero.  If we don't change it to zero, other code could
 219 /// optimized based on the contradictory assumption that it is non-zero.
 220 /// Because instcombine aggressively folds operations with undef args anyway,
 221 /// this won't lose us code quality.
 222 ///
 223 /// This function is defined on values with integer type, values with pointer
 224 /// type (but only if TD is non-null), and vectors of integers.  In the case
 225 /// where V is a vector, known zero, and known one values are the
 226 /// same width as the vector element, and the bit is set only if it is true
 227 /// for all of the elements in the vector.
 228 void llvm::ComputeMaskedBits(Value *V, APInt &KnownZero, APInt &KnownOne,
 229                              const DataLayout *TD, unsigned Depth) {
 230   assert(V && "No Value?");
 231   assert(Depth <= MaxDepth && "Limit Search Depth");
 232   unsigned BitWidth = KnownZero.getBitWidth();
 233
 234   assert((V->getType()->isIntOrIntVectorTy() ||
 235           V->getType()->getScalarType()->isPointerTy()) &&
 236          "Not integer or pointer type!");
 237   assert((!TD ||
 238           TD->getTypeSizeInBits(V->getType()->getScalarType()) == BitWidth) &&
 239          (!V->getType()->isIntOrIntVectorTy() ||
 240           V->getType()->getScalarSizeInBits() == BitWidth) &&
 241          KnownZero.getBitWidth() == BitWidth &&
 242          KnownOne.getBitWidth() == BitWidth &&
 243          "V, Mask, KnownOne and KnownZero should have same BitWidth");
 244
 245   if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
 246     // We know all of the bits for a constant!
 247     KnownOne = CI->getValue();
 248     KnownZero = ~KnownOne;
 249     return;
 250   }
 251   // Null and aggregate-zero are all-zeros.
 252   if (isa<ConstantPointerNull>(V) ||
 253       isa<ConstantAggregateZero>(V)) {
 254     KnownOne.clearAllBits();
 255     KnownZero = APInt::getAllOnesValue(BitWidth);
 256     return;
 257   }
 258   // Handle a constant vector by taking the intersection of the known bits of
 259   // each element.  There is no real need to handle ConstantVector here, because
 260   // we don't handle undef in any particularly useful way.
 261   if (ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V)) {
 262     // We know that CDS must be a vector of integers. Take the intersection of
 263     // each element.
 264     KnownZero.setAllBits(); KnownOne.setAllBits();
 265     APInt Elt(KnownZero.getBitWidth(), 0);
 266     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
 267       Elt = CDS->getElementAsInteger(i);
 268       KnownZero &= ~Elt;
 269       KnownOne &= Elt;
 270     }
 271     return;
 272   }
 273
 274   // The address of an aligned GlobalValue has trailing zeros.
 275   if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 276     unsigned Align = GV->getAlignment();
 277     if (Align == 0 && TD) {
 278       if (GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV)) {
 279         Type *ObjectType = GVar->getType()->getElementType();
 280         if (ObjectType->isSized()) {
 281           // If the object is defined in the current Module, we'll be giving
 282           // it the preferred alignment. Otherwise, we have to assume that it
 283           // may only have the minimum ABI alignment.
 284           if (!GVar->isDeclaration() && !GVar->isWeakForLinker())
 285             Align = TD->getPreferredAlignment(GVar);
 286           else
 287             Align = TD->getABITypeAlignment(ObjectType);
 288         }
 289       }
 290     }
 291     if (Align > 0)
 292       KnownZero = APInt::getLowBitsSet(BitWidth,
 293                                        CountTrailingZeros_32(Align));
 294     else
 295       KnownZero.clearAllBits();
 296     KnownOne.clearAllBits();
 297     return;
 298   }
 299   // A weak GlobalAlias is totally unknown. A non-weak GlobalAlias has
 300   // the bits of its aliasee.
 301   if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
 302     if (GA->mayBeOverridden()) {
 303       KnownZero.clearAllBits(); KnownOne.clearAllBits();
 304     } else {
 305       ComputeMaskedBits(GA->getAliasee(), KnownZero, KnownOne, TD, Depth+1);
 306     }
 307     return;
 308   }
 309
 310   if (Argument *A = dyn_cast<Argument>(V)) {
 311     unsigned Align = 0;
 312
 313     if (A->hasByValAttr()) {
 314       // Get alignment information off byval arguments if specified in the IR.
 315       Align = A->getParamAlignment();
 316     } else if (TD && A->hasStructRetAttr()) {
 317       // An sret parameter has at least the ABI alignment of the return type.
 318       Type *EltTy = cast<PointerType>(A->getType())->getElementType();
 319       if (EltTy->isSized())
 320         Align = TD->getABITypeAlignment(EltTy);
 321     }
 322
 323     if (Align)
 324       KnownZero = APInt::getLowBitsSet(BitWidth, CountTrailingZeros_32(Align));
 325     return;
 326   }
 327
 328   // Start out not knowing anything.
 329   KnownZero.clearAllBits(); KnownOne.clearAllBits();
 330
 331   if (Depth == MaxDepth)
 332     return;  // Limit search depth.
 333
 334   Operator *I = dyn_cast<Operator>(V);
 335   if (!I) return;
 336
 337   APInt KnownZero2(KnownZero), KnownOne2(KnownOne);
 338   switch (I->getOpcode()) {
 339   default: break;
 340   case Instruction::Load:
 341     if (MDNode *MD = cast<LoadInst>(I)->getMetadata(LLVMContext::MD_range))
 342       computeMaskedBitsLoad(*MD, KnownZero);
 343     return;
 344   case Instruction::And: {
 345     // If either the LHS or the RHS are Zero, the result is zero.
 346     ComputeMaskedBits(I->getOperand(1), KnownZero, KnownOne, TD, Depth+1);
 347     ComputeMaskedBits(I->getOperand(0), KnownZero2, KnownOne2, TD, Depth+1);
 348     assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
 349     assert((KnownZero2 & KnownOne2) == 0 && "Bits known to be one AND zero?");
 350
 351     // Output known-1 bits are only known if set in both the LHS & RHS.
 352     KnownOne &= KnownOne2;
 353     // Output known-0 are known to be clear if zero in either the LHS | RHS.
 354     KnownZero |= KnownZero2;
 355     return;
 356   }
 357   case Instruction::Or: {
 358     ComputeMaskedBits(I->getOperand(1), KnownZero, KnownOne, TD, Depth+1);
 359     ComputeMaskedBits(I->getOperand(0), KnownZero2, KnownOne2, TD, Depth+1);
 360     assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
 361     assert((KnownZero2 & KnownOne2) == 0 && "Bits known to be one AND zero?");
 362
 363     // Output known-0 bits are only known if clear in both the LHS & RHS.
 364     KnownZero &= KnownZero2;
 365     // Output known-1 are known to be set if set in either the LHS | RHS.
 366     KnownOne |= KnownOne2;
 367     return;
 368   }
 369   case Instruction::Xor: {
 370     ComputeMaskedBits(I->getOperand(1), KnownZero, KnownOne, TD, Depth+1);
 371     ComputeMaskedBits(I->getOperand(0), KnownZero2, KnownOne2, TD, Depth+1);
 372     assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
 373     assert((KnownZero2 & KnownOne2) == 0 && "Bits known to be one AND zero?");
 374
 375     // Output known-0 bits are known if clear or set in both the LHS & RHS.
 376     APInt KnownZeroOut = (KnownZero & KnownZero2) | (KnownOne & KnownOne2);
 377     // Output known-1 are known to be set if set in only one of the LHS, RHS.
 378     KnownOne = (KnownZero & KnownOne2) | (KnownOne & KnownZero2);
 379     KnownZero = KnownZeroOut;
 380     return;
 381   }
 382   case Instruction::Mul: {
 383     bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
 384     ComputeMaskedBitsMul(I->getOperand(0), I->getOperand(1), NSW,
 385                          KnownZero, KnownOne, KnownZero2, KnownOne2, TD, Depth);
 386     break;
 387   }
 388   case Instruction::UDiv: {
 389     // For the purposes of computing leading zeros we can conservatively
 390     // treat a udiv as a logical right shift by the power of 2 known to
 391     // be less than the denominator.
 392     ComputeMaskedBits(I->getOperand(0), KnownZero2, KnownOne2, TD, Depth+1);
 393     unsigned LeadZ = KnownZero2.countLeadingOnes();
 394
 395     KnownOne2.clearAllBits();
 396     KnownZero2.clearAllBits();
 397     ComputeMaskedBits(I->getOperand(1), KnownZero2, KnownOne2, TD, Depth+1);
 398     unsigned RHSUnknownLeadingOnes = KnownOne2.countLeadingZeros();
 399     if (RHSUnknownLeadingOnes != BitWidth)
 400       LeadZ = std::min(BitWidth,
 401                        LeadZ + BitWidth - RHSUnknownLeadingOnes - 1);
 402
 403     KnownZero = APInt::getHighBitsSet(BitWidth, LeadZ);
 404     return;
 405   }
 406   case Instruction::Select:
 407     ComputeMaskedBits(I->getOperand(2), KnownZero, KnownOne, TD, Depth+1);
 408     ComputeMaskedBits(I->getOperand(1), KnownZero2, KnownOne2, TD,
 409                       Depth+1);
 410     assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
 411     assert((KnownZero2 & KnownOne2) == 0 && "Bits known to be one AND zero?");
 412
 413     // Only known if known in both the LHS and RHS.
 414     KnownOne &= KnownOne2;
 415     KnownZero &= KnownZero2;
 416     return;
 417   case Instruction::FPTrunc:
 418   case Instruction::FPExt:
 419   case Instruction::FPToUI:
 420   case Instruction::FPToSI:
 421   case Instruction::SIToFP:
 422   case Instruction::UIToFP:
 423     return; // Can't work with floating point.
 424   case Instruction::PtrToInt:
 425   case Instruction::IntToPtr:
 426     // We can't handle these if we don't know the pointer size.
 427     if (!TD) return;
 428     // FALL THROUGH and handle them the same as zext/trunc.
 429   case Instruction::ZExt:
 430   case Instruction::Trunc: {
 431     Type *SrcTy = I->getOperand(0)->getType();
 432
 433     unsigned SrcBitWidth;
 434     // Note that we handle pointer operands here because of inttoptr/ptrtoint
 435     // which fall through here.
 436     if(TD) {
 437       SrcBitWidth = TD->getTypeSizeInBits(SrcTy->getScalarType());
 438     } else {
 439       SrcBitWidth = SrcTy->getScalarSizeInBits();
 440       if (!SrcBitWidth) return;
 441     }
 442
 443     assert(SrcBitWidth && "SrcBitWidth can't be zero");
 444     KnownZero = KnownZero.zextOrTrunc(SrcBitWidth);
 445     KnownOne = KnownOne.zextOrTrunc(SrcBitWidth);
 446     ComputeMaskedBits(I->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
 447     KnownZero = KnownZero.zextOrTrunc(BitWidth);
 448     KnownOne = KnownOne.zextOrTrunc(BitWidth);
 449     // Any top bits are known to be zero.
 450     if (BitWidth > SrcBitWidth)
 451       KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - SrcBitWidth);
 452     return;
 453   }
 454   case Instruction::BitCast: {
 455     Type *SrcTy = I->getOperand(0)->getType();
 456     if ((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
 457         // TODO: For now, not handling conversions like:
 458         // (bitcast i64 %x to <2 x i32>)
 459         !I->getType()->isVectorTy()) {
 460       ComputeMaskedBits(I->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
 461       return;
 462     }
 463     break;
 464   }
 465   case Instruction::SExt: {
 466     // Compute the bits in the result that are not present in the input.
 467     unsigned SrcBitWidth = I->getOperand(0)->getType()->getScalarSizeInBits();
 468
 469     KnownZero = KnownZero.trunc(SrcBitWidth);
 470     KnownOne = KnownOne.trunc(SrcBitWidth);
 471     ComputeMaskedBits(I->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
 472     assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
 473     KnownZero = KnownZero.zext(BitWidth);
 474     KnownOne = KnownOne.zext(BitWidth);
 475
 476     // If the sign bit of the input is known set or clear, then we know the
 477     // top bits of the result.
 478     if (KnownZero[SrcBitWidth-1])             // Input sign bit known zero
 479       KnownZero |= APInt::getHighBitsSet(BitWidth, BitWidth - SrcBitWidth);
 480     else if (KnownOne[SrcBitWidth-1])           // Input sign bit known set
 481       KnownOne |= APInt::getHighBitsSet(BitWidth, BitWidth - SrcBitWidth);
 482     return;
 483   }
 484   case Instruction::Shl:
 485     // (shl X, C1) & C2 == 0   iff   (X & C2 >>u C1) == 0
 486     if (ConstantInt *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
 487       uint64_t ShiftAmt = SA->getLimitedValue(BitWidth);
 488       ComputeMaskedBits(I->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
 489       assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
 490       KnownZero <<= ShiftAmt;
 491       KnownOne  <<= ShiftAmt;
 492       KnownZero |= APInt::getLowBitsSet(BitWidth, ShiftAmt); // low bits known 0
 493       return;
 494     }
 495     break;
 496   case Instruction::LShr:
 497     // (ushr X, C1) & C2 == 0   iff  (-1 >> C1) & C2 == 0
 498     if (ConstantInt *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
 499       // Compute the new bits that are at the top now.
 500       uint64_t ShiftAmt = SA->getLimitedValue(BitWidth);
 501
 502       // Unsigned shift right.
 503       ComputeMaskedBits(I->getOperand(0), KnownZero,KnownOne, TD, Depth+1);
 504       assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
 505       KnownZero = APIntOps::lshr(KnownZero, ShiftAmt);
 506       KnownOne  = APIntOps::lshr(KnownOne, ShiftAmt);
 507       // high bits known zero.
 508       KnownZero |= APInt::getHighBitsSet(BitWidth, ShiftAmt);
 509       return;
 510     }
 511     break;
 512   case Instruction::AShr:
 513     // (ashr X, C1) & C2 == 0   iff  (-1 >> C1) & C2 == 0
 514     if (ConstantInt *SA = dyn_cast<ConstantInt>(I->getOperand(1))) {
 515       // Compute the new bits that are at the top now.
 516       uint64_t ShiftAmt = SA->getLimitedValue(BitWidth-1);
 517
 518       // Signed shift right.
 519       ComputeMaskedBits(I->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
 520       assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
 521       KnownZero = APIntOps::lshr(KnownZero, ShiftAmt);
 522       KnownOne  = APIntOps::lshr(KnownOne, ShiftAmt);
 523
 524       APInt HighBits(APInt::getHighBitsSet(BitWidth, ShiftAmt));
 525       if (KnownZero[BitWidth-ShiftAmt-1])    // New bits are known zero.
 526         KnownZero |= HighBits;
 527       else if (KnownOne[BitWidth-ShiftAmt-1])  // New bits are known one.
 528         KnownOne |= HighBits;
 529       return;
 530     }
 531     break;
 532   case Instruction::Sub: {
 533     bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
 534     ComputeMaskedBitsAddSub(false, I->getOperand(0), I->getOperand(1), NSW,
 535                             KnownZero, KnownOne, KnownZero2, KnownOne2, TD,
 536                             Depth);
 537     break;
 538   }
 539   case Instruction::Add: {
 540     bool NSW = cast<OverflowingBinaryOperator>(I)->hasNoSignedWrap();
 541     ComputeMaskedBitsAddSub(true, I->getOperand(0), I->getOperand(1), NSW,
 542                             KnownZero, KnownOne, KnownZero2, KnownOne2, TD,
 543                             Depth);
 544     break;
 545   }
 546   case Instruction::SRem:
 547     if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
 548       APInt RA = Rem->getValue().abs();
 549       if (RA.isPowerOf2()) {
 550         APInt LowBits = RA - 1;
 551         ComputeMaskedBits(I->getOperand(0), KnownZero2, KnownOne2, TD, Depth+1);
 552
 553         // The low bits of the first operand are unchanged by the srem.
 554         KnownZero = KnownZero2 & LowBits;
 555         KnownOne = KnownOne2 & LowBits;
 556
 557         // If the first operand is non-negative or has all low bits zero, then
 558         // the upper bits are all zero.
 559         if (KnownZero2[BitWidth-1] || ((KnownZero2 & LowBits) == LowBits))
 560           KnownZero |= ~LowBits;
 561
 562         // If the first operand is negative and not all low bits are zero, then
 563         // the upper bits are all one.
 564         if (KnownOne2[BitWidth-1] && ((KnownOne2 & LowBits) != 0))
 565           KnownOne |= ~LowBits;
 566
 567         assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
 568       }
 569     }
 570
 571     // The sign bit is the LHS's sign bit, except when the result of the
 572     // remainder is zero.
 573     if (KnownZero.isNonNegative()) {
 574       APInt LHSKnownZero(BitWidth, 0), LHSKnownOne(BitWidth, 0);
 575       ComputeMaskedBits(I->getOperand(0), LHSKnownZero, LHSKnownOne, TD,
 576                         Depth+1);
 577       // If it's known zero, our sign bit is also zero.
 578       if (LHSKnownZero.isNegative())
 579         KnownZero.setBit(BitWidth - 1);
 580     }
 581
 582     break;
 583   case Instruction::URem: {
 584     if (ConstantInt *Rem = dyn_cast<ConstantInt>(I->getOperand(1))) {
 585       APInt RA = Rem->getValue();
 586       if (RA.isPowerOf2()) {
 587         APInt LowBits = (RA - 1);
 588         ComputeMaskedBits(I->getOperand(0), KnownZero, KnownOne, TD,
 589                           Depth+1);
 590         assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
 591         KnownZero |= ~LowBits;
 592         KnownOne &= LowBits;
 593         break;
 594       }
 595     }
 596
 597     // Since the result is less than or equal to either operand, any leading
 598     // zero bits in either operand must also exist in the result.
 599     ComputeMaskedBits(I->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
 600     ComputeMaskedBits(I->getOperand(1), KnownZero2, KnownOne2, TD, Depth+1);
 601
 602     unsigned Leaders = std::max(KnownZero.countLeadingOnes(),
 603                                 KnownZero2.countLeadingOnes());
 604     KnownOne.clearAllBits();
 605     KnownZero = APInt::getHighBitsSet(BitWidth, Leaders);
 606     break;
 607   }
 608
 609   case Instruction::Alloca: {
 610     AllocaInst *AI = cast<AllocaInst>(V);
 611     unsigned Align = AI->getAlignment();
 612     if (Align == 0 && TD)
 613       Align = TD->getABITypeAlignment(AI->getType()->getElementType());
 614
 615     if (Align > 0)
 616       KnownZero = APInt::getLowBitsSet(BitWidth, CountTrailingZeros_32(Align));
 617     break;
 618   }
 619   case Instruction::GetElementPtr: {
 620     // Analyze all of the subscripts of this getelementptr instruction
 621     // to determine if we can prove known low zero bits.
 622     APInt LocalKnownZero(BitWidth, 0), LocalKnownOne(BitWidth, 0);
 623     ComputeMaskedBits(I->getOperand(0), LocalKnownZero, LocalKnownOne, TD,
 624                       Depth+1);
 625     unsigned TrailZ = LocalKnownZero.countTrailingOnes();
 626
 627     gep_type_iterator GTI = gep_type_begin(I);
 628     for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i, ++GTI) {
 629       Value *Index = I->getOperand(i);
 630       if (StructType *STy = dyn_cast<StructType>(*GTI)) {
 631         // Handle struct member offset arithmetic.
 632         if (!TD) return;
 633         const StructLayout *SL = TD->getStructLayout(STy);
 634         unsigned Idx = cast<ConstantInt>(Index)->getZExtValue();
 635         uint64_t Offset = SL->getElementOffset(Idx);
 636         TrailZ = std::min(TrailZ,
 637                           CountTrailingZeros_64(Offset));
 638       } else {
 639         // Handle array index arithmetic.
 640         Type *IndexedTy = GTI.getIndexedType();
 641         if (!IndexedTy->isSized()) return;
 642         unsigned GEPOpiBits = Index->getType()->getScalarSizeInBits();
 643         uint64_t TypeSize = TD ? TD->getTypeAllocSize(IndexedTy) : 1;
 644         LocalKnownZero = LocalKnownOne = APInt(GEPOpiBits, 0);
 645         ComputeMaskedBits(Index, LocalKnownZero, LocalKnownOne, TD, Depth+1);
 646         TrailZ = std::min(TrailZ,
 647                           unsigned(CountTrailingZeros_64(TypeSize) +
 648                                    LocalKnownZero.countTrailingOnes()));
 649       }
 650     }
 651
 652     KnownZero = APInt::getLowBitsSet(BitWidth, TrailZ);
 653     break;
 654   }
 655   case Instruction::PHI: {
 656     PHINode *P = cast<PHINode>(I);
 657     // Handle the case of a simple two-predecessor recurrence PHI.
 658     // There's a lot more that could theoretically be done here, but
 659     // this is sufficient to catch some interesting cases.
 660     if (P->getNumIncomingValues() == 2) {
 661       for (unsigned i = 0; i != 2; ++i) {
 662         Value *L = P->getIncomingValue(i);
 663         Value *R = P->getIncomingValue(!i);
 664         Operator *LU = dyn_cast<Operator>(L);
 665         if (!LU)
 666           continue;
 667         unsigned Opcode = LU->getOpcode();
 668         // Check for operations that have the property that if
 669         // both their operands have low zero bits, the result
 670         // will have low zero bits.
 671         if (Opcode == Instruction::Add ||
 672             Opcode == Instruction::Sub ||
 673             Opcode == Instruction::And ||
 674             Opcode == Instruction::Or ||
 675             Opcode == Instruction::Mul) {
 676           Value *LL = LU->getOperand(0);
 677           Value *LR = LU->getOperand(1);
 678           // Find a recurrence.
 679           if (LL == I)
 680             L = LR;
 681           else if (LR == I)
 682             L = LL;
 683           else
 684             break;
 685           // Ok, we have a PHI of the form L op= R. Check for low
 686           // zero bits.
 687           ComputeMaskedBits(R, KnownZero2, KnownOne2, TD, Depth+1);
 688
 689           // We need to take the minimum number of known bits
 690           APInt KnownZero3(KnownZero), KnownOne3(KnownOne);
 691           ComputeMaskedBits(L, KnownZero3, KnownOne3, TD, Depth+1);
 692
 693           KnownZero = APInt::getLowBitsSet(BitWidth,
 694                                            std::min(KnownZero2.countTrailingOnes(),
 695                                                     KnownZero3.countTrailingOnes()));
 696           break;
 697         }
 698       }
 699     }
 700
 701     // Unreachable blocks may have zero-operand PHI nodes.
 702     if (P->getNumIncomingValues() == 0)
 703       return;
 704
 705     // Otherwise take the unions of the known bit sets of the operands,
 706     // taking conservative care to avoid excessive recursion.
 707     if (Depth < MaxDepth - 1 && !KnownZero && !KnownOne) {
 708       // Skip if every incoming value references to ourself.
 709       if (dyn_cast_or_null<UndefValue>(P->hasConstantValue()))
 710         break;
 711
 712       KnownZero = APInt::getAllOnesValue(BitWidth);
 713       KnownOne = APInt::getAllOnesValue(BitWidth);
 714       for (unsigned i = 0, e = P->getNumIncomingValues(); i != e; ++i) {
 715         // Skip direct self references.
 716         if (P->getIncomingValue(i) == P) continue;
 717
 718         KnownZero2 = APInt(BitWidth, 0);
 719         KnownOne2 = APInt(BitWidth, 0);
 720         // Recurse, but cap the recursion to one level, because we don't
 721         // want to waste time spinning around in loops.
 722         ComputeMaskedBits(P->getIncomingValue(i), KnownZero2, KnownOne2, TD,
 723                           MaxDepth-1);
 724         KnownZero &= KnownZero2;
 725         KnownOne &= KnownOne2;
 726         // If all bits have been ruled out, there's no need to check
 727         // more operands.
 728         if (!KnownZero && !KnownOne)
 729           break;
 730       }
 731     }
 732     break;
 733   }
 734   case Instruction::Call:
 735     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
 736       switch (II->getIntrinsicID()) {
 737       default: break;
 738       case Intrinsic::ctlz:
 739       case Intrinsic::cttz: {
 740         unsigned LowBits = Log2_32(BitWidth)+1;
 741         // If this call is undefined for 0, the result will be less than 2^n.
 742         if (II->getArgOperand(1) == ConstantInt::getTrue(II->getContext()))
 743           LowBits -= 1;
 744         KnownZero = APInt::getHighBitsSet(BitWidth, BitWidth - LowBits);
 745         break;
 746       }
 747       case Intrinsic::ctpop: {
 748         unsigned LowBits = Log2_32(BitWidth)+1;
 749         KnownZero = APInt::getHighBitsSet(BitWidth, BitWidth - LowBits);
 750         break;
 751       }
 752       case Intrinsic::x86_sse42_crc32_64_8:
 753       case Intrinsic::x86_sse42_crc32_64_64:
 754         KnownZero = APInt::getHighBitsSet(64, 32);
 755         break;
 756       }
 757     }
 758     break;
 759   case Instruction::ExtractValue:
 760     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I->getOperand(0))) {
 761       ExtractValueInst *EVI = cast<ExtractValueInst>(I);
 762       if (EVI->getNumIndices() != 1) break;
 763       if (EVI->getIndices()[0] == 0) {
 764         switch (II->getIntrinsicID()) {
 765         default: break;
 766         case Intrinsic::uadd_with_overflow:
 767         case Intrinsic::sadd_with_overflow:
 768           ComputeMaskedBitsAddSub(true, II->getArgOperand(0),
 769                                   II->getArgOperand(1), false, KnownZero,
 770                                   KnownOne, KnownZero2, KnownOne2, TD, Depth);
 771           break;
 772         case Intrinsic::usub_with_overflow:
 773         case Intrinsic::ssub_with_overflow:
 774           ComputeMaskedBitsAddSub(false, II->getArgOperand(0),
 775                                   II->getArgOperand(1), false, KnownZero,
 776                                   KnownOne, KnownZero2, KnownOne2, TD, Depth);
 777           break;
 778         case Intrinsic::umul_with_overflow:
 779         case Intrinsic::smul_with_overflow:
 780           ComputeMaskedBitsMul(II->getArgOperand(0), II->getArgOperand(1),
 781                                false, KnownZero, KnownOne,
 782                                KnownZero2, KnownOne2, TD, Depth);
 783           break;
 784         }
 785       }
 786     }
 787   }
 788 }
 789
 790 /// ComputeSignBit - Determine whether the sign bit is known to be zero or
 791 /// one.  Convenience wrapper around ComputeMaskedBits.
 792 void llvm::ComputeSignBit(Value *V, bool &KnownZero, bool &KnownOne,
 793                           const DataLayout *TD, unsigned Depth) {
 794   unsigned BitWidth = getBitWidth(V->getType(), TD);
 795   if (!BitWidth) {
 796     KnownZero = false;
 797     KnownOne = false;
 798     return;
 799   }
 800   APInt ZeroBits(BitWidth, 0);
 801   APInt OneBits(BitWidth, 0);
 802   ComputeMaskedBits(V, ZeroBits, OneBits, TD, Depth);
 803   KnownOne = OneBits[BitWidth - 1];
 804   KnownZero = ZeroBits[BitWidth - 1];
 805 }
 806
 807 /// isKnownToBeAPowerOfTwo - Return true if the given value is known to have exactly one
 808 /// bit set when defined. For vectors return true if every element is known to
 809 /// be a power of two when defined.  Supports values with integer or pointer
 810 /// types and vectors of integers.
 811 bool llvm::isKnownToBeAPowerOfTwo(Value *V, bool OrZero, unsigned Depth) {
 812   if (Constant *C = dyn_cast<Constant>(V)) {
 813     if (C->isNullValue())
 814       return OrZero;
 815     if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
 816       return CI->getValue().isPowerOf2();
 817     // TODO: Handle vector constants.
 818   }
 819
 820   // 1 << X is clearly a power of two if the one is not shifted off the end.  If
 821   // it is shifted off the end then the result is undefined.
 822   if (match(V, m_Shl(m_One(), m_Value())))
 823     return true;
 824
 825   // (signbit) >>l X is clearly a power of two if the one is not shifted off the
 826   // bottom.  If it is shifted off the bottom then the result is undefined.
 827   if (match(V, m_LShr(m_SignBit(), m_Value())))
 828     return true;
 829
 830   // The remaining tests are all recursive, so bail out if we hit the limit.
 831   if (Depth++ == MaxDepth)
 832     return false;
 833
 834   Value *X = 0, *Y = 0;
 835   // A shift of a power of two is a power of two or zero.
 836   if (OrZero && (match(V, m_Shl(m_Value(X), m_Value())) ||
 837                  match(V, m_Shr(m_Value(X), m_Value()))))
 838     return isKnownToBeAPowerOfTwo(X, /*OrZero*/true, Depth);
 839
 840   if (ZExtInst *ZI = dyn_cast<ZExtInst>(V))
 841     return isKnownToBeAPowerOfTwo(ZI->getOperand(0), OrZero, Depth);
 842
 843   if (SelectInst *SI = dyn_cast<SelectInst>(V))
 844     return isKnownToBeAPowerOfTwo(SI->getTrueValue(), OrZero, Depth) &&
 845       isKnownToBeAPowerOfTwo(SI->getFalseValue(), OrZero, Depth);
 846
 847   if (OrZero && match(V, m_And(m_Value(X), m_Value(Y)))) {
 848     // A power of two and'd with anything is a power of two or zero.
 849     if (isKnownToBeAPowerOfTwo(X, /*OrZero*/true, Depth) ||
 850         isKnownToBeAPowerOfTwo(Y, /*OrZero*/true, Depth))
 851       return true;
 852     // X & (-X) is always a power of two or zero.
 853     if (match(X, m_Neg(m_Specific(Y))) || match(Y, m_Neg(m_Specific(X))))
 854       return true;
 855     return false;
 856   }
 857
 858   // An exact divide or right shift can only shift off zero bits, so the result
 859   // is a power of two only if the first operand is a power of two and not
 860   // copying a sign bit (sdiv int_min, 2).
 861   if (match(V, m_Exact(m_LShr(m_Value(), m_Value()))) ||
 862       match(V, m_Exact(m_UDiv(m_Value(), m_Value())))) {
 863     return isKnownToBeAPowerOfTwo(cast<Operator>(V)->getOperand(0), OrZero, Depth);
 864   }
 865
 866   return false;
 867 }
 868
 869 /// \brief Test whether a GEP's result is known to be non-null.
 870 ///
 871 /// Uses properties inherent in a GEP to try to determine whether it is known
 872 /// to be non-null.
 873 ///
 874 /// Currently this routine does not support vector GEPs.
 875 static bool isGEPKnownNonNull(GEPOperator *GEP, const DataLayout *DL,
 876                               unsigned Depth) {
 877   if (!GEP->isInBounds() || GEP->getPointerAddressSpace() != 0)
 878     return false;
 879
 880   // FIXME: Support vector-GEPs.
 881   assert(GEP->getType()->isPointerTy() && "We only support plain pointer GEP");
 882
 883   // If the base pointer is non-null, we cannot walk to a null address with an
 884   // inbounds GEP in address space zero.
 885   if (isKnownNonZero(GEP->getPointerOperand(), DL, Depth))
 886     return true;
 887
 888   // Past this, if we don't have DataLayout, we can't do much.
 889   if (!DL)
 890     return false;
 891
 892   // Walk the GEP operands and see if any operand introduces a non-zero offset.
 893   // If so, then the GEP cannot produce a null pointer, as doing so would
 894   // inherently violate the inbounds contract within address space zero.
 895   for (gep_type_iterator GTI = gep_type_begin(GEP), GTE = gep_type_end(GEP);
 896        GTI != GTE; ++GTI) {
 897     // Struct types are easy -- they must always be indexed by a constant.
 898     if (StructType *STy = dyn_cast<StructType>(*GTI)) {
 899       ConstantInt *OpC = cast<ConstantInt>(GTI.getOperand());
 900       unsigned ElementIdx = OpC->getZExtValue();
 901       const StructLayout *SL = DL->getStructLayout(STy);
 902       uint64_t ElementOffset = SL->getElementOffset(ElementIdx);
 903       if (ElementOffset > 0)
 904         return true;
 905       continue;
 906     }
 907
 908     // If we have a zero-sized type, the index doesn't matter. Keep looping.
 909     if (DL->getTypeAllocSize(GTI.getIndexedType()) == 0)
 910       continue;
 911
 912     // Fast path the constant operand case both for efficiency and so we don't
 913     // increment Depth when just zipping down an all-constant GEP.
 914     if (ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand())) {
 915       if (!OpC->isZero())
 916         return true;
 917       continue;
 918     }
 919
 920     // We post-increment Depth here because while isKnownNonZero increments it
 921     // as well, when we pop back up that increment won't persist. We don't want
 922     // to recurse 10k times just because we have 10k GEP operands. We don't
 923     // bail completely out because we want to handle constant GEPs regardless
 924     // of depth.
 925     if (Depth++ >= MaxDepth)
 926       continue;
 927
 928     if (isKnownNonZero(GTI.getOperand(), DL, Depth))
 929       return true;
 930   }
 931
 932   return false;
 933 }
 934
 935 /// isKnownNonZero - Return true if the given value is known to be non-zero
 936 /// when defined.  For vectors return true if every element is known to be
 937 /// non-zero when defined.  Supports values with integer or pointer type and
 938 /// vectors of integers.
 939 bool llvm::isKnownNonZero(Value *V, const DataLayout *TD, unsigned Depth) {
 940   if (Constant *C = dyn_cast<Constant>(V)) {
 941     if (C->isNullValue())
 942       return false;
 943     if (isa<ConstantInt>(C))
 944       // Must be non-zero due to null test above.
 945       return true;
 946     // TODO: Handle vectors
 947     return false;
 948   }
 949
 950   // The remaining tests are all recursive, so bail out if we hit the limit.
 951   if (Depth++ >= MaxDepth)
 952     return false;
 953
 954   // Check for pointer simplifications.
 955   if (V->getType()->isPointerTy()) {
 956     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V))
 957       if (isGEPKnownNonNull(GEP, TD, Depth))
 958         return true;
 959   }
 960
 961   unsigned BitWidth = getBitWidth(V->getType()->getScalarType(), TD);
 962
 963   // X | Y != 0 if X != 0 or Y != 0.
 964   Value *X = 0, *Y = 0;
 965   if (match(V, m_Or(m_Value(X), m_Value(Y))))
 966     return isKnownNonZero(X, TD, Depth) || isKnownNonZero(Y, TD, Depth);
 967
 968   // ext X != 0 if X != 0.
 969   if (isa<SExtInst>(V) || isa<ZExtInst>(V))
 970     return isKnownNonZero(cast<Instruction>(V)->getOperand(0), TD, Depth);
 971
 972   // shl X, Y != 0 if X is odd.  Note that the value of the shift is undefined
 973   // if the lowest bit is shifted off the end.
 974   if (BitWidth && match(V, m_Shl(m_Value(X), m_Value(Y)))) {
 975     // shl nuw can't remove any non-zero bits.
 976     OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
 977     if (BO->hasNoUnsignedWrap())
 978       return isKnownNonZero(X, TD, Depth);
 979
 980     APInt KnownZero(BitWidth, 0);
 981     APInt KnownOne(BitWidth, 0);
 982     ComputeMaskedBits(X, KnownZero, KnownOne, TD, Depth);
 983     if (KnownOne[0])
 984       return true;
 985   }
 986   // shr X, Y != 0 if X is negative.  Note that the value of the shift is not
 987   // defined if the sign bit is shifted off the end.
 988   else if (match(V, m_Shr(m_Value(X), m_Value(Y)))) {
 989     // shr exact can only shift out zero bits.
 990     PossiblyExactOperator *BO = cast<PossiblyExactOperator>(V);
 991     if (BO->isExact())
 992       return isKnownNonZero(X, TD, Depth);
 993
 994     bool XKnownNonNegative, XKnownNegative;
 995     ComputeSignBit(X, XKnownNonNegative, XKnownNegative, TD, Depth);
 996     if (XKnownNegative)
 997       return true;
 998   }
 999   // div exact can only produce a zero if the dividend is zero.
1000   else if (match(V, m_Exact(m_IDiv(m_Value(X), m_Value())))) {
1001     return isKnownNonZero(X, TD, Depth);
1002   }
1003   // X + Y.
1004   else if (match(V, m_Add(m_Value(X), m_Value(Y)))) {
1005     bool XKnownNonNegative, XKnownNegative;
1006     bool YKnownNonNegative, YKnownNegative;
1007     ComputeSignBit(X, XKnownNonNegative, XKnownNegative, TD, Depth);
1008     ComputeSignBit(Y, YKnownNonNegative, YKnownNegative, TD, Depth);
1009
1010     // If X and Y are both non-negative (as signed values) then their sum is not
1011     // zero unless both X and Y are zero.
1012     if (XKnownNonNegative && YKnownNonNegative)
1013       if (isKnownNonZero(X, TD, Depth) || isKnownNonZero(Y, TD, Depth))
1014         return true;
1015
1016     // If X and Y are both negative (as signed values) then their sum is not
1017     // zero unless both X and Y equal INT_MIN.
1018     if (BitWidth && XKnownNegative && YKnownNegative) {
1019       APInt KnownZero(BitWidth, 0);
1020       APInt KnownOne(BitWidth, 0);
1021       APInt Mask = APInt::getSignedMaxValue(BitWidth);
1022       // The sign bit of X is set.  If some other bit is set then X is not equal
1023       // to INT_MIN.
1024       ComputeMaskedBits(X, KnownZero, KnownOne, TD, Depth);
1025       if ((KnownOne & Mask) != 0)
1026         return true;
1027       // The sign bit of Y is set.  If some other bit is set then Y is not equal
1028       // to INT_MIN.
1029       ComputeMaskedBits(Y, KnownZero, KnownOne, TD, Depth);
1030       if ((KnownOne & Mask) != 0)
1031         return true;
1032     }
1033
1034     // The sum of a non-negative number and a power of two is not zero.
1035     if (XKnownNonNegative && isKnownToBeAPowerOfTwo(Y, /*OrZero*/false, Depth))
1036       return true;
1037     if (YKnownNonNegative && isKnownToBeAPowerOfTwo(X, /*OrZero*/false, Depth))
1038       return true;
1039   }
1040   // X * Y.
1041   else if (match(V, m_Mul(m_Value(X), m_Value(Y)))) {
1042     OverflowingBinaryOperator *BO = cast<OverflowingBinaryOperator>(V);
1043     // If X and Y are non-zero then so is X * Y as long as the multiplication
1044     // does not overflow.
1045     if ((BO->hasNoSignedWrap() || BO->hasNoUnsignedWrap()) &&
1046         isKnownNonZero(X, TD, Depth) && isKnownNonZero(Y, TD, Depth))
1047       return true;
1048   }
1049   // (C ? X : Y) != 0 if X != 0 and Y != 0.
1050   else if (SelectInst *SI = dyn_cast<SelectInst>(V)) {
1051     if (isKnownNonZero(SI->getTrueValue(), TD, Depth) &&
1052         isKnownNonZero(SI->getFalseValue(), TD, Depth))
1053       return true;
1054   }
1055
1056   if (!BitWidth) return false;
1057   APInt KnownZero(BitWidth, 0);
1058   APInt KnownOne(BitWidth, 0);
1059   ComputeMaskedBits(V, KnownZero, KnownOne, TD, Depth);
1060   return KnownOne != 0;
1061 }
1062
1063 /// MaskedValueIsZero - Return true if 'V & Mask' is known to be zero.  We use
1064 /// this predicate to simplify operations downstream.  Mask is known to be zero
1065 /// for bits that V cannot have.
1066 ///
1067 /// This function is defined on values with integer type, values with pointer
1068 /// type (but only if TD is non-null), and vectors of integers.  In the case
1069 /// where V is a vector, the mask, known zero, and known one values are the
1070 /// same width as the vector element, and the bit is set only if it is true
1071 /// for all of the elements in the vector.
1072 bool llvm::MaskedValueIsZero(Value *V, const APInt &Mask,
1073                              const DataLayout *TD, unsigned Depth) {
1074   APInt KnownZero(Mask.getBitWidth(), 0), KnownOne(Mask.getBitWidth(), 0);
1075   ComputeMaskedBits(V, KnownZero, KnownOne, TD, Depth);
1076   assert((KnownZero & KnownOne) == 0 && "Bits known to be one AND zero?");
1077   return (KnownZero & Mask) == Mask;
1078 }
1079
1080
1081
1082 /// ComputeNumSignBits - Return the number of times the sign bit of the
1083 /// register is replicated into the other bits.  We know that at least 1 bit
1084 /// is always equal to the sign bit (itself), but other cases can give us
1085 /// information.  For example, immediately after an "ashr X, 2", we know that
1086 /// the top 3 bits are all equal to each other, so we return 3.
1087 ///
1088 /// 'Op' must have a scalar integer type.
1089 ///
1090 unsigned llvm::ComputeNumSignBits(Value *V, const DataLayout *TD,
1091                                   unsigned Depth) {
1092   assert((TD || V->getType()->isIntOrIntVectorTy()) &&
1093          "ComputeNumSignBits requires a DataLayout object to operate "
1094          "on non-integer values!");
1095   Type *Ty = V->getType();
1096   unsigned TyBits = TD ? TD->getTypeSizeInBits(V->getType()->getScalarType()) :
1097                          Ty->getScalarSizeInBits();
1098   unsigned Tmp, Tmp2;
1099   unsigned FirstAnswer = 1;
1100
1101   // Note that ConstantInt is handled by the general ComputeMaskedBits case
1102   // below.
1103
1104   if (Depth == 6)
1105     return 1;  // Limit search depth.
1106
1107   Operator *U = dyn_cast<Operator>(V);
1108   switch (Operator::getOpcode(V)) {
1109   default: break;
1110   case Instruction::SExt:
1111     Tmp = TyBits - U->getOperand(0)->getType()->getScalarSizeInBits();
1112     return ComputeNumSignBits(U->getOperand(0), TD, Depth+1) + Tmp;
1113
1114   case Instruction::AShr: {
1115     Tmp = ComputeNumSignBits(U->getOperand(0), TD, Depth+1);
1116     // ashr X, C   -> adds C sign bits.  Vectors too.
1117     const APInt *ShAmt;
1118     if (match(U->getOperand(1), m_APInt(ShAmt))) {
1119       Tmp += ShAmt->getZExtValue();
1120       if (Tmp > TyBits) Tmp = TyBits;
1121     }
1122     return Tmp;
1123   }
1124   case Instruction::Shl: {
1125     const APInt *ShAmt;
1126     if (match(U->getOperand(1), m_APInt(ShAmt))) {
1127       // shl destroys sign bits.
1128       Tmp = ComputeNumSignBits(U->getOperand(0), TD, Depth+1);
1129       Tmp2 = ShAmt->getZExtValue();
1130       if (Tmp2 >= TyBits ||      // Bad shift.
1131           Tmp2 >= Tmp) break;    // Shifted all sign bits out.
1132       return Tmp - Tmp2;
1133     }
1134     break;
1135   }
1136   case Instruction::And:
1137   case Instruction::Or:
1138   case Instruction::Xor:    // NOT is handled here.
1139     // Logical binary ops preserve the number of sign bits at the worst.
1140     Tmp = ComputeNumSignBits(U->getOperand(0), TD, Depth+1);
1141     if (Tmp != 1) {
1142       Tmp2 = ComputeNumSignBits(U->getOperand(1), TD, Depth+1);
1143       FirstAnswer = std::min(Tmp, Tmp2);
1144       // We computed what we know about the sign bits as our first
1145       // answer. Now proceed to the generic code that uses
1146       // ComputeMaskedBits, and pick whichever answer is better.
1147     }
1148     break;
1149
1150   case Instruction::Select:
1151     Tmp = ComputeNumSignBits(U->getOperand(1), TD, Depth+1);
1152     if (Tmp == 1) return 1;  // Early out.
1153     Tmp2 = ComputeNumSignBits(U->getOperand(2), TD, Depth+1);
1154     return std::min(Tmp, Tmp2);
1155
1156   case Instruction::Add:
1157     // Add can have at most one carry bit.  Thus we know that the output
1158     // is, at worst, one more bit than the inputs.
1159     Tmp = ComputeNumSignBits(U->getOperand(0), TD, Depth+1);
1160     if (Tmp == 1) return 1;  // Early out.
1161
1162     // Special case decrementing a value (ADD X, -1):
1163     if (ConstantInt *CRHS = dyn_cast<ConstantInt>(U->getOperand(1)))
1164       if (CRHS->isAllOnesValue()) {
1165         APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
1166         ComputeMaskedBits(U->getOperand(0), KnownZero, KnownOne, TD, Depth+1);
1167
1168         // If the input is known to be 0 or 1, the output is 0/-1, which is all
1169         // sign bits set.
1170         if ((KnownZero | APInt(TyBits, 1)).isAllOnesValue())
1171           return TyBits;
1172
1173         // If we are subtracting one from a positive number, there is no carry
1174         // out of the result.
1175         if (KnownZero.isNegative())
1176           return Tmp;
1177       }
1178
1179     Tmp2 = ComputeNumSignBits(U->getOperand(1), TD, Depth+1);
1180     if (Tmp2 == 1) return 1;
1181     return std::min(Tmp, Tmp2)-1;
1182
1183   case Instruction::Sub:
1184     Tmp2 = ComputeNumSignBits(U->getOperand(1), TD, Depth+1);
1185     if (Tmp2 == 1) return 1;
1186
1187     // Handle NEG.
1188     if (ConstantInt *CLHS = dyn_cast<ConstantInt>(U->getOperand(0)))
1189       if (CLHS->isNullValue()) {
1190         APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
1191         ComputeMaskedBits(U->getOperand(1), KnownZero, KnownOne, TD, Depth+1);
1192         // If the input is known to be 0 or 1, the output is 0/-1, which is all
1193         // sign bits set.
1194         if ((KnownZero | APInt(TyBits, 1)).isAllOnesValue())
1195           return TyBits;
1196
1197         // If the input is known to be positive (the sign bit is known clear),
1198         // the output of the NEG has the same number of sign bits as the input.
1199         if (KnownZero.isNegative())
1200           return Tmp2;
1201
1202         // Otherwise, we treat this like a SUB.
1203       }
1204
1205     // Sub can have at most one carry bit.  Thus we know that the output
1206     // is, at worst, one more bit than the inputs.
1207     Tmp = ComputeNumSignBits(U->getOperand(0), TD, Depth+1);
1208     if (Tmp == 1) return 1;  // Early out.
1209     return std::min(Tmp, Tmp2)-1;
1210
1211   case Instruction::PHI: {
1212     PHINode *PN = cast<PHINode>(U);
1213     // Don't analyze large in-degree PHIs.
1214     if (PN->getNumIncomingValues() > 4) break;
1215
1216     // Take the minimum of all incoming values.  This can't infinitely loop
1217     // because of our depth threshold.
1218     Tmp = ComputeNumSignBits(PN->getIncomingValue(0), TD, Depth+1);
1219     for (unsigned i = 1, e = PN->getNumIncomingValues(); i != e; ++i) {
1220       if (Tmp == 1) return Tmp;
1221       Tmp = std::min(Tmp,
1222                      ComputeNumSignBits(PN->getIncomingValue(i), TD, Depth+1));
1223     }
1224     return Tmp;
1225   }
1226
1227   case Instruction::Trunc:
1228     // FIXME: it's tricky to do anything useful for this, but it is an important
1229     // case for targets like X86.
1230     break;
1231   }
1232
1233   // Finally, if we can prove that the top bits of the result are 0's or 1's,
1234   // use this information.
1235   APInt KnownZero(TyBits, 0), KnownOne(TyBits, 0);
1236   APInt Mask;
1237   ComputeMaskedBits(V, KnownZero, KnownOne, TD, Depth);
1238
1239   if (KnownZero.isNegative()) {        // sign bit is 0
1240     Mask = KnownZero;
1241   } else if (KnownOne.isNegative()) {  // sign bit is 1;
1242     Mask = KnownOne;
1243   } else {
1244     // Nothing known.
1245     return FirstAnswer;
1246   }
1247
1248   // Okay, we know that the sign bit in Mask is set.  Use CLZ to determine
1249   // the number of identical bits in the top of the input value.
1250   Mask = ~Mask;
1251   Mask <<= Mask.getBitWidth()-TyBits;
1252   // Return # leading zeros.  We use 'min' here in case Val was zero before
1253   // shifting.  We don't want to return '64' as for an i32 "0".
1254   return std::max(FirstAnswer, std::min(TyBits, Mask.countLeadingZeros()));
1255 }
1256
1257 /// ComputeMultiple - This function computes the integer multiple of Base that
1258 /// equals V.  If successful, it returns true and returns the multiple in
1259 /// Multiple.  If unsuccessful, it returns false. It looks
1260 /// through SExt instructions only if LookThroughSExt is true.
1261 bool llvm::ComputeMultiple(Value *V, unsigned Base, Value *&Multiple,
1262                            bool LookThroughSExt, unsigned Depth) {
1263   const unsigned MaxDepth = 6;
1264
1265   assert(V && "No Value?");
1266   assert(Depth <= MaxDepth && "Limit Search Depth");
1267   assert(V->getType()->isIntegerTy() && "Not integer or pointer type!");
1268
1269   Type *T = V->getType();
1270
1271   ConstantInt *CI = dyn_cast<ConstantInt>(V);
1272
1273   if (Base == 0)
1274     return false;
1275
1276   if (Base == 1) {
1277     Multiple = V;
1278     return true;
1279   }
1280
1281   ConstantExpr *CO = dyn_cast<ConstantExpr>(V);
1282   Constant *BaseVal = ConstantInt::get(T, Base);
1283   if (CO && CO == BaseVal) {
1284     // Multiple is 1.
1285     Multiple = ConstantInt::get(T, 1);
1286     return true;
1287   }
1288
1289   if (CI && CI->getZExtValue() % Base == 0) {
1290     Multiple = ConstantInt::get(T, CI->getZExtValue() / Base);
1291     return true;
1292   }
1293
1294   if (Depth == MaxDepth) return false;  // Limit search depth.
1295
1296   Operator *I = dyn_cast<Operator>(V);
1297   if (!I) return false;
1298
1299   switch (I->getOpcode()) {
1300   default: break;
1301   case Instruction::SExt:
1302     if (!LookThroughSExt) return false;
1303     // otherwise fall through to ZExt
1304   case Instruction::ZExt:
1305     return ComputeMultiple(I->getOperand(0), Base, Multiple,
1306                            LookThroughSExt, Depth+1);
1307   case Instruction::Shl:
1308   case Instruction::Mul: {
1309     Value *Op0 = I->getOperand(0);
1310     Value *Op1 = I->getOperand(1);
1311
1312     if (I->getOpcode() == Instruction::Shl) {
1313       ConstantInt *Op1CI = dyn_cast<ConstantInt>(Op1);
1314       if (!Op1CI) return false;
1315       // Turn Op0 << Op1 into Op0 * 2^Op1
1316       APInt Op1Int = Op1CI->getValue();
1317       uint64_t BitToSet = Op1Int.getLimitedValue(Op1Int.getBitWidth() - 1);
1318       APInt API(Op1Int.getBitWidth(), 0);
1319       API.setBit(BitToSet);
1320       Op1 = ConstantInt::get(V->getContext(), API);
1321     }
1322
1323     Value *Mul0 = NULL;
1324     if (ComputeMultiple(Op0, Base, Mul0, LookThroughSExt, Depth+1)) {
1325       if (Constant *Op1C = dyn_cast<Constant>(Op1))
1326         if (Constant *MulC = dyn_cast<Constant>(Mul0)) {
1327           if (Op1C->getType()->getPrimitiveSizeInBits() <
1328               MulC->getType()->getPrimitiveSizeInBits())
1329             Op1C = ConstantExpr::getZExt(Op1C, MulC->getType());
1330           if (Op1C->getType()->getPrimitiveSizeInBits() >
1331               MulC->getType()->getPrimitiveSizeInBits())
1332             MulC = ConstantExpr::getZExt(MulC, Op1C->getType());
1333
1334           // V == Base * (Mul0 * Op1), so return (Mul0 * Op1)
1335           Multiple = ConstantExpr::getMul(MulC, Op1C);
1336           return true;
1337         }
1338
1339       if (ConstantInt *Mul0CI = dyn_cast<ConstantInt>(Mul0))
1340         if (Mul0CI->getValue() == 1) {
1341           // V == Base * Op1, so return Op1
1342           Multiple = Op1;
1343           return true;
1344         }
1345     }
1346
1347     Value *Mul1 = NULL;
1348     if (ComputeMultiple(Op1, Base, Mul1, LookThroughSExt, Depth+1)) {
1349       if (Constant *Op0C = dyn_cast<Constant>(Op0))
1350         if (Constant *MulC = dyn_cast<Constant>(Mul1)) {
1351           if (Op0C->getType()->getPrimitiveSizeInBits() <
1352               MulC->getType()->getPrimitiveSizeInBits())
1353             Op0C = ConstantExpr::getZExt(Op0C, MulC->getType());
1354           if (Op0C->getType()->getPrimitiveSizeInBits() >
1355               MulC->getType()->getPrimitiveSizeInBits())
1356             MulC = ConstantExpr::getZExt(MulC, Op0C->getType());
1357
1358           // V == Base * (Mul1 * Op0), so return (Mul1 * Op0)
1359           Multiple = ConstantExpr::getMul(MulC, Op0C);
1360           return true;
1361         }
1362
1363       if (ConstantInt *Mul1CI = dyn_cast<ConstantInt>(Mul1))
1364         if (Mul1CI->getValue() == 1) {
1365           // V == Base * Op0, so return Op0
1366           Multiple = Op0;
1367           return true;
1368         }
1369     }
1370   }
1371   }
1372
1373   // We could not determine if V is a multiple of Base.
1374   return false;
1375 }
1376
1377 /// CannotBeNegativeZero - Return true if we can prove that the specified FP
1378 /// value is never equal to -0.0.
1379 ///
1380 /// NOTE: this function will need to be revisited when we support non-default
1381 /// rounding modes!
1382 ///
1383 bool llvm::CannotBeNegativeZero(const Value *V, unsigned Depth) {
1384   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(V))
1385     return !CFP->getValueAPF().isNegZero();
1386
1387   if (Depth == 6)
1388     return 1;  // Limit search depth.
1389
1390   const Operator *I = dyn_cast<Operator>(V);
1391   if (I == 0) return false;
1392
1393   // Check if the nsz fast-math flag is set
1394   if (const FPMathOperator *FPO = dyn_cast<FPMathOperator>(I))
1395     if (FPO->hasNoSignedZeros())
1396       return true;
1397
1398   // (add x, 0.0) is guaranteed to return +0.0, not -0.0.
1399   if (I->getOpcode() == Instruction::FAdd &&
1400       isa<ConstantFP>(I->getOperand(1)) &&
1401       cast<ConstantFP>(I->getOperand(1))->isNullValue())
1402     return true;
1403
1404   // sitofp and uitofp turn into +0.0 for zero.
1405   if (isa<SIToFPInst>(I) || isa<UIToFPInst>(I))
1406     return true;
1407
1408   if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(I))
1409     // sqrt(-0.0) = -0.0, no other negative results are possible.
1410     if (II->getIntrinsicID() == Intrinsic::sqrt)
1411       return CannotBeNegativeZero(II->getArgOperand(0), Depth+1);
1412
1413   if (const CallInst *CI = dyn_cast<CallInst>(I))
1414     if (const Function *F = CI->getCalledFunction()) {
1415       if (F->isDeclaration()) {
1416         // abs(x) != -0.0
1417         if (F->getName() == "abs") return true;
1418         // fabs[lf](x) != -0.0
1419         if (F->getName() == "fabs") return true;
1420         if (F->getName() == "fabsf") return true;
1421         if (F->getName() == "fabsl") return true;
1422         if (F->getName() == "sqrt" || F->getName() == "sqrtf" ||
1423             F->getName() == "sqrtl")
1424           return CannotBeNegativeZero(CI->getArgOperand(0), Depth+1);
1425       }
1426     }
1427
1428   return false;
1429 }
1430
1431 /// isBytewiseValue - If the specified value can be set by repeating the same
1432 /// byte in memory, return the i8 value that it is represented with.  This is
1433 /// true for all i8 values obviously, but is also true for i32 0, i32 -1,
1434 /// i16 0xF0F0, double 0.0 etc.  If the value can't be handled with a repeated
1435 /// byte store (e.g. i16 0x1234), return null.
1436 Value *llvm::isBytewiseValue(Value *V) {
1437   // All byte-wide stores are splatable, even of arbitrary variables.
1438   if (V->getType()->isIntegerTy(8)) return V;
1439
1440   // Handle 'null' ConstantArrayZero etc.
1441   if (Constant *C = dyn_cast<Constant>(V))
1442     if (C->isNullValue())
1443       return Constant::getNullValue(Type::getInt8Ty(V->getContext()));
1444
1445   // Constant float and double values can be handled as integer values if the
1446   // corresponding integer value is "byteable".  An important case is 0.0.
1447   if (ConstantFP *CFP = dyn_cast<ConstantFP>(V)) {
1448     if (CFP->getType()->isFloatTy())
1449       V = ConstantExpr::getBitCast(CFP, Type::getInt32Ty(V->getContext()));
1450     if (CFP->getType()->isDoubleTy())
1451       V = ConstantExpr::getBitCast(CFP, Type::getInt64Ty(V->getContext()));
1452     // Don't handle long double formats, which have strange constraints.
1453   }
1454
1455   // We can handle constant integers that are power of two in size and a
1456   // multiple of 8 bits.
1457   if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
1458     unsigned Width = CI->getBitWidth();
1459     if (isPowerOf2_32(Width) && Width > 8) {
1460       // We can handle this value if the recursive binary decomposition is the
1461       // same at all levels.
1462       APInt Val = CI->getValue();
1463       APInt Val2;
1464       while (Val.getBitWidth() != 8) {
1465         unsigned NextWidth = Val.getBitWidth()/2;
1466         Val2  = Val.lshr(NextWidth);
1467         Val2 = Val2.trunc(Val.getBitWidth()/2);
1468         Val = Val.trunc(Val.getBitWidth()/2);
1469
1470         // If the top/bottom halves aren't the same, reject it.
1471         if (Val != Val2)
1472           return 0;
1473       }
1474       return ConstantInt::get(V->getContext(), Val);
1475     }
1476   }
1477
1478   // A ConstantDataArray/Vector is splatable if all its members are equal and
1479   // also splatable.
1480   if (ConstantDataSequential *CA = dyn_cast<ConstantDataSequential>(V)) {
1481     Value *Elt = CA->getElementAsConstant(0);
1482     Value *Val = isBytewiseValue(Elt);
1483     if (!Val)
1484       return 0;
1485
1486     for (unsigned I = 1, E = CA->getNumElements(); I != E; ++I)
1487       if (CA->getElementAsConstant(I) != Elt)
1488         return 0;
1489
1490     return Val;
1491   }
1492
1493   // Conceptually, we could handle things like:
1494   //   %a = zext i8 %X to i16
1495   //   %b = shl i16 %a, 8
1496   //   %c = or i16 %a, %b
1497   // but until there is an example that actually needs this, it doesn't seem
1498   // worth worrying about.
1499   return 0;
1500 }
1501
1502
1503 // This is the recursive version of BuildSubAggregate. It takes a few different
1504 // arguments. Idxs is the index within the nested struct From that we are
1505 // looking at now (which is of type IndexedType). IdxSkip is the number of
1506 // indices from Idxs that should be left out when inserting into the resulting
1507 // struct. To is the result struct built so far, new insertvalue instructions
1508 // build on that.
1509 static Value *BuildSubAggregate(Value *From, Value* To, Type *IndexedType,
1510                                 SmallVector<unsigned, 10> &Idxs,
1511                                 unsigned IdxSkip,
1512                                 Instruction *InsertBefore) {
1513   llvm::StructType *STy = llvm::dyn_cast<llvm::StructType>(IndexedType);
1514   if (STy) {
1515     // Save the original To argument so we can modify it
1516     Value *OrigTo = To;
1517     // General case, the type indexed by Idxs is a struct
1518     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1519       // Process each struct element recursively
1520       Idxs.push_back(i);
1521       Value *PrevTo = To;
1522       To = BuildSubAggregate(From, To, STy->getElementType(i), Idxs, IdxSkip,
1523                              InsertBefore);
1524       Idxs.pop_back();
1525       if (!To) {
1526         // Couldn't find any inserted value for this index? Cleanup
1527         while (PrevTo != OrigTo) {
1528           InsertValueInst* Del = cast<InsertValueInst>(PrevTo);
1529           PrevTo = Del->getAggregateOperand();
1530           Del->eraseFromParent();
1531         }
1532         // Stop processing elements
1533         break;
1534       }
1535     }
1536     // If we successfully found a value for each of our subaggregates
1537     if (To)
1538       return To;
1539   }
1540   // Base case, the type indexed by SourceIdxs is not a struct, or not all of
1541   // the struct's elements had a value that was inserted directly. In the latter
1542   // case, perhaps we can't determine each of the subelements individually, but
1543   // we might be able to find the complete struct somewhere.
1544
1545   // Find the value that is at that particular spot
1546   Value *V = FindInsertedValue(From, Idxs);
1547
1548   if (!V)
1549     return NULL;
1550
1551   // Insert the value in the new (sub) aggregrate
1552   return llvm::InsertValueInst::Create(To, V, makeArrayRef(Idxs).slice(IdxSkip),
1553                                        "tmp", InsertBefore);
1554 }
1555
1556 // This helper takes a nested struct and extracts a part of it (which is again a
1557 // struct) into a new value. For example, given the struct:
1558 // { a, { b, { c, d }, e } }
1559 // and the indices "1, 1" this returns
1560 // { c, d }.
1561 //
1562 // It does this by inserting an insertvalue for each element in the resulting
1563 // struct, as opposed to just inserting a single struct. This will only work if
1564 // each of the elements of the substruct are known (ie, inserted into From by an
1565 // insertvalue instruction somewhere).
1566 //
1567 // All inserted insertvalue instructions are inserted before InsertBefore
1568 static Value *BuildSubAggregate(Value *From, ArrayRef<unsigned> idx_range,
1569                                 Instruction *InsertBefore) {
1570   assert(InsertBefore && "Must have someplace to insert!");
1571   Type *IndexedType = ExtractValueInst::getIndexedType(From->getType(),
1572                                                              idx_range);
1573   Value *To = UndefValue::get(IndexedType);
1574   SmallVector<unsigned, 10> Idxs(idx_range.begin(), idx_range.end());
1575   unsigned IdxSkip = Idxs.size();
1576
1577   return BuildSubAggregate(From, To, IndexedType, Idxs, IdxSkip, InsertBefore);
1578 }
1579
1580 /// FindInsertedValue - Given an aggregrate and an sequence of indices, see if
1581 /// the scalar value indexed is already around as a register, for example if it
1582 /// were inserted directly into the aggregrate.
1583 ///
1584 /// If InsertBefore is not null, this function will duplicate (modified)
1585 /// insertvalues when a part of a nested struct is extracted.
1586 Value *llvm::FindInsertedValue(Value *V, ArrayRef<unsigned> idx_range,
1587                                Instruction *InsertBefore) {
1588   // Nothing to index? Just return V then (this is useful at the end of our
1589   // recursion).
1590   if (idx_range.empty())
1591     return V;
1592   // We have indices, so V should have an indexable type.
1593   assert((V->getType()->isStructTy() || V->getType()->isArrayTy()) &&
1594          "Not looking at a struct or array?");
1595   assert(ExtractValueInst::getIndexedType(V->getType(), idx_range) &&
1596          "Invalid indices for type?");
1597
1598   if (Constant *C = dyn_cast<Constant>(V)) {
1599     C = C->getAggregateElement(idx_range[0]);
1600     if (C == 0) return 0;
1601     return FindInsertedValue(C, idx_range.slice(1), InsertBefore);
1602   }
1603
1604   if (InsertValueInst *I = dyn_cast<InsertValueInst>(V)) {
1605     // Loop the indices for the insertvalue instruction in parallel with the
1606     // requested indices
1607     const unsigned *req_idx = idx_range.begin();
1608     for (const unsigned *i = I->idx_begin(), *e = I->idx_end();
1609          i != e; ++i, ++req_idx) {
1610       if (req_idx == idx_range.end()) {
1611         // We can't handle this without inserting insertvalues
1612         if (!InsertBefore)
1613           return 0;
1614
1615         // The requested index identifies a part of a nested aggregate. Handle
1616         // this specially. For example,
1617         // %A = insertvalue { i32, {i32, i32 } } undef, i32 10, 1, 0
1618         // %B = insertvalue { i32, {i32, i32 } } %A, i32 11, 1, 1
1619         // %C = extractvalue {i32, { i32, i32 } } %B, 1
1620         // This can be changed into
1621         // %A = insertvalue {i32, i32 } undef, i32 10, 0
1622         // %C = insertvalue {i32, i32 } %A, i32 11, 1
1623         // which allows the unused 0,0 element from the nested struct to be
1624         // removed.
1625         return BuildSubAggregate(V, makeArrayRef(idx_range.begin(), req_idx),
1626                                  InsertBefore);
1627       }
1628
1629       // This insert value inserts something else than what we are looking for.
1630       // See if the (aggregrate) value inserted into has the value we are
1631       // looking for, then.
1632       if (*req_idx != *i)
1633         return FindInsertedValue(I->getAggregateOperand(), idx_range,
1634                                  InsertBefore);
1635     }
1636     // If we end up here, the indices of the insertvalue match with those
1637     // requested (though possibly only partially). Now we recursively look at
1638     // the inserted value, passing any remaining indices.
1639     return FindInsertedValue(I->getInsertedValueOperand(),
1640                              makeArrayRef(req_idx, idx_range.end()),
1641                              InsertBefore);
1642   }
1643
1644   if (ExtractValueInst *I = dyn_cast<ExtractValueInst>(V)) {
1645     // If we're extracting a value from an aggregrate that was extracted from
1646     // something else, we can extract from that something else directly instead.
1647     // However, we will need to chain I's indices with the requested indices.
1648
1649     // Calculate the number of indices required
1650     unsigned size = I->getNumIndices() + idx_range.size();
1651     // Allocate some space to put the new indices in
1652     SmallVector<unsigned, 5> Idxs;
1653     Idxs.reserve(size);
1654     // Add indices from the extract value instruction
1655     Idxs.append(I->idx_begin(), I->idx_end());
1656
1657     // Add requested indices
1658     Idxs.append(idx_range.begin(), idx_range.end());
1659
1660     assert(Idxs.size() == size
1661            && "Number of indices added not correct?");
1662
1663     return FindInsertedValue(I->getAggregateOperand(), Idxs, InsertBefore);
1664   }
1665   // Otherwise, we don't know (such as, extracting from a function return value
1666   // or load instruction)
1667   return 0;
1668 }
1669
1670 /// GetPointerBaseWithConstantOffset - Analyze the specified pointer to see if
1671 /// it can be expressed as a base pointer plus a constant offset.  Return the
1672 /// base and offset to the caller.
1673 Value *llvm::GetPointerBaseWithConstantOffset(Value *Ptr, int64_t &Offset,
1674                                               const DataLayout &TD) {
1675   unsigned BitWidth = TD.getPointerSizeInBits();
1676   APInt ByteOffset(BitWidth, 0);
1677   while (1) {
1678     if (Ptr->getType()->isVectorTy())
1679       break;
1680
1681     if (GEPOperator *GEP = dyn_cast<GEPOperator>(Ptr)) {
1682       APInt GEPOffset(BitWidth, 0);
1683       if (!GEP->accumulateConstantOffset(TD, GEPOffset))
1684         break;
1685       ByteOffset += GEPOffset;
1686       Ptr = GEP->getPointerOperand();
1687     } else if (Operator::getOpcode(Ptr) == Instruction::BitCast) {
1688       Ptr = cast<Operator>(Ptr)->getOperand(0);
1689     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(Ptr)) {
1690       if (GA->mayBeOverridden())
1691         break;
1692       Ptr = GA->getAliasee();
1693     } else {
1694       break;
1695     }
1696   }
1697   Offset = ByteOffset.getSExtValue();
1698   return Ptr;
1699 }
1700
1701
1702 /// getConstantStringInfo - This function computes the length of a
1703 /// null-terminated C string pointed to by V.  If successful, it returns true
1704 /// and returns the string in Str.  If unsuccessful, it returns false.
1705 bool llvm::getConstantStringInfo(const Value *V, StringRef &Str,
1706                                  uint64_t Offset, bool TrimAtNul) {
1707   assert(V);
1708
1709   // Look through bitcast instructions and geps.
1710   V = V->stripPointerCasts();
1711
1712   // If the value is a GEP instructionor  constant expression, treat it as an
1713   // offset.
1714   if (const GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
1715     // Make sure the GEP has exactly three arguments.
1716     if (GEP->getNumOperands() != 3)
1717       return false;
1718
1719     // Make sure the index-ee is a pointer to array of i8.
1720     PointerType *PT = cast<PointerType>(GEP->getOperand(0)->getType());
1721     ArrayType *AT = dyn_cast<ArrayType>(PT->getElementType());
1722     if (AT == 0 || !AT->getElementType()->isIntegerTy(8))
1723       return false;
1724
1725     // Check to make sure that the first operand of the GEP is an integer and
1726     // has value 0 so that we are sure we're indexing into the initializer.
1727     const ConstantInt *FirstIdx = dyn_cast<ConstantInt>(GEP->getOperand(1));
1728     if (FirstIdx == 0 || !FirstIdx->isZero())
1729       return false;
1730
1731     // If the second index isn't a ConstantInt, then this is a variable index
1732     // into the array.  If this occurs, we can't say anything meaningful about
1733     // the string.
1734     uint64_t StartIdx = 0;
1735     if (const ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(2)))
1736       StartIdx = CI->getZExtValue();
1737     else
1738       return false;
1739     return getConstantStringInfo(GEP->getOperand(0), Str, StartIdx+Offset);
1740   }
1741
1742   // The GEP instruction, constant or instruction, must reference a global
1743   // variable that is a constant and is initialized. The referenced constant
1744   // initializer is the array that we'll use for optimization.
1745   const GlobalVariable *GV = dyn_cast<GlobalVariable>(V);
1746   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer())
1747     return false;
1748
1749   // Handle the all-zeros case
1750   if (GV->getInitializer()->isNullValue()) {
1751     // This is a degenerate case. The initializer is constant zero so the
1752     // length of the string must be zero.
1753     Str = "";
1754     return true;
1755   }
1756
1757   // Must be a Constant Array
1758   const ConstantDataArray *Array =
1759     dyn_cast<ConstantDataArray>(GV->getInitializer());
1760   if (Array == 0 || !Array->isString())
1761     return false;
1762
1763   // Get the number of elements in the array
1764   uint64_t NumElts = Array->getType()->getArrayNumElements();
1765
1766   // Start out with the entire array in the StringRef.
1767   Str = Array->getAsString();
1768
1769   if (Offset > NumElts)
1770     return false;
1771
1772   // Skip over 'offset' bytes.
1773   Str = Str.substr(Offset);
1774
1775   if (TrimAtNul) {
1776     // Trim off the \0 and anything after it.  If the array is not nul
1777     // terminated, we just return the whole end of string.  The client may know
1778     // some other way that the string is length-bound.
1779     Str = Str.substr(0, Str.find('\0'));
1780   }
1781   return true;
1782 }
1783
1784 // These next two are very similar to the above, but also look through PHI
1785 // nodes.
1786 // TODO: See if we can integrate these two together.
1787
1788 /// GetStringLengthH - If we can compute the length of the string pointed to by
1789 /// the specified pointer, return 'len+1'.  If we can't, return 0.
1790 static uint64_t GetStringLengthH(Value *V, SmallPtrSet<PHINode*, 32> &PHIs) {
1791   // Look through noop bitcast instructions.
1792   V = V->stripPointerCasts();
1793
1794   // If this is a PHI node, there are two cases: either we have already seen it
1795   // or we haven't.
1796   if (PHINode *PN = dyn_cast<PHINode>(V)) {
1797     if (!PHIs.insert(PN))
1798       return ~0ULL;  // already in the set.
1799
1800     // If it was new, see if all the input strings are the same length.
1801     uint64_t LenSoFar = ~0ULL;
1802     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1803       uint64_t Len = GetStringLengthH(PN->getIncomingValue(i), PHIs);
1804       if (Len == 0) return 0; // Unknown length -> unknown.
1805
1806       if (Len == ~0ULL) continue;
1807
1808       if (Len != LenSoFar && LenSoFar != ~0ULL)
1809         return 0;    // Disagree -> unknown.
1810       LenSoFar = Len;
1811     }
1812
1813     // Success, all agree.
1814     return LenSoFar;
1815   }
1816
1817   // strlen(select(c,x,y)) -> strlen(x) ^ strlen(y)
1818   if (SelectInst *SI = dyn_cast<SelectInst>(V)) {
1819     uint64_t Len1 = GetStringLengthH(SI->getTrueValue(), PHIs);
1820     if (Len1 == 0) return 0;
1821     uint64_t Len2 = GetStringLengthH(SI->getFalseValue(), PHIs);
1822     if (Len2 == 0) return 0;
1823     if (Len1 == ~0ULL) return Len2;
1824     if (Len2 == ~0ULL) return Len1;
1825     if (Len1 != Len2) return 0;
1826     return Len1;
1827   }
1828
1829   // Otherwise, see if we can read the string.
1830   StringRef StrData;
1831   if (!getConstantStringInfo(V, StrData))
1832     return 0;
1833
1834   return StrData.size()+1;
1835 }
1836
1837 /// GetStringLength - If we can compute the length of the string pointed to by
1838 /// the specified pointer, return 'len+1'.  If we can't, return 0.
1839 uint64_t llvm::GetStringLength(Value *V) {
1840   if (!V->getType()->isPointerTy()) return 0;
1841
1842   SmallPtrSet<PHINode*, 32> PHIs;
1843   uint64_t Len = GetStringLengthH(V, PHIs);
1844   // If Len is ~0ULL, we had an infinite phi cycle: this is dead code, so return
1845   // an empty string as a length.
1846   return Len == ~0ULL ? 1 : Len;
1847 }
1848
1849 Value *
1850 llvm::GetUnderlyingObject(Value *V, const DataLayout *TD, unsigned MaxLookup) {
1851   if (!V->getType()->isPointerTy())
1852     return V;
1853   for (unsigned Count = 0; MaxLookup == 0 || Count < MaxLookup; ++Count) {
1854     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
1855       V = GEP->getPointerOperand();
1856     } else if (Operator::getOpcode(V) == Instruction::BitCast) {
1857       V = cast<Operator>(V)->getOperand(0);
1858     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
1859       if (GA->mayBeOverridden())
1860         return V;
1861       V = GA->getAliasee();
1862     } else {
1863       // See if InstructionSimplify knows any relevant tricks.
1864       if (Instruction *I = dyn_cast<Instruction>(V))
1865         // TODO: Acquire a DominatorTree and use it.
1866         if (Value *Simplified = SimplifyInstruction(I, TD, 0)) {
1867           V = Simplified;
1868           continue;
1869         }
1870
1871       return V;
1872     }
1873     assert(V->getType()->isPointerTy() && "Unexpected operand type!");
1874   }
1875   return V;
1876 }
1877
1878 void
1879 llvm::GetUnderlyingObjects(Value *V,
1880                            SmallVectorImpl<Value *> &Objects,
1881                            const DataLayout *TD,
1882                            unsigned MaxLookup) {
1883   SmallPtrSet<Value *, 4> Visited;
1884   SmallVector<Value *, 4> Worklist;
1885   Worklist.push_back(V);
1886   do {
1887     Value *P = Worklist.pop_back_val();
1888     P = GetUnderlyingObject(P, TD, MaxLookup);
1889
1890     if (!Visited.insert(P))
1891       continue;
1892
1893     if (SelectInst *SI = dyn_cast<SelectInst>(P)) {
1894       Worklist.push_back(SI->getTrueValue());
1895       Worklist.push_back(SI->getFalseValue());
1896       continue;
1897     }
1898
1899     if (PHINode *PN = dyn_cast<PHINode>(P)) {
1900       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1901         Worklist.push_back(PN->getIncomingValue(i));
1902       continue;
1903     }
1904
1905     Objects.push_back(P);
1906   } while (!Worklist.empty());
1907 }
1908
1909 /// onlyUsedByLifetimeMarkers - Return true if the only users of this pointer
1910 /// are lifetime markers.
1911 ///
1912 bool llvm::onlyUsedByLifetimeMarkers(const Value *V) {
1913   for (Value::const_use_iterator UI = V->use_begin(), UE = V->use_end();
1914        UI != UE; ++UI) {
1915     const IntrinsicInst *II = dyn_cast<IntrinsicInst>(*UI);
1916     if (!II) return false;
1917
1918     if (II->getIntrinsicID() != Intrinsic::lifetime_start &&
1919         II->getIntrinsicID() != Intrinsic::lifetime_end)
1920       return false;
1921   }
1922   return true;
1923 }
1924
1925 bool llvm::isSafeToSpeculativelyExecute(const Value *V,
1926                                         const DataLayout *TD) {
1927   const Operator *Inst = dyn_cast<Operator>(V);
1928   if (!Inst)
1929     return false;
1930
1931   for (unsigned i = 0, e = Inst->getNumOperands(); i != e; ++i)
1932     if (Constant *C = dyn_cast<Constant>(Inst->getOperand(i)))
1933       if (C->canTrap())
1934         return false;
1935
1936   switch (Inst->getOpcode()) {
1937   default:
1938     return true;
1939   case Instruction::UDiv:
1940   case Instruction::URem:
1941     // x / y is undefined if y == 0, but calcuations like x / 3 are safe.
1942     return isKnownNonZero(Inst->getOperand(1), TD);
1943   case Instruction::SDiv:
1944   case Instruction::SRem: {
1945     Value *Op = Inst->getOperand(1);
1946     // x / y is undefined if y == 0
1947     if (!isKnownNonZero(Op, TD))
1948       return false;
1949     // x / y might be undefined if y == -1
1950     unsigned BitWidth = getBitWidth(Op->getType(), TD);
1951     if (BitWidth == 0)
1952       return false;
1953     APInt KnownZero(BitWidth, 0);
1954     APInt KnownOne(BitWidth, 0);
1955     ComputeMaskedBits(Op, KnownZero, KnownOne, TD);
1956     return !!KnownZero;
1957   }
1958   case Instruction::Load: {
1959     const LoadInst *LI = cast<LoadInst>(Inst);
1960     if (!LI->isUnordered())
1961       return false;
1962     return LI->getPointerOperand()->isDereferenceablePointer();
1963   }
1964   case Instruction::Call: {
1965    if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
1966      switch (II->getIntrinsicID()) {
1967        // These synthetic intrinsics have no side-effects, and just mark
1968        // information about their operands.
1969        // FIXME: There are other no-op synthetic instructions that potentially
1970        // should be considered at least *safe* to speculate...
1971        case Intrinsic::dbg_declare:
1972        case Intrinsic::dbg_value:
1973          return true;
1974
1975        case Intrinsic::bswap:
1976        case Intrinsic::ctlz:
1977        case Intrinsic::ctpop:
1978        case Intrinsic::cttz:
1979        case Intrinsic::objectsize:
1980        case Intrinsic::sadd_with_overflow:
1981        case Intrinsic::smul_with_overflow:
1982        case Intrinsic::ssub_with_overflow:
1983        case Intrinsic::uadd_with_overflow:
1984        case Intrinsic::umul_with_overflow:
1985        case Intrinsic::usub_with_overflow:
1986          return true;
1987        // TODO: some fp intrinsics are marked as having the same error handling
1988        // as libm. They're safe to speculate when they won't error.
1989        // TODO: are convert_{from,to}_fp16 safe?
1990        // TODO: can we list target-specific intrinsics here?
1991        default: break;
1992      }
1993    }
1994     return false; // The called function could have undefined behavior or
1995                   // side-effects, even if marked readnone nounwind.
1996   }
1997   case Instruction::VAArg:
1998   case Instruction::Alloca:
1999   case Instruction::Invoke:
2000   case Instruction::PHI:
2001   case Instruction::Store:
2002   case Instruction::Ret:
2003   case Instruction::Br:
2004   case Instruction::IndirectBr:
2005   case Instruction::Switch:
2006   case Instruction::Unreachable:
2007   case Instruction::Fence:
2008   case Instruction::LandingPad:
2009   case Instruction::AtomicRMW:
2010   case Instruction::AtomicCmpXchg:
2011   case Instruction::Resume:
2012     return false; // Misc instructions which have effects
2013   }
2014 }