lib/Analysis/InstructionSimplify.cpp

   1 //===- InstructionSimplify.cpp - Fold instruction operands ----------------===//
   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 routines for folding instructions into simpler forms
  11 // that do not require creating new instructions.  This does constant folding
  12 // ("add i32 1, 1" -> "2") but can also handle non-constant operands, either
  13 // returning a constant ("and i32 %x, 0" -> "0") or an already existing value
  14 // ("and i32 %x, %x" -> "%x").  All operands are assumed to have already been
  15 // simplified: This is usually true and assuming it simplifies the logic (if
  16 // they have not been simplified then results are correct but maybe suboptimal).
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #include "llvm/Analysis/InstructionSimplify.h"
  21 #include "llvm/ADT/SetVector.h"
  22 #include "llvm/ADT/Statistic.h"
  23 #include "llvm/Analysis/AliasAnalysis.h"
  24 #include "llvm/Analysis/AssumptionCache.h"
  25 #include "llvm/Analysis/CaptureTracking.h"
  26 #include "llvm/Analysis/CmpInstAnalysis.h"
  27 #include "llvm/Analysis/ConstantFolding.h"
  28 #include "llvm/Analysis/LoopAnalysisManager.h"
  29 #include "llvm/Analysis/MemoryBuiltins.h"
  30 #include "llvm/Analysis/ValueTracking.h"
  31 #include "llvm/Analysis/VectorUtils.h"
  32 #include "llvm/IR/ConstantRange.h"
  33 #include "llvm/IR/DataLayout.h"
  34 #include "llvm/IR/Dominators.h"
  35 #include "llvm/IR/GetElementPtrTypeIterator.h"
  36 #include "llvm/IR/GlobalAlias.h"
  37 #include "llvm/IR/Operator.h"
  38 #include "llvm/IR/PatternMatch.h"
  39 #include "llvm/IR/ValueHandle.h"
  40 #include "llvm/Support/KnownBits.h"
  41 #include <algorithm>
  42 using namespace llvm;
  43 using namespace llvm::PatternMatch;
  44
  45 #define DEBUG_TYPE "instsimplify"
  46
  47 enum { RecursionLimit = 3 };
  48
  49 STATISTIC(NumExpand,  "Number of expansions");
  50 STATISTIC(NumReassoc, "Number of reassociations");
  51
  52 static Value *SimplifyAndInst(Value *, Value *, const SimplifyQuery &, unsigned);
  53 static Value *SimplifyBinOp(unsigned, Value *, Value *, const SimplifyQuery &,
  54                             unsigned);
  55 static Value *SimplifyFPBinOp(unsigned, Value *, Value *, const FastMathFlags &,
  56                               const SimplifyQuery &, unsigned);
  57 static Value *SimplifyCmpInst(unsigned, Value *, Value *, const SimplifyQuery &,
  58                               unsigned);
  59 static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
  60                                const SimplifyQuery &Q, unsigned MaxRecurse);
  61 static Value *SimplifyOrInst(Value *, Value *, const SimplifyQuery &, unsigned);
  62 static Value *SimplifyXorInst(Value *, Value *, const SimplifyQuery &, unsigned);
  63 static Value *SimplifyCastInst(unsigned, Value *, Type *,
  64                                const SimplifyQuery &, unsigned);
  65 static Value *SimplifyGEPInst(Type *, ArrayRef<Value *>, const SimplifyQuery &,
  66                               unsigned);
  67
  68 static Value *foldSelectWithBinaryOp(Value *Cond, Value *TrueVal,
  69                                      Value *FalseVal) {
  70   BinaryOperator::BinaryOps BinOpCode;
  71   if (auto *BO = dyn_cast<BinaryOperator>(Cond))
  72     BinOpCode = BO->getOpcode();
  73   else
  74     return nullptr;
  75
  76   CmpInst::Predicate ExpectedPred, Pred1, Pred2;
  77   if (BinOpCode == BinaryOperator::Or) {
  78     ExpectedPred = ICmpInst::ICMP_NE;
  79   } else if (BinOpCode == BinaryOperator::And) {
  80     ExpectedPred = ICmpInst::ICMP_EQ;
  81   } else
  82     return nullptr;
  83
  84   // %A = icmp eq %TV, %FV
  85   // %B = icmp eq %X, %Y (and one of these is a select operand)
  86   // %C = and %A, %B
  87   // %D = select %C, %TV, %FV
  88   // -->
  89   // %FV
  90
  91   // %A = icmp ne %TV, %FV
  92   // %B = icmp ne %X, %Y (and one of these is a select operand)
  93   // %C = or %A, %B
  94   // %D = select %C, %TV, %FV
  95   // -->
  96   // %TV
  97   Value *X, *Y;
  98   if (!match(Cond, m_c_BinOp(m_c_ICmp(Pred1, m_Specific(TrueVal),
  99                                       m_Specific(FalseVal)),
 100                              m_ICmp(Pred2, m_Value(X), m_Value(Y)))) ||
 101       Pred1 != Pred2 || Pred1 != ExpectedPred)
 102     return nullptr;
 103
 104   if (X == TrueVal || X == FalseVal || Y == TrueVal || Y == FalseVal)
 105     return BinOpCode == BinaryOperator::Or ? TrueVal : FalseVal;
 106
 107   return nullptr;
 108 }
 109
 110 /// For a boolean type or a vector of boolean type, return false or a vector
 111 /// with every element false.
 112 static Constant *getFalse(Type *Ty) {
 113   return ConstantInt::getFalse(Ty);
 114 }
 115
 116 /// For a boolean type or a vector of boolean type, return true or a vector
 117 /// with every element true.
 118 static Constant *getTrue(Type *Ty) {
 119   return ConstantInt::getTrue(Ty);
 120 }
 121
 122 /// isSameCompare - Is V equivalent to the comparison "LHS Pred RHS"?
 123 static bool isSameCompare(Value *V, CmpInst::Predicate Pred, Value *LHS,
 124                           Value *RHS) {
 125   CmpInst *Cmp = dyn_cast<CmpInst>(V);
 126   if (!Cmp)
 127     return false;
 128   CmpInst::Predicate CPred = Cmp->getPredicate();
 129   Value *CLHS = Cmp->getOperand(0), *CRHS = Cmp->getOperand(1);
 130   if (CPred == Pred && CLHS == LHS && CRHS == RHS)
 131     return true;
 132   return CPred == CmpInst::getSwappedPredicate(Pred) && CLHS == RHS &&
 133     CRHS == LHS;
 134 }
 135
 136 /// Does the given value dominate the specified phi node?
 137 static bool valueDominatesPHI(Value *V, PHINode *P, const DominatorTree *DT) {
 138   Instruction *I = dyn_cast<Instruction>(V);
 139   if (!I)
 140     // Arguments and constants dominate all instructions.
 141     return true;
 142
 143   // If we are processing instructions (and/or basic blocks) that have not been
 144   // fully added to a function, the parent nodes may still be null. Simply
 145   // return the conservative answer in these cases.
 146   if (!I->getParent() || !P->getParent() || !I->getFunction())
 147     return false;
 148
 149   // If we have a DominatorTree then do a precise test.
 150   if (DT)
 151     return DT->dominates(I, P);
 152
 153   // Otherwise, if the instruction is in the entry block and is not an invoke,
 154   // then it obviously dominates all phi nodes.
 155   if (I->getParent() == &I->getFunction()->getEntryBlock() &&
 156       !isa<InvokeInst>(I))
 157     return true;
 158
 159   return false;
 160 }
 161
 162 /// Simplify "A op (B op' C)" by distributing op over op', turning it into
 163 /// "(A op B) op' (A op C)".  Here "op" is given by Opcode and "op'" is
 164 /// given by OpcodeToExpand, while "A" corresponds to LHS and "B op' C" to RHS.
 165 /// Also performs the transform "(A op' B) op C" -> "(A op C) op' (B op C)".
 166 /// Returns the simplified value, or null if no simplification was performed.
 167 static Value *ExpandBinOp(Instruction::BinaryOps Opcode, Value *LHS, Value *RHS,
 168                           Instruction::BinaryOps OpcodeToExpand,
 169                           const SimplifyQuery &Q, unsigned MaxRecurse) {
 170   // Recursion is always used, so bail out at once if we already hit the limit.
 171   if (!MaxRecurse--)
 172     return nullptr;
 173
 174   // Check whether the expression has the form "(A op' B) op C".
 175   if (BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS))
 176     if (Op0->getOpcode() == OpcodeToExpand) {
 177       // It does!  Try turning it into "(A op C) op' (B op C)".
 178       Value *A = Op0->getOperand(0), *B = Op0->getOperand(1), *C = RHS;
 179       // Do "A op C" and "B op C" both simplify?
 180       if (Value *L = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse))
 181         if (Value *R = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
 182           // They do! Return "L op' R" if it simplifies or is already available.
 183           // If "L op' R" equals "A op' B" then "L op' R" is just the LHS.
 184           if ((L == A && R == B) || (Instruction::isCommutative(OpcodeToExpand)
 185                                      && L == B && R == A)) {
 186             ++NumExpand;
 187             return LHS;
 188           }
 189           // Otherwise return "L op' R" if it simplifies.
 190           if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
 191             ++NumExpand;
 192             return V;
 193           }
 194         }
 195     }
 196
 197   // Check whether the expression has the form "A op (B op' C)".
 198   if (BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS))
 199     if (Op1->getOpcode() == OpcodeToExpand) {
 200       // It does!  Try turning it into "(A op B) op' (A op C)".
 201       Value *A = LHS, *B = Op1->getOperand(0), *C = Op1->getOperand(1);
 202       // Do "A op B" and "A op C" both simplify?
 203       if (Value *L = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse))
 204         if (Value *R = SimplifyBinOp(Opcode, A, C, Q, MaxRecurse)) {
 205           // They do! Return "L op' R" if it simplifies or is already available.
 206           // If "L op' R" equals "B op' C" then "L op' R" is just the RHS.
 207           if ((L == B && R == C) || (Instruction::isCommutative(OpcodeToExpand)
 208                                      && L == C && R == B)) {
 209             ++NumExpand;
 210             return RHS;
 211           }
 212           // Otherwise return "L op' R" if it simplifies.
 213           if (Value *V = SimplifyBinOp(OpcodeToExpand, L, R, Q, MaxRecurse)) {
 214             ++NumExpand;
 215             return V;
 216           }
 217         }
 218     }
 219
 220   return nullptr;
 221 }
 222
 223 /// Generic simplifications for associative binary operations.
 224 /// Returns the simpler value, or null if none was found.
 225 static Value *SimplifyAssociativeBinOp(Instruction::BinaryOps Opcode,
 226                                        Value *LHS, Value *RHS,
 227                                        const SimplifyQuery &Q,
 228                                        unsigned MaxRecurse) {
 229   assert(Instruction::isAssociative(Opcode) && "Not an associative operation!");
 230
 231   // Recursion is always used, so bail out at once if we already hit the limit.
 232   if (!MaxRecurse--)
 233     return nullptr;
 234
 235   BinaryOperator *Op0 = dyn_cast<BinaryOperator>(LHS);
 236   BinaryOperator *Op1 = dyn_cast<BinaryOperator>(RHS);
 237
 238   // Transform: "(A op B) op C" ==> "A op (B op C)" if it simplifies completely.
 239   if (Op0 && Op0->getOpcode() == Opcode) {
 240     Value *A = Op0->getOperand(0);
 241     Value *B = Op0->getOperand(1);
 242     Value *C = RHS;
 243
 244     // Does "B op C" simplify?
 245     if (Value *V = SimplifyBinOp(Opcode, B, C, Q, MaxRecurse)) {
 246       // It does!  Return "A op V" if it simplifies or is already available.
 247       // If V equals B then "A op V" is just the LHS.
 248       if (V == B) return LHS;
 249       // Otherwise return "A op V" if it simplifies.
 250       if (Value *W = SimplifyBinOp(Opcode, A, V, Q, MaxRecurse)) {
 251         ++NumReassoc;
 252         return W;
 253       }
 254     }
 255   }
 256
 257   // Transform: "A op (B op C)" ==> "(A op B) op C" if it simplifies completely.
 258   if (Op1 && Op1->getOpcode() == Opcode) {
 259     Value *A = LHS;
 260     Value *B = Op1->getOperand(0);
 261     Value *C = Op1->getOperand(1);
 262
 263     // Does "A op B" simplify?
 264     if (Value *V = SimplifyBinOp(Opcode, A, B, Q, MaxRecurse)) {
 265       // It does!  Return "V op C" if it simplifies or is already available.
 266       // If V equals B then "V op C" is just the RHS.
 267       if (V == B) return RHS;
 268       // Otherwise return "V op C" if it simplifies.
 269       if (Value *W = SimplifyBinOp(Opcode, V, C, Q, MaxRecurse)) {
 270         ++NumReassoc;
 271         return W;
 272       }
 273     }
 274   }
 275
 276   // The remaining transforms require commutativity as well as associativity.
 277   if (!Instruction::isCommutative(Opcode))
 278     return nullptr;
 279
 280   // Transform: "(A op B) op C" ==> "(C op A) op B" if it simplifies completely.
 281   if (Op0 && Op0->getOpcode() == Opcode) {
 282     Value *A = Op0->getOperand(0);
 283     Value *B = Op0->getOperand(1);
 284     Value *C = RHS;
 285
 286     // Does "C op A" simplify?
 287     if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
 288       // It does!  Return "V op B" if it simplifies or is already available.
 289       // If V equals A then "V op B" is just the LHS.
 290       if (V == A) return LHS;
 291       // Otherwise return "V op B" if it simplifies.
 292       if (Value *W = SimplifyBinOp(Opcode, V, B, Q, MaxRecurse)) {
 293         ++NumReassoc;
 294         return W;
 295       }
 296     }
 297   }
 298
 299   // Transform: "A op (B op C)" ==> "B op (C op A)" if it simplifies completely.
 300   if (Op1 && Op1->getOpcode() == Opcode) {
 301     Value *A = LHS;
 302     Value *B = Op1->getOperand(0);
 303     Value *C = Op1->getOperand(1);
 304
 305     // Does "C op A" simplify?
 306     if (Value *V = SimplifyBinOp(Opcode, C, A, Q, MaxRecurse)) {
 307       // It does!  Return "B op V" if it simplifies or is already available.
 308       // If V equals C then "B op V" is just the RHS.
 309       if (V == C) return RHS;
 310       // Otherwise return "B op V" if it simplifies.
 311       if (Value *W = SimplifyBinOp(Opcode, B, V, Q, MaxRecurse)) {
 312         ++NumReassoc;
 313         return W;
 314       }
 315     }
 316   }
 317
 318   return nullptr;
 319 }
 320
 321 /// In the case of a binary operation with a select instruction as an operand,
 322 /// try to simplify the binop by seeing whether evaluating it on both branches
 323 /// of the select results in the same value. Returns the common value if so,
 324 /// otherwise returns null.
 325 static Value *ThreadBinOpOverSelect(Instruction::BinaryOps Opcode, Value *LHS,
 326                                     Value *RHS, const SimplifyQuery &Q,
 327                                     unsigned MaxRecurse) {
 328   // Recursion is always used, so bail out at once if we already hit the limit.
 329   if (!MaxRecurse--)
 330     return nullptr;
 331
 332   SelectInst *SI;
 333   if (isa<SelectInst>(LHS)) {
 334     SI = cast<SelectInst>(LHS);
 335   } else {
 336     assert(isa<SelectInst>(RHS) && "No select instruction operand!");
 337     SI = cast<SelectInst>(RHS);
 338   }
 339
 340   // Evaluate the BinOp on the true and false branches of the select.
 341   Value *TV;
 342   Value *FV;
 343   if (SI == LHS) {
 344     TV = SimplifyBinOp(Opcode, SI->getTrueValue(), RHS, Q, MaxRecurse);
 345     FV = SimplifyBinOp(Opcode, SI->getFalseValue(), RHS, Q, MaxRecurse);
 346   } else {
 347     TV = SimplifyBinOp(Opcode, LHS, SI->getTrueValue(), Q, MaxRecurse);
 348     FV = SimplifyBinOp(Opcode, LHS, SI->getFalseValue(), Q, MaxRecurse);
 349   }
 350
 351   // If they simplified to the same value, then return the common value.
 352   // If they both failed to simplify then return null.
 353   if (TV == FV)
 354     return TV;
 355
 356   // If one branch simplified to undef, return the other one.
 357   if (TV && isa<UndefValue>(TV))
 358     return FV;
 359   if (FV && isa<UndefValue>(FV))
 360     return TV;
 361
 362   // If applying the operation did not change the true and false select values,
 363   // then the result of the binop is the select itself.
 364   if (TV == SI->getTrueValue() && FV == SI->getFalseValue())
 365     return SI;
 366
 367   // If one branch simplified and the other did not, and the simplified
 368   // value is equal to the unsimplified one, return the simplified value.
 369   // For example, select (cond, X, X & Z) & Z -> X & Z.
 370   if ((FV && !TV) || (TV && !FV)) {
 371     // Check that the simplified value has the form "X op Y" where "op" is the
 372     // same as the original operation.
 373     Instruction *Simplified = dyn_cast<Instruction>(FV ? FV : TV);
 374     if (Simplified && Simplified->getOpcode() == unsigned(Opcode)) {
 375       // The value that didn't simplify is "UnsimplifiedLHS op UnsimplifiedRHS".
 376       // We already know that "op" is the same as for the simplified value.  See
 377       // if the operands match too.  If so, return the simplified value.
 378       Value *UnsimplifiedBranch = FV ? SI->getTrueValue() : SI->getFalseValue();
 379       Value *UnsimplifiedLHS = SI == LHS ? UnsimplifiedBranch : LHS;
 380       Value *UnsimplifiedRHS = SI == LHS ? RHS : UnsimplifiedBranch;
 381       if (Simplified->getOperand(0) == UnsimplifiedLHS &&
 382           Simplified->getOperand(1) == UnsimplifiedRHS)
 383         return Simplified;
 384       if (Simplified->isCommutative() &&
 385           Simplified->getOperand(1) == UnsimplifiedLHS &&
 386           Simplified->getOperand(0) == UnsimplifiedRHS)
 387         return Simplified;
 388     }
 389   }
 390
 391   return nullptr;
 392 }
 393
 394 /// In the case of a comparison with a select instruction, try to simplify the
 395 /// comparison by seeing whether both branches of the select result in the same
 396 /// value. Returns the common value if so, otherwise returns null.
 397 static Value *ThreadCmpOverSelect(CmpInst::Predicate Pred, Value *LHS,
 398                                   Value *RHS, const SimplifyQuery &Q,
 399                                   unsigned MaxRecurse) {
 400   // Recursion is always used, so bail out at once if we already hit the limit.
 401   if (!MaxRecurse--)
 402     return nullptr;
 403
 404   // Make sure the select is on the LHS.
 405   if (!isa<SelectInst>(LHS)) {
 406     std::swap(LHS, RHS);
 407     Pred = CmpInst::getSwappedPredicate(Pred);
 408   }
 409   assert(isa<SelectInst>(LHS) && "Not comparing with a select instruction!");
 410   SelectInst *SI = cast<SelectInst>(LHS);
 411   Value *Cond = SI->getCondition();
 412   Value *TV = SI->getTrueValue();
 413   Value *FV = SI->getFalseValue();
 414
 415   // Now that we have "cmp select(Cond, TV, FV), RHS", analyse it.
 416   // Does "cmp TV, RHS" simplify?
 417   Value *TCmp = SimplifyCmpInst(Pred, TV, RHS, Q, MaxRecurse);
 418   if (TCmp == Cond) {
 419     // It not only simplified, it simplified to the select condition.  Replace
 420     // it with 'true'.
 421     TCmp = getTrue(Cond->getType());
 422   } else if (!TCmp) {
 423     // It didn't simplify.  However if "cmp TV, RHS" is equal to the select
 424     // condition then we can replace it with 'true'.  Otherwise give up.
 425     if (!isSameCompare(Cond, Pred, TV, RHS))
 426       return nullptr;
 427     TCmp = getTrue(Cond->getType());
 428   }
 429
 430   // Does "cmp FV, RHS" simplify?
 431   Value *FCmp = SimplifyCmpInst(Pred, FV, RHS, Q, MaxRecurse);
 432   if (FCmp == Cond) {
 433     // It not only simplified, it simplified to the select condition.  Replace
 434     // it with 'false'.
 435     FCmp = getFalse(Cond->getType());
 436   } else if (!FCmp) {
 437     // It didn't simplify.  However if "cmp FV, RHS" is equal to the select
 438     // condition then we can replace it with 'false'.  Otherwise give up.
 439     if (!isSameCompare(Cond, Pred, FV, RHS))
 440       return nullptr;
 441     FCmp = getFalse(Cond->getType());
 442   }
 443
 444   // If both sides simplified to the same value, then use it as the result of
 445   // the original comparison.
 446   if (TCmp == FCmp)
 447     return TCmp;
 448
 449   // The remaining cases only make sense if the select condition has the same
 450   // type as the result of the comparison, so bail out if this is not so.
 451   if (Cond->getType()->isVectorTy() != RHS->getType()->isVectorTy())
 452     return nullptr;
 453   // If the false value simplified to false, then the result of the compare
 454   // is equal to "Cond && TCmp".  This also catches the case when the false
 455   // value simplified to false and the true value to true, returning "Cond".
 456   if (match(FCmp, m_Zero()))
 457     if (Value *V = SimplifyAndInst(Cond, TCmp, Q, MaxRecurse))
 458       return V;
 459   // If the true value simplified to true, then the result of the compare
 460   // is equal to "Cond || FCmp".
 461   if (match(TCmp, m_One()))
 462     if (Value *V = SimplifyOrInst(Cond, FCmp, Q, MaxRecurse))
 463       return V;
 464   // Finally, if the false value simplified to true and the true value to
 465   // false, then the result of the compare is equal to "!Cond".
 466   if (match(FCmp, m_One()) && match(TCmp, m_Zero()))
 467     if (Value *V =
 468         SimplifyXorInst(Cond, Constant::getAllOnesValue(Cond->getType()),
 469                         Q, MaxRecurse))
 470       return V;
 471
 472   return nullptr;
 473 }
 474
 475 /// In the case of a binary operation with an operand that is a PHI instruction,
 476 /// try to simplify the binop by seeing whether evaluating it on the incoming
 477 /// phi values yields the same result for every value. If so returns the common
 478 /// value, otherwise returns null.
 479 static Value *ThreadBinOpOverPHI(Instruction::BinaryOps Opcode, Value *LHS,
 480                                  Value *RHS, const SimplifyQuery &Q,
 481                                  unsigned MaxRecurse) {
 482   // Recursion is always used, so bail out at once if we already hit the limit.
 483   if (!MaxRecurse--)
 484     return nullptr;
 485
 486   PHINode *PI;
 487   if (isa<PHINode>(LHS)) {
 488     PI = cast<PHINode>(LHS);
 489     // Bail out if RHS and the phi may be mutually interdependent due to a loop.
 490     if (!valueDominatesPHI(RHS, PI, Q.DT))
 491       return nullptr;
 492   } else {
 493     assert(isa<PHINode>(RHS) && "No PHI instruction operand!");
 494     PI = cast<PHINode>(RHS);
 495     // Bail out if LHS and the phi may be mutually interdependent due to a loop.
 496     if (!valueDominatesPHI(LHS, PI, Q.DT))
 497       return nullptr;
 498   }
 499
 500   // Evaluate the BinOp on the incoming phi values.
 501   Value *CommonValue = nullptr;
 502   for (Value *Incoming : PI->incoming_values()) {
 503     // If the incoming value is the phi node itself, it can safely be skipped.
 504     if (Incoming == PI) continue;
 505     Value *V = PI == LHS ?
 506       SimplifyBinOp(Opcode, Incoming, RHS, Q, MaxRecurse) :
 507       SimplifyBinOp(Opcode, LHS, Incoming, Q, MaxRecurse);
 508     // If the operation failed to simplify, or simplified to a different value
 509     // to previously, then give up.
 510     if (!V || (CommonValue && V != CommonValue))
 511       return nullptr;
 512     CommonValue = V;
 513   }
 514
 515   return CommonValue;
 516 }
 517
 518 /// In the case of a comparison with a PHI instruction, try to simplify the
 519 /// comparison by seeing whether comparing with all of the incoming phi values
 520 /// yields the same result every time. If so returns the common result,
 521 /// otherwise returns null.
 522 static Value *ThreadCmpOverPHI(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
 523                                const SimplifyQuery &Q, unsigned MaxRecurse) {
 524   // Recursion is always used, so bail out at once if we already hit the limit.
 525   if (!MaxRecurse--)
 526     return nullptr;
 527
 528   // Make sure the phi is on the LHS.
 529   if (!isa<PHINode>(LHS)) {
 530     std::swap(LHS, RHS);
 531     Pred = CmpInst::getSwappedPredicate(Pred);
 532   }
 533   assert(isa<PHINode>(LHS) && "Not comparing with a phi instruction!");
 534   PHINode *PI = cast<PHINode>(LHS);
 535
 536   // Bail out if RHS and the phi may be mutually interdependent due to a loop.
 537   if (!valueDominatesPHI(RHS, PI, Q.DT))
 538     return nullptr;
 539
 540   // Evaluate the BinOp on the incoming phi values.
 541   Value *CommonValue = nullptr;
 542   for (Value *Incoming : PI->incoming_values()) {
 543     // If the incoming value is the phi node itself, it can safely be skipped.
 544     if (Incoming == PI) continue;
 545     Value *V = SimplifyCmpInst(Pred, Incoming, RHS, Q, MaxRecurse);
 546     // If the operation failed to simplify, or simplified to a different value
 547     // to previously, then give up.
 548     if (!V || (CommonValue && V != CommonValue))
 549       return nullptr;
 550     CommonValue = V;
 551   }
 552
 553   return CommonValue;
 554 }
 555
 556 static Constant *foldOrCommuteConstant(Instruction::BinaryOps Opcode,
 557                                        Value *&Op0, Value *&Op1,
 558                                        const SimplifyQuery &Q) {
 559   if (auto *CLHS = dyn_cast<Constant>(Op0)) {
 560     if (auto *CRHS = dyn_cast<Constant>(Op1))
 561       return ConstantFoldBinaryOpOperands(Opcode, CLHS, CRHS, Q.DL);
 562
 563     // Canonicalize the constant to the RHS if this is a commutative operation.
 564     if (Instruction::isCommutative(Opcode))
 565       std::swap(Op0, Op1);
 566   }
 567   return nullptr;
 568 }
 569
 570 /// Given operands for an Add, see if we can fold the result.
 571 /// If not, this returns null.
 572 static Value *SimplifyAddInst(Value *Op0, Value *Op1, bool IsNSW, bool IsNUW,
 573                               const SimplifyQuery &Q, unsigned MaxRecurse) {
 574   if (Constant *C = foldOrCommuteConstant(Instruction::Add, Op0, Op1, Q))
 575     return C;
 576
 577   // X + undef -> undef
 578   if (match(Op1, m_Undef()))
 579     return Op1;
 580
 581   // X + 0 -> X
 582   if (match(Op1, m_Zero()))
 583     return Op0;
 584
 585   // If two operands are negative, return 0.
 586   if (isKnownNegation(Op0, Op1))
 587     return Constant::getNullValue(Op0->getType());
 588
 589   // X + (Y - X) -> Y
 590   // (Y - X) + X -> Y
 591   // Eg: X + -X -> 0
 592   Value *Y = nullptr;
 593   if (match(Op1, m_Sub(m_Value(Y), m_Specific(Op0))) ||
 594       match(Op0, m_Sub(m_Value(Y), m_Specific(Op1))))
 595     return Y;
 596
 597   // X + ~X -> -1   since   ~X = -X-1
 598   Type *Ty = Op0->getType();
 599   if (match(Op0, m_Not(m_Specific(Op1))) ||
 600       match(Op1, m_Not(m_Specific(Op0))))
 601     return Constant::getAllOnesValue(Ty);
 602
 603   // add nsw/nuw (xor Y, signmask), signmask --> Y
 604   // The no-wrapping add guarantees that the top bit will be set by the add.
 605   // Therefore, the xor must be clearing the already set sign bit of Y.
 606   if ((IsNSW || IsNUW) && match(Op1, m_SignMask()) &&
 607       match(Op0, m_Xor(m_Value(Y), m_SignMask())))
 608     return Y;
 609
 610   // add nuw %x, -1  ->  -1, because %x can only be 0.
 611   if (IsNUW && match(Op1, m_AllOnes()))
 612     return Op1; // Which is -1.
 613
 614   /// i1 add -> xor.
 615   if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
 616     if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
 617       return V;
 618
 619   // Try some generic simplifications for associative operations.
 620   if (Value *V = SimplifyAssociativeBinOp(Instruction::Add, Op0, Op1, Q,
 621                                           MaxRecurse))
 622     return V;
 623
 624   // Threading Add over selects and phi nodes is pointless, so don't bother.
 625   // Threading over the select in "A + select(cond, B, C)" means evaluating
 626   // "A+B" and "A+C" and seeing if they are equal; but they are equal if and
 627   // only if B and C are equal.  If B and C are equal then (since we assume
 628   // that operands have already been simplified) "select(cond, B, C)" should
 629   // have been simplified to the common value of B and C already.  Analysing
 630   // "A+B" and "A+C" thus gains nothing, but costs compile time.  Similarly
 631   // for threading over phi nodes.
 632
 633   return nullptr;
 634 }
 635
 636 Value *llvm::SimplifyAddInst(Value *Op0, Value *Op1, bool IsNSW, bool IsNUW,
 637                              const SimplifyQuery &Query) {
 638   return ::SimplifyAddInst(Op0, Op1, IsNSW, IsNUW, Query, RecursionLimit);
 639 }
 640
 641 /// Compute the base pointer and cumulative constant offsets for V.
 642 ///
 643 /// This strips all constant offsets off of V, leaving it the base pointer, and
 644 /// accumulates the total constant offset applied in the returned constant. It
 645 /// returns 0 if V is not a pointer, and returns the constant '0' if there are
 646 /// no constant offsets applied.
 647 ///
 648 /// This is very similar to GetPointerBaseWithConstantOffset except it doesn't
 649 /// follow non-inbounds geps. This allows it to remain usable for icmp ult/etc.
 650 /// folding.
 651 static Constant *stripAndComputeConstantOffsets(const DataLayout &DL, Value *&V,
 652                                                 bool AllowNonInbounds = false) {
 653   assert(V->getType()->isPtrOrPtrVectorTy());
 654
 655   Type *IntPtrTy = DL.getIntPtrType(V->getType())->getScalarType();
 656   APInt Offset = APInt::getNullValue(IntPtrTy->getIntegerBitWidth());
 657
 658   // Even though we don't look through PHI nodes, we could be called on an
 659   // instruction in an unreachable block, which may be on a cycle.
 660   SmallPtrSet<Value *, 4> Visited;
 661   Visited.insert(V);
 662   do {
 663     if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) {
 664       if ((!AllowNonInbounds && !GEP->isInBounds()) ||
 665           !GEP->accumulateConstantOffset(DL, Offset))
 666         break;
 667       V = GEP->getPointerOperand();
 668     } else if (Operator::getOpcode(V) == Instruction::BitCast) {
 669       V = cast<Operator>(V)->getOperand(0);
 670     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
 671       if (GA->isInterposable())
 672         break;
 673       V = GA->getAliasee();
 674     } else {
 675       if (auto CS = CallSite(V))
 676         if (Value *RV = CS.getReturnedArgOperand()) {
 677           V = RV;
 678           continue;
 679         }
 680       break;
 681     }
 682     assert(V->getType()->isPtrOrPtrVectorTy() && "Unexpected operand type!");
 683   } while (Visited.insert(V).second);
 684
 685   Constant *OffsetIntPtr = ConstantInt::get(IntPtrTy, Offset);
 686   if (V->getType()->isVectorTy())
 687     return ConstantVector::getSplat(V->getType()->getVectorNumElements(),
 688                                     OffsetIntPtr);
 689   return OffsetIntPtr;
 690 }
 691
 692 /// Compute the constant difference between two pointer values.
 693 /// If the difference is not a constant, returns zero.
 694 static Constant *computePointerDifference(const DataLayout &DL, Value *LHS,
 695                                           Value *RHS) {
 696   Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
 697   Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
 698
 699   // If LHS and RHS are not related via constant offsets to the same base
 700   // value, there is nothing we can do here.
 701   if (LHS != RHS)
 702     return nullptr;
 703
 704   // Otherwise, the difference of LHS - RHS can be computed as:
 705   //    LHS - RHS
 706   //  = (LHSOffset + Base) - (RHSOffset + Base)
 707   //  = LHSOffset - RHSOffset
 708   return ConstantExpr::getSub(LHSOffset, RHSOffset);
 709 }
 710
 711 /// Given operands for a Sub, see if we can fold the result.
 712 /// If not, this returns null.
 713 static Value *SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
 714                               const SimplifyQuery &Q, unsigned MaxRecurse) {
 715   if (Constant *C = foldOrCommuteConstant(Instruction::Sub, Op0, Op1, Q))
 716     return C;
 717
 718   // X - undef -> undef
 719   // undef - X -> undef
 720   if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
 721     return UndefValue::get(Op0->getType());
 722
 723   // X - 0 -> X
 724   if (match(Op1, m_Zero()))
 725     return Op0;
 726
 727   // X - X -> 0
 728   if (Op0 == Op1)
 729     return Constant::getNullValue(Op0->getType());
 730
 731   // Is this a negation?
 732   if (match(Op0, m_Zero())) {
 733     // 0 - X -> 0 if the sub is NUW.
 734     if (isNUW)
 735       return Constant::getNullValue(Op0->getType());
 736
 737     KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
 738     if (Known.Zero.isMaxSignedValue()) {
 739       // Op1 is either 0 or the minimum signed value. If the sub is NSW, then
 740       // Op1 must be 0 because negating the minimum signed value is undefined.
 741       if (isNSW)
 742         return Constant::getNullValue(Op0->getType());
 743
 744       // 0 - X -> X if X is 0 or the minimum signed value.
 745       return Op1;
 746     }
 747   }
 748
 749   // (X + Y) - Z -> X + (Y - Z) or Y + (X - Z) if everything simplifies.
 750   // For example, (X + Y) - Y -> X; (Y + X) - Y -> X
 751   Value *X = nullptr, *Y = nullptr, *Z = Op1;
 752   if (MaxRecurse && match(Op0, m_Add(m_Value(X), m_Value(Y)))) { // (X + Y) - Z
 753     // See if "V === Y - Z" simplifies.
 754     if (Value *V = SimplifyBinOp(Instruction::Sub, Y, Z, Q, MaxRecurse-1))
 755       // It does!  Now see if "X + V" simplifies.
 756       if (Value *W = SimplifyBinOp(Instruction::Add, X, V, Q, MaxRecurse-1)) {
 757         // It does, we successfully reassociated!
 758         ++NumReassoc;
 759         return W;
 760       }
 761     // See if "V === X - Z" simplifies.
 762     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
 763       // It does!  Now see if "Y + V" simplifies.
 764       if (Value *W = SimplifyBinOp(Instruction::Add, Y, V, Q, MaxRecurse-1)) {
 765         // It does, we successfully reassociated!
 766         ++NumReassoc;
 767         return W;
 768       }
 769   }
 770
 771   // X - (Y + Z) -> (X - Y) - Z or (X - Z) - Y if everything simplifies.
 772   // For example, X - (X + 1) -> -1
 773   X = Op0;
 774   if (MaxRecurse && match(Op1, m_Add(m_Value(Y), m_Value(Z)))) { // X - (Y + Z)
 775     // See if "V === X - Y" simplifies.
 776     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
 777       // It does!  Now see if "V - Z" simplifies.
 778       if (Value *W = SimplifyBinOp(Instruction::Sub, V, Z, Q, MaxRecurse-1)) {
 779         // It does, we successfully reassociated!
 780         ++NumReassoc;
 781         return W;
 782       }
 783     // See if "V === X - Z" simplifies.
 784     if (Value *V = SimplifyBinOp(Instruction::Sub, X, Z, Q, MaxRecurse-1))
 785       // It does!  Now see if "V - Y" simplifies.
 786       if (Value *W = SimplifyBinOp(Instruction::Sub, V, Y, Q, MaxRecurse-1)) {
 787         // It does, we successfully reassociated!
 788         ++NumReassoc;
 789         return W;
 790       }
 791   }
 792
 793   // Z - (X - Y) -> (Z - X) + Y if everything simplifies.
 794   // For example, X - (X - Y) -> Y.
 795   Z = Op0;
 796   if (MaxRecurse && match(Op1, m_Sub(m_Value(X), m_Value(Y)))) // Z - (X - Y)
 797     // See if "V === Z - X" simplifies.
 798     if (Value *V = SimplifyBinOp(Instruction::Sub, Z, X, Q, MaxRecurse-1))
 799       // It does!  Now see if "V + Y" simplifies.
 800       if (Value *W = SimplifyBinOp(Instruction::Add, V, Y, Q, MaxRecurse-1)) {
 801         // It does, we successfully reassociated!
 802         ++NumReassoc;
 803         return W;
 804       }
 805
 806   // trunc(X) - trunc(Y) -> trunc(X - Y) if everything simplifies.
 807   if (MaxRecurse && match(Op0, m_Trunc(m_Value(X))) &&
 808       match(Op1, m_Trunc(m_Value(Y))))
 809     if (X->getType() == Y->getType())
 810       // See if "V === X - Y" simplifies.
 811       if (Value *V = SimplifyBinOp(Instruction::Sub, X, Y, Q, MaxRecurse-1))
 812         // It does!  Now see if "trunc V" simplifies.
 813         if (Value *W = SimplifyCastInst(Instruction::Trunc, V, Op0->getType(),
 814                                         Q, MaxRecurse - 1))
 815           // It does, return the simplified "trunc V".
 816           return W;
 817
 818   // Variations on GEP(base, I, ...) - GEP(base, i, ...) -> GEP(null, I-i, ...).
 819   if (match(Op0, m_PtrToInt(m_Value(X))) &&
 820       match(Op1, m_PtrToInt(m_Value(Y))))
 821     if (Constant *Result = computePointerDifference(Q.DL, X, Y))
 822       return ConstantExpr::getIntegerCast(Result, Op0->getType(), true);
 823
 824   // i1 sub -> xor.
 825   if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
 826     if (Value *V = SimplifyXorInst(Op0, Op1, Q, MaxRecurse-1))
 827       return V;
 828
 829   // Threading Sub over selects and phi nodes is pointless, so don't bother.
 830   // Threading over the select in "A - select(cond, B, C)" means evaluating
 831   // "A-B" and "A-C" and seeing if they are equal; but they are equal if and
 832   // only if B and C are equal.  If B and C are equal then (since we assume
 833   // that operands have already been simplified) "select(cond, B, C)" should
 834   // have been simplified to the common value of B and C already.  Analysing
 835   // "A-B" and "A-C" thus gains nothing, but costs compile time.  Similarly
 836   // for threading over phi nodes.
 837
 838   return nullptr;
 839 }
 840
 841 Value *llvm::SimplifySubInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
 842                              const SimplifyQuery &Q) {
 843   return ::SimplifySubInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
 844 }
 845
 846 /// Given operands for a Mul, see if we can fold the result.
 847 /// If not, this returns null.
 848 static Value *SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
 849                               unsigned MaxRecurse) {
 850   if (Constant *C = foldOrCommuteConstant(Instruction::Mul, Op0, Op1, Q))
 851     return C;
 852
 853   // X * undef -> 0
 854   // X * 0 -> 0
 855   if (match(Op1, m_CombineOr(m_Undef(), m_Zero())))
 856     return Constant::getNullValue(Op0->getType());
 857
 858   // X * 1 -> X
 859   if (match(Op1, m_One()))
 860     return Op0;
 861
 862   // (X / Y) * Y -> X if the division is exact.
 863   Value *X = nullptr;
 864   if (match(Op0, m_Exact(m_IDiv(m_Value(X), m_Specific(Op1)))) || // (X / Y) * Y
 865       match(Op1, m_Exact(m_IDiv(m_Value(X), m_Specific(Op0)))))   // Y * (X / Y)
 866     return X;
 867
 868   // i1 mul -> and.
 869   if (MaxRecurse && Op0->getType()->isIntOrIntVectorTy(1))
 870     if (Value *V = SimplifyAndInst(Op0, Op1, Q, MaxRecurse-1))
 871       return V;
 872
 873   // Try some generic simplifications for associative operations.
 874   if (Value *V = SimplifyAssociativeBinOp(Instruction::Mul, Op0, Op1, Q,
 875                                           MaxRecurse))
 876     return V;
 877
 878   // Mul distributes over Add. Try some generic simplifications based on this.
 879   if (Value *V = ExpandBinOp(Instruction::Mul, Op0, Op1, Instruction::Add,
 880                              Q, MaxRecurse))
 881     return V;
 882
 883   // If the operation is with the result of a select instruction, check whether
 884   // operating on either branch of the select always yields the same value.
 885   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
 886     if (Value *V = ThreadBinOpOverSelect(Instruction::Mul, Op0, Op1, Q,
 887                                          MaxRecurse))
 888       return V;
 889
 890   // If the operation is with the result of a phi instruction, check whether
 891   // operating on all incoming values of the phi always yields the same value.
 892   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
 893     if (Value *V = ThreadBinOpOverPHI(Instruction::Mul, Op0, Op1, Q,
 894                                       MaxRecurse))
 895       return V;
 896
 897   return nullptr;
 898 }
 899
 900 Value *llvm::SimplifyMulInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
 901   return ::SimplifyMulInst(Op0, Op1, Q, RecursionLimit);
 902 }
 903
 904 /// Check for common or similar folds of integer division or integer remainder.
 905 /// This applies to all 4 opcodes (sdiv/udiv/srem/urem).
 906 static Value *simplifyDivRem(Value *Op0, Value *Op1, bool IsDiv) {
 907   Type *Ty = Op0->getType();
 908
 909   // X / undef -> undef
 910   // X % undef -> undef
 911   if (match(Op1, m_Undef()))
 912     return Op1;
 913
 914   // X / 0 -> undef
 915   // X % 0 -> undef
 916   // We don't need to preserve faults!
 917   if (match(Op1, m_Zero()))
 918     return UndefValue::get(Ty);
 919
 920   // If any element of a constant divisor vector is zero or undef, the whole op
 921   // is undef.
 922   auto *Op1C = dyn_cast<Constant>(Op1);
 923   if (Op1C && Ty->isVectorTy()) {
 924     unsigned NumElts = Ty->getVectorNumElements();
 925     for (unsigned i = 0; i != NumElts; ++i) {
 926       Constant *Elt = Op1C->getAggregateElement(i);
 927       if (Elt && (Elt->isNullValue() || isa<UndefValue>(Elt)))
 928         return UndefValue::get(Ty);
 929     }
 930   }
 931
 932   // undef / X -> 0
 933   // undef % X -> 0
 934   if (match(Op0, m_Undef()))
 935     return Constant::getNullValue(Ty);
 936
 937   // 0 / X -> 0
 938   // 0 % X -> 0
 939   if (match(Op0, m_Zero()))
 940     return Constant::getNullValue(Op0->getType());
 941
 942   // X / X -> 1
 943   // X % X -> 0
 944   if (Op0 == Op1)
 945     return IsDiv ? ConstantInt::get(Ty, 1) : Constant::getNullValue(Ty);
 946
 947   // X / 1 -> X
 948   // X % 1 -> 0
 949   // If this is a boolean op (single-bit element type), we can't have
 950   // division-by-zero or remainder-by-zero, so assume the divisor is 1.
 951   // Similarly, if we're zero-extending a boolean divisor, then assume it's a 1.
 952   Value *X;
 953   if (match(Op1, m_One()) || Ty->isIntOrIntVectorTy(1) ||
 954       (match(Op1, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)))
 955     return IsDiv ? Op0 : Constant::getNullValue(Ty);
 956
 957   return nullptr;
 958 }
 959
 960 /// Given a predicate and two operands, return true if the comparison is true.
 961 /// This is a helper for div/rem simplification where we return some other value
 962 /// when we can prove a relationship between the operands.
 963 static bool isICmpTrue(ICmpInst::Predicate Pred, Value *LHS, Value *RHS,
 964                        const SimplifyQuery &Q, unsigned MaxRecurse) {
 965   Value *V = SimplifyICmpInst(Pred, LHS, RHS, Q, MaxRecurse);
 966   Constant *C = dyn_cast_or_null<Constant>(V);
 967   return (C && C->isAllOnesValue());
 968 }
 969
 970 /// Return true if we can simplify X / Y to 0. Remainder can adapt that answer
 971 /// to simplify X % Y to X.
 972 static bool isDivZero(Value *X, Value *Y, const SimplifyQuery &Q,
 973                       unsigned MaxRecurse, bool IsSigned) {
 974   // Recursion is always used, so bail out at once if we already hit the limit.
 975   if (!MaxRecurse--)
 976     return false;
 977
 978   if (IsSigned) {
 979     // |X| / |Y| --> 0
 980     //
 981     // We require that 1 operand is a simple constant. That could be extended to
 982     // 2 variables if we computed the sign bit for each.
 983     //
 984     // Make sure that a constant is not the minimum signed value because taking
 985     // the abs() of that is undefined.
 986     Type *Ty = X->getType();
 987     const APInt *C;
 988     if (match(X, m_APInt(C)) && !C->isMinSignedValue()) {
 989       // Is the variable divisor magnitude always greater than the constant
 990       // dividend magnitude?
 991       // |Y| > |C| --> Y < -abs(C) or Y > abs(C)
 992       Constant *PosDividendC = ConstantInt::get(Ty, C->abs());
 993       Constant *NegDividendC = ConstantInt::get(Ty, -C->abs());
 994       if (isICmpTrue(CmpInst::ICMP_SLT, Y, NegDividendC, Q, MaxRecurse) ||
 995           isICmpTrue(CmpInst::ICMP_SGT, Y, PosDividendC, Q, MaxRecurse))
 996         return true;
 997     }
 998     if (match(Y, m_APInt(C))) {
 999       // Special-case: we can't take the abs() of a minimum signed value. If
1000       // that's the divisor, then all we have to do is prove that the dividend
1001       // is also not the minimum signed value.
1002       if (C->isMinSignedValue())
1003         return isICmpTrue(CmpInst::ICMP_NE, X, Y, Q, MaxRecurse);
1004
1005       // Is the variable dividend magnitude always less than the constant
1006       // divisor magnitude?
1007       // |X| < |C| --> X > -abs(C) and X < abs(C)
1008       Constant *PosDivisorC = ConstantInt::get(Ty, C->abs());
1009       Constant *NegDivisorC = ConstantInt::get(Ty, -C->abs());
1010       if (isICmpTrue(CmpInst::ICMP_SGT, X, NegDivisorC, Q, MaxRecurse) &&
1011           isICmpTrue(CmpInst::ICMP_SLT, X, PosDivisorC, Q, MaxRecurse))
1012         return true;
1013     }
1014     return false;
1015   }
1016
1017   // IsSigned == false.
1018   // Is the dividend unsigned less than the divisor?
1019   return isICmpTrue(ICmpInst::ICMP_ULT, X, Y, Q, MaxRecurse);
1020 }
1021
1022 /// These are simplifications common to SDiv and UDiv.
1023 static Value *simplifyDiv(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
1024                           const SimplifyQuery &Q, unsigned MaxRecurse) {
1025   if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1026     return C;
1027
1028   if (Value *V = simplifyDivRem(Op0, Op1, true))
1029     return V;
1030
1031   bool IsSigned = Opcode == Instruction::SDiv;
1032
1033   // (X * Y) / Y -> X if the multiplication does not overflow.
1034   Value *X;
1035   if (match(Op0, m_c_Mul(m_Value(X), m_Specific(Op1)))) {
1036     auto *Mul = cast<OverflowingBinaryOperator>(Op0);
1037     // If the Mul does not overflow, then we are good to go.
1038     if ((IsSigned && Mul->hasNoSignedWrap()) ||
1039         (!IsSigned && Mul->hasNoUnsignedWrap()))
1040       return X;
1041     // If X has the form X = A / Y, then X * Y cannot overflow.
1042     if ((IsSigned && match(X, m_SDiv(m_Value(), m_Specific(Op1)))) ||
1043         (!IsSigned && match(X, m_UDiv(m_Value(), m_Specific(Op1)))))
1044       return X;
1045   }
1046
1047   // (X rem Y) / Y -> 0
1048   if ((IsSigned && match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1049       (!IsSigned && match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1050     return Constant::getNullValue(Op0->getType());
1051
1052   // (X /u C1) /u C2 -> 0 if C1 * C2 overflow
1053   ConstantInt *C1, *C2;
1054   if (!IsSigned && match(Op0, m_UDiv(m_Value(X), m_ConstantInt(C1))) &&
1055       match(Op1, m_ConstantInt(C2))) {
1056     bool Overflow;
1057     (void)C1->getValue().umul_ov(C2->getValue(), Overflow);
1058     if (Overflow)
1059       return Constant::getNullValue(Op0->getType());
1060   }
1061
1062   // If the operation is with the result of a select instruction, check whether
1063   // operating on either branch of the select always yields the same value.
1064   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1065     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1066       return V;
1067
1068   // If the operation is with the result of a phi instruction, check whether
1069   // operating on all incoming values of the phi always yields the same value.
1070   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1071     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1072       return V;
1073
1074   if (isDivZero(Op0, Op1, Q, MaxRecurse, IsSigned))
1075     return Constant::getNullValue(Op0->getType());
1076
1077   return nullptr;
1078 }
1079
1080 /// These are simplifications common to SRem and URem.
1081 static Value *simplifyRem(Instruction::BinaryOps Opcode, Value *Op0, Value *Op1,
1082                           const SimplifyQuery &Q, unsigned MaxRecurse) {
1083   if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1084     return C;
1085
1086   if (Value *V = simplifyDivRem(Op0, Op1, false))
1087     return V;
1088
1089   // (X % Y) % Y -> X % Y
1090   if ((Opcode == Instruction::SRem &&
1091        match(Op0, m_SRem(m_Value(), m_Specific(Op1)))) ||
1092       (Opcode == Instruction::URem &&
1093        match(Op0, m_URem(m_Value(), m_Specific(Op1)))))
1094     return Op0;
1095
1096   // (X << Y) % X -> 0
1097   if ((Opcode == Instruction::SRem &&
1098        match(Op0, m_NSWShl(m_Specific(Op1), m_Value()))) ||
1099       (Opcode == Instruction::URem &&
1100        match(Op0, m_NUWShl(m_Specific(Op1), m_Value()))))
1101     return Constant::getNullValue(Op0->getType());
1102
1103   // If the operation is with the result of a select instruction, check whether
1104   // operating on either branch of the select always yields the same value.
1105   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1106     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1107       return V;
1108
1109   // If the operation is with the result of a phi instruction, check whether
1110   // operating on all incoming values of the phi always yields the same value.
1111   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1112     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1113       return V;
1114
1115   // If X / Y == 0, then X % Y == X.
1116   if (isDivZero(Op0, Op1, Q, MaxRecurse, Opcode == Instruction::SRem))
1117     return Op0;
1118
1119   return nullptr;
1120 }
1121
1122 /// Given operands for an SDiv, see if we can fold the result.
1123 /// If not, this returns null.
1124 static Value *SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1125                                unsigned MaxRecurse) {
1126   // If two operands are negated and no signed overflow, return -1.
1127   if (isKnownNegation(Op0, Op1, /*NeedNSW=*/true))
1128     return Constant::getAllOnesValue(Op0->getType());
1129
1130   return simplifyDiv(Instruction::SDiv, Op0, Op1, Q, MaxRecurse);
1131 }
1132
1133 Value *llvm::SimplifySDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1134   return ::SimplifySDivInst(Op0, Op1, Q, RecursionLimit);
1135 }
1136
1137 /// Given operands for a UDiv, see if we can fold the result.
1138 /// If not, this returns null.
1139 static Value *SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1140                                unsigned MaxRecurse) {
1141   return simplifyDiv(Instruction::UDiv, Op0, Op1, Q, MaxRecurse);
1142 }
1143
1144 Value *llvm::SimplifyUDivInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1145   return ::SimplifyUDivInst(Op0, Op1, Q, RecursionLimit);
1146 }
1147
1148 /// Given operands for an SRem, see if we can fold the result.
1149 /// If not, this returns null.
1150 static Value *SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1151                                unsigned MaxRecurse) {
1152   // If the divisor is 0, the result is undefined, so assume the divisor is -1.
1153   // srem Op0, (sext i1 X) --> srem Op0, -1 --> 0
1154   Value *X;
1155   if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
1156     return ConstantInt::getNullValue(Op0->getType());
1157
1158   // If the two operands are negated, return 0.
1159   if (isKnownNegation(Op0, Op1))
1160     return ConstantInt::getNullValue(Op0->getType());
1161
1162   return simplifyRem(Instruction::SRem, Op0, Op1, Q, MaxRecurse);
1163 }
1164
1165 Value *llvm::SimplifySRemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1166   return ::SimplifySRemInst(Op0, Op1, Q, RecursionLimit);
1167 }
1168
1169 /// Given operands for a URem, see if we can fold the result.
1170 /// If not, this returns null.
1171 static Value *SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1172                                unsigned MaxRecurse) {
1173   return simplifyRem(Instruction::URem, Op0, Op1, Q, MaxRecurse);
1174 }
1175
1176 Value *llvm::SimplifyURemInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1177   return ::SimplifyURemInst(Op0, Op1, Q, RecursionLimit);
1178 }
1179
1180 /// Returns true if a shift by \c Amount always yields undef.
1181 static bool isUndefShift(Value *Amount) {
1182   Constant *C = dyn_cast<Constant>(Amount);
1183   if (!C)
1184     return false;
1185
1186   // X shift by undef -> undef because it may shift by the bitwidth.
1187   if (isa<UndefValue>(C))
1188     return true;
1189
1190   // Shifting by the bitwidth or more is undefined.
1191   if (ConstantInt *CI = dyn_cast<ConstantInt>(C))
1192     if (CI->getValue().getLimitedValue() >=
1193         CI->getType()->getScalarSizeInBits())
1194       return true;
1195
1196   // If all lanes of a vector shift are undefined the whole shift is.
1197   if (isa<ConstantVector>(C) || isa<ConstantDataVector>(C)) {
1198     for (unsigned I = 0, E = C->getType()->getVectorNumElements(); I != E; ++I)
1199       if (!isUndefShift(C->getAggregateElement(I)))
1200         return false;
1201     return true;
1202   }
1203
1204   return false;
1205 }
1206
1207 /// Given operands for an Shl, LShr or AShr, see if we can fold the result.
1208 /// If not, this returns null.
1209 static Value *SimplifyShift(Instruction::BinaryOps Opcode, Value *Op0,
1210                             Value *Op1, const SimplifyQuery &Q, unsigned MaxRecurse) {
1211   if (Constant *C = foldOrCommuteConstant(Opcode, Op0, Op1, Q))
1212     return C;
1213
1214   // 0 shift by X -> 0
1215   if (match(Op0, m_Zero()))
1216     return Constant::getNullValue(Op0->getType());
1217
1218   // X shift by 0 -> X
1219   // Shift-by-sign-extended bool must be shift-by-0 because shift-by-all-ones
1220   // would be poison.
1221   Value *X;
1222   if (match(Op1, m_Zero()) ||
1223       (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1)))
1224     return Op0;
1225
1226   // Fold undefined shifts.
1227   if (isUndefShift(Op1))
1228     return UndefValue::get(Op0->getType());
1229
1230   // If the operation is with the result of a select instruction, check whether
1231   // operating on either branch of the select always yields the same value.
1232   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1233     if (Value *V = ThreadBinOpOverSelect(Opcode, Op0, Op1, Q, MaxRecurse))
1234       return V;
1235
1236   // If the operation is with the result of a phi instruction, check whether
1237   // operating on all incoming values of the phi always yields the same value.
1238   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1239     if (Value *V = ThreadBinOpOverPHI(Opcode, Op0, Op1, Q, MaxRecurse))
1240       return V;
1241
1242   // If any bits in the shift amount make that value greater than or equal to
1243   // the number of bits in the type, the shift is undefined.
1244   KnownBits Known = computeKnownBits(Op1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1245   if (Known.One.getLimitedValue() >= Known.getBitWidth())
1246     return UndefValue::get(Op0->getType());
1247
1248   // If all valid bits in the shift amount are known zero, the first operand is
1249   // unchanged.
1250   unsigned NumValidShiftBits = Log2_32_Ceil(Known.getBitWidth());
1251   if (Known.countMinTrailingZeros() >= NumValidShiftBits)
1252     return Op0;
1253
1254   return nullptr;
1255 }
1256
1257 /// Given operands for an Shl, LShr or AShr, see if we can
1258 /// fold the result.  If not, this returns null.
1259 static Value *SimplifyRightShift(Instruction::BinaryOps Opcode, Value *Op0,
1260                                  Value *Op1, bool isExact, const SimplifyQuery &Q,
1261                                  unsigned MaxRecurse) {
1262   if (Value *V = SimplifyShift(Opcode, Op0, Op1, Q, MaxRecurse))
1263     return V;
1264
1265   // X >> X -> 0
1266   if (Op0 == Op1)
1267     return Constant::getNullValue(Op0->getType());
1268
1269   // undef >> X -> 0
1270   // undef >> X -> undef (if it's exact)
1271   if (match(Op0, m_Undef()))
1272     return isExact ? Op0 : Constant::getNullValue(Op0->getType());
1273
1274   // The low bit cannot be shifted out of an exact shift if it is set.
1275   if (isExact) {
1276     KnownBits Op0Known = computeKnownBits(Op0, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
1277     if (Op0Known.One[0])
1278       return Op0;
1279   }
1280
1281   return nullptr;
1282 }
1283
1284 /// Given operands for an Shl, see if we can fold the result.
1285 /// If not, this returns null.
1286 static Value *SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
1287                               const SimplifyQuery &Q, unsigned MaxRecurse) {
1288   if (Value *V = SimplifyShift(Instruction::Shl, Op0, Op1, Q, MaxRecurse))
1289     return V;
1290
1291   // undef << X -> 0
1292   // undef << X -> undef if (if it's NSW/NUW)
1293   if (match(Op0, m_Undef()))
1294     return isNSW || isNUW ? Op0 : Constant::getNullValue(Op0->getType());
1295
1296   // (X >> A) << A -> X
1297   Value *X;
1298   if (match(Op0, m_Exact(m_Shr(m_Value(X), m_Specific(Op1)))))
1299     return X;
1300
1301   // shl nuw i8 C, %x  ->  C  iff C has sign bit set.
1302   if (isNUW && match(Op0, m_Negative()))
1303     return Op0;
1304   // NOTE: could use computeKnownBits() / LazyValueInfo,
1305   // but the cost-benefit analysis suggests it isn't worth it.
1306
1307   return nullptr;
1308 }
1309
1310 Value *llvm::SimplifyShlInst(Value *Op0, Value *Op1, bool isNSW, bool isNUW,
1311                              const SimplifyQuery &Q) {
1312   return ::SimplifyShlInst(Op0, Op1, isNSW, isNUW, Q, RecursionLimit);
1313 }
1314
1315 /// Given operands for an LShr, see if we can fold the result.
1316 /// If not, this returns null.
1317 static Value *SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
1318                                const SimplifyQuery &Q, unsigned MaxRecurse) {
1319   if (Value *V = SimplifyRightShift(Instruction::LShr, Op0, Op1, isExact, Q,
1320                                     MaxRecurse))
1321       return V;
1322
1323   // (X << A) >> A -> X
1324   Value *X;
1325   if (match(Op0, m_NUWShl(m_Value(X), m_Specific(Op1))))
1326     return X;
1327
1328   return nullptr;
1329 }
1330
1331 Value *llvm::SimplifyLShrInst(Value *Op0, Value *Op1, bool isExact,
1332                               const SimplifyQuery &Q) {
1333   return ::SimplifyLShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1334 }
1335
1336 /// Given operands for an AShr, see if we can fold the result.
1337 /// If not, this returns null.
1338 static Value *SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
1339                                const SimplifyQuery &Q, unsigned MaxRecurse) {
1340   if (Value *V = SimplifyRightShift(Instruction::AShr, Op0, Op1, isExact, Q,
1341                                     MaxRecurse))
1342     return V;
1343
1344   // all ones >>a X -> -1
1345   // Do not return Op0 because it may contain undef elements if it's a vector.
1346   if (match(Op0, m_AllOnes()))
1347     return Constant::getAllOnesValue(Op0->getType());
1348
1349   // (X << A) >> A -> X
1350   Value *X;
1351   if (match(Op0, m_NSWShl(m_Value(X), m_Specific(Op1))))
1352     return X;
1353
1354   // Arithmetic shifting an all-sign-bit value is a no-op.
1355   unsigned NumSignBits = ComputeNumSignBits(Op0, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
1356   if (NumSignBits == Op0->getType()->getScalarSizeInBits())
1357     return Op0;
1358
1359   return nullptr;
1360 }
1361
1362 Value *llvm::SimplifyAShrInst(Value *Op0, Value *Op1, bool isExact,
1363                               const SimplifyQuery &Q) {
1364   return ::SimplifyAShrInst(Op0, Op1, isExact, Q, RecursionLimit);
1365 }
1366
1367 /// Commuted variants are assumed to be handled by calling this function again
1368 /// with the parameters swapped.
1369 static Value *simplifyUnsignedRangeCheck(ICmpInst *ZeroICmp,
1370                                          ICmpInst *UnsignedICmp, bool IsAnd) {
1371   Value *X, *Y;
1372
1373   ICmpInst::Predicate EqPred;
1374   if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(Y), m_Zero())) ||
1375       !ICmpInst::isEquality(EqPred))
1376     return nullptr;
1377
1378   ICmpInst::Predicate UnsignedPred;
1379   if (match(UnsignedICmp, m_ICmp(UnsignedPred, m_Value(X), m_Specific(Y))) &&
1380       ICmpInst::isUnsigned(UnsignedPred))
1381     ;
1382   else if (match(UnsignedICmp,
1383                  m_ICmp(UnsignedPred, m_Specific(Y), m_Value(X))) &&
1384            ICmpInst::isUnsigned(UnsignedPred))
1385     UnsignedPred = ICmpInst::getSwappedPredicate(UnsignedPred);
1386   else
1387     return nullptr;
1388
1389   // X < Y && Y != 0  -->  X < Y
1390   // X < Y || Y != 0  -->  Y != 0
1391   if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE)
1392     return IsAnd ? UnsignedICmp : ZeroICmp;
1393
1394   // X >= Y || Y != 0  -->  true
1395   // X >= Y || Y == 0  -->  X >= Y
1396   if (UnsignedPred == ICmpInst::ICMP_UGE && !IsAnd) {
1397     if (EqPred == ICmpInst::ICMP_NE)
1398       return getTrue(UnsignedICmp->getType());
1399     return UnsignedICmp;
1400   }
1401
1402   // X < Y && Y == 0  -->  false
1403   if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_EQ &&
1404       IsAnd)
1405     return getFalse(UnsignedICmp->getType());
1406
1407   return nullptr;
1408 }
1409
1410 /// Commuted variants are assumed to be handled by calling this function again
1411 /// with the parameters swapped.
1412 static Value *simplifyAndOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1413   ICmpInst::Predicate Pred0, Pred1;
1414   Value *A ,*B;
1415   if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1416       !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1417     return nullptr;
1418
1419   // We have (icmp Pred0, A, B) & (icmp Pred1, A, B).
1420   // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1421   // can eliminate Op1 from this 'and'.
1422   if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1423     return Op0;
1424
1425   // Check for any combination of predicates that are guaranteed to be disjoint.
1426   if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1427       (Pred0 == ICmpInst::ICMP_EQ && ICmpInst::isFalseWhenEqual(Pred1)) ||
1428       (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT) ||
1429       (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT))
1430     return getFalse(Op0->getType());
1431
1432   return nullptr;
1433 }
1434
1435 /// Commuted variants are assumed to be handled by calling this function again
1436 /// with the parameters swapped.
1437 static Value *simplifyOrOfICmpsWithSameOperands(ICmpInst *Op0, ICmpInst *Op1) {
1438   ICmpInst::Predicate Pred0, Pred1;
1439   Value *A ,*B;
1440   if (!match(Op0, m_ICmp(Pred0, m_Value(A), m_Value(B))) ||
1441       !match(Op1, m_ICmp(Pred1, m_Specific(A), m_Specific(B))))
1442     return nullptr;
1443
1444   // We have (icmp Pred0, A, B) | (icmp Pred1, A, B).
1445   // If Op1 is always implied true by Op0, then Op0 is a subset of Op1, and we
1446   // can eliminate Op0 from this 'or'.
1447   if (ICmpInst::isImpliedTrueByMatchingCmp(Pred0, Pred1))
1448     return Op1;
1449
1450   // Check for any combination of predicates that cover the entire range of
1451   // possibilities.
1452   if ((Pred0 == ICmpInst::getInversePredicate(Pred1)) ||
1453       (Pred0 == ICmpInst::ICMP_NE && ICmpInst::isTrueWhenEqual(Pred1)) ||
1454       (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGE) ||
1455       (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGE))
1456     return getTrue(Op0->getType());
1457
1458   return nullptr;
1459 }
1460
1461 /// Test if a pair of compares with a shared operand and 2 constants has an
1462 /// empty set intersection, full set union, or if one compare is a superset of
1463 /// the other.
1464 static Value *simplifyAndOrOfICmpsWithConstants(ICmpInst *Cmp0, ICmpInst *Cmp1,
1465                                                 bool IsAnd) {
1466   // Look for this pattern: {and/or} (icmp X, C0), (icmp X, C1)).
1467   if (Cmp0->getOperand(0) != Cmp1->getOperand(0))
1468     return nullptr;
1469
1470   const APInt *C0, *C1;
1471   if (!match(Cmp0->getOperand(1), m_APInt(C0)) ||
1472       !match(Cmp1->getOperand(1), m_APInt(C1)))
1473     return nullptr;
1474
1475   auto Range0 = ConstantRange::makeExactICmpRegion(Cmp0->getPredicate(), *C0);
1476   auto Range1 = ConstantRange::makeExactICmpRegion(Cmp1->getPredicate(), *C1);
1477
1478   // For and-of-compares, check if the intersection is empty:
1479   // (icmp X, C0) && (icmp X, C1) --> empty set --> false
1480   if (IsAnd && Range0.intersectWith(Range1).isEmptySet())
1481     return getFalse(Cmp0->getType());
1482
1483   // For or-of-compares, check if the union is full:
1484   // (icmp X, C0) || (icmp X, C1) --> full set --> true
1485   if (!IsAnd && Range0.unionWith(Range1).isFullSet())
1486     return getTrue(Cmp0->getType());
1487
1488   // Is one range a superset of the other?
1489   // If this is and-of-compares, take the smaller set:
1490   // (icmp sgt X, 4) && (icmp sgt X, 42) --> icmp sgt X, 42
1491   // If this is or-of-compares, take the larger set:
1492   // (icmp sgt X, 4) || (icmp sgt X, 42) --> icmp sgt X, 4
1493   if (Range0.contains(Range1))
1494     return IsAnd ? Cmp1 : Cmp0;
1495   if (Range1.contains(Range0))
1496     return IsAnd ? Cmp0 : Cmp1;
1497
1498   return nullptr;
1499 }
1500
1501 static Value *simplifyAndOrOfICmpsWithZero(ICmpInst *Cmp0, ICmpInst *Cmp1,
1502                                            bool IsAnd) {
1503   ICmpInst::Predicate P0 = Cmp0->getPredicate(), P1 = Cmp1->getPredicate();
1504   if (!match(Cmp0->getOperand(1), m_Zero()) ||
1505       !match(Cmp1->getOperand(1), m_Zero()) || P0 != P1)
1506     return nullptr;
1507
1508   if ((IsAnd && P0 != ICmpInst::ICMP_NE) || (!IsAnd && P1 != ICmpInst::ICMP_EQ))
1509     return nullptr;
1510
1511   // We have either "(X == 0 || Y == 0)" or "(X != 0 && Y != 0)".
1512   Value *X = Cmp0->getOperand(0);
1513   Value *Y = Cmp1->getOperand(0);
1514
1515   // If one of the compares is a masked version of a (not) null check, then
1516   // that compare implies the other, so we eliminate the other. Optionally, look
1517   // through a pointer-to-int cast to match a null check of a pointer type.
1518
1519   // (X == 0) || (([ptrtoint] X & ?) == 0) --> ([ptrtoint] X & ?) == 0
1520   // (X == 0) || ((? & [ptrtoint] X) == 0) --> (? & [ptrtoint] X) == 0
1521   // (X != 0) && (([ptrtoint] X & ?) != 0) --> ([ptrtoint] X & ?) != 0
1522   // (X != 0) && ((? & [ptrtoint] X) != 0) --> (? & [ptrtoint] X) != 0
1523   if (match(Y, m_c_And(m_Specific(X), m_Value())) ||
1524       match(Y, m_c_And(m_PtrToInt(m_Specific(X)), m_Value())))
1525     return Cmp1;
1526
1527   // (([ptrtoint] Y & ?) == 0) || (Y == 0) --> ([ptrtoint] Y & ?) == 0
1528   // ((? & [ptrtoint] Y) == 0) || (Y == 0) --> (? & [ptrtoint] Y) == 0
1529   // (([ptrtoint] Y & ?) != 0) && (Y != 0) --> ([ptrtoint] Y & ?) != 0
1530   // ((? & [ptrtoint] Y) != 0) && (Y != 0) --> (? & [ptrtoint] Y) != 0
1531   if (match(X, m_c_And(m_Specific(Y), m_Value())) ||
1532       match(X, m_c_And(m_PtrToInt(m_Specific(Y)), m_Value())))
1533     return Cmp0;
1534
1535   return nullptr;
1536 }
1537
1538 static Value *simplifyAndOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1) {
1539   // (icmp (add V, C0), C1) & (icmp V, C0)
1540   ICmpInst::Predicate Pred0, Pred1;
1541   const APInt *C0, *C1;
1542   Value *V;
1543   if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1544     return nullptr;
1545
1546   if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1547     return nullptr;
1548
1549   auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1550   if (AddInst->getOperand(1) != Op1->getOperand(1))
1551     return nullptr;
1552
1553   Type *ITy = Op0->getType();
1554   bool isNSW = AddInst->hasNoSignedWrap();
1555   bool isNUW = AddInst->hasNoUnsignedWrap();
1556
1557   const APInt Delta = *C1 - *C0;
1558   if (C0->isStrictlyPositive()) {
1559     if (Delta == 2) {
1560       if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_SGT)
1561         return getFalse(ITy);
1562       if (Pred0 == ICmpInst::ICMP_SLT && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1563         return getFalse(ITy);
1564     }
1565     if (Delta == 1) {
1566       if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_SGT)
1567         return getFalse(ITy);
1568       if (Pred0 == ICmpInst::ICMP_SLE && Pred1 == ICmpInst::ICMP_SGT && isNSW)
1569         return getFalse(ITy);
1570     }
1571   }
1572   if (C0->getBoolValue() && isNUW) {
1573     if (Delta == 2)
1574       if (Pred0 == ICmpInst::ICMP_ULT && Pred1 == ICmpInst::ICMP_UGT)
1575         return getFalse(ITy);
1576     if (Delta == 1)
1577       if (Pred0 == ICmpInst::ICMP_ULE && Pred1 == ICmpInst::ICMP_UGT)
1578         return getFalse(ITy);
1579   }
1580
1581   return nullptr;
1582 }
1583
1584 static Value *simplifyAndOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1585   if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/true))
1586     return X;
1587   if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/true))
1588     return X;
1589
1590   if (Value *X = simplifyAndOfICmpsWithSameOperands(Op0, Op1))
1591     return X;
1592   if (Value *X = simplifyAndOfICmpsWithSameOperands(Op1, Op0))
1593     return X;
1594
1595   if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, true))
1596     return X;
1597
1598   if (Value *X = simplifyAndOrOfICmpsWithZero(Op0, Op1, true))
1599     return X;
1600
1601   if (Value *X = simplifyAndOfICmpsWithAdd(Op0, Op1))
1602     return X;
1603   if (Value *X = simplifyAndOfICmpsWithAdd(Op1, Op0))
1604     return X;
1605
1606   return nullptr;
1607 }
1608
1609 static Value *simplifyOrOfICmpsWithAdd(ICmpInst *Op0, ICmpInst *Op1) {
1610   // (icmp (add V, C0), C1) | (icmp V, C0)
1611   ICmpInst::Predicate Pred0, Pred1;
1612   const APInt *C0, *C1;
1613   Value *V;
1614   if (!match(Op0, m_ICmp(Pred0, m_Add(m_Value(V), m_APInt(C0)), m_APInt(C1))))
1615     return nullptr;
1616
1617   if (!match(Op1, m_ICmp(Pred1, m_Specific(V), m_Value())))
1618     return nullptr;
1619
1620   auto *AddInst = cast<BinaryOperator>(Op0->getOperand(0));
1621   if (AddInst->getOperand(1) != Op1->getOperand(1))
1622     return nullptr;
1623
1624   Type *ITy = Op0->getType();
1625   bool isNSW = AddInst->hasNoSignedWrap();
1626   bool isNUW = AddInst->hasNoUnsignedWrap();
1627
1628   const APInt Delta = *C1 - *C0;
1629   if (C0->isStrictlyPositive()) {
1630     if (Delta == 2) {
1631       if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_SLE)
1632         return getTrue(ITy);
1633       if (Pred0 == ICmpInst::ICMP_SGE && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1634         return getTrue(ITy);
1635     }
1636     if (Delta == 1) {
1637       if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_SLE)
1638         return getTrue(ITy);
1639       if (Pred0 == ICmpInst::ICMP_SGT && Pred1 == ICmpInst::ICMP_SLE && isNSW)
1640         return getTrue(ITy);
1641     }
1642   }
1643   if (C0->getBoolValue() && isNUW) {
1644     if (Delta == 2)
1645       if (Pred0 == ICmpInst::ICMP_UGE && Pred1 == ICmpInst::ICMP_ULE)
1646         return getTrue(ITy);
1647     if (Delta == 1)
1648       if (Pred0 == ICmpInst::ICMP_UGT && Pred1 == ICmpInst::ICMP_ULE)
1649         return getTrue(ITy);
1650   }
1651
1652   return nullptr;
1653 }
1654
1655 static Value *simplifyOrOfICmps(ICmpInst *Op0, ICmpInst *Op1) {
1656   if (Value *X = simplifyUnsignedRangeCheck(Op0, Op1, /*IsAnd=*/false))
1657     return X;
1658   if (Value *X = simplifyUnsignedRangeCheck(Op1, Op0, /*IsAnd=*/false))
1659     return X;
1660
1661   if (Value *X = simplifyOrOfICmpsWithSameOperands(Op0, Op1))
1662     return X;
1663   if (Value *X = simplifyOrOfICmpsWithSameOperands(Op1, Op0))
1664     return X;
1665
1666   if (Value *X = simplifyAndOrOfICmpsWithConstants(Op0, Op1, false))
1667     return X;
1668
1669   if (Value *X = simplifyAndOrOfICmpsWithZero(Op0, Op1, false))
1670     return X;
1671
1672   if (Value *X = simplifyOrOfICmpsWithAdd(Op0, Op1))
1673     return X;
1674   if (Value *X = simplifyOrOfICmpsWithAdd(Op1, Op0))
1675     return X;
1676
1677   return nullptr;
1678 }
1679
1680 static Value *simplifyAndOrOfFCmps(FCmpInst *LHS, FCmpInst *RHS, bool IsAnd) {
1681   Value *LHS0 = LHS->getOperand(0), *LHS1 = LHS->getOperand(1);
1682   Value *RHS0 = RHS->getOperand(0), *RHS1 = RHS->getOperand(1);
1683   if (LHS0->getType() != RHS0->getType())
1684     return nullptr;
1685
1686   FCmpInst::Predicate PredL = LHS->getPredicate(), PredR = RHS->getPredicate();
1687   if ((PredL == FCmpInst::FCMP_ORD && PredR == FCmpInst::FCMP_ORD && IsAnd) ||
1688       (PredL == FCmpInst::FCMP_UNO && PredR == FCmpInst::FCMP_UNO && !IsAnd)) {
1689     // (fcmp ord NNAN, X) & (fcmp ord X, Y) --> fcmp ord X, Y
1690     // (fcmp ord NNAN, X) & (fcmp ord Y, X) --> fcmp ord Y, X
1691     // (fcmp ord X, NNAN) & (fcmp ord X, Y) --> fcmp ord X, Y
1692     // (fcmp ord X, NNAN) & (fcmp ord Y, X) --> fcmp ord Y, X
1693     // (fcmp uno NNAN, X) | (fcmp uno X, Y) --> fcmp uno X, Y
1694     // (fcmp uno NNAN, X) | (fcmp uno Y, X) --> fcmp uno Y, X
1695     // (fcmp uno X, NNAN) | (fcmp uno X, Y) --> fcmp uno X, Y
1696     // (fcmp uno X, NNAN) | (fcmp uno Y, X) --> fcmp uno Y, X
1697     if ((isKnownNeverNaN(LHS0) && (LHS1 == RHS0 || LHS1 == RHS1)) ||
1698         (isKnownNeverNaN(LHS1) && (LHS0 == RHS0 || LHS0 == RHS1)))
1699       return RHS;
1700
1701     // (fcmp ord X, Y) & (fcmp ord NNAN, X) --> fcmp ord X, Y
1702     // (fcmp ord Y, X) & (fcmp ord NNAN, X) --> fcmp ord Y, X
1703     // (fcmp ord X, Y) & (fcmp ord X, NNAN) --> fcmp ord X, Y
1704     // (fcmp ord Y, X) & (fcmp ord X, NNAN) --> fcmp ord Y, X
1705     // (fcmp uno X, Y) | (fcmp uno NNAN, X) --> fcmp uno X, Y
1706     // (fcmp uno Y, X) | (fcmp uno NNAN, X) --> fcmp uno Y, X
1707     // (fcmp uno X, Y) | (fcmp uno X, NNAN) --> fcmp uno X, Y
1708     // (fcmp uno Y, X) | (fcmp uno X, NNAN) --> fcmp uno Y, X
1709     if ((isKnownNeverNaN(RHS0) && (RHS1 == LHS0 || RHS1 == LHS1)) ||
1710         (isKnownNeverNaN(RHS1) && (RHS0 == LHS0 || RHS0 == LHS1)))
1711       return LHS;
1712   }
1713
1714   return nullptr;
1715 }
1716
1717 static Value *simplifyAndOrOfCmps(Value *Op0, Value *Op1, bool IsAnd) {
1718   // Look through casts of the 'and' operands to find compares.
1719   auto *Cast0 = dyn_cast<CastInst>(Op0);
1720   auto *Cast1 = dyn_cast<CastInst>(Op1);
1721   if (Cast0 && Cast1 && Cast0->getOpcode() == Cast1->getOpcode() &&
1722       Cast0->getSrcTy() == Cast1->getSrcTy()) {
1723     Op0 = Cast0->getOperand(0);
1724     Op1 = Cast1->getOperand(0);
1725   }
1726
1727   Value *V = nullptr;
1728   auto *ICmp0 = dyn_cast<ICmpInst>(Op0);
1729   auto *ICmp1 = dyn_cast<ICmpInst>(Op1);
1730   if (ICmp0 && ICmp1)
1731     V = IsAnd ? simplifyAndOfICmps(ICmp0, ICmp1) :
1732                 simplifyOrOfICmps(ICmp0, ICmp1);
1733
1734   auto *FCmp0 = dyn_cast<FCmpInst>(Op0);
1735   auto *FCmp1 = dyn_cast<FCmpInst>(Op1);
1736   if (FCmp0 && FCmp1)
1737     V = simplifyAndOrOfFCmps(FCmp0, FCmp1, IsAnd);
1738
1739   if (!V)
1740     return nullptr;
1741   if (!Cast0)
1742     return V;
1743
1744   // If we looked through casts, we can only handle a constant simplification
1745   // because we are not allowed to create a cast instruction here.
1746   if (auto *C = dyn_cast<Constant>(V))
1747     return ConstantExpr::getCast(Cast0->getOpcode(), C, Cast0->getType());
1748
1749   return nullptr;
1750 }
1751
1752 /// Given operands for an And, see if we can fold the result.
1753 /// If not, this returns null.
1754 static Value *SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1755                               unsigned MaxRecurse) {
1756   if (Constant *C = foldOrCommuteConstant(Instruction::And, Op0, Op1, Q))
1757     return C;
1758
1759   // X & undef -> 0
1760   if (match(Op1, m_Undef()))
1761     return Constant::getNullValue(Op0->getType());
1762
1763   // X & X = X
1764   if (Op0 == Op1)
1765     return Op0;
1766
1767   // X & 0 = 0
1768   if (match(Op1, m_Zero()))
1769     return Constant::getNullValue(Op0->getType());
1770
1771   // X & -1 = X
1772   if (match(Op1, m_AllOnes()))
1773     return Op0;
1774
1775   // A & ~A  =  ~A & A  =  0
1776   if (match(Op0, m_Not(m_Specific(Op1))) ||
1777       match(Op1, m_Not(m_Specific(Op0))))
1778     return Constant::getNullValue(Op0->getType());
1779
1780   // (A | ?) & A = A
1781   if (match(Op0, m_c_Or(m_Specific(Op1), m_Value())))
1782     return Op1;
1783
1784   // A & (A | ?) = A
1785   if (match(Op1, m_c_Or(m_Specific(Op0), m_Value())))
1786     return Op0;
1787
1788   // A mask that only clears known zeros of a shifted value is a no-op.
1789   Value *X;
1790   const APInt *Mask;
1791   const APInt *ShAmt;
1792   if (match(Op1, m_APInt(Mask))) {
1793     // If all bits in the inverted and shifted mask are clear:
1794     // and (shl X, ShAmt), Mask --> shl X, ShAmt
1795     if (match(Op0, m_Shl(m_Value(X), m_APInt(ShAmt))) &&
1796         (~(*Mask)).lshr(*ShAmt).isNullValue())
1797       return Op0;
1798
1799     // If all bits in the inverted and shifted mask are clear:
1800     // and (lshr X, ShAmt), Mask --> lshr X, ShAmt
1801     if (match(Op0, m_LShr(m_Value(X), m_APInt(ShAmt))) &&
1802         (~(*Mask)).shl(*ShAmt).isNullValue())
1803       return Op0;
1804   }
1805
1806   // A & (-A) = A if A is a power of two or zero.
1807   if (match(Op0, m_Neg(m_Specific(Op1))) ||
1808       match(Op1, m_Neg(m_Specific(Op0)))) {
1809     if (isKnownToBeAPowerOfTwo(Op0, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1810                                Q.DT))
1811       return Op0;
1812     if (isKnownToBeAPowerOfTwo(Op1, Q.DL, /*OrZero*/ true, 0, Q.AC, Q.CxtI,
1813                                Q.DT))
1814       return Op1;
1815   }
1816
1817   if (Value *V = simplifyAndOrOfCmps(Op0, Op1, true))
1818     return V;
1819
1820   // Try some generic simplifications for associative operations.
1821   if (Value *V = SimplifyAssociativeBinOp(Instruction::And, Op0, Op1, Q,
1822                                           MaxRecurse))
1823     return V;
1824
1825   // And distributes over Or.  Try some generic simplifications based on this.
1826   if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Or,
1827                              Q, MaxRecurse))
1828     return V;
1829
1830   // And distributes over Xor.  Try some generic simplifications based on this.
1831   if (Value *V = ExpandBinOp(Instruction::And, Op0, Op1, Instruction::Xor,
1832                              Q, MaxRecurse))
1833     return V;
1834
1835   // If the operation is with the result of a select instruction, check whether
1836   // operating on either branch of the select always yields the same value.
1837   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1838     if (Value *V = ThreadBinOpOverSelect(Instruction::And, Op0, Op1, Q,
1839                                          MaxRecurse))
1840       return V;
1841
1842   // If the operation is with the result of a phi instruction, check whether
1843   // operating on all incoming values of the phi always yields the same value.
1844   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1845     if (Value *V = ThreadBinOpOverPHI(Instruction::And, Op0, Op1, Q,
1846                                       MaxRecurse))
1847       return V;
1848
1849   return nullptr;
1850 }
1851
1852 Value *llvm::SimplifyAndInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1853   return ::SimplifyAndInst(Op0, Op1, Q, RecursionLimit);
1854 }
1855
1856 /// Given operands for an Or, see if we can fold the result.
1857 /// If not, this returns null.
1858 static Value *SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1859                              unsigned MaxRecurse) {
1860   if (Constant *C = foldOrCommuteConstant(Instruction::Or, Op0, Op1, Q))
1861     return C;
1862
1863   // X | undef -> -1
1864   // X | -1 = -1
1865   // Do not return Op1 because it may contain undef elements if it's a vector.
1866   if (match(Op1, m_Undef()) || match(Op1, m_AllOnes()))
1867     return Constant::getAllOnesValue(Op0->getType());
1868
1869   // X | X = X
1870   // X | 0 = X
1871   if (Op0 == Op1 || match(Op1, m_Zero()))
1872     return Op0;
1873
1874   // A | ~A  =  ~A | A  =  -1
1875   if (match(Op0, m_Not(m_Specific(Op1))) ||
1876       match(Op1, m_Not(m_Specific(Op0))))
1877     return Constant::getAllOnesValue(Op0->getType());
1878
1879   // (A & ?) | A = A
1880   if (match(Op0, m_c_And(m_Specific(Op1), m_Value())))
1881     return Op1;
1882
1883   // A | (A & ?) = A
1884   if (match(Op1, m_c_And(m_Specific(Op0), m_Value())))
1885     return Op0;
1886
1887   // ~(A & ?) | A = -1
1888   if (match(Op0, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
1889     return Constant::getAllOnesValue(Op1->getType());
1890
1891   // A | ~(A & ?) = -1
1892   if (match(Op1, m_Not(m_c_And(m_Specific(Op1), m_Value()))))
1893     return Constant::getAllOnesValue(Op0->getType());
1894
1895   Value *A, *B;
1896   // (A & ~B) | (A ^ B) -> (A ^ B)
1897   // (~B & A) | (A ^ B) -> (A ^ B)
1898   // (A & ~B) | (B ^ A) -> (B ^ A)
1899   // (~B & A) | (B ^ A) -> (B ^ A)
1900   if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
1901       (match(Op0, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1902        match(Op0, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
1903     return Op1;
1904
1905   // Commute the 'or' operands.
1906   // (A ^ B) | (A & ~B) -> (A ^ B)
1907   // (A ^ B) | (~B & A) -> (A ^ B)
1908   // (B ^ A) | (A & ~B) -> (B ^ A)
1909   // (B ^ A) | (~B & A) -> (B ^ A)
1910   if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
1911       (match(Op1, m_c_And(m_Specific(A), m_Not(m_Specific(B)))) ||
1912        match(Op1, m_c_And(m_Not(m_Specific(A)), m_Specific(B)))))
1913     return Op0;
1914
1915   // (A & B) | (~A ^ B) -> (~A ^ B)
1916   // (B & A) | (~A ^ B) -> (~A ^ B)
1917   // (A & B) | (B ^ ~A) -> (B ^ ~A)
1918   // (B & A) | (B ^ ~A) -> (B ^ ~A)
1919   if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1920       (match(Op1, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1921        match(Op1, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1922     return Op1;
1923
1924   // (~A ^ B) | (A & B) -> (~A ^ B)
1925   // (~A ^ B) | (B & A) -> (~A ^ B)
1926   // (B ^ ~A) | (A & B) -> (B ^ ~A)
1927   // (B ^ ~A) | (B & A) -> (B ^ ~A)
1928   if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
1929       (match(Op0, m_c_Xor(m_Specific(A), m_Not(m_Specific(B)))) ||
1930        match(Op0, m_c_Xor(m_Not(m_Specific(A)), m_Specific(B)))))
1931     return Op0;
1932
1933   if (Value *V = simplifyAndOrOfCmps(Op0, Op1, false))
1934     return V;
1935
1936   // Try some generic simplifications for associative operations.
1937   if (Value *V = SimplifyAssociativeBinOp(Instruction::Or, Op0, Op1, Q,
1938                                           MaxRecurse))
1939     return V;
1940
1941   // Or distributes over And.  Try some generic simplifications based on this.
1942   if (Value *V = ExpandBinOp(Instruction::Or, Op0, Op1, Instruction::And, Q,
1943                              MaxRecurse))
1944     return V;
1945
1946   // If the operation is with the result of a select instruction, check whether
1947   // operating on either branch of the select always yields the same value.
1948   if (isa<SelectInst>(Op0) || isa<SelectInst>(Op1))
1949     if (Value *V = ThreadBinOpOverSelect(Instruction::Or, Op0, Op1, Q,
1950                                          MaxRecurse))
1951       return V;
1952
1953   // (A & C1)|(B & C2)
1954   const APInt *C1, *C2;
1955   if (match(Op0, m_And(m_Value(A), m_APInt(C1))) &&
1956       match(Op1, m_And(m_Value(B), m_APInt(C2)))) {
1957     if (*C1 == ~*C2) {
1958       // (A & C1)|(B & C2)
1959       // If we have: ((V + N) & C1) | (V & C2)
1960       // .. and C2 = ~C1 and C2 is 0+1+ and (N & C2) == 0
1961       // replace with V+N.
1962       Value *N;
1963       if (C2->isMask() && // C2 == 0+1+
1964           match(A, m_c_Add(m_Specific(B), m_Value(N)))) {
1965         // Add commutes, try both ways.
1966         if (MaskedValueIsZero(N, *C2, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
1967           return A;
1968       }
1969       // Or commutes, try both ways.
1970       if (C1->isMask() &&
1971           match(B, m_c_Add(m_Specific(A), m_Value(N)))) {
1972         // Add commutes, try both ways.
1973         if (MaskedValueIsZero(N, *C1, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
1974           return B;
1975       }
1976     }
1977   }
1978
1979   // If the operation is with the result of a phi instruction, check whether
1980   // operating on all incoming values of the phi always yields the same value.
1981   if (isa<PHINode>(Op0) || isa<PHINode>(Op1))
1982     if (Value *V = ThreadBinOpOverPHI(Instruction::Or, Op0, Op1, Q, MaxRecurse))
1983       return V;
1984
1985   return nullptr;
1986 }
1987
1988 Value *llvm::SimplifyOrInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
1989   return ::SimplifyOrInst(Op0, Op1, Q, RecursionLimit);
1990 }
1991
1992 /// Given operands for a Xor, see if we can fold the result.
1993 /// If not, this returns null.
1994 static Value *SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q,
1995                               unsigned MaxRecurse) {
1996   if (Constant *C = foldOrCommuteConstant(Instruction::Xor, Op0, Op1, Q))
1997     return C;
1998
1999   // A ^ undef -> undef
2000   if (match(Op1, m_Undef()))
2001     return Op1;
2002
2003   // A ^ 0 = A
2004   if (match(Op1, m_Zero()))
2005     return Op0;
2006
2007   // A ^ A = 0
2008   if (Op0 == Op1)
2009     return Constant::getNullValue(Op0->getType());
2010
2011   // A ^ ~A  =  ~A ^ A  =  -1
2012   if (match(Op0, m_Not(m_Specific(Op1))) ||
2013       match(Op1, m_Not(m_Specific(Op0))))
2014     return Constant::getAllOnesValue(Op0->getType());
2015
2016   // Try some generic simplifications for associative operations.
2017   if (Value *V = SimplifyAssociativeBinOp(Instruction::Xor, Op0, Op1, Q,
2018                                           MaxRecurse))
2019     return V;
2020
2021   // Threading Xor over selects and phi nodes is pointless, so don't bother.
2022   // Threading over the select in "A ^ select(cond, B, C)" means evaluating
2023   // "A^B" and "A^C" and seeing if they are equal; but they are equal if and
2024   // only if B and C are equal.  If B and C are equal then (since we assume
2025   // that operands have already been simplified) "select(cond, B, C)" should
2026   // have been simplified to the common value of B and C already.  Analysing
2027   // "A^B" and "A^C" thus gains nothing, but costs compile time.  Similarly
2028   // for threading over phi nodes.
2029
2030   return nullptr;
2031 }
2032
2033 Value *llvm::SimplifyXorInst(Value *Op0, Value *Op1, const SimplifyQuery &Q) {
2034   return ::SimplifyXorInst(Op0, Op1, Q, RecursionLimit);
2035 }
2036
2037
2038 static Type *GetCompareTy(Value *Op) {
2039   return CmpInst::makeCmpResultType(Op->getType());
2040 }
2041
2042 /// Rummage around inside V looking for something equivalent to the comparison
2043 /// "LHS Pred RHS". Return such a value if found, otherwise return null.
2044 /// Helper function for analyzing max/min idioms.
2045 static Value *ExtractEquivalentCondition(Value *V, CmpInst::Predicate Pred,
2046                                          Value *LHS, Value *RHS) {
2047   SelectInst *SI = dyn_cast<SelectInst>(V);
2048   if (!SI)
2049     return nullptr;
2050   CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
2051   if (!Cmp)
2052     return nullptr;
2053   Value *CmpLHS = Cmp->getOperand(0), *CmpRHS = Cmp->getOperand(1);
2054   if (Pred == Cmp->getPredicate() && LHS == CmpLHS && RHS == CmpRHS)
2055     return Cmp;
2056   if (Pred == CmpInst::getSwappedPredicate(Cmp->getPredicate()) &&
2057       LHS == CmpRHS && RHS == CmpLHS)
2058     return Cmp;
2059   return nullptr;
2060 }
2061
2062 // A significant optimization not implemented here is assuming that alloca
2063 // addresses are not equal to incoming argument values. They don't *alias*,
2064 // as we say, but that doesn't mean they aren't equal, so we take a
2065 // conservative approach.
2066 //
2067 // This is inspired in part by C++11 5.10p1:
2068 //   "Two pointers of the same type compare equal if and only if they are both
2069 //    null, both point to the same function, or both represent the same
2070 //    address."
2071 //
2072 // This is pretty permissive.
2073 //
2074 // It's also partly due to C11 6.5.9p6:
2075 //   "Two pointers compare equal if and only if both are null pointers, both are
2076 //    pointers to the same object (including a pointer to an object and a
2077 //    subobject at its beginning) or function, both are pointers to one past the
2078 //    last element of the same array object, or one is a pointer to one past the
2079 //    end of one array object and the other is a pointer to the start of a
2080 //    different array object that happens to immediately follow the first array
2081 //    object in the address space.)
2082 //
2083 // C11's version is more restrictive, however there's no reason why an argument
2084 // couldn't be a one-past-the-end value for a stack object in the caller and be
2085 // equal to the beginning of a stack object in the callee.
2086 //
2087 // If the C and C++ standards are ever made sufficiently restrictive in this
2088 // area, it may be possible to update LLVM's semantics accordingly and reinstate
2089 // this optimization.
2090 static Constant *
2091 computePointerICmp(const DataLayout &DL, const TargetLibraryInfo *TLI,
2092                    const DominatorTree *DT, CmpInst::Predicate Pred,
2093                    AssumptionCache *AC, const Instruction *CxtI,
2094                    Value *LHS, Value *RHS) {
2095   // First, skip past any trivial no-ops.
2096   LHS = LHS->stripPointerCasts();
2097   RHS = RHS->stripPointerCasts();
2098
2099   // A non-null pointer is not equal to a null pointer.
2100   if (llvm::isKnownNonZero(LHS, DL) && isa<ConstantPointerNull>(RHS) &&
2101       (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE))
2102     return ConstantInt::get(GetCompareTy(LHS),
2103                             !CmpInst::isTrueWhenEqual(Pred));
2104
2105   // We can only fold certain predicates on pointer comparisons.
2106   switch (Pred) {
2107   default:
2108     return nullptr;
2109
2110     // Equality comaprisons are easy to fold.
2111   case CmpInst::ICMP_EQ:
2112   case CmpInst::ICMP_NE:
2113     break;
2114
2115     // We can only handle unsigned relational comparisons because 'inbounds' on
2116     // a GEP only protects against unsigned wrapping.
2117   case CmpInst::ICMP_UGT:
2118   case CmpInst::ICMP_UGE:
2119   case CmpInst::ICMP_ULT:
2120   case CmpInst::ICMP_ULE:
2121     // However, we have to switch them to their signed variants to handle
2122     // negative indices from the base pointer.
2123     Pred = ICmpInst::getSignedPredicate(Pred);
2124     break;
2125   }
2126
2127   // Strip off any constant offsets so that we can reason about them.
2128   // It's tempting to use getUnderlyingObject or even just stripInBoundsOffsets
2129   // here and compare base addresses like AliasAnalysis does, however there are
2130   // numerous hazards. AliasAnalysis and its utilities rely on special rules
2131   // governing loads and stores which don't apply to icmps. Also, AliasAnalysis
2132   // doesn't need to guarantee pointer inequality when it says NoAlias.
2133   Constant *LHSOffset = stripAndComputeConstantOffsets(DL, LHS);
2134   Constant *RHSOffset = stripAndComputeConstantOffsets(DL, RHS);
2135
2136   // If LHS and RHS are related via constant offsets to the same base
2137   // value, we can replace it with an icmp which just compares the offsets.
2138   if (LHS == RHS)
2139     return ConstantExpr::getICmp(Pred, LHSOffset, RHSOffset);
2140
2141   // Various optimizations for (in)equality comparisons.
2142   if (Pred == CmpInst::ICMP_EQ || Pred == CmpInst::ICMP_NE) {
2143     // Different non-empty allocations that exist at the same time have
2144     // different addresses (if the program can tell). Global variables always
2145     // exist, so they always exist during the lifetime of each other and all
2146     // allocas. Two different allocas usually have different addresses...
2147     //
2148     // However, if there's an @llvm.stackrestore dynamically in between two
2149     // allocas, they may have the same address. It's tempting to reduce the
2150     // scope of the problem by only looking at *static* allocas here. That would
2151     // cover the majority of allocas while significantly reducing the likelihood
2152     // of having an @llvm.stackrestore pop up in the middle. However, it's not
2153     // actually impossible for an @llvm.stackrestore to pop up in the middle of
2154     // an entry block. Also, if we have a block that's not attached to a
2155     // function, we can't tell if it's "static" under the current definition.
2156     // Theoretically, this problem could be fixed by creating a new kind of
2157     // instruction kind specifically for static allocas. Such a new instruction
2158     // could be required to be at the top of the entry block, thus preventing it
2159     // from being subject to a @llvm.stackrestore. Instcombine could even
2160     // convert regular allocas into these special allocas. It'd be nifty.
2161     // However, until then, this problem remains open.
2162     //
2163     // So, we'll assume that two non-empty allocas have different addresses
2164     // for now.
2165     //
2166     // With all that, if the offsets are within the bounds of their allocations
2167     // (and not one-past-the-end! so we can't use inbounds!), and their
2168     // allocations aren't the same, the pointers are not equal.
2169     //
2170     // Note that it's not necessary to check for LHS being a global variable
2171     // address, due to canonicalization and constant folding.
2172     if (isa<AllocaInst>(LHS) &&
2173         (isa<AllocaInst>(RHS) || isa<GlobalVariable>(RHS))) {
2174       ConstantInt *LHSOffsetCI = dyn_cast<ConstantInt>(LHSOffset);
2175       ConstantInt *RHSOffsetCI = dyn_cast<ConstantInt>(RHSOffset);
2176       uint64_t LHSSize, RHSSize;
2177       ObjectSizeOpts Opts;
2178       Opts.NullIsUnknownSize =
2179           NullPointerIsDefined(cast<AllocaInst>(LHS)->getFunction());
2180       if (LHSOffsetCI && RHSOffsetCI &&
2181           getObjectSize(LHS, LHSSize, DL, TLI, Opts) &&
2182           getObjectSize(RHS, RHSSize, DL, TLI, Opts)) {
2183         const APInt &LHSOffsetValue = LHSOffsetCI->getValue();
2184         const APInt &RHSOffsetValue = RHSOffsetCI->getValue();
2185         if (!LHSOffsetValue.isNegative() &&
2186             !RHSOffsetValue.isNegative() &&
2187             LHSOffsetValue.ult(LHSSize) &&
2188             RHSOffsetValue.ult(RHSSize)) {
2189           return ConstantInt::get(GetCompareTy(LHS),
2190                                   !CmpInst::isTrueWhenEqual(Pred));
2191         }
2192       }
2193
2194       // Repeat the above check but this time without depending on DataLayout
2195       // or being able to compute a precise size.
2196       if (!cast<PointerType>(LHS->getType())->isEmptyTy() &&
2197           !cast<PointerType>(RHS->getType())->isEmptyTy() &&
2198           LHSOffset->isNullValue() &&
2199           RHSOffset->isNullValue())
2200         return ConstantInt::get(GetCompareTy(LHS),
2201                                 !CmpInst::isTrueWhenEqual(Pred));
2202     }
2203
2204     // Even if an non-inbounds GEP occurs along the path we can still optimize
2205     // equality comparisons concerning the result. We avoid walking the whole
2206     // chain again by starting where the last calls to
2207     // stripAndComputeConstantOffsets left off and accumulate the offsets.
2208     Constant *LHSNoBound = stripAndComputeConstantOffsets(DL, LHS, true);
2209     Constant *RHSNoBound = stripAndComputeConstantOffsets(DL, RHS, true);
2210     if (LHS == RHS)
2211       return ConstantExpr::getICmp(Pred,
2212                                    ConstantExpr::getAdd(LHSOffset, LHSNoBound),
2213                                    ConstantExpr::getAdd(RHSOffset, RHSNoBound));
2214
2215     // If one side of the equality comparison must come from a noalias call
2216     // (meaning a system memory allocation function), and the other side must
2217     // come from a pointer that cannot overlap with dynamically-allocated
2218     // memory within the lifetime of the current function (allocas, byval
2219     // arguments, globals), then determine the comparison result here.
2220     SmallVector<Value *, 8> LHSUObjs, RHSUObjs;
2221     GetUnderlyingObjects(LHS, LHSUObjs, DL);
2222     GetUnderlyingObjects(RHS, RHSUObjs, DL);
2223
2224     // Is the set of underlying objects all noalias calls?
2225     auto IsNAC = [](ArrayRef<Value *> Objects) {
2226       return all_of(Objects, isNoAliasCall);
2227     };
2228
2229     // Is the set of underlying objects all things which must be disjoint from
2230     // noalias calls. For allocas, we consider only static ones (dynamic
2231     // allocas might be transformed into calls to malloc not simultaneously
2232     // live with the compared-to allocation). For globals, we exclude symbols
2233     // that might be resolve lazily to symbols in another dynamically-loaded
2234     // library (and, thus, could be malloc'ed by the implementation).
2235     auto IsAllocDisjoint = [](ArrayRef<Value *> Objects) {
2236       return all_of(Objects, [](Value *V) {
2237         if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
2238           return AI->getParent() && AI->getFunction() && AI->isStaticAlloca();
2239         if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
2240           return (GV->hasLocalLinkage() || GV->hasHiddenVisibility() ||
2241                   GV->hasProtectedVisibility() || GV->hasGlobalUnnamedAddr()) &&
2242                  !GV->isThreadLocal();
2243         if (const Argument *A = dyn_cast<Argument>(V))
2244           return A->hasByValAttr();
2245         return false;
2246       });
2247     };
2248
2249     if ((IsNAC(LHSUObjs) && IsAllocDisjoint(RHSUObjs)) ||
2250         (IsNAC(RHSUObjs) && IsAllocDisjoint(LHSUObjs)))
2251         return ConstantInt::get(GetCompareTy(LHS),
2252                                 !CmpInst::isTrueWhenEqual(Pred));
2253
2254     // Fold comparisons for non-escaping pointer even if the allocation call
2255     // cannot be elided. We cannot fold malloc comparison to null. Also, the
2256     // dynamic allocation call could be either of the operands.
2257     Value *MI = nullptr;
2258     if (isAllocLikeFn(LHS, TLI) &&
2259         llvm::isKnownNonZero(RHS, DL, 0, nullptr, CxtI, DT))
2260       MI = LHS;
2261     else if (isAllocLikeFn(RHS, TLI) &&
2262              llvm::isKnownNonZero(LHS, DL, 0, nullptr, CxtI, DT))
2263       MI = RHS;
2264     // FIXME: We should also fold the compare when the pointer escapes, but the
2265     // compare dominates the pointer escape
2266     if (MI && !PointerMayBeCaptured(MI, true, true))
2267       return ConstantInt::get(GetCompareTy(LHS),
2268                               CmpInst::isFalseWhenEqual(Pred));
2269   }
2270
2271   // Otherwise, fail.
2272   return nullptr;
2273 }
2274
2275 /// Fold an icmp when its operands have i1 scalar type.
2276 static Value *simplifyICmpOfBools(CmpInst::Predicate Pred, Value *LHS,
2277                                   Value *RHS, const SimplifyQuery &Q) {
2278   Type *ITy = GetCompareTy(LHS); // The return type.
2279   Type *OpTy = LHS->getType();   // The operand type.
2280   if (!OpTy->isIntOrIntVectorTy(1))
2281     return nullptr;
2282
2283   // A boolean compared to true/false can be simplified in 14 out of the 20
2284   // (10 predicates * 2 constants) possible combinations. Cases not handled here
2285   // require a 'not' of the LHS, so those must be transformed in InstCombine.
2286   if (match(RHS, m_Zero())) {
2287     switch (Pred) {
2288     case CmpInst::ICMP_NE:  // X !=  0 -> X
2289     case CmpInst::ICMP_UGT: // X >u  0 -> X
2290     case CmpInst::ICMP_SLT: // X <s  0 -> X
2291       return LHS;
2292
2293     case CmpInst::ICMP_ULT: // X <u  0 -> false
2294     case CmpInst::ICMP_SGT: // X >s  0 -> false
2295       return getFalse(ITy);
2296
2297     case CmpInst::ICMP_UGE: // X >=u 0 -> true
2298     case CmpInst::ICMP_SLE: // X <=s 0 -> true
2299       return getTrue(ITy);
2300
2301     default: break;
2302     }
2303   } else if (match(RHS, m_One())) {
2304     switch (Pred) {
2305     case CmpInst::ICMP_EQ:  // X ==   1 -> X
2306     case CmpInst::ICMP_UGE: // X >=u  1 -> X
2307     case CmpInst::ICMP_SLE: // X <=s -1 -> X
2308       return LHS;
2309
2310     case CmpInst::ICMP_UGT: // X >u   1 -> false
2311     case CmpInst::ICMP_SLT: // X <s  -1 -> false
2312       return getFalse(ITy);
2313
2314     case CmpInst::ICMP_ULE: // X <=u  1 -> true
2315     case CmpInst::ICMP_SGE: // X >=s -1 -> true
2316       return getTrue(ITy);
2317
2318     default: break;
2319     }
2320   }
2321
2322   switch (Pred) {
2323   default:
2324     break;
2325   case ICmpInst::ICMP_UGE:
2326     if (isImpliedCondition(RHS, LHS, Q.DL).getValueOr(false))
2327       return getTrue(ITy);
2328     break;
2329   case ICmpInst::ICMP_SGE:
2330     /// For signed comparison, the values for an i1 are 0 and -1
2331     /// respectively. This maps into a truth table of:
2332     /// LHS | RHS | LHS >=s RHS   | LHS implies RHS
2333     ///  0  |  0  |  1 (0 >= 0)   |  1
2334     ///  0  |  1  |  1 (0 >= -1)  |  1
2335     ///  1  |  0  |  0 (-1 >= 0)  |  0
2336     ///  1  |  1  |  1 (-1 >= -1) |  1
2337     if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2338       return getTrue(ITy);
2339     break;
2340   case ICmpInst::ICMP_ULE:
2341     if (isImpliedCondition(LHS, RHS, Q.DL).getValueOr(false))
2342       return getTrue(ITy);
2343     break;
2344   }
2345
2346   return nullptr;
2347 }
2348
2349 /// Try hard to fold icmp with zero RHS because this is a common case.
2350 static Value *simplifyICmpWithZero(CmpInst::Predicate Pred, Value *LHS,
2351                                    Value *RHS, const SimplifyQuery &Q) {
2352   if (!match(RHS, m_Zero()))
2353     return nullptr;
2354
2355   Type *ITy = GetCompareTy(LHS); // The return type.
2356   switch (Pred) {
2357   default:
2358     llvm_unreachable("Unknown ICmp predicate!");
2359   case ICmpInst::ICMP_ULT:
2360     return getFalse(ITy);
2361   case ICmpInst::ICMP_UGE:
2362     return getTrue(ITy);
2363   case ICmpInst::ICMP_EQ:
2364   case ICmpInst::ICMP_ULE:
2365     if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
2366       return getFalse(ITy);
2367     break;
2368   case ICmpInst::ICMP_NE:
2369   case ICmpInst::ICMP_UGT:
2370     if (isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
2371       return getTrue(ITy);
2372     break;
2373   case ICmpInst::ICMP_SLT: {
2374     KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2375     if (LHSKnown.isNegative())
2376       return getTrue(ITy);
2377     if (LHSKnown.isNonNegative())
2378       return getFalse(ITy);
2379     break;
2380   }
2381   case ICmpInst::ICMP_SLE: {
2382     KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2383     if (LHSKnown.isNegative())
2384       return getTrue(ITy);
2385     if (LHSKnown.isNonNegative() &&
2386         isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
2387       return getFalse(ITy);
2388     break;
2389   }
2390   case ICmpInst::ICMP_SGE: {
2391     KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2392     if (LHSKnown.isNegative())
2393       return getFalse(ITy);
2394     if (LHSKnown.isNonNegative())
2395       return getTrue(ITy);
2396     break;
2397   }
2398   case ICmpInst::ICMP_SGT: {
2399     KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2400     if (LHSKnown.isNegative())
2401       return getFalse(ITy);
2402     if (LHSKnown.isNonNegative() &&
2403         isKnownNonZero(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT))
2404       return getTrue(ITy);
2405     break;
2406   }
2407   }
2408
2409   return nullptr;
2410 }
2411
2412 /// Many binary operators with a constant operand have an easy-to-compute
2413 /// range of outputs. This can be used to fold a comparison to always true or
2414 /// always false.
2415 static void setLimitsForBinOp(BinaryOperator &BO, APInt &Lower, APInt &Upper) {
2416   unsigned Width = Lower.getBitWidth();
2417   const APInt *C;
2418   switch (BO.getOpcode()) {
2419   case Instruction::Add:
2420     if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
2421       // FIXME: If we have both nuw and nsw, we should reduce the range further.
2422       if (BO.hasNoUnsignedWrap()) {
2423         // 'add nuw x, C' produces [C, UINT_MAX].
2424         Lower = *C;
2425       } else if (BO.hasNoSignedWrap()) {
2426         if (C->isNegative()) {
2427           // 'add nsw x, -C' produces [SINT_MIN, SINT_MAX - C].
2428           Lower = APInt::getSignedMinValue(Width);
2429           Upper = APInt::getSignedMaxValue(Width) + *C + 1;
2430         } else {
2431           // 'add nsw x, +C' produces [SINT_MIN + C, SINT_MAX].
2432           Lower = APInt::getSignedMinValue(Width) + *C;
2433           Upper = APInt::getSignedMaxValue(Width) + 1;
2434         }
2435       }
2436     }
2437     break;
2438
2439   case Instruction::And:
2440     if (match(BO.getOperand(1), m_APInt(C)))
2441       // 'and x, C' produces [0, C].
2442       Upper = *C + 1;
2443     break;
2444
2445   case Instruction::Or:
2446     if (match(BO.getOperand(1), m_APInt(C)))
2447       // 'or x, C' produces [C, UINT_MAX].
2448       Lower = *C;
2449     break;
2450
2451   case Instruction::AShr:
2452     if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2453       // 'ashr x, C' produces [INT_MIN >> C, INT_MAX >> C].
2454       Lower = APInt::getSignedMinValue(Width).ashr(*C);
2455       Upper = APInt::getSignedMaxValue(Width).ashr(*C) + 1;
2456     } else if (match(BO.getOperand(0), m_APInt(C))) {
2457       unsigned ShiftAmount = Width - 1;
2458       if (!C->isNullValue() && BO.isExact())
2459         ShiftAmount = C->countTrailingZeros();
2460       if (C->isNegative()) {
2461         // 'ashr C, x' produces [C, C >> (Width-1)]
2462         Lower = *C;
2463         Upper = C->ashr(ShiftAmount) + 1;
2464       } else {
2465         // 'ashr C, x' produces [C >> (Width-1), C]
2466         Lower = C->ashr(ShiftAmount);
2467         Upper = *C + 1;
2468       }
2469     }
2470     break;
2471
2472   case Instruction::LShr:
2473     if (match(BO.getOperand(1), m_APInt(C)) && C->ult(Width)) {
2474       // 'lshr x, C' produces [0, UINT_MAX >> C].
2475       Upper = APInt::getAllOnesValue(Width).lshr(*C) + 1;
2476     } else if (match(BO.getOperand(0), m_APInt(C))) {
2477       // 'lshr C, x' produces [C >> (Width-1), C].
2478       unsigned ShiftAmount = Width - 1;
2479       if (!C->isNullValue() && BO.isExact())
2480         ShiftAmount = C->countTrailingZeros();
2481       Lower = C->lshr(ShiftAmount);
2482       Upper = *C + 1;
2483     }
2484     break;
2485
2486   case Instruction::Shl:
2487     if (match(BO.getOperand(0), m_APInt(C))) {
2488       if (BO.hasNoUnsignedWrap()) {
2489         // 'shl nuw C, x' produces [C, C << CLZ(C)]
2490         Lower = *C;
2491         Upper = Lower.shl(Lower.countLeadingZeros()) + 1;
2492       } else if (BO.hasNoSignedWrap()) { // TODO: What if both nuw+nsw?
2493         if (C->isNegative()) {
2494           // 'shl nsw C, x' produces [C << CLO(C)-1, C]
2495           unsigned ShiftAmount = C->countLeadingOnes() - 1;
2496           Lower = C->shl(ShiftAmount);
2497           Upper = *C + 1;
2498         } else {
2499           // 'shl nsw C, x' produces [C, C << CLZ(C)-1]
2500           unsigned ShiftAmount = C->countLeadingZeros() - 1;
2501           Lower = *C;
2502           Upper = C->shl(ShiftAmount) + 1;
2503         }
2504       }
2505     }
2506     break;
2507
2508   case Instruction::SDiv:
2509     if (match(BO.getOperand(1), m_APInt(C))) {
2510       APInt IntMin = APInt::getSignedMinValue(Width);
2511       APInt IntMax = APInt::getSignedMaxValue(Width);
2512       if (C->isAllOnesValue()) {
2513         // 'sdiv x, -1' produces [INT_MIN + 1, INT_MAX]
2514         //    where C != -1 and C != 0 and C != 1
2515         Lower = IntMin + 1;
2516         Upper = IntMax + 1;
2517       } else if (C->countLeadingZeros() < Width - 1) {
2518         // 'sdiv x, C' produces [INT_MIN / C, INT_MAX / C]
2519         //    where C != -1 and C != 0 and C != 1
2520         Lower = IntMin.sdiv(*C);
2521         Upper = IntMax.sdiv(*C);
2522         if (Lower.sgt(Upper))
2523           std::swap(Lower, Upper);
2524         Upper = Upper + 1;
2525         assert(Upper != Lower && "Upper part of range has wrapped!");
2526       }
2527     } else if (match(BO.getOperand(0), m_APInt(C))) {
2528       if (C->isMinSignedValue()) {
2529         // 'sdiv INT_MIN, x' produces [INT_MIN, INT_MIN / -2].
2530         Lower = *C;
2531         Upper = Lower.lshr(1) + 1;
2532       } else {
2533         // 'sdiv C, x' produces [-|C|, |C|].
2534         Upper = C->abs() + 1;
2535         Lower = (-Upper) + 1;
2536       }
2537     }
2538     break;
2539
2540   case Instruction::UDiv:
2541     if (match(BO.getOperand(1), m_APInt(C)) && !C->isNullValue()) {
2542       // 'udiv x, C' produces [0, UINT_MAX / C].
2543       Upper = APInt::getMaxValue(Width).udiv(*C) + 1;
2544     } else if (match(BO.getOperand(0), m_APInt(C))) {
2545       // 'udiv C, x' produces [0, C].
2546       Upper = *C + 1;
2547     }
2548     break;
2549
2550   case Instruction::SRem:
2551     if (match(BO.getOperand(1), m_APInt(C))) {
2552       // 'srem x, C' produces (-|C|, |C|).
2553       Upper = C->abs();
2554       Lower = (-Upper) + 1;
2555     }
2556     break;
2557
2558   case Instruction::URem:
2559     if (match(BO.getOperand(1), m_APInt(C)))
2560       // 'urem x, C' produces [0, C).
2561       Upper = *C;
2562     break;
2563
2564   default:
2565     break;
2566   }
2567 }
2568
2569 static Value *simplifyICmpWithConstant(CmpInst::Predicate Pred, Value *LHS,
2570                                        Value *RHS) {
2571   Type *ITy = GetCompareTy(RHS); // The return type.
2572
2573   Value *X;
2574   // Sign-bit checks can be optimized to true/false after unsigned
2575   // floating-point casts:
2576   // icmp slt (bitcast (uitofp X)),  0 --> false
2577   // icmp sgt (bitcast (uitofp X)), -1 --> true
2578   if (match(LHS, m_BitCast(m_UIToFP(m_Value(X))))) {
2579     if (Pred == ICmpInst::ICMP_SLT && match(RHS, m_Zero()))
2580       return ConstantInt::getFalse(ITy);
2581     if (Pred == ICmpInst::ICMP_SGT && match(RHS, m_AllOnes()))
2582       return ConstantInt::getTrue(ITy);
2583   }
2584
2585   const APInt *C;
2586   if (!match(RHS, m_APInt(C)))
2587     return nullptr;
2588
2589   // Rule out tautological comparisons (eg., ult 0 or uge 0).
2590   ConstantRange RHS_CR = ConstantRange::makeExactICmpRegion(Pred, *C);
2591   if (RHS_CR.isEmptySet())
2592     return ConstantInt::getFalse(ITy);
2593   if (RHS_CR.isFullSet())
2594     return ConstantInt::getTrue(ITy);
2595
2596   // Find the range of possible values for binary operators.
2597   unsigned Width = C->getBitWidth();
2598   APInt Lower = APInt(Width, 0);
2599   APInt Upper = APInt(Width, 0);
2600   if (auto *BO = dyn_cast<BinaryOperator>(LHS))
2601     setLimitsForBinOp(*BO, Lower, Upper);
2602
2603   ConstantRange LHS_CR =
2604       Lower != Upper ? ConstantRange(Lower, Upper) : ConstantRange(Width, true);
2605
2606   if (auto *I = dyn_cast<Instruction>(LHS))
2607     if (auto *Ranges = I->getMetadata(LLVMContext::MD_range))
2608       LHS_CR = LHS_CR.intersectWith(getConstantRangeFromMetadata(*Ranges));
2609
2610   if (!LHS_CR.isFullSet()) {
2611     if (RHS_CR.contains(LHS_CR))
2612       return ConstantInt::getTrue(ITy);
2613     if (RHS_CR.inverse().contains(LHS_CR))
2614       return ConstantInt::getFalse(ITy);
2615   }
2616
2617   return nullptr;
2618 }
2619
2620 /// TODO: A large part of this logic is duplicated in InstCombine's
2621 /// foldICmpBinOp(). We should be able to share that and avoid the code
2622 /// duplication.
2623 static Value *simplifyICmpWithBinOp(CmpInst::Predicate Pred, Value *LHS,
2624                                     Value *RHS, const SimplifyQuery &Q,
2625                                     unsigned MaxRecurse) {
2626   Type *ITy = GetCompareTy(LHS); // The return type.
2627
2628   BinaryOperator *LBO = dyn_cast<BinaryOperator>(LHS);
2629   BinaryOperator *RBO = dyn_cast<BinaryOperator>(RHS);
2630   if (MaxRecurse && (LBO || RBO)) {
2631     // Analyze the case when either LHS or RHS is an add instruction.
2632     Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
2633     // LHS = A + B (or A and B are null); RHS = C + D (or C and D are null).
2634     bool NoLHSWrapProblem = false, NoRHSWrapProblem = false;
2635     if (LBO && LBO->getOpcode() == Instruction::Add) {
2636       A = LBO->getOperand(0);
2637       B = LBO->getOperand(1);
2638       NoLHSWrapProblem =
2639           ICmpInst::isEquality(Pred) ||
2640           (CmpInst::isUnsigned(Pred) && LBO->hasNoUnsignedWrap()) ||
2641           (CmpInst::isSigned(Pred) && LBO->hasNoSignedWrap());
2642     }
2643     if (RBO && RBO->getOpcode() == Instruction::Add) {
2644       C = RBO->getOperand(0);
2645       D = RBO->getOperand(1);
2646       NoRHSWrapProblem =
2647           ICmpInst::isEquality(Pred) ||
2648           (CmpInst::isUnsigned(Pred) && RBO->hasNoUnsignedWrap()) ||
2649           (CmpInst::isSigned(Pred) && RBO->hasNoSignedWrap());
2650     }
2651
2652     // icmp (X+Y), X -> icmp Y, 0 for equalities or if there is no overflow.
2653     if ((A == RHS || B == RHS) && NoLHSWrapProblem)
2654       if (Value *V = SimplifyICmpInst(Pred, A == RHS ? B : A,
2655                                       Constant::getNullValue(RHS->getType()), Q,
2656                                       MaxRecurse - 1))
2657         return V;
2658
2659     // icmp X, (X+Y) -> icmp 0, Y for equalities or if there is no overflow.
2660     if ((C == LHS || D == LHS) && NoRHSWrapProblem)
2661       if (Value *V =
2662               SimplifyICmpInst(Pred, Constant::getNullValue(LHS->getType()),
2663                                C == LHS ? D : C, Q, MaxRecurse - 1))
2664         return V;
2665
2666     // icmp (X+Y), (X+Z) -> icmp Y,Z for equalities or if there is no overflow.
2667     if (A && C && (A == C || A == D || B == C || B == D) && NoLHSWrapProblem &&
2668         NoRHSWrapProblem) {
2669       // Determine Y and Z in the form icmp (X+Y), (X+Z).
2670       Value *Y, *Z;
2671       if (A == C) {
2672         // C + B == C + D  ->  B == D
2673         Y = B;
2674         Z = D;
2675       } else if (A == D) {
2676         // D + B == C + D  ->  B == C
2677         Y = B;
2678         Z = C;
2679       } else if (B == C) {
2680         // A + C == C + D  ->  A == D
2681         Y = A;
2682         Z = D;
2683       } else {
2684         assert(B == D);
2685         // A + D == C + D  ->  A == C
2686         Y = A;
2687         Z = C;
2688       }
2689       if (Value *V = SimplifyICmpInst(Pred, Y, Z, Q, MaxRecurse - 1))
2690         return V;
2691     }
2692   }
2693
2694   {
2695     Value *Y = nullptr;
2696     // icmp pred (or X, Y), X
2697     if (LBO && match(LBO, m_c_Or(m_Value(Y), m_Specific(RHS)))) {
2698       if (Pred == ICmpInst::ICMP_ULT)
2699         return getFalse(ITy);
2700       if (Pred == ICmpInst::ICMP_UGE)
2701         return getTrue(ITy);
2702
2703       if (Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SGE) {
2704         KnownBits RHSKnown = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2705         KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2706         if (RHSKnown.isNonNegative() && YKnown.isNegative())
2707           return Pred == ICmpInst::ICMP_SLT ? getTrue(ITy) : getFalse(ITy);
2708         if (RHSKnown.isNegative() || YKnown.isNonNegative())
2709           return Pred == ICmpInst::ICMP_SLT ? getFalse(ITy) : getTrue(ITy);
2710       }
2711     }
2712     // icmp pred X, (or X, Y)
2713     if (RBO && match(RBO, m_c_Or(m_Value(Y), m_Specific(LHS)))) {
2714       if (Pred == ICmpInst::ICMP_ULE)
2715         return getTrue(ITy);
2716       if (Pred == ICmpInst::ICMP_UGT)
2717         return getFalse(ITy);
2718
2719       if (Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SLE) {
2720         KnownBits LHSKnown = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2721         KnownBits YKnown = computeKnownBits(Y, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2722         if (LHSKnown.isNonNegative() && YKnown.isNegative())
2723           return Pred == ICmpInst::ICMP_SGT ? getTrue(ITy) : getFalse(ITy);
2724         if (LHSKnown.isNegative() || YKnown.isNonNegative())
2725           return Pred == ICmpInst::ICMP_SGT ? getFalse(ITy) : getTrue(ITy);
2726       }
2727     }
2728   }
2729
2730   // icmp pred (and X, Y), X
2731   if (LBO && match(LBO, m_c_And(m_Value(), m_Specific(RHS)))) {
2732     if (Pred == ICmpInst::ICMP_UGT)
2733       return getFalse(ITy);
2734     if (Pred == ICmpInst::ICMP_ULE)
2735       return getTrue(ITy);
2736   }
2737   // icmp pred X, (and X, Y)
2738   if (RBO && match(RBO, m_c_And(m_Value(), m_Specific(LHS)))) {
2739     if (Pred == ICmpInst::ICMP_UGE)
2740       return getTrue(ITy);
2741     if (Pred == ICmpInst::ICMP_ULT)
2742       return getFalse(ITy);
2743   }
2744
2745   // 0 - (zext X) pred C
2746   if (!CmpInst::isUnsigned(Pred) && match(LHS, m_Neg(m_ZExt(m_Value())))) {
2747     if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) {
2748       if (RHSC->getValue().isStrictlyPositive()) {
2749         if (Pred == ICmpInst::ICMP_SLT)
2750           return ConstantInt::getTrue(RHSC->getContext());
2751         if (Pred == ICmpInst::ICMP_SGE)
2752           return ConstantInt::getFalse(RHSC->getContext());
2753         if (Pred == ICmpInst::ICMP_EQ)
2754           return ConstantInt::getFalse(RHSC->getContext());
2755         if (Pred == ICmpInst::ICMP_NE)
2756           return ConstantInt::getTrue(RHSC->getContext());
2757       }
2758       if (RHSC->getValue().isNonNegative()) {
2759         if (Pred == ICmpInst::ICMP_SLE)
2760           return ConstantInt::getTrue(RHSC->getContext());
2761         if (Pred == ICmpInst::ICMP_SGT)
2762           return ConstantInt::getFalse(RHSC->getContext());
2763       }
2764     }
2765   }
2766
2767   // icmp pred (urem X, Y), Y
2768   if (LBO && match(LBO, m_URem(m_Value(), m_Specific(RHS)))) {
2769     switch (Pred) {
2770     default:
2771       break;
2772     case ICmpInst::ICMP_SGT:
2773     case ICmpInst::ICMP_SGE: {
2774       KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2775       if (!Known.isNonNegative())
2776         break;
2777       LLVM_FALLTHROUGH;
2778     }
2779     case ICmpInst::ICMP_EQ:
2780     case ICmpInst::ICMP_UGT:
2781     case ICmpInst::ICMP_UGE:
2782       return getFalse(ITy);
2783     case ICmpInst::ICMP_SLT:
2784     case ICmpInst::ICMP_SLE: {
2785       KnownBits Known = computeKnownBits(RHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2786       if (!Known.isNonNegative())
2787         break;
2788       LLVM_FALLTHROUGH;
2789     }
2790     case ICmpInst::ICMP_NE:
2791     case ICmpInst::ICMP_ULT:
2792     case ICmpInst::ICMP_ULE:
2793       return getTrue(ITy);
2794     }
2795   }
2796
2797   // icmp pred X, (urem Y, X)
2798   if (RBO && match(RBO, m_URem(m_Value(), m_Specific(LHS)))) {
2799     switch (Pred) {
2800     default:
2801       break;
2802     case ICmpInst::ICMP_SGT:
2803     case ICmpInst::ICMP_SGE: {
2804       KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2805       if (!Known.isNonNegative())
2806         break;
2807       LLVM_FALLTHROUGH;
2808     }
2809     case ICmpInst::ICMP_NE:
2810     case ICmpInst::ICMP_UGT:
2811     case ICmpInst::ICMP_UGE:
2812       return getTrue(ITy);
2813     case ICmpInst::ICMP_SLT:
2814     case ICmpInst::ICMP_SLE: {
2815       KnownBits Known = computeKnownBits(LHS, Q.DL, 0, Q.AC, Q.CxtI, Q.DT);
2816       if (!Known.isNonNegative())
2817         break;
2818       LLVM_FALLTHROUGH;
2819     }
2820     case ICmpInst::ICMP_EQ:
2821     case ICmpInst::ICMP_ULT:
2822     case ICmpInst::ICMP_ULE:
2823       return getFalse(ITy);
2824     }
2825   }
2826
2827   // x >> y <=u x
2828   // x udiv y <=u x.
2829   if (LBO && (match(LBO, m_LShr(m_Specific(RHS), m_Value())) ||
2830               match(LBO, m_UDiv(m_Specific(RHS), m_Value())))) {
2831     // icmp pred (X op Y), X
2832     if (Pred == ICmpInst::ICMP_UGT)
2833       return getFalse(ITy);
2834     if (Pred == ICmpInst::ICMP_ULE)
2835       return getTrue(ITy);
2836   }
2837
2838   // x >=u x >> y
2839   // x >=u x udiv y.
2840   if (RBO && (match(RBO, m_LShr(m_Specific(LHS), m_Value())) ||
2841               match(RBO, m_UDiv(m_Specific(LHS), m_Value())))) {
2842     // icmp pred X, (X op Y)
2843     if (Pred == ICmpInst::ICMP_ULT)
2844       return getFalse(ITy);
2845     if (Pred == ICmpInst::ICMP_UGE)
2846       return getTrue(ITy);
2847   }
2848
2849   // handle:
2850   //   CI2 << X == CI
2851   //   CI2 << X != CI
2852   //
2853   //   where CI2 is a power of 2 and CI isn't
2854   if (auto *CI = dyn_cast<ConstantInt>(RHS)) {
2855     const APInt *CI2Val, *CIVal = &CI->getValue();
2856     if (LBO && match(LBO, m_Shl(m_APInt(CI2Val), m_Value())) &&
2857         CI2Val->isPowerOf2()) {
2858       if (!CIVal->isPowerOf2()) {
2859         // CI2 << X can equal zero in some circumstances,
2860         // this simplification is unsafe if CI is zero.
2861         //
2862         // We know it is safe if:
2863         // - The shift is nsw, we can't shift out the one bit.
2864         // - The shift is nuw, we can't shift out the one bit.
2865         // - CI2 is one
2866         // - CI isn't zero
2867         if (LBO->hasNoSignedWrap() || LBO->hasNoUnsignedWrap() ||
2868             CI2Val->isOneValue() || !CI->isZero()) {
2869           if (Pred == ICmpInst::ICMP_EQ)
2870             return ConstantInt::getFalse(RHS->getContext());
2871           if (Pred == ICmpInst::ICMP_NE)
2872             return ConstantInt::getTrue(RHS->getContext());
2873         }
2874       }
2875       if (CIVal->isSignMask() && CI2Val->isOneValue()) {
2876         if (Pred == ICmpInst::ICMP_UGT)
2877           return ConstantInt::getFalse(RHS->getContext());
2878         if (Pred == ICmpInst::ICMP_ULE)
2879           return ConstantInt::getTrue(RHS->getContext());
2880       }
2881     }
2882   }
2883
2884   if (MaxRecurse && LBO && RBO && LBO->getOpcode() == RBO->getOpcode() &&
2885       LBO->getOperand(1) == RBO->getOperand(1)) {
2886     switch (LBO->getOpcode()) {
2887     default:
2888       break;
2889     case Instruction::UDiv:
2890     case Instruction::LShr:
2891       if (ICmpInst::isSigned(Pred) || !LBO->isExact() || !RBO->isExact())
2892         break;
2893       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2894                                       RBO->getOperand(0), Q, MaxRecurse - 1))
2895           return V;
2896       break;
2897     case Instruction::SDiv:
2898       if (!ICmpInst::isEquality(Pred) || !LBO->isExact() || !RBO->isExact())
2899         break;
2900       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2901                                       RBO->getOperand(0), Q, MaxRecurse - 1))
2902         return V;
2903       break;
2904     case Instruction::AShr:
2905       if (!LBO->isExact() || !RBO->isExact())
2906         break;
2907       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2908                                       RBO->getOperand(0), Q, MaxRecurse - 1))
2909         return V;
2910       break;
2911     case Instruction::Shl: {
2912       bool NUW = LBO->hasNoUnsignedWrap() && RBO->hasNoUnsignedWrap();
2913       bool NSW = LBO->hasNoSignedWrap() && RBO->hasNoSignedWrap();
2914       if (!NUW && !NSW)
2915         break;
2916       if (!NSW && ICmpInst::isSigned(Pred))
2917         break;
2918       if (Value *V = SimplifyICmpInst(Pred, LBO->getOperand(0),
2919                                       RBO->getOperand(0), Q, MaxRecurse - 1))
2920         return V;
2921       break;
2922     }
2923     }
2924   }
2925   return nullptr;
2926 }
2927
2928 /// Simplify integer comparisons where at least one operand of the compare
2929 /// matches an integer min/max idiom.
2930 static Value *simplifyICmpWithMinMax(CmpInst::Predicate Pred, Value *LHS,
2931                                      Value *RHS, const SimplifyQuery &Q,
2932                                      unsigned MaxRecurse) {
2933   Type *ITy = GetCompareTy(LHS); // The return type.
2934   Value *A, *B;
2935   CmpInst::Predicate P = CmpInst::BAD_ICMP_PREDICATE;
2936   CmpInst::Predicate EqP; // Chosen so that "A == max/min(A,B)" iff "A EqP B".
2937
2938   // Signed variants on "max(a,b)>=a -> true".
2939   if (match(LHS, m_SMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
2940     if (A != RHS)
2941       std::swap(A, B);       // smax(A, B) pred A.
2942     EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2943     // We analyze this as smax(A, B) pred A.
2944     P = Pred;
2945   } else if (match(RHS, m_SMax(m_Value(A), m_Value(B))) &&
2946              (A == LHS || B == LHS)) {
2947     if (A != LHS)
2948       std::swap(A, B);       // A pred smax(A, B).
2949     EqP = CmpInst::ICMP_SGE; // "A == smax(A, B)" iff "A sge B".
2950     // We analyze this as smax(A, B) swapped-pred A.
2951     P = CmpInst::getSwappedPredicate(Pred);
2952   } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
2953              (A == RHS || B == RHS)) {
2954     if (A != RHS)
2955       std::swap(A, B);       // smin(A, B) pred A.
2956     EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2957     // We analyze this as smax(-A, -B) swapped-pred -A.
2958     // Note that we do not need to actually form -A or -B thanks to EqP.
2959     P = CmpInst::getSwappedPredicate(Pred);
2960   } else if (match(RHS, m_SMin(m_Value(A), m_Value(B))) &&
2961              (A == LHS || B == LHS)) {
2962     if (A != LHS)
2963       std::swap(A, B);       // A pred smin(A, B).
2964     EqP = CmpInst::ICMP_SLE; // "A == smin(A, B)" iff "A sle B".
2965     // We analyze this as smax(-A, -B) pred -A.
2966     // Note that we do not need to actually form -A or -B thanks to EqP.
2967     P = Pred;
2968   }
2969   if (P != CmpInst::BAD_ICMP_PREDICATE) {
2970     // Cases correspond to "max(A, B) p A".
2971     switch (P) {
2972     default:
2973       break;
2974     case CmpInst::ICMP_EQ:
2975     case CmpInst::ICMP_SLE:
2976       // Equivalent to "A EqP B".  This may be the same as the condition tested
2977       // in the max/min; if so, we can just return that.
2978       if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
2979         return V;
2980       if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
2981         return V;
2982       // Otherwise, see if "A EqP B" simplifies.
2983       if (MaxRecurse)
2984         if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
2985           return V;
2986       break;
2987     case CmpInst::ICMP_NE:
2988     case CmpInst::ICMP_SGT: {
2989       CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
2990       // Equivalent to "A InvEqP B".  This may be the same as the condition
2991       // tested in the max/min; if so, we can just return that.
2992       if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
2993         return V;
2994       if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
2995         return V;
2996       // Otherwise, see if "A InvEqP B" simplifies.
2997       if (MaxRecurse)
2998         if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
2999           return V;
3000       break;
3001     }
3002     case CmpInst::ICMP_SGE:
3003       // Always true.
3004       return getTrue(ITy);
3005     case CmpInst::ICMP_SLT:
3006       // Always false.
3007       return getFalse(ITy);
3008     }
3009   }
3010
3011   // Unsigned variants on "max(a,b)>=a -> true".
3012   P = CmpInst::BAD_ICMP_PREDICATE;
3013   if (match(LHS, m_UMax(m_Value(A), m_Value(B))) && (A == RHS || B == RHS)) {
3014     if (A != RHS)
3015       std::swap(A, B);       // umax(A, B) pred A.
3016     EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
3017     // We analyze this as umax(A, B) pred A.
3018     P = Pred;
3019   } else if (match(RHS, m_UMax(m_Value(A), m_Value(B))) &&
3020              (A == LHS || B == LHS)) {
3021     if (A != LHS)
3022       std::swap(A, B);       // A pred umax(A, B).
3023     EqP = CmpInst::ICMP_UGE; // "A == umax(A, B)" iff "A uge B".
3024     // We analyze this as umax(A, B) swapped-pred A.
3025     P = CmpInst::getSwappedPredicate(Pred);
3026   } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3027              (A == RHS || B == RHS)) {
3028     if (A != RHS)
3029       std::swap(A, B);       // umin(A, B) pred A.
3030     EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
3031     // We analyze this as umax(-A, -B) swapped-pred -A.
3032     // Note that we do not need to actually form -A or -B thanks to EqP.
3033     P = CmpInst::getSwappedPredicate(Pred);
3034   } else if (match(RHS, m_UMin(m_Value(A), m_Value(B))) &&
3035              (A == LHS || B == LHS)) {
3036     if (A != LHS)
3037       std::swap(A, B);       // A pred umin(A, B).
3038     EqP = CmpInst::ICMP_ULE; // "A == umin(A, B)" iff "A ule B".
3039     // We analyze this as umax(-A, -B) pred -A.
3040     // Note that we do not need to actually form -A or -B thanks to EqP.
3041     P = Pred;
3042   }
3043   if (P != CmpInst::BAD_ICMP_PREDICATE) {
3044     // Cases correspond to "max(A, B) p A".
3045     switch (P) {
3046     default:
3047       break;
3048     case CmpInst::ICMP_EQ:
3049     case CmpInst::ICMP_ULE:
3050       // Equivalent to "A EqP B".  This may be the same as the condition tested
3051       // in the max/min; if so, we can just return that.
3052       if (Value *V = ExtractEquivalentCondition(LHS, EqP, A, B))
3053         return V;
3054       if (Value *V = ExtractEquivalentCondition(RHS, EqP, A, B))
3055         return V;
3056       // Otherwise, see if "A EqP B" simplifies.
3057       if (MaxRecurse)
3058         if (Value *V = SimplifyICmpInst(EqP, A, B, Q, MaxRecurse - 1))
3059           return V;
3060       break;
3061     case CmpInst::ICMP_NE:
3062     case CmpInst::ICMP_UGT: {
3063       CmpInst::Predicate InvEqP = CmpInst::getInversePredicate(EqP);
3064       // Equivalent to "A InvEqP B".  This may be the same as the condition
3065       // tested in the max/min; if so, we can just return that.
3066       if (Value *V = ExtractEquivalentCondition(LHS, InvEqP, A, B))
3067         return V;
3068       if (Value *V = ExtractEquivalentCondition(RHS, InvEqP, A, B))
3069         return V;
3070       // Otherwise, see if "A InvEqP B" simplifies.
3071       if (MaxRecurse)
3072         if (Value *V = SimplifyICmpInst(InvEqP, A, B, Q, MaxRecurse - 1))
3073           return V;
3074       break;
3075     }
3076     case CmpInst::ICMP_UGE:
3077       // Always true.
3078       return getTrue(ITy);
3079     case CmpInst::ICMP_ULT:
3080       // Always false.
3081       return getFalse(ITy);
3082     }
3083   }
3084
3085   // Variants on "max(x,y) >= min(x,z)".
3086   Value *C, *D;
3087   if (match(LHS, m_SMax(m_Value(A), m_Value(B))) &&
3088       match(RHS, m_SMin(m_Value(C), m_Value(D))) &&
3089       (A == C || A == D || B == C || B == D)) {
3090     // max(x, ?) pred min(x, ?).
3091     if (Pred == CmpInst::ICMP_SGE)
3092       // Always true.
3093       return getTrue(ITy);
3094     if (Pred == CmpInst::ICMP_SLT)
3095       // Always false.
3096       return getFalse(ITy);
3097   } else if (match(LHS, m_SMin(m_Value(A), m_Value(B))) &&
3098              match(RHS, m_SMax(m_Value(C), m_Value(D))) &&
3099              (A == C || A == D || B == C || B == D)) {
3100     // min(x, ?) pred max(x, ?).
3101     if (Pred == CmpInst::ICMP_SLE)
3102       // Always true.
3103       return getTrue(ITy);
3104     if (Pred == CmpInst::ICMP_SGT)
3105       // Always false.
3106       return getFalse(ITy);
3107   } else if (match(LHS, m_UMax(m_Value(A), m_Value(B))) &&
3108              match(RHS, m_UMin(m_Value(C), m_Value(D))) &&
3109              (A == C || A == D || B == C || B == D)) {
3110     // max(x, ?) pred min(x, ?).
3111     if (Pred == CmpInst::ICMP_UGE)
3112       // Always true.
3113       return getTrue(ITy);
3114     if (Pred == CmpInst::ICMP_ULT)
3115       // Always false.
3116       return getFalse(ITy);
3117   } else if (match(LHS, m_UMin(m_Value(A), m_Value(B))) &&
3118              match(RHS, m_UMax(m_Value(C), m_Value(D))) &&
3119              (A == C || A == D || B == C || B == D)) {
3120     // min(x, ?) pred max(x, ?).
3121     if (Pred == CmpInst::ICMP_ULE)
3122       // Always true.
3123       return getTrue(ITy);
3124     if (Pred == CmpInst::ICMP_UGT)
3125       // Always false.
3126       return getFalse(ITy);
3127   }
3128
3129   return nullptr;
3130 }
3131
3132 /// Given operands for an ICmpInst, see if we can fold the result.
3133 /// If not, this returns null.
3134 static Value *SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3135                                const SimplifyQuery &Q, unsigned MaxRecurse) {
3136   CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3137   assert(CmpInst::isIntPredicate(Pred) && "Not an integer compare!");
3138
3139   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
3140     if (Constant *CRHS = dyn_cast<Constant>(RHS))
3141       return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
3142
3143     // If we have a constant, make sure it is on the RHS.
3144     std::swap(LHS, RHS);
3145     Pred = CmpInst::getSwappedPredicate(Pred);
3146   }
3147
3148   Type *ITy = GetCompareTy(LHS); // The return type.
3149
3150   // icmp X, X -> true/false
3151   // icmp X, undef -> true/false because undef could be X.
3152   if (LHS == RHS || isa<UndefValue>(RHS))
3153     return ConstantInt::get(ITy, CmpInst::isTrueWhenEqual(Pred));
3154
3155   if (Value *V = simplifyICmpOfBools(Pred, LHS, RHS, Q))
3156     return V;
3157
3158   if (Value *V = simplifyICmpWithZero(Pred, LHS, RHS, Q))
3159     return V;
3160
3161   if (Value *V = simplifyICmpWithConstant(Pred, LHS, RHS))
3162     return V;
3163
3164   // If both operands have range metadata, use the metadata
3165   // to simplify the comparison.
3166   if (isa<Instruction>(RHS) && isa<Instruction>(LHS)) {
3167     auto RHS_Instr = cast<Instruction>(RHS);
3168     auto LHS_Instr = cast<Instruction>(LHS);
3169
3170     if (RHS_Instr->getMetadata(LLVMContext::MD_range) &&
3171         LHS_Instr->getMetadata(LLVMContext::MD_range)) {
3172       auto RHS_CR = getConstantRangeFromMetadata(
3173           *RHS_Instr->getMetadata(LLVMContext::MD_range));
3174       auto LHS_CR = getConstantRangeFromMetadata(
3175           *LHS_Instr->getMetadata(LLVMContext::MD_range));
3176
3177       auto Satisfied_CR = ConstantRange::makeSatisfyingICmpRegion(Pred, RHS_CR);
3178       if (Satisfied_CR.contains(LHS_CR))
3179         return ConstantInt::getTrue(RHS->getContext());
3180
3181       auto InversedSatisfied_CR = ConstantRange::makeSatisfyingICmpRegion(
3182                 CmpInst::getInversePredicate(Pred), RHS_CR);
3183       if (InversedSatisfied_CR.contains(LHS_CR))
3184         return ConstantInt::getFalse(RHS->getContext());
3185     }
3186   }
3187
3188   // Compare of cast, for example (zext X) != 0 -> X != 0
3189   if (isa<CastInst>(LHS) && (isa<Constant>(RHS) || isa<CastInst>(RHS))) {
3190     Instruction *LI = cast<CastInst>(LHS);
3191     Value *SrcOp = LI->getOperand(0);
3192     Type *SrcTy = SrcOp->getType();
3193     Type *DstTy = LI->getType();
3194
3195     // Turn icmp (ptrtoint x), (ptrtoint/constant) into a compare of the input
3196     // if the integer type is the same size as the pointer type.
3197     if (MaxRecurse && isa<PtrToIntInst>(LI) &&
3198         Q.DL.getTypeSizeInBits(SrcTy) == DstTy->getPrimitiveSizeInBits()) {
3199       if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
3200         // Transfer the cast to the constant.
3201         if (Value *V = SimplifyICmpInst(Pred, SrcOp,
3202                                         ConstantExpr::getIntToPtr(RHSC, SrcTy),
3203                                         Q, MaxRecurse-1))
3204           return V;
3205       } else if (PtrToIntInst *RI = dyn_cast<PtrToIntInst>(RHS)) {
3206         if (RI->getOperand(0)->getType() == SrcTy)
3207           // Compare without the cast.
3208           if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
3209                                           Q, MaxRecurse-1))
3210             return V;
3211       }
3212     }
3213
3214     if (isa<ZExtInst>(LHS)) {
3215       // Turn icmp (zext X), (zext Y) into a compare of X and Y if they have the
3216       // same type.
3217       if (ZExtInst *RI = dyn_cast<ZExtInst>(RHS)) {
3218         if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3219           // Compare X and Y.  Note that signed predicates become unsigned.
3220           if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
3221                                           SrcOp, RI->getOperand(0), Q,
3222                                           MaxRecurse-1))
3223             return V;
3224       }
3225       // Turn icmp (zext X), Cst into a compare of X and Cst if Cst is extended
3226       // too.  If not, then try to deduce the result of the comparison.
3227       else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3228         // Compute the constant that would happen if we truncated to SrcTy then
3229         // reextended to DstTy.
3230         Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3231         Constant *RExt = ConstantExpr::getCast(CastInst::ZExt, Trunc, DstTy);
3232
3233         // If the re-extended constant didn't change then this is effectively
3234         // also a case of comparing two zero-extended values.
3235         if (RExt == CI && MaxRecurse)
3236           if (Value *V = SimplifyICmpInst(ICmpInst::getUnsignedPredicate(Pred),
3237                                         SrcOp, Trunc, Q, MaxRecurse-1))
3238             return V;
3239
3240         // Otherwise the upper bits of LHS are zero while RHS has a non-zero bit
3241         // there.  Use this to work out the result of the comparison.
3242         if (RExt != CI) {
3243           switch (Pred) {
3244           default: llvm_unreachable("Unknown ICmp predicate!");
3245           // LHS <u RHS.
3246           case ICmpInst::ICMP_EQ:
3247           case ICmpInst::ICMP_UGT:
3248           case ICmpInst::ICMP_UGE:
3249             return ConstantInt::getFalse(CI->getContext());
3250
3251           case ICmpInst::ICMP_NE:
3252           case ICmpInst::ICMP_ULT:
3253           case ICmpInst::ICMP_ULE:
3254             return ConstantInt::getTrue(CI->getContext());
3255
3256           // LHS is non-negative.  If RHS is negative then LHS >s LHS.  If RHS
3257           // is non-negative then LHS <s RHS.
3258           case ICmpInst::ICMP_SGT:
3259           case ICmpInst::ICMP_SGE:
3260             return CI->getValue().isNegative() ?
3261               ConstantInt::getTrue(CI->getContext()) :
3262               ConstantInt::getFalse(CI->getContext());
3263
3264           case ICmpInst::ICMP_SLT:
3265           case ICmpInst::ICMP_SLE:
3266             return CI->getValue().isNegative() ?
3267               ConstantInt::getFalse(CI->getContext()) :
3268               ConstantInt::getTrue(CI->getContext());
3269           }
3270         }
3271       }
3272     }
3273
3274     if (isa<SExtInst>(LHS)) {
3275       // Turn icmp (sext X), (sext Y) into a compare of X and Y if they have the
3276       // same type.
3277       if (SExtInst *RI = dyn_cast<SExtInst>(RHS)) {
3278         if (MaxRecurse && SrcTy == RI->getOperand(0)->getType())
3279           // Compare X and Y.  Note that the predicate does not change.
3280           if (Value *V = SimplifyICmpInst(Pred, SrcOp, RI->getOperand(0),
3281                                           Q, MaxRecurse-1))
3282             return V;
3283       }
3284       // Turn icmp (sext X), Cst into a compare of X and Cst if Cst is extended
3285       // too.  If not, then try to deduce the result of the comparison.
3286       else if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) {
3287         // Compute the constant that would happen if we truncated to SrcTy then
3288         // reextended to DstTy.
3289         Constant *Trunc = ConstantExpr::getTrunc(CI, SrcTy);
3290         Constant *RExt = ConstantExpr::getCast(CastInst::SExt, Trunc, DstTy);
3291
3292         // If the re-extended constant didn't change then this is effectively
3293         // also a case of comparing two sign-extended values.
3294         if (RExt == CI && MaxRecurse)
3295           if (Value *V = SimplifyICmpInst(Pred, SrcOp, Trunc, Q, MaxRecurse-1))
3296             return V;
3297
3298         // Otherwise the upper bits of LHS are all equal, while RHS has varying
3299         // bits there.  Use this to work out the result of the comparison.
3300         if (RExt != CI) {
3301           switch (Pred) {
3302           default: llvm_unreachable("Unknown ICmp predicate!");
3303           case ICmpInst::ICMP_EQ:
3304             return ConstantInt::getFalse(CI->getContext());
3305           case ICmpInst::ICMP_NE:
3306             return ConstantInt::getTrue(CI->getContext());
3307
3308           // If RHS is non-negative then LHS <s RHS.  If RHS is negative then
3309           // LHS >s RHS.
3310           case ICmpInst::ICMP_SGT:
3311           case ICmpInst::ICMP_SGE:
3312             return CI->getValue().isNegative() ?
3313               ConstantInt::getTrue(CI->getContext()) :
3314               ConstantInt::getFalse(CI->getContext());
3315           case ICmpInst::ICMP_SLT:
3316           case ICmpInst::ICMP_SLE:
3317             return CI->getValue().isNegative() ?
3318               ConstantInt::getFalse(CI->getContext()) :
3319               ConstantInt::getTrue(CI->getContext());
3320
3321           // If LHS is non-negative then LHS <u RHS.  If LHS is negative then
3322           // LHS >u RHS.
3323           case ICmpInst::ICMP_UGT:
3324           case ICmpInst::ICMP_UGE:
3325             // Comparison is true iff the LHS <s 0.
3326             if (MaxRecurse)
3327               if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SLT, SrcOp,
3328                                               Constant::getNullValue(SrcTy),
3329                                               Q, MaxRecurse-1))
3330                 return V;
3331             break;
3332           case ICmpInst::ICMP_ULT:
3333           case ICmpInst::ICMP_ULE:
3334             // Comparison is true iff the LHS >=s 0.
3335             if (MaxRecurse)
3336               if (Value *V = SimplifyICmpInst(ICmpInst::ICMP_SGE, SrcOp,
3337                                               Constant::getNullValue(SrcTy),
3338                                               Q, MaxRecurse-1))
3339                 return V;
3340             break;
3341           }
3342         }
3343       }
3344     }
3345   }
3346
3347   // icmp eq|ne X, Y -> false|true if X != Y
3348   if (ICmpInst::isEquality(Pred) &&
3349       isKnownNonEqual(LHS, RHS, Q.DL, Q.AC, Q.CxtI, Q.DT)) {
3350     return Pred == ICmpInst::ICMP_NE ? getTrue(ITy) : getFalse(ITy);
3351   }
3352
3353   if (Value *V = simplifyICmpWithBinOp(Pred, LHS, RHS, Q, MaxRecurse))
3354     return V;
3355
3356   if (Value *V = simplifyICmpWithMinMax(Pred, LHS, RHS, Q, MaxRecurse))
3357     return V;
3358
3359   // Simplify comparisons of related pointers using a powerful, recursive
3360   // GEP-walk when we have target data available..
3361   if (LHS->getType()->isPointerTy())
3362     if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI, LHS,
3363                                      RHS))
3364       return C;
3365   if (auto *CLHS = dyn_cast<PtrToIntOperator>(LHS))
3366     if (auto *CRHS = dyn_cast<PtrToIntOperator>(RHS))
3367       if (Q.DL.getTypeSizeInBits(CLHS->getPointerOperandType()) ==
3368               Q.DL.getTypeSizeInBits(CLHS->getType()) &&
3369           Q.DL.getTypeSizeInBits(CRHS->getPointerOperandType()) ==
3370               Q.DL.getTypeSizeInBits(CRHS->getType()))
3371         if (auto *C = computePointerICmp(Q.DL, Q.TLI, Q.DT, Pred, Q.AC, Q.CxtI,
3372                                          CLHS->getPointerOperand(),
3373                                          CRHS->getPointerOperand()))
3374           return C;
3375
3376   if (GetElementPtrInst *GLHS = dyn_cast<GetElementPtrInst>(LHS)) {
3377     if (GEPOperator *GRHS = dyn_cast<GEPOperator>(RHS)) {
3378       if (GLHS->getPointerOperand() == GRHS->getPointerOperand() &&
3379           GLHS->hasAllConstantIndices() && GRHS->hasAllConstantIndices() &&
3380           (ICmpInst::isEquality(Pred) ||
3381            (GLHS->isInBounds() && GRHS->isInBounds() &&
3382             Pred == ICmpInst::getSignedPredicate(Pred)))) {
3383         // The bases are equal and the indices are constant.  Build a constant
3384         // expression GEP with the same indices and a null base pointer to see
3385         // what constant folding can make out of it.
3386         Constant *Null = Constant::getNullValue(GLHS->getPointerOperandType());
3387         SmallVector<Value *, 4> IndicesLHS(GLHS->idx_begin(), GLHS->idx_end());
3388         Constant *NewLHS = ConstantExpr::getGetElementPtr(
3389             GLHS->getSourceElementType(), Null, IndicesLHS);
3390
3391         SmallVector<Value *, 4> IndicesRHS(GRHS->idx_begin(), GRHS->idx_end());
3392         Constant *NewRHS = ConstantExpr::getGetElementPtr(
3393             GLHS->getSourceElementType(), Null, IndicesRHS);
3394         return ConstantExpr::getICmp(Pred, NewLHS, NewRHS);
3395       }
3396     }
3397   }
3398
3399   // If the comparison is with the result of a select instruction, check whether
3400   // comparing with either branch of the select always yields the same value.
3401   if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
3402     if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
3403       return V;
3404
3405   // If the comparison is with the result of a phi instruction, check whether
3406   // doing the compare with each incoming phi value yields a common result.
3407   if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
3408     if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
3409       return V;
3410
3411   return nullptr;
3412 }
3413
3414 Value *llvm::SimplifyICmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3415                               const SimplifyQuery &Q) {
3416   return ::SimplifyICmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
3417 }
3418
3419 /// Given operands for an FCmpInst, see if we can fold the result.
3420 /// If not, this returns null.
3421 static Value *SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3422                                FastMathFlags FMF, const SimplifyQuery &Q,
3423                                unsigned MaxRecurse) {
3424   CmpInst::Predicate Pred = (CmpInst::Predicate)Predicate;
3425   assert(CmpInst::isFPPredicate(Pred) && "Not an FP compare!");
3426
3427   if (Constant *CLHS = dyn_cast<Constant>(LHS)) {
3428     if (Constant *CRHS = dyn_cast<Constant>(RHS))
3429       return ConstantFoldCompareInstOperands(Pred, CLHS, CRHS, Q.DL, Q.TLI);
3430
3431     // If we have a constant, make sure it is on the RHS.
3432     std::swap(LHS, RHS);
3433     Pred = CmpInst::getSwappedPredicate(Pred);
3434   }
3435
3436   // Fold trivial predicates.
3437   Type *RetTy = GetCompareTy(LHS);
3438   if (Pred == FCmpInst::FCMP_FALSE)
3439     return getFalse(RetTy);
3440   if (Pred == FCmpInst::FCMP_TRUE)
3441     return getTrue(RetTy);
3442
3443   // UNO/ORD predicates can be trivially folded if NaNs are ignored.
3444   if (FMF.noNaNs()) {
3445     if (Pred == FCmpInst::FCMP_UNO)
3446       return getFalse(RetTy);
3447     if (Pred == FCmpInst::FCMP_ORD)
3448       return getTrue(RetTy);
3449   }
3450
3451   // NaN is unordered; NaN is not ordered.
3452   assert((FCmpInst::isOrdered(Pred) || FCmpInst::isUnordered(Pred)) &&
3453          "Comparison must be either ordered or unordered");
3454   if (match(RHS, m_NaN()))
3455     return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
3456
3457   // fcmp pred x, undef  and  fcmp pred undef, x
3458   // fold to true if unordered, false if ordered
3459   if (isa<UndefValue>(LHS) || isa<UndefValue>(RHS)) {
3460     // Choosing NaN for the undef will always make unordered comparison succeed
3461     // and ordered comparison fail.
3462     return ConstantInt::get(RetTy, CmpInst::isUnordered(Pred));
3463   }
3464
3465   // fcmp x,x -> true/false.  Not all compares are foldable.
3466   if (LHS == RHS) {
3467     if (CmpInst::isTrueWhenEqual(Pred))
3468       return getTrue(RetTy);
3469     if (CmpInst::isFalseWhenEqual(Pred))
3470       return getFalse(RetTy);
3471   }
3472
3473   // Handle fcmp with constant RHS.
3474   const APFloat *C;
3475   if (match(RHS, m_APFloat(C))) {
3476     // Check whether the constant is an infinity.
3477     if (C->isInfinity()) {
3478       if (C->isNegative()) {
3479         switch (Pred) {
3480         case FCmpInst::FCMP_OLT:
3481           // No value is ordered and less than negative infinity.
3482           return getFalse(RetTy);
3483         case FCmpInst::FCMP_UGE:
3484           // All values are unordered with or at least negative infinity.
3485           return getTrue(RetTy);
3486         default:
3487           break;
3488         }
3489       } else {
3490         switch (Pred) {
3491         case FCmpInst::FCMP_OGT:
3492           // No value is ordered and greater than infinity.
3493           return getFalse(RetTy);
3494         case FCmpInst::FCMP_ULE:
3495           // All values are unordered with and at most infinity.
3496           return getTrue(RetTy);
3497         default:
3498           break;
3499         }
3500       }
3501     }
3502     if (C->isZero()) {
3503       switch (Pred) {
3504       case FCmpInst::FCMP_UGE:
3505         if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3506           return getTrue(RetTy);
3507         break;
3508       case FCmpInst::FCMP_OLT:
3509         // X < 0
3510         if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3511           return getFalse(RetTy);
3512         break;
3513       default:
3514         break;
3515       }
3516     } else if (C->isNegative()) {
3517       assert(!C->isNaN() && "Unexpected NaN constant!");
3518       // TODO: We can catch more cases by using a range check rather than
3519       //       relying on CannotBeOrderedLessThanZero.
3520       switch (Pred) {
3521       case FCmpInst::FCMP_UGE:
3522       case FCmpInst::FCMP_UGT:
3523       case FCmpInst::FCMP_UNE:
3524         // (X >= 0) implies (X > C) when (C < 0)
3525         if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3526           return getTrue(RetTy);
3527         break;
3528       case FCmpInst::FCMP_OEQ:
3529       case FCmpInst::FCMP_OLE:
3530       case FCmpInst::FCMP_OLT:
3531         // (X >= 0) implies !(X < C) when (C < 0)
3532         if (CannotBeOrderedLessThanZero(LHS, Q.TLI))
3533           return getFalse(RetTy);
3534         break;
3535       default:
3536         break;
3537       }
3538     }
3539   }
3540
3541   // If the comparison is with the result of a select instruction, check whether
3542   // comparing with either branch of the select always yields the same value.
3543   if (isa<SelectInst>(LHS) || isa<SelectInst>(RHS))
3544     if (Value *V = ThreadCmpOverSelect(Pred, LHS, RHS, Q, MaxRecurse))
3545       return V;
3546
3547   // If the comparison is with the result of a phi instruction, check whether
3548   // doing the compare with each incoming phi value yields a common result.
3549   if (isa<PHINode>(LHS) || isa<PHINode>(RHS))
3550     if (Value *V = ThreadCmpOverPHI(Pred, LHS, RHS, Q, MaxRecurse))
3551       return V;
3552
3553   return nullptr;
3554 }
3555
3556 Value *llvm::SimplifyFCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
3557                               FastMathFlags FMF, const SimplifyQuery &Q) {
3558   return ::SimplifyFCmpInst(Predicate, LHS, RHS, FMF, Q, RecursionLimit);
3559 }
3560
3561 /// See if V simplifies when its operand Op is replaced with RepOp.
3562 static const Value *SimplifyWithOpReplaced(Value *V, Value *Op, Value *RepOp,
3563                                            const SimplifyQuery &Q,
3564                                            unsigned MaxRecurse) {
3565   // Trivial replacement.
3566   if (V == Op)
3567     return RepOp;
3568
3569   // We cannot replace a constant, and shouldn't even try.
3570   if (isa<Constant>(Op))
3571     return nullptr;
3572
3573   auto *I = dyn_cast<Instruction>(V);
3574   if (!I)
3575     return nullptr;
3576
3577   // If this is a binary operator, try to simplify it with the replaced op.
3578   if (auto *B = dyn_cast<BinaryOperator>(I)) {
3579     // Consider:
3580     //   %cmp = icmp eq i32 %x, 2147483647
3581     //   %add = add nsw i32 %x, 1
3582     //   %sel = select i1 %cmp, i32 -2147483648, i32 %add
3583     //
3584     // We can't replace %sel with %add unless we strip away the flags.
3585     if (isa<OverflowingBinaryOperator>(B))
3586       if (B->hasNoSignedWrap() || B->hasNoUnsignedWrap())
3587         return nullptr;
3588     if (isa<PossiblyExactOperator>(B))
3589       if (B->isExact())
3590         return nullptr;
3591
3592     if (MaxRecurse) {
3593       if (B->getOperand(0) == Op)
3594         return SimplifyBinOp(B->getOpcode(), RepOp, B->getOperand(1), Q,
3595                              MaxRecurse - 1);
3596       if (B->getOperand(1) == Op)
3597         return SimplifyBinOp(B->getOpcode(), B->getOperand(0), RepOp, Q,
3598                              MaxRecurse - 1);
3599     }
3600   }
3601
3602   // Same for CmpInsts.
3603   if (CmpInst *C = dyn_cast<CmpInst>(I)) {
3604     if (MaxRecurse) {
3605       if (C->getOperand(0) == Op)
3606         return SimplifyCmpInst(C->getPredicate(), RepOp, C->getOperand(1), Q,
3607                                MaxRecurse - 1);
3608       if (C->getOperand(1) == Op)
3609         return SimplifyCmpInst(C->getPredicate(), C->getOperand(0), RepOp, Q,
3610                                MaxRecurse - 1);
3611     }
3612   }
3613
3614   // Same for GEPs.
3615   if (auto *GEP = dyn_cast<GetElementPtrInst>(I)) {
3616     if (MaxRecurse) {
3617       SmallVector<Value *, 8> NewOps(GEP->getNumOperands());
3618       transform(GEP->operands(), NewOps.begin(),
3619                 [&](Value *V) { return V == Op ? RepOp : V; });
3620       return SimplifyGEPInst(GEP->getSourceElementType(), NewOps, Q,
3621                              MaxRecurse - 1);
3622     }
3623   }
3624
3625   // TODO: We could hand off more cases to instsimplify here.
3626
3627   // If all operands are constant after substituting Op for RepOp then we can
3628   // constant fold the instruction.
3629   if (Constant *CRepOp = dyn_cast<Constant>(RepOp)) {
3630     // Build a list of all constant operands.
3631     SmallVector<Constant *, 8> ConstOps;
3632     for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
3633       if (I->getOperand(i) == Op)
3634         ConstOps.push_back(CRepOp);
3635       else if (Constant *COp = dyn_cast<Constant>(I->getOperand(i)))
3636         ConstOps.push_back(COp);
3637       else
3638         break;
3639     }
3640
3641     // All operands were constants, fold it.
3642     if (ConstOps.size() == I->getNumOperands()) {
3643       if (CmpInst *C = dyn_cast<CmpInst>(I))
3644         return ConstantFoldCompareInstOperands(C->getPredicate(), ConstOps[0],
3645                                                ConstOps[1], Q.DL, Q.TLI);
3646
3647       if (LoadInst *LI = dyn_cast<LoadInst>(I))
3648         if (!LI->isVolatile())
3649           return ConstantFoldLoadFromConstPtr(ConstOps[0], LI->getType(), Q.DL);
3650
3651       return ConstantFoldInstOperands(I, ConstOps, Q.DL, Q.TLI);
3652     }
3653   }
3654
3655   return nullptr;
3656 }
3657
3658 /// Try to simplify a select instruction when its condition operand is an
3659 /// integer comparison where one operand of the compare is a constant.
3660 static Value *simplifySelectBitTest(Value *TrueVal, Value *FalseVal, Value *X,
3661                                     const APInt *Y, bool TrueWhenUnset) {
3662   const APInt *C;
3663
3664   // (X & Y) == 0 ? X & ~Y : X  --> X
3665   // (X & Y) != 0 ? X & ~Y : X  --> X & ~Y
3666   if (FalseVal == X && match(TrueVal, m_And(m_Specific(X), m_APInt(C))) &&
3667       *Y == ~*C)
3668     return TrueWhenUnset ? FalseVal : TrueVal;
3669
3670   // (X & Y) == 0 ? X : X & ~Y  --> X & ~Y
3671   // (X & Y) != 0 ? X : X & ~Y  --> X
3672   if (TrueVal == X && match(FalseVal, m_And(m_Specific(X), m_APInt(C))) &&
3673       *Y == ~*C)
3674     return TrueWhenUnset ? FalseVal : TrueVal;
3675
3676   if (Y->isPowerOf2()) {
3677     // (X & Y) == 0 ? X | Y : X  --> X | Y
3678     // (X & Y) != 0 ? X | Y : X  --> X
3679     if (FalseVal == X && match(TrueVal, m_Or(m_Specific(X), m_APInt(C))) &&
3680         *Y == *C)
3681       return TrueWhenUnset ? TrueVal : FalseVal;
3682
3683     // (X & Y) == 0 ? X : X | Y  --> X
3684     // (X & Y) != 0 ? X : X | Y  --> X | Y
3685     if (TrueVal == X && match(FalseVal, m_Or(m_Specific(X), m_APInt(C))) &&
3686         *Y == *C)
3687       return TrueWhenUnset ? TrueVal : FalseVal;
3688   }
3689
3690   return nullptr;
3691 }
3692
3693 /// An alternative way to test if a bit is set or not uses sgt/slt instead of
3694 /// eq/ne.
3695 static Value *simplifySelectWithFakeICmpEq(Value *CmpLHS, Value *CmpRHS,
3696                                            ICmpInst::Predicate Pred,
3697                                            Value *TrueVal, Value *FalseVal) {
3698   Value *X;
3699   APInt Mask;
3700   if (!decomposeBitTestICmp(CmpLHS, CmpRHS, Pred, X, Mask))
3701     return nullptr;
3702
3703   return simplifySelectBitTest(TrueVal, FalseVal, X, &Mask,
3704                                Pred == ICmpInst::ICMP_EQ);
3705 }
3706
3707 /// Try to simplify a select instruction when its condition operand is an
3708 /// integer comparison.
3709 static Value *simplifySelectWithICmpCond(Value *CondVal, Value *TrueVal,
3710                                          Value *FalseVal, const SimplifyQuery &Q,
3711                                          unsigned MaxRecurse) {
3712   ICmpInst::Predicate Pred;
3713   Value *CmpLHS, *CmpRHS;
3714   if (!match(CondVal, m_ICmp(Pred, m_Value(CmpLHS), m_Value(CmpRHS))))
3715     return nullptr;
3716
3717   if (ICmpInst::isEquality(Pred) && match(CmpRHS, m_Zero())) {
3718     Value *X;
3719     const APInt *Y;
3720     if (match(CmpLHS, m_And(m_Value(X), m_APInt(Y))))
3721       if (Value *V = simplifySelectBitTest(TrueVal, FalseVal, X, Y,
3722                                            Pred == ICmpInst::ICMP_EQ))
3723         return V;
3724   }
3725
3726   // Check for other compares that behave like bit test.
3727   if (Value *V = simplifySelectWithFakeICmpEq(CmpLHS, CmpRHS, Pred,
3728                                               TrueVal, FalseVal))
3729     return V;
3730
3731   // If we have an equality comparison, then we know the value in one of the
3732   // arms of the select. See if substituting this value into the arm and
3733   // simplifying the result yields the same value as the other arm.
3734   if (Pred == ICmpInst::ICMP_EQ) {
3735     if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3736             TrueVal ||
3737         SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3738             TrueVal)
3739       return FalseVal;
3740     if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3741             FalseVal ||
3742         SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3743             FalseVal)
3744       return FalseVal;
3745   } else if (Pred == ICmpInst::ICMP_NE) {
3746     if (SimplifyWithOpReplaced(TrueVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3747             FalseVal ||
3748         SimplifyWithOpReplaced(TrueVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3749             FalseVal)
3750       return TrueVal;
3751     if (SimplifyWithOpReplaced(FalseVal, CmpLHS, CmpRHS, Q, MaxRecurse) ==
3752             TrueVal ||
3753         SimplifyWithOpReplaced(FalseVal, CmpRHS, CmpLHS, Q, MaxRecurse) ==
3754             TrueVal)
3755       return TrueVal;
3756   }
3757
3758   return nullptr;
3759 }
3760
3761 /// Given operands for a SelectInst, see if we can fold the result.
3762 /// If not, this returns null.
3763 static Value *SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
3764                                  const SimplifyQuery &Q, unsigned MaxRecurse) {
3765   if (auto *CondC = dyn_cast<Constant>(Cond)) {
3766     if (auto *TrueC = dyn_cast<Constant>(TrueVal))
3767       if (auto *FalseC = dyn_cast<Constant>(FalseVal))
3768         return ConstantFoldSelectInstruction(CondC, TrueC, FalseC);
3769
3770     // select undef, X, Y -> X or Y
3771     if (isa<UndefValue>(CondC))
3772       return isa<Constant>(FalseVal) ? FalseVal : TrueVal;
3773
3774     // TODO: Vector constants with undef elements don't simplify.
3775
3776     // select true, X, Y  -> X
3777     if (CondC->isAllOnesValue())
3778       return TrueVal;
3779     // select false, X, Y -> Y
3780     if (CondC->isNullValue())
3781       return FalseVal;
3782   }
3783
3784   // select ?, X, X -> X
3785   if (TrueVal == FalseVal)
3786     return TrueVal;
3787
3788   if (isa<UndefValue>(TrueVal))   // select ?, undef, X -> X
3789     return FalseVal;
3790   if (isa<UndefValue>(FalseVal))   // select ?, X, undef -> X
3791     return TrueVal;
3792
3793   if (Value *V =
3794           simplifySelectWithICmpCond(Cond, TrueVal, FalseVal, Q, MaxRecurse))
3795     return V;
3796
3797   if (Value *V = foldSelectWithBinaryOp(Cond, TrueVal, FalseVal))
3798     return V;
3799
3800   return nullptr;
3801 }
3802
3803 Value *llvm::SimplifySelectInst(Value *Cond, Value *TrueVal, Value *FalseVal,
3804                                 const SimplifyQuery &Q) {
3805   return ::SimplifySelectInst(Cond, TrueVal, FalseVal, Q, RecursionLimit);
3806 }
3807
3808 /// Given operands for an GetElementPtrInst, see if we can fold the result.
3809 /// If not, this returns null.
3810 static Value *SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
3811                               const SimplifyQuery &Q, unsigned) {
3812   // The type of the GEP pointer operand.
3813   unsigned AS =
3814       cast<PointerType>(Ops[0]->getType()->getScalarType())->getAddressSpace();
3815
3816   // getelementptr P -> P.
3817   if (Ops.size() == 1)
3818     return Ops[0];
3819
3820   // Compute the (pointer) type returned by the GEP instruction.
3821   Type *LastType = GetElementPtrInst::getIndexedType(SrcTy, Ops.slice(1));
3822   Type *GEPTy = PointerType::get(LastType, AS);
3823   if (VectorType *VT = dyn_cast<VectorType>(Ops[0]->getType()))
3824     GEPTy = VectorType::get(GEPTy, VT->getNumElements());
3825   else if (VectorType *VT = dyn_cast<VectorType>(Ops[1]->getType()))
3826     GEPTy = VectorType::get(GEPTy, VT->getNumElements());
3827
3828   if (isa<UndefValue>(Ops[0]))
3829     return UndefValue::get(GEPTy);
3830
3831   if (Ops.size() == 2) {
3832     // getelementptr P, 0 -> P.
3833     if (match(Ops[1], m_Zero()) && Ops[0]->getType() == GEPTy)
3834       return Ops[0];
3835
3836     Type *Ty = SrcTy;
3837     if (Ty->isSized()) {
3838       Value *P;
3839       uint64_t C;
3840       uint64_t TyAllocSize = Q.DL.getTypeAllocSize(Ty);
3841       // getelementptr P, N -> P if P points to a type of zero size.
3842       if (TyAllocSize == 0 && Ops[0]->getType() == GEPTy)
3843         return Ops[0];
3844
3845       // The following transforms are only safe if the ptrtoint cast
3846       // doesn't truncate the pointers.
3847       if (Ops[1]->getType()->getScalarSizeInBits() ==
3848           Q.DL.getIndexSizeInBits(AS)) {
3849         auto PtrToIntOrZero = [GEPTy](Value *P) -> Value * {
3850           if (match(P, m_Zero()))
3851             return Constant::getNullValue(GEPTy);
3852           Value *Temp;
3853           if (match(P, m_PtrToInt(m_Value(Temp))))
3854             if (Temp->getType() == GEPTy)
3855               return Temp;
3856           return nullptr;
3857         };
3858
3859         // getelementptr V, (sub P, V) -> P if P points to a type of size 1.
3860         if (TyAllocSize == 1 &&
3861             match(Ops[1], m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0])))))
3862           if (Value *R = PtrToIntOrZero(P))
3863             return R;
3864
3865         // getelementptr V, (ashr (sub P, V), C) -> Q
3866         // if P points to a type of size 1 << C.
3867         if (match(Ops[1],
3868                   m_AShr(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3869                          m_ConstantInt(C))) &&
3870             TyAllocSize == 1ULL << C)
3871           if (Value *R = PtrToIntOrZero(P))
3872             return R;
3873
3874         // getelementptr V, (sdiv (sub P, V), C) -> Q
3875         // if P points to a type of size C.
3876         if (match(Ops[1],
3877                   m_SDiv(m_Sub(m_Value(P), m_PtrToInt(m_Specific(Ops[0]))),
3878                          m_SpecificInt(TyAllocSize))))
3879           if (Value *R = PtrToIntOrZero(P))
3880             return R;
3881       }
3882     }
3883   }
3884
3885   if (Q.DL.getTypeAllocSize(LastType) == 1 &&
3886       all_of(Ops.slice(1).drop_back(1),
3887              [](Value *Idx) { return match(Idx, m_Zero()); })) {
3888     unsigned IdxWidth =
3889         Q.DL.getIndexSizeInBits(Ops[0]->getType()->getPointerAddressSpace());
3890     if (Q.DL.getTypeSizeInBits(Ops.back()->getType()) == IdxWidth) {
3891       APInt BasePtrOffset(IdxWidth, 0);
3892       Value *StrippedBasePtr =
3893           Ops[0]->stripAndAccumulateInBoundsConstantOffsets(Q.DL,
3894                                                             BasePtrOffset);
3895
3896       // gep (gep V, C), (sub 0, V) -> C
3897       if (match(Ops.back(),
3898                 m_Sub(m_Zero(), m_PtrToInt(m_Specific(StrippedBasePtr))))) {
3899         auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset);
3900         return ConstantExpr::getIntToPtr(CI, GEPTy);
3901       }
3902       // gep (gep V, C), (xor V, -1) -> C-1
3903       if (match(Ops.back(),
3904                 m_Xor(m_PtrToInt(m_Specific(StrippedBasePtr)), m_AllOnes()))) {
3905         auto *CI = ConstantInt::get(GEPTy->getContext(), BasePtrOffset - 1);
3906         return ConstantExpr::getIntToPtr(CI, GEPTy);
3907       }
3908     }
3909   }
3910
3911   // Check to see if this is constant foldable.
3912   if (!all_of(Ops, [](Value *V) { return isa<Constant>(V); }))
3913     return nullptr;
3914
3915   auto *CE = ConstantExpr::getGetElementPtr(SrcTy, cast<Constant>(Ops[0]),
3916                                             Ops.slice(1));
3917   if (auto *CEFolded = ConstantFoldConstant(CE, Q.DL))
3918     return CEFolded;
3919   return CE;
3920 }
3921
3922 Value *llvm::SimplifyGEPInst(Type *SrcTy, ArrayRef<Value *> Ops,
3923                              const SimplifyQuery &Q) {
3924   return ::SimplifyGEPInst(SrcTy, Ops, Q, RecursionLimit);
3925 }
3926
3927 /// Given operands for an InsertValueInst, see if we can fold the result.
3928 /// If not, this returns null.
3929 static Value *SimplifyInsertValueInst(Value *Agg, Value *Val,
3930                                       ArrayRef<unsigned> Idxs, const SimplifyQuery &Q,
3931                                       unsigned) {
3932   if (Constant *CAgg = dyn_cast<Constant>(Agg))
3933     if (Constant *CVal = dyn_cast<Constant>(Val))
3934       return ConstantFoldInsertValueInstruction(CAgg, CVal, Idxs);
3935
3936   // insertvalue x, undef, n -> x
3937   if (match(Val, m_Undef()))
3938     return Agg;
3939
3940   // insertvalue x, (extractvalue y, n), n
3941   if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(Val))
3942     if (EV->getAggregateOperand()->getType() == Agg->getType() &&
3943         EV->getIndices() == Idxs) {
3944       // insertvalue undef, (extractvalue y, n), n -> y
3945       if (match(Agg, m_Undef()))
3946         return EV->getAggregateOperand();
3947
3948       // insertvalue y, (extractvalue y, n), n -> y
3949       if (Agg == EV->getAggregateOperand())
3950         return Agg;
3951     }
3952
3953   return nullptr;
3954 }
3955
3956 Value *llvm::SimplifyInsertValueInst(Value *Agg, Value *Val,
3957                                      ArrayRef<unsigned> Idxs,
3958                                      const SimplifyQuery &Q) {
3959   return ::SimplifyInsertValueInst(Agg, Val, Idxs, Q, RecursionLimit);
3960 }
3961
3962 Value *llvm::SimplifyInsertElementInst(Value *Vec, Value *Val, Value *Idx,
3963                                        const SimplifyQuery &Q) {
3964   // Try to constant fold.
3965   auto *VecC = dyn_cast<Constant>(Vec);
3966   auto *ValC = dyn_cast<Constant>(Val);
3967   auto *IdxC = dyn_cast<Constant>(Idx);
3968   if (VecC && ValC && IdxC)
3969     return ConstantFoldInsertElementInstruction(VecC, ValC, IdxC);
3970
3971   // Fold into undef if index is out of bounds.
3972   if (auto *CI = dyn_cast<ConstantInt>(Idx)) {
3973     uint64_t NumElements = cast<VectorType>(Vec->getType())->getNumElements();
3974     if (CI->uge(NumElements))
3975       return UndefValue::get(Vec->getType());
3976   }
3977
3978   // If index is undef, it might be out of bounds (see above case)
3979   if (isa<UndefValue>(Idx))
3980     return UndefValue::get(Vec->getType());
3981
3982   return nullptr;
3983 }
3984
3985 /// Given operands for an ExtractValueInst, see if we can fold the result.
3986 /// If not, this returns null.
3987 static Value *SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
3988                                        const SimplifyQuery &, unsigned) {
3989   if (auto *CAgg = dyn_cast<Constant>(Agg))
3990     return ConstantFoldExtractValueInstruction(CAgg, Idxs);
3991
3992   // extractvalue x, (insertvalue y, elt, n), n -> elt
3993   unsigned NumIdxs = Idxs.size();
3994   for (auto *IVI = dyn_cast<InsertValueInst>(Agg); IVI != nullptr;
3995        IVI = dyn_cast<InsertValueInst>(IVI->getAggregateOperand())) {
3996     ArrayRef<unsigned> InsertValueIdxs = IVI->getIndices();
3997     unsigned NumInsertValueIdxs = InsertValueIdxs.size();
3998     unsigned NumCommonIdxs = std::min(NumInsertValueIdxs, NumIdxs);
3999     if (InsertValueIdxs.slice(0, NumCommonIdxs) ==
4000         Idxs.slice(0, NumCommonIdxs)) {
4001       if (NumIdxs == NumInsertValueIdxs)
4002         return IVI->getInsertedValueOperand();
4003       break;
4004     }
4005   }
4006
4007   return nullptr;
4008 }
4009
4010 Value *llvm::SimplifyExtractValueInst(Value *Agg, ArrayRef<unsigned> Idxs,
4011                                       const SimplifyQuery &Q) {
4012   return ::SimplifyExtractValueInst(Agg, Idxs, Q, RecursionLimit);
4013 }
4014
4015 /// Given operands for an ExtractElementInst, see if we can fold the result.
4016 /// If not, this returns null.
4017 static Value *SimplifyExtractElementInst(Value *Vec, Value *Idx, const SimplifyQuery &,
4018                                          unsigned) {
4019   if (auto *CVec = dyn_cast<Constant>(Vec)) {
4020     if (auto *CIdx = dyn_cast<Constant>(Idx))
4021       return ConstantFoldExtractElementInstruction(CVec, CIdx);
4022
4023     // The index is not relevant if our vector is a splat.
4024     if (auto *Splat = CVec->getSplatValue())
4025       return Splat;
4026
4027     if (isa<UndefValue>(Vec))
4028       return UndefValue::get(Vec->getType()->getVectorElementType());
4029   }
4030
4031   // If extracting a specified index from the vector, see if we can recursively
4032   // find a previously computed scalar that was inserted into the vector.
4033   if (auto *IdxC = dyn_cast<ConstantInt>(Idx)) {
4034     if (IdxC->getValue().uge(Vec->getType()->getVectorNumElements()))
4035       // definitely out of bounds, thus undefined result
4036       return UndefValue::get(Vec->getType()->getVectorElementType());
4037     if (Value *Elt = findScalarElement(Vec, IdxC->getZExtValue()))
4038       return Elt;
4039   }
4040
4041   // An undef extract index can be arbitrarily chosen to be an out-of-range
4042   // index value, which would result in the instruction being undef.
4043   if (isa<UndefValue>(Idx))
4044     return UndefValue::get(Vec->getType()->getVectorElementType());
4045
4046   return nullptr;
4047 }
4048
4049 Value *llvm::SimplifyExtractElementInst(Value *Vec, Value *Idx,
4050                                         const SimplifyQuery &Q) {
4051   return ::SimplifyExtractElementInst(Vec, Idx, Q, RecursionLimit);
4052 }
4053
4054 /// See if we can fold the given phi. If not, returns null.
4055 static Value *SimplifyPHINode(PHINode *PN, const SimplifyQuery &Q) {
4056   // If all of the PHI's incoming values are the same then replace the PHI node
4057   // with the common value.
4058   Value *CommonValue = nullptr;
4059   bool HasUndefInput = false;
4060   for (Value *Incoming : PN->incoming_values()) {
4061     // If the incoming value is the phi node itself, it can safely be skipped.
4062     if (Incoming == PN) continue;
4063     if (isa<UndefValue>(Incoming)) {
4064       // Remember that we saw an undef value, but otherwise ignore them.
4065       HasUndefInput = true;
4066       continue;
4067     }
4068     if (CommonValue && Incoming != CommonValue)
4069       return nullptr;  // Not the same, bail out.
4070     CommonValue = Incoming;
4071   }
4072
4073   // If CommonValue is null then all of the incoming values were either undef or
4074   // equal to the phi node itself.
4075   if (!CommonValue)
4076     return UndefValue::get(PN->getType());
4077
4078   // If we have a PHI node like phi(X, undef, X), where X is defined by some
4079   // instruction, we cannot return X as the result of the PHI node unless it
4080   // dominates the PHI block.
4081   if (HasUndefInput)
4082     return valueDominatesPHI(CommonValue, PN, Q.DT) ? CommonValue : nullptr;
4083
4084   return CommonValue;
4085 }
4086
4087 static Value *SimplifyCastInst(unsigned CastOpc, Value *Op,
4088                                Type *Ty, const SimplifyQuery &Q, unsigned MaxRecurse) {
4089   if (auto *C = dyn_cast<Constant>(Op))
4090     return ConstantFoldCastOperand(CastOpc, C, Ty, Q.DL);
4091
4092   if (auto *CI = dyn_cast<CastInst>(Op)) {
4093     auto *Src = CI->getOperand(0);
4094     Type *SrcTy = Src->getType();
4095     Type *MidTy = CI->getType();
4096     Type *DstTy = Ty;
4097     if (Src->getType() == Ty) {
4098       auto FirstOp = static_cast<Instruction::CastOps>(CI->getOpcode());
4099       auto SecondOp = static_cast<Instruction::CastOps>(CastOpc);
4100       Type *SrcIntPtrTy =
4101           SrcTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(SrcTy) : nullptr;
4102       Type *MidIntPtrTy =
4103           MidTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(MidTy) : nullptr;
4104       Type *DstIntPtrTy =
4105           DstTy->isPtrOrPtrVectorTy() ? Q.DL.getIntPtrType(DstTy) : nullptr;
4106       if (CastInst::isEliminableCastPair(FirstOp, SecondOp, SrcTy, MidTy, DstTy,
4107                                          SrcIntPtrTy, MidIntPtrTy,
4108                                          DstIntPtrTy) == Instruction::BitCast)
4109         return Src;
4110     }
4111   }
4112
4113   // bitcast x -> x
4114   if (CastOpc == Instruction::BitCast)
4115     if (Op->getType() == Ty)
4116       return Op;
4117
4118   return nullptr;
4119 }
4120
4121 Value *llvm::SimplifyCastInst(unsigned CastOpc, Value *Op, Type *Ty,
4122                               const SimplifyQuery &Q) {
4123   return ::SimplifyCastInst(CastOpc, Op, Ty, Q, RecursionLimit);
4124 }
4125
4126 /// For the given destination element of a shuffle, peek through shuffles to
4127 /// match a root vector source operand that contains that element in the same
4128 /// vector lane (ie, the same mask index), so we can eliminate the shuffle(s).
4129 static Value *foldIdentityShuffles(int DestElt, Value *Op0, Value *Op1,
4130                                    int MaskVal, Value *RootVec,
4131                                    unsigned MaxRecurse) {
4132   if (!MaxRecurse--)
4133     return nullptr;
4134
4135   // Bail out if any mask value is undefined. That kind of shuffle may be
4136   // simplified further based on demanded bits or other folds.
4137   if (MaskVal == -1)
4138     return nullptr;
4139
4140   // The mask value chooses which source operand we need to look at next.
4141   int InVecNumElts = Op0->getType()->getVectorNumElements();
4142   int RootElt = MaskVal;
4143   Value *SourceOp = Op0;
4144   if (MaskVal >= InVecNumElts) {
4145     RootElt = MaskVal - InVecNumElts;
4146     SourceOp = Op1;
4147   }
4148
4149   // If the source operand is a shuffle itself, look through it to find the
4150   // matching root vector.
4151   if (auto *SourceShuf = dyn_cast<ShuffleVectorInst>(SourceOp)) {
4152     return foldIdentityShuffles(
4153         DestElt, SourceShuf->getOperand(0), SourceShuf->getOperand(1),
4154         SourceShuf->getMaskValue(RootElt), RootVec, MaxRecurse);
4155   }
4156
4157   // TODO: Look through bitcasts? What if the bitcast changes the vector element
4158   // size?
4159
4160   // The source operand is not a shuffle. Initialize the root vector value for
4161   // this shuffle if that has not been done yet.
4162   if (!RootVec)
4163     RootVec = SourceOp;
4164
4165   // Give up as soon as a source operand does not match the existing root value.
4166   if (RootVec != SourceOp)
4167     return nullptr;
4168
4169   // The element must be coming from the same lane in the source vector
4170   // (although it may have crossed lanes in intermediate shuffles).
4171   if (RootElt != DestElt)
4172     return nullptr;
4173
4174   return RootVec;
4175 }
4176
4177 static Value *SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4178                                         Type *RetTy, const SimplifyQuery &Q,
4179                                         unsigned MaxRecurse) {
4180   if (isa<UndefValue>(Mask))
4181     return UndefValue::get(RetTy);
4182
4183   Type *InVecTy = Op0->getType();
4184   unsigned MaskNumElts = Mask->getType()->getVectorNumElements();
4185   unsigned InVecNumElts = InVecTy->getVectorNumElements();
4186
4187   SmallVector<int, 32> Indices;
4188   ShuffleVectorInst::getShuffleMask(Mask, Indices);
4189   assert(MaskNumElts == Indices.size() &&
4190          "Size of Indices not same as number of mask elements?");
4191
4192   // Canonicalization: If mask does not select elements from an input vector,
4193   // replace that input vector with undef.
4194   bool MaskSelects0 = false, MaskSelects1 = false;
4195   for (unsigned i = 0; i != MaskNumElts; ++i) {
4196     if (Indices[i] == -1)
4197       continue;
4198     if ((unsigned)Indices[i] < InVecNumElts)
4199       MaskSelects0 = true;
4200     else
4201       MaskSelects1 = true;
4202   }
4203   if (!MaskSelects0)
4204     Op0 = UndefValue::get(InVecTy);
4205   if (!MaskSelects1)
4206     Op1 = UndefValue::get(InVecTy);
4207
4208   auto *Op0Const = dyn_cast<Constant>(Op0);
4209   auto *Op1Const = dyn_cast<Constant>(Op1);
4210
4211   // If all operands are constant, constant fold the shuffle.
4212   if (Op0Const && Op1Const)
4213     return ConstantFoldShuffleVectorInstruction(Op0Const, Op1Const, Mask);
4214
4215   // Canonicalization: if only one input vector is constant, it shall be the
4216   // second one.
4217   if (Op0Const && !Op1Const) {
4218     std::swap(Op0, Op1);
4219     ShuffleVectorInst::commuteShuffleMask(Indices, InVecNumElts);
4220   }
4221
4222   // A shuffle of a splat is always the splat itself. Legal if the shuffle's
4223   // value type is same as the input vectors' type.
4224   if (auto *OpShuf = dyn_cast<ShuffleVectorInst>(Op0))
4225     if (isa<UndefValue>(Op1) && RetTy == InVecTy &&
4226         OpShuf->getMask()->getSplatValue())
4227       return Op0;
4228
4229   // Don't fold a shuffle with undef mask elements. This may get folded in a
4230   // better way using demanded bits or other analysis.
4231   // TODO: Should we allow this?
4232   if (find(Indices, -1) != Indices.end())
4233     return nullptr;
4234
4235   // Check if every element of this shuffle can be mapped back to the
4236   // corresponding element of a single root vector. If so, we don't need this
4237   // shuffle. This handles simple identity shuffles as well as chains of
4238   // shuffles that may widen/narrow and/or move elements across lanes and back.
4239   Value *RootVec = nullptr;
4240   for (unsigned i = 0; i != MaskNumElts; ++i) {
4241     // Note that recursion is limited for each vector element, so if any element
4242     // exceeds the limit, this will fail to simplify.
4243     RootVec =
4244         foldIdentityShuffles(i, Op0, Op1, Indices[i], RootVec, MaxRecurse);
4245
4246     // We can't replace a widening/narrowing shuffle with one of its operands.
4247     if (!RootVec || RootVec->getType() != RetTy)
4248       return nullptr;
4249   }
4250   return RootVec;
4251 }
4252
4253 /// Given operands for a ShuffleVectorInst, fold the result or return null.
4254 Value *llvm::SimplifyShuffleVectorInst(Value *Op0, Value *Op1, Constant *Mask,
4255                                        Type *RetTy, const SimplifyQuery &Q) {
4256   return ::SimplifyShuffleVectorInst(Op0, Op1, Mask, RetTy, Q, RecursionLimit);
4257 }
4258
4259 static Constant *propagateNaN(Constant *In) {
4260   // If the input is a vector with undef elements, just return a default NaN.
4261   if (!In->isNaN())
4262     return ConstantFP::getNaN(In->getType());
4263
4264   // Propagate the existing NaN constant when possible.
4265   // TODO: Should we quiet a signaling NaN?
4266   return In;
4267 }
4268
4269 static Constant *simplifyFPBinop(Value *Op0, Value *Op1) {
4270   if (isa<UndefValue>(Op0) || isa<UndefValue>(Op1))
4271     return ConstantFP::getNaN(Op0->getType());
4272
4273   if (match(Op0, m_NaN()))
4274     return propagateNaN(cast<Constant>(Op0));
4275   if (match(Op1, m_NaN()))
4276     return propagateNaN(cast<Constant>(Op1));
4277
4278   return nullptr;
4279 }
4280
4281 /// Given operands for an FAdd, see if we can fold the result.  If not, this
4282 /// returns null.
4283 static Value *SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4284                                const SimplifyQuery &Q, unsigned MaxRecurse) {
4285   if (Constant *C = foldOrCommuteConstant(Instruction::FAdd, Op0, Op1, Q))
4286     return C;
4287
4288   if (Constant *C = simplifyFPBinop(Op0, Op1))
4289     return C;
4290
4291   // fadd X, -0 ==> X
4292   if (match(Op1, m_NegZeroFP()))
4293     return Op0;
4294
4295   // fadd X, 0 ==> X, when we know X is not -0
4296   if (match(Op1, m_PosZeroFP()) &&
4297       (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4298     return Op0;
4299
4300   // With nnan: (+/-0.0 - X) + X --> 0.0 (and commuted variant)
4301   // We don't have to explicitly exclude infinities (ninf): INF + -INF == NaN.
4302   // Negative zeros are allowed because we always end up with positive zero:
4303   // X = -0.0: (-0.0 - (-0.0)) + (-0.0) == ( 0.0) + (-0.0) == 0.0
4304   // X = -0.0: ( 0.0 - (-0.0)) + (-0.0) == ( 0.0) + (-0.0) == 0.0
4305   // X =  0.0: (-0.0 - ( 0.0)) + ( 0.0) == (-0.0) + ( 0.0) == 0.0
4306   // X =  0.0: ( 0.0 - ( 0.0)) + ( 0.0) == ( 0.0) + ( 0.0) == 0.0
4307   if (FMF.noNaNs() && (match(Op0, m_FSub(m_AnyZeroFP(), m_Specific(Op1))) ||
4308                        match(Op1, m_FSub(m_AnyZeroFP(), m_Specific(Op0)))))
4309     return ConstantFP::getNullValue(Op0->getType());
4310
4311   return nullptr;
4312 }
4313
4314 /// Given operands for an FSub, see if we can fold the result.  If not, this
4315 /// returns null.
4316 static Value *SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4317                                const SimplifyQuery &Q, unsigned MaxRecurse) {
4318   if (Constant *C = foldOrCommuteConstant(Instruction::FSub, Op0, Op1, Q))
4319     return C;
4320
4321   if (Constant *C = simplifyFPBinop(Op0, Op1))
4322     return C;
4323
4324   // fsub X, +0 ==> X
4325   if (match(Op1, m_PosZeroFP()))
4326     return Op0;
4327
4328   // fsub X, -0 ==> X, when we know X is not -0
4329   if (match(Op1, m_NegZeroFP()) &&
4330       (FMF.noSignedZeros() || CannotBeNegativeZero(Op0, Q.TLI)))
4331     return Op0;
4332
4333   // fsub -0.0, (fsub -0.0, X) ==> X
4334   Value *X;
4335   if (match(Op0, m_NegZeroFP()) &&
4336       match(Op1, m_FSub(m_NegZeroFP(), m_Value(X))))
4337     return X;
4338
4339   // fsub 0.0, (fsub 0.0, X) ==> X if signed zeros are ignored.
4340   if (FMF.noSignedZeros() && match(Op0, m_AnyZeroFP()) &&
4341       match(Op1, m_FSub(m_AnyZeroFP(), m_Value(X))))
4342     return X;
4343
4344   // fsub nnan x, x ==> 0.0
4345   if (FMF.noNaNs() && Op0 == Op1)
4346     return Constant::getNullValue(Op0->getType());
4347
4348   return nullptr;
4349 }
4350
4351 /// Given the operands for an FMul, see if we can fold the result
4352 static Value *SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4353                                const SimplifyQuery &Q, unsigned MaxRecurse) {
4354   if (Constant *C = foldOrCommuteConstant(Instruction::FMul, Op0, Op1, Q))
4355     return C;
4356
4357   if (Constant *C = simplifyFPBinop(Op0, Op1))
4358     return C;
4359
4360   // fmul X, 1.0 ==> X
4361   if (match(Op1, m_FPOne()))
4362     return Op0;
4363
4364   // fmul nnan nsz X, 0 ==> 0
4365   if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op1, m_AnyZeroFP()))
4366     return ConstantFP::getNullValue(Op0->getType());
4367
4368   // sqrt(X) * sqrt(X) --> X, if we can:
4369   // 1. Remove the intermediate rounding (reassociate).
4370   // 2. Ignore non-zero negative numbers because sqrt would produce NAN.
4371   // 3. Ignore -0.0 because sqrt(-0.0) == -0.0, but -0.0 * -0.0 == 0.0.
4372   Value *X;
4373   if (Op0 == Op1 && match(Op0, m_Intrinsic<Intrinsic::sqrt>(m_Value(X))) &&
4374       FMF.allowReassoc() && FMF.noNaNs() && FMF.noSignedZeros())
4375     return X;
4376
4377   return nullptr;
4378 }
4379
4380 Value *llvm::SimplifyFAddInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4381                               const SimplifyQuery &Q) {
4382   return ::SimplifyFAddInst(Op0, Op1, FMF, Q, RecursionLimit);
4383 }
4384
4385
4386 Value *llvm::SimplifyFSubInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4387                               const SimplifyQuery &Q) {
4388   return ::SimplifyFSubInst(Op0, Op1, FMF, Q, RecursionLimit);
4389 }
4390
4391 Value *llvm::SimplifyFMulInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4392                               const SimplifyQuery &Q) {
4393   return ::SimplifyFMulInst(Op0, Op1, FMF, Q, RecursionLimit);
4394 }
4395
4396 static Value *SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4397                                const SimplifyQuery &Q, unsigned) {
4398   if (Constant *C = foldOrCommuteConstant(Instruction::FDiv, Op0, Op1, Q))
4399     return C;
4400
4401   if (Constant *C = simplifyFPBinop(Op0, Op1))
4402     return C;
4403
4404   // X / 1.0 -> X
4405   if (match(Op1, m_FPOne()))
4406     return Op0;
4407
4408   // 0 / X -> 0
4409   // Requires that NaNs are off (X could be zero) and signed zeroes are
4410   // ignored (X could be positive or negative, so the output sign is unknown).
4411   if (FMF.noNaNs() && FMF.noSignedZeros() && match(Op0, m_AnyZeroFP()))
4412     return ConstantFP::getNullValue(Op0->getType());
4413
4414   if (FMF.noNaNs()) {
4415     // X / X -> 1.0 is legal when NaNs are ignored.
4416     // We can ignore infinities because INF/INF is NaN.
4417     if (Op0 == Op1)
4418       return ConstantFP::get(Op0->getType(), 1.0);
4419
4420     // (X * Y) / Y --> X if we can reassociate to the above form.
4421     Value *X;
4422     if (FMF.allowReassoc() && match(Op0, m_c_FMul(m_Value(X), m_Specific(Op1))))
4423       return X;
4424
4425     // -X /  X -> -1.0 and
4426     //  X / -X -> -1.0 are legal when NaNs are ignored.
4427     // We can ignore signed zeros because +-0.0/+-0.0 is NaN and ignored.
4428     if ((BinaryOperator::isFNeg(Op0, /*IgnoreZeroSign=*/true) &&
4429          BinaryOperator::getFNegArgument(Op0) == Op1) ||
4430         (BinaryOperator::isFNeg(Op1, /*IgnoreZeroSign=*/true) &&
4431          BinaryOperator::getFNegArgument(Op1) == Op0))
4432       return ConstantFP::get(Op0->getType(), -1.0);
4433   }
4434
4435   return nullptr;
4436 }
4437
4438 Value *llvm::SimplifyFDivInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4439                               const SimplifyQuery &Q) {
4440   return ::SimplifyFDivInst(Op0, Op1, FMF, Q, RecursionLimit);
4441 }
4442
4443 static Value *SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4444                                const SimplifyQuery &Q, unsigned) {
4445   if (Constant *C = foldOrCommuteConstant(Instruction::FRem, Op0, Op1, Q))
4446     return C;
4447
4448   if (Constant *C = simplifyFPBinop(Op0, Op1))
4449     return C;
4450
4451   // Unlike fdiv, the result of frem always matches the sign of the dividend.
4452   // The constant match may include undef elements in a vector, so return a full
4453   // zero constant as the result.
4454   if (FMF.noNaNs()) {
4455     // +0 % X -> 0
4456     if (match(Op0, m_PosZeroFP()))
4457       return ConstantFP::getNullValue(Op0->getType());
4458     // -0 % X -> -0
4459     if (match(Op0, m_NegZeroFP()))
4460       return ConstantFP::getNegativeZero(Op0->getType());
4461   }
4462
4463   return nullptr;
4464 }
4465
4466 Value *llvm::SimplifyFRemInst(Value *Op0, Value *Op1, FastMathFlags FMF,
4467                               const SimplifyQuery &Q) {
4468   return ::SimplifyFRemInst(Op0, Op1, FMF, Q, RecursionLimit);
4469 }
4470
4471 //=== Helper functions for higher up the class hierarchy.
4472
4473 /// Given operands for a BinaryOperator, see if we can fold the result.
4474 /// If not, this returns null.
4475 static Value *SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
4476                             const SimplifyQuery &Q, unsigned MaxRecurse) {
4477   switch (Opcode) {
4478   case Instruction::Add:
4479     return SimplifyAddInst(LHS, RHS, false, false, Q, MaxRecurse);
4480   case Instruction::Sub:
4481     return SimplifySubInst(LHS, RHS, false, false, Q, MaxRecurse);
4482   case Instruction::Mul:
4483     return SimplifyMulInst(LHS, RHS, Q, MaxRecurse);
4484   case Instruction::SDiv:
4485     return SimplifySDivInst(LHS, RHS, Q, MaxRecurse);
4486   case Instruction::UDiv:
4487     return SimplifyUDivInst(LHS, RHS, Q, MaxRecurse);
4488   case Instruction::SRem:
4489     return SimplifySRemInst(LHS, RHS, Q, MaxRecurse);
4490   case Instruction::URem:
4491     return SimplifyURemInst(LHS, RHS, Q, MaxRecurse);
4492   case Instruction::Shl:
4493     return SimplifyShlInst(LHS, RHS, false, false, Q, MaxRecurse);
4494   case Instruction::LShr:
4495     return SimplifyLShrInst(LHS, RHS, false, Q, MaxRecurse);
4496   case Instruction::AShr:
4497     return SimplifyAShrInst(LHS, RHS, false, Q, MaxRecurse);
4498   case Instruction::And:
4499     return SimplifyAndInst(LHS, RHS, Q, MaxRecurse);
4500   case Instruction::Or:
4501     return SimplifyOrInst(LHS, RHS, Q, MaxRecurse);
4502   case Instruction::Xor:
4503     return SimplifyXorInst(LHS, RHS, Q, MaxRecurse);
4504   case Instruction::FAdd:
4505     return SimplifyFAddInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4506   case Instruction::FSub:
4507     return SimplifyFSubInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4508   case Instruction::FMul:
4509     return SimplifyFMulInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4510   case Instruction::FDiv:
4511     return SimplifyFDivInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4512   case Instruction::FRem:
4513     return SimplifyFRemInst(LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4514   default:
4515     llvm_unreachable("Unexpected opcode");
4516   }
4517 }
4518
4519 /// Given operands for a BinaryOperator, see if we can fold the result.
4520 /// If not, this returns null.
4521 /// In contrast to SimplifyBinOp, try to use FastMathFlag when folding the
4522 /// result. In case we don't need FastMathFlags, simply fall to SimplifyBinOp.
4523 static Value *SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
4524                               const FastMathFlags &FMF, const SimplifyQuery &Q,
4525                               unsigned MaxRecurse) {
4526   switch (Opcode) {
4527   case Instruction::FAdd:
4528     return SimplifyFAddInst(LHS, RHS, FMF, Q, MaxRecurse);
4529   case Instruction::FSub:
4530     return SimplifyFSubInst(LHS, RHS, FMF, Q, MaxRecurse);
4531   case Instruction::FMul:
4532     return SimplifyFMulInst(LHS, RHS, FMF, Q, MaxRecurse);
4533   case Instruction::FDiv:
4534     return SimplifyFDivInst(LHS, RHS, FMF, Q, MaxRecurse);
4535   default:
4536     return SimplifyBinOp(Opcode, LHS, RHS, Q, MaxRecurse);
4537   }
4538 }
4539
4540 Value *llvm::SimplifyBinOp(unsigned Opcode, Value *LHS, Value *RHS,
4541                            const SimplifyQuery &Q) {
4542   return ::SimplifyBinOp(Opcode, LHS, RHS, Q, RecursionLimit);
4543 }
4544
4545 Value *llvm::SimplifyFPBinOp(unsigned Opcode, Value *LHS, Value *RHS,
4546                              FastMathFlags FMF, const SimplifyQuery &Q) {
4547   return ::SimplifyFPBinOp(Opcode, LHS, RHS, FMF, Q, RecursionLimit);
4548 }
4549
4550 /// Given operands for a CmpInst, see if we can fold the result.
4551 static Value *SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
4552                               const SimplifyQuery &Q, unsigned MaxRecurse) {
4553   if (CmpInst::isIntPredicate((CmpInst::Predicate)Predicate))
4554     return SimplifyICmpInst(Predicate, LHS, RHS, Q, MaxRecurse);
4555   return SimplifyFCmpInst(Predicate, LHS, RHS, FastMathFlags(), Q, MaxRecurse);
4556 }
4557
4558 Value *llvm::SimplifyCmpInst(unsigned Predicate, Value *LHS, Value *RHS,
4559                              const SimplifyQuery &Q) {
4560   return ::SimplifyCmpInst(Predicate, LHS, RHS, Q, RecursionLimit);
4561 }
4562
4563 static bool IsIdempotent(Intrinsic::ID ID) {
4564   switch (ID) {
4565   default: return false;
4566
4567   // Unary idempotent: f(f(x)) = f(x)
4568   case Intrinsic::fabs:
4569   case Intrinsic::floor:
4570   case Intrinsic::ceil:
4571   case Intrinsic::trunc:
4572   case Intrinsic::rint:
4573   case Intrinsic::nearbyint:
4574   case Intrinsic::round:
4575   case Intrinsic::canonicalize:
4576     return true;
4577   }
4578 }
4579
4580 static Value *SimplifyRelativeLoad(Constant *Ptr, Constant *Offset,
4581                                    const DataLayout &DL) {
4582   GlobalValue *PtrSym;
4583   APInt PtrOffset;
4584   if (!IsConstantOffsetFromGlobal(Ptr, PtrSym, PtrOffset, DL))
4585     return nullptr;
4586
4587   Type *Int8PtrTy = Type::getInt8PtrTy(Ptr->getContext());
4588   Type *Int32Ty = Type::getInt32Ty(Ptr->getContext());
4589   Type *Int32PtrTy = Int32Ty->getPointerTo();
4590   Type *Int64Ty = Type::getInt64Ty(Ptr->getContext());
4591
4592   auto *OffsetConstInt = dyn_cast<ConstantInt>(Offset);
4593   if (!OffsetConstInt || OffsetConstInt->getType()->getBitWidth() > 64)
4594     return nullptr;
4595
4596   uint64_t OffsetInt = OffsetConstInt->getSExtValue();
4597   if (OffsetInt % 4 != 0)
4598     return nullptr;
4599
4600   Constant *C = ConstantExpr::getGetElementPtr(
4601       Int32Ty, ConstantExpr::getBitCast(Ptr, Int32PtrTy),
4602       ConstantInt::get(Int64Ty, OffsetInt / 4));
4603   Constant *Loaded = ConstantFoldLoadFromConstPtr(C, Int32Ty, DL);
4604   if (!Loaded)
4605     return nullptr;
4606
4607   auto *LoadedCE = dyn_cast<ConstantExpr>(Loaded);
4608   if (!LoadedCE)
4609     return nullptr;
4610
4611   if (LoadedCE->getOpcode() == Instruction::Trunc) {
4612     LoadedCE = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4613     if (!LoadedCE)
4614       return nullptr;
4615   }
4616
4617   if (LoadedCE->getOpcode() != Instruction::Sub)
4618     return nullptr;
4619
4620   auto *LoadedLHS = dyn_cast<ConstantExpr>(LoadedCE->getOperand(0));
4621   if (!LoadedLHS || LoadedLHS->getOpcode() != Instruction::PtrToInt)
4622     return nullptr;
4623   auto *LoadedLHSPtr = LoadedLHS->getOperand(0);
4624
4625   Constant *LoadedRHS = LoadedCE->getOperand(1);
4626   GlobalValue *LoadedRHSSym;
4627   APInt LoadedRHSOffset;
4628   if (!IsConstantOffsetFromGlobal(LoadedRHS, LoadedRHSSym, LoadedRHSOffset,
4629                                   DL) ||
4630       PtrSym != LoadedRHSSym || PtrOffset != LoadedRHSOffset)
4631     return nullptr;
4632
4633   return ConstantExpr::getBitCast(LoadedLHSPtr, Int8PtrTy);
4634 }
4635
4636 static bool maskIsAllZeroOrUndef(Value *Mask) {
4637   auto *ConstMask = dyn_cast<Constant>(Mask);
4638   if (!ConstMask)
4639     return false;
4640   if (ConstMask->isNullValue() || isa<UndefValue>(ConstMask))
4641     return true;
4642   for (unsigned I = 0, E = ConstMask->getType()->getVectorNumElements(); I != E;
4643        ++I) {
4644     if (auto *MaskElt = ConstMask->getAggregateElement(I))
4645       if (MaskElt->isNullValue() || isa<UndefValue>(MaskElt))
4646         continue;
4647     return false;
4648   }
4649   return true;
4650 }
4651
4652 static Value *simplifyUnaryIntrinsic(Function *F, Value *Op0,
4653                                      const SimplifyQuery &Q) {
4654   // Idempotent functions return the same result when called repeatedly.
4655   Intrinsic::ID IID = F->getIntrinsicID();
4656   if (IsIdempotent(IID))
4657     if (auto *II = dyn_cast<IntrinsicInst>(Op0))
4658       if (II->getIntrinsicID() == IID)
4659         return II;
4660
4661   Value *X;
4662   switch (IID) {
4663   case Intrinsic::fabs:
4664     if (SignBitMustBeZero(Op0, Q.TLI)) return Op0;
4665     break;
4666   case Intrinsic::bswap:
4667     // bswap(bswap(x)) -> x
4668     if (match(Op0, m_BSwap(m_Value(X)))) return X;
4669     break;
4670   case Intrinsic::bitreverse:
4671     // bitreverse(bitreverse(x)) -> x
4672     if (match(Op0, m_BitReverse(m_Value(X)))) return X;
4673     break;
4674   case Intrinsic::exp:
4675     // exp(log(x)) -> x
4676     if (Q.CxtI->hasAllowReassoc() &&
4677         match(Op0, m_Intrinsic<Intrinsic::log>(m_Value(X)))) return X;
4678     break;
4679   case Intrinsic::exp2:
4680     // exp2(log2(x)) -> x
4681     if (Q.CxtI->hasAllowReassoc() &&
4682         match(Op0, m_Intrinsic<Intrinsic::log2>(m_Value(X)))) return X;
4683     break;
4684   case Intrinsic::log:
4685     // log(exp(x)) -> x
4686     if (Q.CxtI->hasAllowReassoc() &&
4687         match(Op0, m_Intrinsic<Intrinsic::exp>(m_Value(X)))) return X;
4688     break;
4689   case Intrinsic::log2:
4690     // log2(exp2(x)) -> x
4691     if (Q.CxtI->hasAllowReassoc() &&
4692         match(Op0, m_Intrinsic<Intrinsic::exp2>(m_Value(X)))) return X;
4693     break;
4694   default:
4695     break;
4696   }
4697
4698   return nullptr;
4699 }
4700
4701 static Value *simplifyBinaryIntrinsic(Function *F, Value *Op0, Value *Op1,
4702                                       const SimplifyQuery &Q) {
4703   Intrinsic::ID IID = F->getIntrinsicID();
4704   Type *ReturnType = F->getReturnType();
4705   switch (IID) {
4706   case Intrinsic::usub_with_overflow:
4707   case Intrinsic::ssub_with_overflow:
4708     // X - X -> { 0, false }
4709     if (Op0 == Op1)
4710       return Constant::getNullValue(ReturnType);
4711     // X - undef -> undef
4712     // undef - X -> undef
4713     if (isa<UndefValue>(Op0) || isa<UndefValue>(Op1))
4714       return UndefValue::get(ReturnType);
4715     break;
4716   case Intrinsic::uadd_with_overflow:
4717   case Intrinsic::sadd_with_overflow:
4718     // X + undef -> undef
4719     if (isa<UndefValue>(Op0) || isa<UndefValue>(Op1))
4720       return UndefValue::get(ReturnType);
4721     break;
4722   case Intrinsic::umul_with_overflow:
4723   case Intrinsic::smul_with_overflow:
4724     // 0 * X -> { 0, false }
4725     // X * 0 -> { 0, false }
4726     if (match(Op0, m_Zero()) || match(Op1, m_Zero()))
4727       return Constant::getNullValue(ReturnType);
4728     // undef * X -> { 0, false }
4729     // X * undef -> { 0, false }
4730     if (match(Op0, m_Undef()) || match(Op1, m_Undef()))
4731       return Constant::getNullValue(ReturnType);
4732     break;
4733   case Intrinsic::load_relative:
4734     if (auto *C0 = dyn_cast<Constant>(Op0))
4735       if (auto *C1 = dyn_cast<Constant>(Op1))
4736         return SimplifyRelativeLoad(C0, C1, Q.DL);
4737     break;
4738   case Intrinsic::powi:
4739     if (auto *Power = dyn_cast<ConstantInt>(Op1)) {
4740       // powi(x, 0) -> 1.0
4741       if (Power->isZero())
4742         return ConstantFP::get(Op0->getType(), 1.0);
4743       // powi(x, 1) -> x
4744       if (Power->isOne())
4745         return Op0;
4746     }
4747     break;
4748   case Intrinsic::maxnum:
4749   case Intrinsic::minnum:
4750     // If one argument is NaN, return the other argument.
4751     if (match(Op0, m_NaN())) return Op1;
4752     if (match(Op1, m_NaN())) return Op0;
4753     break;
4754   default:
4755     break;
4756   }
4757
4758   return nullptr;
4759 }
4760
4761 template <typename IterTy>
4762 static Value *simplifyIntrinsic(Function *F, IterTy ArgBegin, IterTy ArgEnd,
4763                                 const SimplifyQuery &Q) {
4764   // Intrinsics with no operands have some kind of side effect. Don't simplify.
4765   unsigned NumOperands = std::distance(ArgBegin, ArgEnd);
4766   if (NumOperands == 0)
4767     return nullptr;
4768
4769   Intrinsic::ID IID = F->getIntrinsicID();
4770   if (NumOperands == 1)
4771     return simplifyUnaryIntrinsic(F, ArgBegin[0], Q);
4772
4773   if (NumOperands == 2)
4774     return simplifyBinaryIntrinsic(F, ArgBegin[0], ArgBegin[1], Q);
4775
4776   // Handle intrinsics with 3 or more arguments.
4777   switch (IID) {
4778   case Intrinsic::masked_load: {
4779     Value *MaskArg = ArgBegin[2];
4780     Value *PassthruArg = ArgBegin[3];
4781     // If the mask is all zeros or undef, the "passthru" argument is the result.
4782     if (maskIsAllZeroOrUndef(MaskArg))
4783       return PassthruArg;
4784     return nullptr;
4785   }
4786   case Intrinsic::fshl:
4787   case Intrinsic::fshr: {
4788     Value *ShAmtArg = ArgBegin[2];
4789     const APInt *ShAmtC;
4790     if (match(ShAmtArg, m_APInt(ShAmtC))) {
4791       // If there's effectively no shift, return the 1st arg or 2nd arg.
4792       // TODO: For vectors, we could check each element of a non-splat constant.
4793       APInt BitWidth = APInt(ShAmtC->getBitWidth(), ShAmtC->getBitWidth());
4794       if (ShAmtC->urem(BitWidth).isNullValue())
4795         return ArgBegin[IID == Intrinsic::fshl ? 0 : 1];
4796     }
4797     return nullptr;
4798   }
4799   default:
4800     return nullptr;
4801   }
4802 }
4803
4804 template <typename IterTy>
4805 static Value *SimplifyCall(ImmutableCallSite CS, Value *V, IterTy ArgBegin,
4806                            IterTy ArgEnd, const SimplifyQuery &Q,
4807                            unsigned MaxRecurse) {
4808   Type *Ty = V->getType();
4809   if (PointerType *PTy = dyn_cast<PointerType>(Ty))
4810     Ty = PTy->getElementType();
4811   FunctionType *FTy = cast<FunctionType>(Ty);
4812
4813   // call undef -> undef
4814   // call null -> undef
4815   if (isa<UndefValue>(V) || isa<ConstantPointerNull>(V))
4816     return UndefValue::get(FTy->getReturnType());
4817
4818   Function *F = dyn_cast<Function>(V);
4819   if (!F)
4820     return nullptr;
4821
4822   if (F->isIntrinsic())
4823     if (Value *Ret = simplifyIntrinsic(F, ArgBegin, ArgEnd, Q))
4824       return Ret;
4825
4826   if (!canConstantFoldCallTo(CS, F))
4827     return nullptr;
4828
4829   SmallVector<Constant *, 4> ConstantArgs;
4830   ConstantArgs.reserve(ArgEnd - ArgBegin);
4831   for (IterTy I = ArgBegin, E = ArgEnd; I != E; ++I) {
4832     Constant *C = dyn_cast<Constant>(*I);
4833     if (!C)
4834       return nullptr;
4835     ConstantArgs.push_back(C);
4836   }
4837
4838   return ConstantFoldCall(CS, F, ConstantArgs, Q.TLI);
4839 }
4840
4841 Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
4842                           User::op_iterator ArgBegin, User::op_iterator ArgEnd,
4843                           const SimplifyQuery &Q) {
4844   return ::SimplifyCall(CS, V, ArgBegin, ArgEnd, Q, RecursionLimit);
4845 }
4846
4847 Value *llvm::SimplifyCall(ImmutableCallSite CS, Value *V,
4848                           ArrayRef<Value *> Args, const SimplifyQuery &Q) {
4849   return ::SimplifyCall(CS, V, Args.begin(), Args.end(), Q, RecursionLimit);
4850 }
4851
4852 Value *llvm::SimplifyCall(ImmutableCallSite ICS, const SimplifyQuery &Q) {
4853   CallSite CS(const_cast<Instruction*>(ICS.getInstruction()));
4854   return ::SimplifyCall(CS, CS.getCalledValue(), CS.arg_begin(), CS.arg_end(),
4855                         Q, RecursionLimit);
4856 }
4857
4858 /// See if we can compute a simplified version of this instruction.
4859 /// If not, this returns null.
4860
4861 Value *llvm::SimplifyInstruction(Instruction *I, const SimplifyQuery &SQ,
4862                                  OptimizationRemarkEmitter *ORE) {
4863   const SimplifyQuery Q = SQ.CxtI ? SQ : SQ.getWithInstruction(I);
4864   Value *Result;
4865
4866   switch (I->getOpcode()) {
4867   default:
4868     Result = ConstantFoldInstruction(I, Q.DL, Q.TLI);
4869     break;
4870   case Instruction::FAdd:
4871     Result = SimplifyFAddInst(I->getOperand(0), I->getOperand(1),
4872                               I->getFastMathFlags(), Q);
4873     break;
4874   case Instruction::Add:
4875     Result = SimplifyAddInst(I->getOperand(0), I->getOperand(1),
4876                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
4877                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
4878     break;
4879   case Instruction::FSub:
4880     Result = SimplifyFSubInst(I->getOperand(0), I->getOperand(1),
4881                               I->getFastMathFlags(), Q);
4882     break;
4883   case Instruction::Sub:
4884     Result = SimplifySubInst(I->getOperand(0), I->getOperand(1),
4885                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
4886                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
4887     break;
4888   case Instruction::FMul:
4889     Result = SimplifyFMulInst(I->getOperand(0), I->getOperand(1),
4890                               I->getFastMathFlags(), Q);
4891     break;
4892   case Instruction::Mul:
4893     Result = SimplifyMulInst(I->getOperand(0), I->getOperand(1), Q);
4894     break;
4895   case Instruction::SDiv:
4896     Result = SimplifySDivInst(I->getOperand(0), I->getOperand(1), Q);
4897     break;
4898   case Instruction::UDiv:
4899     Result = SimplifyUDivInst(I->getOperand(0), I->getOperand(1), Q);
4900     break;
4901   case Instruction::FDiv:
4902     Result = SimplifyFDivInst(I->getOperand(0), I->getOperand(1),
4903                               I->getFastMathFlags(), Q);
4904     break;
4905   case Instruction::SRem:
4906     Result = SimplifySRemInst(I->getOperand(0), I->getOperand(1), Q);
4907     break;
4908   case Instruction::URem:
4909     Result = SimplifyURemInst(I->getOperand(0), I->getOperand(1), Q);
4910     break;
4911   case Instruction::FRem:
4912     Result = SimplifyFRemInst(I->getOperand(0), I->getOperand(1),
4913                               I->getFastMathFlags(), Q);
4914     break;
4915   case Instruction::Shl:
4916     Result = SimplifyShlInst(I->getOperand(0), I->getOperand(1),
4917                              cast<BinaryOperator>(I)->hasNoSignedWrap(),
4918                              cast<BinaryOperator>(I)->hasNoUnsignedWrap(), Q);
4919     break;
4920   case Instruction::LShr:
4921     Result = SimplifyLShrInst(I->getOperand(0), I->getOperand(1),
4922                               cast<BinaryOperator>(I)->isExact(), Q);
4923     break;
4924   case Instruction::AShr:
4925     Result = SimplifyAShrInst(I->getOperand(0), I->getOperand(1),
4926                               cast<BinaryOperator>(I)->isExact(), Q);
4927     break;
4928   case Instruction::And:
4929     Result = SimplifyAndInst(I->getOperand(0), I->getOperand(1), Q);
4930     break;
4931   case Instruction::Or:
4932     Result = SimplifyOrInst(I->getOperand(0), I->getOperand(1), Q);
4933     break;
4934   case Instruction::Xor:
4935     Result = SimplifyXorInst(I->getOperand(0), I->getOperand(1), Q);
4936     break;
4937   case Instruction::ICmp:
4938     Result = SimplifyICmpInst(cast<ICmpInst>(I)->getPredicate(),
4939                               I->getOperand(0), I->getOperand(1), Q);
4940     break;
4941   case Instruction::FCmp:
4942     Result =
4943         SimplifyFCmpInst(cast<FCmpInst>(I)->getPredicate(), I->getOperand(0),
4944                          I->getOperand(1), I->getFastMathFlags(), Q);
4945     break;
4946   case Instruction::Select:
4947     Result = SimplifySelectInst(I->getOperand(0), I->getOperand(1),
4948                                 I->getOperand(2), Q);
4949     break;
4950   case Instruction::GetElementPtr: {
4951     SmallVector<Value *, 8> Ops(I->op_begin(), I->op_end());
4952     Result = SimplifyGEPInst(cast<GetElementPtrInst>(I)->getSourceElementType(),
4953                              Ops, Q);
4954     break;
4955   }
4956   case Instruction::InsertValue: {
4957     InsertValueInst *IV = cast<InsertValueInst>(I);
4958     Result = SimplifyInsertValueInst(IV->getAggregateOperand(),
4959                                      IV->getInsertedValueOperand(),
4960                                      IV->getIndices(), Q);
4961     break;
4962   }
4963   case Instruction::InsertElement: {
4964     auto *IE = cast<InsertElementInst>(I);
4965     Result = SimplifyInsertElementInst(IE->getOperand(0), IE->getOperand(1),
4966                                        IE->getOperand(2), Q);
4967     break;
4968   }
4969   case Instruction::ExtractValue: {
4970     auto *EVI = cast<ExtractValueInst>(I);
4971     Result = SimplifyExtractValueInst(EVI->getAggregateOperand(),
4972                                       EVI->getIndices(), Q);
4973     break;
4974   }
4975   case Instruction::ExtractElement: {
4976     auto *EEI = cast<ExtractElementInst>(I);
4977     Result = SimplifyExtractElementInst(EEI->getVectorOperand(),
4978                                         EEI->getIndexOperand(), Q);
4979     break;
4980   }
4981   case Instruction::ShuffleVector: {
4982     auto *SVI = cast<ShuffleVectorInst>(I);
4983     Result = SimplifyShuffleVectorInst(SVI->getOperand(0), SVI->getOperand(1),
4984                                        SVI->getMask(), SVI->getType(), Q);
4985     break;
4986   }
4987   case Instruction::PHI:
4988     Result = SimplifyPHINode(cast<PHINode>(I), Q);
4989     break;
4990   case Instruction::Call: {
4991     CallSite CS(cast<CallInst>(I));
4992     Result = SimplifyCall(CS, Q);
4993     break;
4994   }
4995 #define HANDLE_CAST_INST(num, opc, clas) case Instruction::opc:
4996 #include "llvm/IR/Instruction.def"
4997 #undef HANDLE_CAST_INST
4998     Result =
4999         SimplifyCastInst(I->getOpcode(), I->getOperand(0), I->getType(), Q);
5000     break;
5001   case Instruction::Alloca:
5002     // No simplifications for Alloca and it can't be constant folded.
5003     Result = nullptr;
5004     break;
5005   }
5006
5007   // In general, it is possible for computeKnownBits to determine all bits in a
5008   // value even when the operands are not all constants.
5009   if (!Result && I->getType()->isIntOrIntVectorTy()) {
5010     KnownBits Known = computeKnownBits(I, Q.DL, /*Depth*/ 0, Q.AC, I, Q.DT, ORE);
5011     if (Known.isConstant())
5012       Result = ConstantInt::get(I->getType(), Known.getConstant());
5013   }
5014
5015   /// If called on unreachable code, the above logic may report that the
5016   /// instruction simplified to itself.  Make life easier for users by
5017   /// detecting that case here, returning a safe value instead.
5018   return Result == I ? UndefValue::get(I->getType()) : Result;
5019 }
5020
5021 /// Implementation of recursive simplification through an instruction's
5022 /// uses.
5023 ///
5024 /// This is the common implementation of the recursive simplification routines.
5025 /// If we have a pre-simplified value in 'SimpleV', that is forcibly used to
5026 /// replace the instruction 'I'. Otherwise, we simply add 'I' to the list of
5027 /// instructions to process and attempt to simplify it using
5028 /// InstructionSimplify.
5029 ///
5030 /// This routine returns 'true' only when *it* simplifies something. The passed
5031 /// in simplified value does not count toward this.
5032 static bool replaceAndRecursivelySimplifyImpl(Instruction *I, Value *SimpleV,
5033                                               const TargetLibraryInfo *TLI,
5034                                               const DominatorTree *DT,
5035                                               AssumptionCache *AC) {
5036   bool Simplified = false;
5037   SmallSetVector<Instruction *, 8> Worklist;
5038   const DataLayout &DL = I->getModule()->getDataLayout();
5039
5040   // If we have an explicit value to collapse to, do that round of the
5041   // simplification loop by hand initially.
5042   if (SimpleV) {
5043     for (User *U : I->users())
5044       if (U != I)
5045         Worklist.insert(cast<Instruction>(U));
5046
5047     // Replace the instruction with its simplified value.
5048     I->replaceAllUsesWith(SimpleV);
5049
5050     // Gracefully handle edge cases where the instruction is not wired into any
5051     // parent block.
5052     if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
5053         !I->mayHaveSideEffects())
5054       I->eraseFromParent();
5055   } else {
5056     Worklist.insert(I);
5057   }
5058
5059   // Note that we must test the size on each iteration, the worklist can grow.
5060   for (unsigned Idx = 0; Idx != Worklist.size(); ++Idx) {
5061     I = Worklist[Idx];
5062
5063     // See if this instruction simplifies.
5064     SimpleV = SimplifyInstruction(I, {DL, TLI, DT, AC});
5065     if (!SimpleV)
5066       continue;
5067
5068     Simplified = true;
5069
5070     // Stash away all the uses of the old instruction so we can check them for
5071     // recursive simplifications after a RAUW. This is cheaper than checking all
5072     // uses of To on the recursive step in most cases.
5073     for (User *U : I->users())
5074       Worklist.insert(cast<Instruction>(U));
5075
5076     // Replace the instruction with its simplified value.
5077     I->replaceAllUsesWith(SimpleV);
5078
5079     // Gracefully handle edge cases where the instruction is not wired into any
5080     // parent block.
5081     if (I->getParent() && !I->isEHPad() && !isa<TerminatorInst>(I) &&
5082         !I->mayHaveSideEffects())
5083       I->eraseFromParent();
5084   }
5085   return Simplified;
5086 }
5087
5088 bool llvm::recursivelySimplifyInstruction(Instruction *I,
5089                                           const TargetLibraryInfo *TLI,
5090                                           const DominatorTree *DT,
5091                                           AssumptionCache *AC) {
5092   return replaceAndRecursivelySimplifyImpl(I, nullptr, TLI, DT, AC);
5093 }
5094
5095 bool llvm::replaceAndRecursivelySimplify(Instruction *I, Value *SimpleV,
5096                                          const TargetLibraryInfo *TLI,
5097                                          const DominatorTree *DT,
5098                                          AssumptionCache *AC) {
5099   assert(I != SimpleV && "replaceAndRecursivelySimplify(X,X) is not valid!");
5100   assert(SimpleV && "Must provide a simplified value.");
5101   return replaceAndRecursivelySimplifyImpl(I, SimpleV, TLI, DT, AC);
5102 }
5103
5104 namespace llvm {
5105 const SimplifyQuery getBestSimplifyQuery(Pass &P, Function &F) {
5106   auto *DTWP = P.getAnalysisIfAvailable<DominatorTreeWrapperPass>();
5107   auto *DT = DTWP ? &DTWP->getDomTree() : nullptr;
5108   auto *TLIWP = P.getAnalysisIfAvailable<TargetLibraryInfoWrapperPass>();
5109   auto *TLI = TLIWP ? &TLIWP->getTLI() : nullptr;
5110   auto *ACWP = P.getAnalysisIfAvailable<AssumptionCacheTracker>();
5111   auto *AC = ACWP ? &ACWP->getAssumptionCache(F) : nullptr;
5112   return {F.getParent()->getDataLayout(), TLI, DT, AC};
5113 }
5114
5115 const SimplifyQuery getBestSimplifyQuery(LoopStandardAnalysisResults &AR,
5116                                          const DataLayout &DL) {
5117   return {DL, &AR.TLI, &AR.DT, &AR.AC};
5118 }
5119
5120 template <class T, class... TArgs>
5121 const SimplifyQuery getBestSimplifyQuery(AnalysisManager<T, TArgs...> &AM,
5122                                          Function &F) {
5123   auto *DT = AM.template getCachedResult<DominatorTreeAnalysis>(F);
5124   auto *TLI = AM.template getCachedResult<TargetLibraryAnalysis>(F);
5125   auto *AC = AM.template getCachedResult<AssumptionAnalysis>(F);
5126   return {F.getParent()->getDataLayout(), TLI, DT, AC};
5127 }
5128 template const SimplifyQuery getBestSimplifyQuery(AnalysisManager<Function> &,
5129                                                   Function &);
5130 }