New InstCombine pattern: (icmp ult/ule (A + C1), C3) | (icmp ult/ule (A + C2), C3...
[oota-llvm.git] / lib / Transforms / InstCombine / InstCombineAndOrXor.cpp
1 //===- InstCombineAndOrXor.cpp --------------------------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the visitAnd, visitOr, and visitXor functions.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "InstCombine.h"
15 #include "llvm/Analysis/InstructionSimplify.h"
16 #include "llvm/IR/ConstantRange.h"
17 #include "llvm/IR/Intrinsics.h"
18 #include "llvm/IR/PatternMatch.h"
19 #include "llvm/Transforms/Utils/CmpInstAnalysis.h"
20 using namespace llvm;
21 using namespace PatternMatch;
22
23 #define DEBUG_TYPE "instcombine"
24
25 /// isFreeToInvert - Return true if the specified value is free to invert (apply
26 /// ~ to).  This happens in cases where the ~ can be eliminated.
27 static inline bool isFreeToInvert(Value *V) {
28   // ~(~(X)) -> X.
29   if (BinaryOperator::isNot(V))
30     return true;
31
32   // Constants can be considered to be not'ed values.
33   if (isa<ConstantInt>(V))
34     return true;
35
36   // Compares can be inverted if they have a single use.
37   if (CmpInst *CI = dyn_cast<CmpInst>(V))
38     return CI->hasOneUse();
39
40   return false;
41 }
42
43 static inline Value *dyn_castNotVal(Value *V) {
44   // If this is not(not(x)) don't return that this is a not: we want the two
45   // not's to be folded first.
46   if (BinaryOperator::isNot(V)) {
47     Value *Operand = BinaryOperator::getNotArgument(V);
48     if (!isFreeToInvert(Operand))
49       return Operand;
50   }
51
52   // Constants can be considered to be not'ed values...
53   if (ConstantInt *C = dyn_cast<ConstantInt>(V))
54     return ConstantInt::get(C->getType(), ~C->getValue());
55   return nullptr;
56 }
57
58 /// getFCmpCode - Similar to getICmpCode but for FCmpInst. This encodes a fcmp
59 /// predicate into a three bit mask. It also returns whether it is an ordered
60 /// predicate by reference.
61 static unsigned getFCmpCode(FCmpInst::Predicate CC, bool &isOrdered) {
62   isOrdered = false;
63   switch (CC) {
64   case FCmpInst::FCMP_ORD: isOrdered = true; return 0;  // 000
65   case FCmpInst::FCMP_UNO:                   return 0;  // 000
66   case FCmpInst::FCMP_OGT: isOrdered = true; return 1;  // 001
67   case FCmpInst::FCMP_UGT:                   return 1;  // 001
68   case FCmpInst::FCMP_OEQ: isOrdered = true; return 2;  // 010
69   case FCmpInst::FCMP_UEQ:                   return 2;  // 010
70   case FCmpInst::FCMP_OGE: isOrdered = true; return 3;  // 011
71   case FCmpInst::FCMP_UGE:                   return 3;  // 011
72   case FCmpInst::FCMP_OLT: isOrdered = true; return 4;  // 100
73   case FCmpInst::FCMP_ULT:                   return 4;  // 100
74   case FCmpInst::FCMP_ONE: isOrdered = true; return 5;  // 101
75   case FCmpInst::FCMP_UNE:                   return 5;  // 101
76   case FCmpInst::FCMP_OLE: isOrdered = true; return 6;  // 110
77   case FCmpInst::FCMP_ULE:                   return 6;  // 110
78     // True -> 7
79   default:
80     // Not expecting FCMP_FALSE and FCMP_TRUE;
81     llvm_unreachable("Unexpected FCmp predicate!");
82   }
83 }
84
85 /// getNewICmpValue - This is the complement of getICmpCode, which turns an
86 /// opcode and two operands into either a constant true or false, or a brand
87 /// new ICmp instruction. The sign is passed in to determine which kind
88 /// of predicate to use in the new icmp instruction.
89 static Value *getNewICmpValue(bool Sign, unsigned Code, Value *LHS, Value *RHS,
90                               InstCombiner::BuilderTy *Builder) {
91   ICmpInst::Predicate NewPred;
92   if (Value *NewConstant = getICmpValue(Sign, Code, LHS, RHS, NewPred))
93     return NewConstant;
94   return Builder->CreateICmp(NewPred, LHS, RHS);
95 }
96
97 /// getFCmpValue - This is the complement of getFCmpCode, which turns an
98 /// opcode and two operands into either a FCmp instruction. isordered is passed
99 /// in to determine which kind of predicate to use in the new fcmp instruction.
100 static Value *getFCmpValue(bool isordered, unsigned code,
101                            Value *LHS, Value *RHS,
102                            InstCombiner::BuilderTy *Builder) {
103   CmpInst::Predicate Pred;
104   switch (code) {
105   default: llvm_unreachable("Illegal FCmp code!");
106   case 0: Pred = isordered ? FCmpInst::FCMP_ORD : FCmpInst::FCMP_UNO; break;
107   case 1: Pred = isordered ? FCmpInst::FCMP_OGT : FCmpInst::FCMP_UGT; break;
108   case 2: Pred = isordered ? FCmpInst::FCMP_OEQ : FCmpInst::FCMP_UEQ; break;
109   case 3: Pred = isordered ? FCmpInst::FCMP_OGE : FCmpInst::FCMP_UGE; break;
110   case 4: Pred = isordered ? FCmpInst::FCMP_OLT : FCmpInst::FCMP_ULT; break;
111   case 5: Pred = isordered ? FCmpInst::FCMP_ONE : FCmpInst::FCMP_UNE; break;
112   case 6: Pred = isordered ? FCmpInst::FCMP_OLE : FCmpInst::FCMP_ULE; break;
113   case 7:
114     if (!isordered) return ConstantInt::getTrue(LHS->getContext());
115     Pred = FCmpInst::FCMP_ORD; break;
116   }
117   return Builder->CreateFCmp(Pred, LHS, RHS);
118 }
119
120 // OptAndOp - This handles expressions of the form ((val OP C1) & C2).  Where
121 // the Op parameter is 'OP', OpRHS is 'C1', and AndRHS is 'C2'.  Op is
122 // guaranteed to be a binary operator.
123 Instruction *InstCombiner::OptAndOp(Instruction *Op,
124                                     ConstantInt *OpRHS,
125                                     ConstantInt *AndRHS,
126                                     BinaryOperator &TheAnd) {
127   Value *X = Op->getOperand(0);
128   Constant *Together = nullptr;
129   if (!Op->isShift())
130     Together = ConstantExpr::getAnd(AndRHS, OpRHS);
131
132   switch (Op->getOpcode()) {
133   case Instruction::Xor:
134     if (Op->hasOneUse()) {
135       // (X ^ C1) & C2 --> (X & C2) ^ (C1&C2)
136       Value *And = Builder->CreateAnd(X, AndRHS);
137       And->takeName(Op);
138       return BinaryOperator::CreateXor(And, Together);
139     }
140     break;
141   case Instruction::Or:
142     if (Op->hasOneUse()){
143       if (Together != OpRHS) {
144         // (X | C1) & C2 --> (X | (C1&C2)) & C2
145         Value *Or = Builder->CreateOr(X, Together);
146         Or->takeName(Op);
147         return BinaryOperator::CreateAnd(Or, AndRHS);
148       }
149
150       ConstantInt *TogetherCI = dyn_cast<ConstantInt>(Together);
151       if (TogetherCI && !TogetherCI->isZero()){
152         // (X | C1) & C2 --> (X & (C2^(C1&C2))) | C1
153         // NOTE: This reduces the number of bits set in the & mask, which
154         // can expose opportunities for store narrowing.
155         Together = ConstantExpr::getXor(AndRHS, Together);
156         Value *And = Builder->CreateAnd(X, Together);
157         And->takeName(Op);
158         return BinaryOperator::CreateOr(And, OpRHS);
159       }
160     }
161
162     break;
163   case Instruction::Add:
164     if (Op->hasOneUse()) {
165       // Adding a one to a single bit bit-field should be turned into an XOR
166       // of the bit.  First thing to check is to see if this AND is with a
167       // single bit constant.
168       const APInt &AndRHSV = AndRHS->getValue();
169
170       // If there is only one bit set.
171       if (AndRHSV.isPowerOf2()) {
172         // Ok, at this point, we know that we are masking the result of the
173         // ADD down to exactly one bit.  If the constant we are adding has
174         // no bits set below this bit, then we can eliminate the ADD.
175         const APInt& AddRHS = OpRHS->getValue();
176
177         // Check to see if any bits below the one bit set in AndRHSV are set.
178         if ((AddRHS & (AndRHSV-1)) == 0) {
179           // If not, the only thing that can effect the output of the AND is
180           // the bit specified by AndRHSV.  If that bit is set, the effect of
181           // the XOR is to toggle the bit.  If it is clear, then the ADD has
182           // no effect.
183           if ((AddRHS & AndRHSV) == 0) { // Bit is not set, noop
184             TheAnd.setOperand(0, X);
185             return &TheAnd;
186           } else {
187             // Pull the XOR out of the AND.
188             Value *NewAnd = Builder->CreateAnd(X, AndRHS);
189             NewAnd->takeName(Op);
190             return BinaryOperator::CreateXor(NewAnd, AndRHS);
191           }
192         }
193       }
194     }
195     break;
196
197   case Instruction::Shl: {
198     // We know that the AND will not produce any of the bits shifted in, so if
199     // the anded constant includes them, clear them now!
200     //
201     uint32_t BitWidth = AndRHS->getType()->getBitWidth();
202     uint32_t OpRHSVal = OpRHS->getLimitedValue(BitWidth);
203     APInt ShlMask(APInt::getHighBitsSet(BitWidth, BitWidth-OpRHSVal));
204     ConstantInt *CI = Builder->getInt(AndRHS->getValue() & ShlMask);
205
206     if (CI->getValue() == ShlMask)
207       // Masking out bits that the shift already masks.
208       return ReplaceInstUsesWith(TheAnd, Op);   // No need for the and.
209
210     if (CI != AndRHS) {                  // Reducing bits set in and.
211       TheAnd.setOperand(1, CI);
212       return &TheAnd;
213     }
214     break;
215   }
216   case Instruction::LShr: {
217     // We know that the AND will not produce any of the bits shifted in, so if
218     // the anded constant includes them, clear them now!  This only applies to
219     // unsigned shifts, because a signed shr may bring in set bits!
220     //
221     uint32_t BitWidth = AndRHS->getType()->getBitWidth();
222     uint32_t OpRHSVal = OpRHS->getLimitedValue(BitWidth);
223     APInt ShrMask(APInt::getLowBitsSet(BitWidth, BitWidth - OpRHSVal));
224     ConstantInt *CI = Builder->getInt(AndRHS->getValue() & ShrMask);
225
226     if (CI->getValue() == ShrMask)
227       // Masking out bits that the shift already masks.
228       return ReplaceInstUsesWith(TheAnd, Op);
229
230     if (CI != AndRHS) {
231       TheAnd.setOperand(1, CI);  // Reduce bits set in and cst.
232       return &TheAnd;
233     }
234     break;
235   }
236   case Instruction::AShr:
237     // Signed shr.
238     // See if this is shifting in some sign extension, then masking it out
239     // with an and.
240     if (Op->hasOneUse()) {
241       uint32_t BitWidth = AndRHS->getType()->getBitWidth();
242       uint32_t OpRHSVal = OpRHS->getLimitedValue(BitWidth);
243       APInt ShrMask(APInt::getLowBitsSet(BitWidth, BitWidth - OpRHSVal));
244       Constant *C = Builder->getInt(AndRHS->getValue() & ShrMask);
245       if (C == AndRHS) {          // Masking out bits shifted in.
246         // (Val ashr C1) & C2 -> (Val lshr C1) & C2
247         // Make the argument unsigned.
248         Value *ShVal = Op->getOperand(0);
249         ShVal = Builder->CreateLShr(ShVal, OpRHS, Op->getName());
250         return BinaryOperator::CreateAnd(ShVal, AndRHS, TheAnd.getName());
251       }
252     }
253     break;
254   }
255   return nullptr;
256 }
257
258 /// Emit a computation of: (V >= Lo && V < Hi) if Inside is true, otherwise
259 /// (V < Lo || V >= Hi).  In practice, we emit the more efficient
260 /// (V-Lo) \<u Hi-Lo.  This method expects that Lo <= Hi. isSigned indicates
261 /// whether to treat the V, Lo and HI as signed or not. IB is the location to
262 /// insert new instructions.
263 Value *InstCombiner::InsertRangeTest(Value *V, Constant *Lo, Constant *Hi,
264                                      bool isSigned, bool Inside) {
265   assert(cast<ConstantInt>(ConstantExpr::getICmp((isSigned ?
266             ICmpInst::ICMP_SLE:ICmpInst::ICMP_ULE), Lo, Hi))->getZExtValue() &&
267          "Lo is not <= Hi in range emission code!");
268
269   if (Inside) {
270     if (Lo == Hi)  // Trivially false.
271       return Builder->getFalse();
272
273     // V >= Min && V < Hi --> V < Hi
274     if (cast<ConstantInt>(Lo)->isMinValue(isSigned)) {
275       ICmpInst::Predicate pred = (isSigned ?
276         ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT);
277       return Builder->CreateICmp(pred, V, Hi);
278     }
279
280     // Emit V-Lo <u Hi-Lo
281     Constant *NegLo = ConstantExpr::getNeg(Lo);
282     Value *Add = Builder->CreateAdd(V, NegLo, V->getName()+".off");
283     Constant *UpperBound = ConstantExpr::getAdd(NegLo, Hi);
284     return Builder->CreateICmpULT(Add, UpperBound);
285   }
286
287   if (Lo == Hi)  // Trivially true.
288     return Builder->getTrue();
289
290   // V < Min || V >= Hi -> V > Hi-1
291   Hi = SubOne(cast<ConstantInt>(Hi));
292   if (cast<ConstantInt>(Lo)->isMinValue(isSigned)) {
293     ICmpInst::Predicate pred = (isSigned ?
294         ICmpInst::ICMP_SGT : ICmpInst::ICMP_UGT);
295     return Builder->CreateICmp(pred, V, Hi);
296   }
297
298   // Emit V-Lo >u Hi-1-Lo
299   // Note that Hi has already had one subtracted from it, above.
300   ConstantInt *NegLo = cast<ConstantInt>(ConstantExpr::getNeg(Lo));
301   Value *Add = Builder->CreateAdd(V, NegLo, V->getName()+".off");
302   Constant *LowerBound = ConstantExpr::getAdd(NegLo, Hi);
303   return Builder->CreateICmpUGT(Add, LowerBound);
304 }
305
306 // isRunOfOnes - Returns true iff Val consists of one contiguous run of 1s with
307 // any number of 0s on either side.  The 1s are allowed to wrap from LSB to
308 // MSB, so 0x000FFF0, 0x0000FFFF, and 0xFF0000FF are all runs.  0x0F0F0000 is
309 // not, since all 1s are not contiguous.
310 static bool isRunOfOnes(ConstantInt *Val, uint32_t &MB, uint32_t &ME) {
311   const APInt& V = Val->getValue();
312   uint32_t BitWidth = Val->getType()->getBitWidth();
313   if (!APIntOps::isShiftedMask(BitWidth, V)) return false;
314
315   // look for the first zero bit after the run of ones
316   MB = BitWidth - ((V - 1) ^ V).countLeadingZeros();
317   // look for the first non-zero bit
318   ME = V.getActiveBits();
319   return true;
320 }
321
322 /// FoldLogicalPlusAnd - This is part of an expression (LHS +/- RHS) & Mask,
323 /// where isSub determines whether the operator is a sub.  If we can fold one of
324 /// the following xforms:
325 ///
326 /// ((A & N) +/- B) & Mask -> (A +/- B) & Mask iff N&Mask == Mask
327 /// ((A | N) +/- B) & Mask -> (A +/- B) & Mask iff N&Mask == 0
328 /// ((A ^ N) +/- B) & Mask -> (A +/- B) & Mask iff N&Mask == 0
329 ///
330 /// return (A +/- B).
331 ///
332 Value *InstCombiner::FoldLogicalPlusAnd(Value *LHS, Value *RHS,
333                                         ConstantInt *Mask, bool isSub,
334                                         Instruction &I) {
335   Instruction *LHSI = dyn_cast<Instruction>(LHS);
336   if (!LHSI || LHSI->getNumOperands() != 2 ||
337       !isa<ConstantInt>(LHSI->getOperand(1))) return nullptr;
338
339   ConstantInt *N = cast<ConstantInt>(LHSI->getOperand(1));
340
341   switch (LHSI->getOpcode()) {
342   default: return nullptr;
343   case Instruction::And:
344     if (ConstantExpr::getAnd(N, Mask) == Mask) {
345       // If the AndRHS is a power of two minus one (0+1+), this is simple.
346       if ((Mask->getValue().countLeadingZeros() +
347            Mask->getValue().countPopulation()) ==
348           Mask->getValue().getBitWidth())
349         break;
350
351       // Otherwise, if Mask is 0+1+0+, and if B is known to have the low 0+
352       // part, we don't need any explicit masks to take them out of A.  If that
353       // is all N is, ignore it.
354       uint32_t MB = 0, ME = 0;
355       if (isRunOfOnes(Mask, MB, ME)) {  // begin/end bit of run, inclusive
356         uint32_t BitWidth = cast<IntegerType>(RHS->getType())->getBitWidth();
357         APInt Mask(APInt::getLowBitsSet(BitWidth, MB-1));
358         if (MaskedValueIsZero(RHS, Mask))
359           break;
360       }
361     }
362     return nullptr;
363   case Instruction::Or:
364   case Instruction::Xor:
365     // If the AndRHS is a power of two minus one (0+1+), and N&Mask == 0
366     if ((Mask->getValue().countLeadingZeros() +
367          Mask->getValue().countPopulation()) == Mask->getValue().getBitWidth()
368         && ConstantExpr::getAnd(N, Mask)->isNullValue())
369       break;
370     return nullptr;
371   }
372
373   if (isSub)
374     return Builder->CreateSub(LHSI->getOperand(0), RHS, "fold");
375   return Builder->CreateAdd(LHSI->getOperand(0), RHS, "fold");
376 }
377
378 /// enum for classifying (icmp eq (A & B), C) and (icmp ne (A & B), C)
379 /// One of A and B is considered the mask, the other the value. This is
380 /// described as the "AMask" or "BMask" part of the enum. If the enum
381 /// contains only "Mask", then both A and B can be considered masks.
382 /// If A is the mask, then it was proven, that (A & C) == C. This
383 /// is trivial if C == A, or C == 0. If both A and C are constants, this
384 /// proof is also easy.
385 /// For the following explanations we assume that A is the mask.
386 /// The part "AllOnes" declares, that the comparison is true only
387 /// if (A & B) == A, or all bits of A are set in B.
388 ///   Example: (icmp eq (A & 3), 3) -> FoldMskICmp_AMask_AllOnes
389 /// The part "AllZeroes" declares, that the comparison is true only
390 /// if (A & B) == 0, or all bits of A are cleared in B.
391 ///   Example: (icmp eq (A & 3), 0) -> FoldMskICmp_Mask_AllZeroes
392 /// The part "Mixed" declares, that (A & B) == C and C might or might not
393 /// contain any number of one bits and zero bits.
394 ///   Example: (icmp eq (A & 3), 1) -> FoldMskICmp_AMask_Mixed
395 /// The Part "Not" means, that in above descriptions "==" should be replaced
396 /// by "!=".
397 ///   Example: (icmp ne (A & 3), 3) -> FoldMskICmp_AMask_NotAllOnes
398 /// If the mask A contains a single bit, then the following is equivalent:
399 ///    (icmp eq (A & B), A) equals (icmp ne (A & B), 0)
400 ///    (icmp ne (A & B), A) equals (icmp eq (A & B), 0)
401 enum MaskedICmpType {
402   FoldMskICmp_AMask_AllOnes           =     1,
403   FoldMskICmp_AMask_NotAllOnes        =     2,
404   FoldMskICmp_BMask_AllOnes           =     4,
405   FoldMskICmp_BMask_NotAllOnes        =     8,
406   FoldMskICmp_Mask_AllZeroes          =    16,
407   FoldMskICmp_Mask_NotAllZeroes       =    32,
408   FoldMskICmp_AMask_Mixed             =    64,
409   FoldMskICmp_AMask_NotMixed          =   128,
410   FoldMskICmp_BMask_Mixed             =   256,
411   FoldMskICmp_BMask_NotMixed          =   512
412 };
413
414 /// return the set of pattern classes (from MaskedICmpType)
415 /// that (icmp SCC (A & B), C) satisfies
416 static unsigned getTypeOfMaskedICmp(Value* A, Value* B, Value* C,
417                                     ICmpInst::Predicate SCC)
418 {
419   ConstantInt *ACst = dyn_cast<ConstantInt>(A);
420   ConstantInt *BCst = dyn_cast<ConstantInt>(B);
421   ConstantInt *CCst = dyn_cast<ConstantInt>(C);
422   bool icmp_eq = (SCC == ICmpInst::ICMP_EQ);
423   bool icmp_abit = (ACst && !ACst->isZero() &&
424                     ACst->getValue().isPowerOf2());
425   bool icmp_bbit = (BCst && !BCst->isZero() &&
426                     BCst->getValue().isPowerOf2());
427   unsigned result = 0;
428   if (CCst && CCst->isZero()) {
429     // if C is zero, then both A and B qualify as mask
430     result |= (icmp_eq ? (FoldMskICmp_Mask_AllZeroes |
431                           FoldMskICmp_Mask_AllZeroes |
432                           FoldMskICmp_AMask_Mixed |
433                           FoldMskICmp_BMask_Mixed)
434                        : (FoldMskICmp_Mask_NotAllZeroes |
435                           FoldMskICmp_Mask_NotAllZeroes |
436                           FoldMskICmp_AMask_NotMixed |
437                           FoldMskICmp_BMask_NotMixed));
438     if (icmp_abit)
439       result |= (icmp_eq ? (FoldMskICmp_AMask_NotAllOnes |
440                             FoldMskICmp_AMask_NotMixed)
441                          : (FoldMskICmp_AMask_AllOnes |
442                             FoldMskICmp_AMask_Mixed));
443     if (icmp_bbit)
444       result |= (icmp_eq ? (FoldMskICmp_BMask_NotAllOnes |
445                             FoldMskICmp_BMask_NotMixed)
446                          : (FoldMskICmp_BMask_AllOnes |
447                             FoldMskICmp_BMask_Mixed));
448     return result;
449   }
450   if (A == C) {
451     result |= (icmp_eq ? (FoldMskICmp_AMask_AllOnes |
452                           FoldMskICmp_AMask_Mixed)
453                        : (FoldMskICmp_AMask_NotAllOnes |
454                           FoldMskICmp_AMask_NotMixed));
455     if (icmp_abit)
456       result |= (icmp_eq ? (FoldMskICmp_Mask_NotAllZeroes |
457                             FoldMskICmp_AMask_NotMixed)
458                          : (FoldMskICmp_Mask_AllZeroes |
459                             FoldMskICmp_AMask_Mixed));
460   } else if (ACst && CCst &&
461              ConstantExpr::getAnd(ACst, CCst) == CCst) {
462     result |= (icmp_eq ? FoldMskICmp_AMask_Mixed
463                        : FoldMskICmp_AMask_NotMixed);
464   }
465   if (B == C) {
466     result |= (icmp_eq ? (FoldMskICmp_BMask_AllOnes |
467                           FoldMskICmp_BMask_Mixed)
468                        : (FoldMskICmp_BMask_NotAllOnes |
469                           FoldMskICmp_BMask_NotMixed));
470     if (icmp_bbit)
471       result |= (icmp_eq ? (FoldMskICmp_Mask_NotAllZeroes |
472                             FoldMskICmp_BMask_NotMixed)
473                          : (FoldMskICmp_Mask_AllZeroes |
474                             FoldMskICmp_BMask_Mixed));
475   } else if (BCst && CCst &&
476              ConstantExpr::getAnd(BCst, CCst) == CCst) {
477     result |= (icmp_eq ? FoldMskICmp_BMask_Mixed
478                        : FoldMskICmp_BMask_NotMixed);
479   }
480   return result;
481 }
482
483 /// Convert an analysis of a masked ICmp into its equivalent if all boolean
484 /// operations had the opposite sense. Since each "NotXXX" flag (recording !=)
485 /// is adjacent to the corresponding normal flag (recording ==), this just
486 /// involves swapping those bits over.
487 static unsigned conjugateICmpMask(unsigned Mask) {
488   unsigned NewMask;
489   NewMask = (Mask & (FoldMskICmp_AMask_AllOnes | FoldMskICmp_BMask_AllOnes |
490                      FoldMskICmp_Mask_AllZeroes | FoldMskICmp_AMask_Mixed |
491                      FoldMskICmp_BMask_Mixed))
492             << 1;
493
494   NewMask |=
495       (Mask & (FoldMskICmp_AMask_NotAllOnes | FoldMskICmp_BMask_NotAllOnes |
496                FoldMskICmp_Mask_NotAllZeroes | FoldMskICmp_AMask_NotMixed |
497                FoldMskICmp_BMask_NotMixed))
498       >> 1;
499
500   return NewMask;
501 }
502
503 /// decomposeBitTestICmp - Decompose an icmp into the form ((X & Y) pred Z)
504 /// if possible. The returned predicate is either == or !=. Returns false if
505 /// decomposition fails.
506 static bool decomposeBitTestICmp(const ICmpInst *I, ICmpInst::Predicate &Pred,
507                                  Value *&X, Value *&Y, Value *&Z) {
508   ConstantInt *C = dyn_cast<ConstantInt>(I->getOperand(1));
509   if (!C)
510     return false;
511
512   switch (I->getPredicate()) {
513   default:
514     return false;
515   case ICmpInst::ICMP_SLT:
516     // X < 0 is equivalent to (X & SignBit) != 0.
517     if (!C->isZero())
518       return false;
519     Y = ConstantInt::get(I->getContext(), APInt::getSignBit(C->getBitWidth()));
520     Pred = ICmpInst::ICMP_NE;
521     break;
522   case ICmpInst::ICMP_SGT:
523     // X > -1 is equivalent to (X & SignBit) == 0.
524     if (!C->isAllOnesValue())
525       return false;
526     Y = ConstantInt::get(I->getContext(), APInt::getSignBit(C->getBitWidth()));
527     Pred = ICmpInst::ICMP_EQ;
528     break;
529   case ICmpInst::ICMP_ULT:
530     // X <u 2^n is equivalent to (X & ~(2^n-1)) == 0.
531     if (!C->getValue().isPowerOf2())
532       return false;
533     Y = ConstantInt::get(I->getContext(), -C->getValue());
534     Pred = ICmpInst::ICMP_EQ;
535     break;
536   case ICmpInst::ICMP_UGT:
537     // X >u 2^n-1 is equivalent to (X & ~(2^n-1)) != 0.
538     if (!(C->getValue() + 1).isPowerOf2())
539       return false;
540     Y = ConstantInt::get(I->getContext(), ~C->getValue());
541     Pred = ICmpInst::ICMP_NE;
542     break;
543   }
544
545   X = I->getOperand(0);
546   Z = ConstantInt::getNullValue(C->getType());
547   return true;
548 }
549
550 /// foldLogOpOfMaskedICmpsHelper:
551 /// handle (icmp(A & B) ==/!= C) &/| (icmp(A & D) ==/!= E)
552 /// return the set of pattern classes (from MaskedICmpType)
553 /// that both LHS and RHS satisfy
554 static unsigned foldLogOpOfMaskedICmpsHelper(Value*& A,
555                                              Value*& B, Value*& C,
556                                              Value*& D, Value*& E,
557                                              ICmpInst *LHS, ICmpInst *RHS,
558                                              ICmpInst::Predicate &LHSCC,
559                                              ICmpInst::Predicate &RHSCC) {
560   if (LHS->getOperand(0)->getType() != RHS->getOperand(0)->getType()) return 0;
561   // vectors are not (yet?) supported
562   if (LHS->getOperand(0)->getType()->isVectorTy()) return 0;
563
564   // Here comes the tricky part:
565   // LHS might be of the form L11 & L12 == X, X == L21 & L22,
566   // and L11 & L12 == L21 & L22. The same goes for RHS.
567   // Now we must find those components L** and R**, that are equal, so
568   // that we can extract the parameters A, B, C, D, and E for the canonical
569   // above.
570   Value *L1 = LHS->getOperand(0);
571   Value *L2 = LHS->getOperand(1);
572   Value *L11,*L12,*L21,*L22;
573   // Check whether the icmp can be decomposed into a bit test.
574   if (decomposeBitTestICmp(LHS, LHSCC, L11, L12, L2)) {
575     L21 = L22 = L1 = nullptr;
576   } else {
577     // Look for ANDs in the LHS icmp.
578     if (!L1->getType()->isIntegerTy()) {
579       // You can icmp pointers, for example. They really aren't masks.
580       L11 = L12 = nullptr;
581     } else if (!match(L1, m_And(m_Value(L11), m_Value(L12)))) {
582       // Any icmp can be viewed as being trivially masked; if it allows us to
583       // remove one, it's worth it.
584       L11 = L1;
585       L12 = Constant::getAllOnesValue(L1->getType());
586     }
587
588     if (!L2->getType()->isIntegerTy()) {
589       // You can icmp pointers, for example. They really aren't masks.
590       L21 = L22 = nullptr;
591     } else if (!match(L2, m_And(m_Value(L21), m_Value(L22)))) {
592       L21 = L2;
593       L22 = Constant::getAllOnesValue(L2->getType());
594     }
595   }
596
597   // Bail if LHS was a icmp that can't be decomposed into an equality.
598   if (!ICmpInst::isEquality(LHSCC))
599     return 0;
600
601   Value *R1 = RHS->getOperand(0);
602   Value *R2 = RHS->getOperand(1);
603   Value *R11,*R12;
604   bool ok = false;
605   if (decomposeBitTestICmp(RHS, RHSCC, R11, R12, R2)) {
606     if (R11 == L11 || R11 == L12 || R11 == L21 || R11 == L22) {
607       A = R11; D = R12;
608     } else if (R12 == L11 || R12 == L12 || R12 == L21 || R12 == L22) {
609       A = R12; D = R11;
610     } else {
611       return 0;
612     }
613     E = R2; R1 = nullptr; ok = true;
614   } else if (R1->getType()->isIntegerTy()) {
615     if (!match(R1, m_And(m_Value(R11), m_Value(R12)))) {
616       // As before, model no mask as a trivial mask if it'll let us do an
617       // optimization.
618       R11 = R1;
619       R12 = Constant::getAllOnesValue(R1->getType());
620     }
621
622     if (R11 == L11 || R11 == L12 || R11 == L21 || R11 == L22) {
623       A = R11; D = R12; E = R2; ok = true;
624     } else if (R12 == L11 || R12 == L12 || R12 == L21 || R12 == L22) {
625       A = R12; D = R11; E = R2; ok = true;
626     }
627   }
628
629   // Bail if RHS was a icmp that can't be decomposed into an equality.
630   if (!ICmpInst::isEquality(RHSCC))
631     return 0;
632
633   // Look for ANDs in on the right side of the RHS icmp.
634   if (!ok && R2->getType()->isIntegerTy()) {
635     if (!match(R2, m_And(m_Value(R11), m_Value(R12)))) {
636       R11 = R2;
637       R12 = Constant::getAllOnesValue(R2->getType());
638     }
639
640     if (R11 == L11 || R11 == L12 || R11 == L21 || R11 == L22) {
641       A = R11; D = R12; E = R1; ok = true;
642     } else if (R12 == L11 || R12 == L12 || R12 == L21 || R12 == L22) {
643       A = R12; D = R11; E = R1; ok = true;
644     } else {
645       return 0;
646     }
647   }
648   if (!ok)
649     return 0;
650
651   if (L11 == A) {
652     B = L12; C = L2;
653   } else if (L12 == A) {
654     B = L11; C = L2;
655   } else if (L21 == A) {
656     B = L22; C = L1;
657   } else if (L22 == A) {
658     B = L21; C = L1;
659   }
660
661   unsigned left_type = getTypeOfMaskedICmp(A, B, C, LHSCC);
662   unsigned right_type = getTypeOfMaskedICmp(A, D, E, RHSCC);
663   return left_type & right_type;
664 }
665 /// foldLogOpOfMaskedICmps:
666 /// try to fold (icmp(A & B) ==/!= C) &/| (icmp(A & D) ==/!= E)
667 /// into a single (icmp(A & X) ==/!= Y)
668 static Value* foldLogOpOfMaskedICmps(ICmpInst *LHS, ICmpInst *RHS, bool IsAnd,
669                                      llvm::InstCombiner::BuilderTy* Builder) {
670   Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr, *E = nullptr;
671   ICmpInst::Predicate LHSCC = LHS->getPredicate(), RHSCC = RHS->getPredicate();
672   unsigned mask = foldLogOpOfMaskedICmpsHelper(A, B, C, D, E, LHS, RHS,
673                                                LHSCC, RHSCC);
674   if (mask == 0) return nullptr;
675   assert(ICmpInst::isEquality(LHSCC) && ICmpInst::isEquality(RHSCC) &&
676          "foldLogOpOfMaskedICmpsHelper must return an equality predicate.");
677
678   // In full generality:
679   //     (icmp (A & B) Op C) | (icmp (A & D) Op E)
680   // ==  ![ (icmp (A & B) !Op C) & (icmp (A & D) !Op E) ]
681   //
682   // If the latter can be converted into (icmp (A & X) Op Y) then the former is
683   // equivalent to (icmp (A & X) !Op Y).
684   //
685   // Therefore, we can pretend for the rest of this function that we're dealing
686   // with the conjunction, provided we flip the sense of any comparisons (both
687   // input and output).
688
689   // In most cases we're going to produce an EQ for the "&&" case.
690   ICmpInst::Predicate NEWCC = IsAnd ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE;
691   if (!IsAnd) {
692     // Convert the masking analysis into its equivalent with negated
693     // comparisons.
694     mask = conjugateICmpMask(mask);
695   }
696
697   if (mask & FoldMskICmp_Mask_AllZeroes) {
698     // (icmp eq (A & B), 0) & (icmp eq (A & D), 0)
699     // -> (icmp eq (A & (B|D)), 0)
700     Value* newOr = Builder->CreateOr(B, D);
701     Value* newAnd = Builder->CreateAnd(A, newOr);
702     // we can't use C as zero, because we might actually handle
703     //   (icmp ne (A & B), B) & (icmp ne (A & D), D)
704     // with B and D, having a single bit set
705     Value* zero = Constant::getNullValue(A->getType());
706     return Builder->CreateICmp(NEWCC, newAnd, zero);
707   }
708   if (mask & FoldMskICmp_BMask_AllOnes) {
709     // (icmp eq (A & B), B) & (icmp eq (A & D), D)
710     // -> (icmp eq (A & (B|D)), (B|D))
711     Value* newOr = Builder->CreateOr(B, D);
712     Value* newAnd = Builder->CreateAnd(A, newOr);
713     return Builder->CreateICmp(NEWCC, newAnd, newOr);
714   }
715   if (mask & FoldMskICmp_AMask_AllOnes) {
716     // (icmp eq (A & B), A) & (icmp eq (A & D), A)
717     // -> (icmp eq (A & (B&D)), A)
718     Value* newAnd1 = Builder->CreateAnd(B, D);
719     Value* newAnd = Builder->CreateAnd(A, newAnd1);
720     return Builder->CreateICmp(NEWCC, newAnd, A);
721   }
722
723   // Remaining cases assume at least that B and D are constant, and depend on
724   // their actual values. This isn't strictly, necessary, just a "handle the
725   // easy cases for now" decision.
726   ConstantInt *BCst = dyn_cast<ConstantInt>(B);
727   if (!BCst) return nullptr;
728   ConstantInt *DCst = dyn_cast<ConstantInt>(D);
729   if (!DCst) return nullptr;
730
731   if (mask & (FoldMskICmp_Mask_NotAllZeroes | FoldMskICmp_BMask_NotAllOnes)) {
732     // (icmp ne (A & B), 0) & (icmp ne (A & D), 0) and
733     // (icmp ne (A & B), B) & (icmp ne (A & D), D)
734     //     -> (icmp ne (A & B), 0) or (icmp ne (A & D), 0)
735     // Only valid if one of the masks is a superset of the other (check "B&D" is
736     // the same as either B or D).
737     APInt NewMask = BCst->getValue() & DCst->getValue();
738
739     if (NewMask == BCst->getValue())
740       return LHS;
741     else if (NewMask == DCst->getValue())
742       return RHS;
743   }
744   if (mask & FoldMskICmp_AMask_NotAllOnes) {
745     // (icmp ne (A & B), B) & (icmp ne (A & D), D)
746     //     -> (icmp ne (A & B), A) or (icmp ne (A & D), A)
747     // Only valid if one of the masks is a superset of the other (check "B|D" is
748     // the same as either B or D).
749     APInt NewMask = BCst->getValue() | DCst->getValue();
750
751     if (NewMask == BCst->getValue())
752       return LHS;
753     else if (NewMask == DCst->getValue())
754       return RHS;
755   }
756   if (mask & FoldMskICmp_BMask_Mixed) {
757     // (icmp eq (A & B), C) & (icmp eq (A & D), E)
758     // We already know that B & C == C && D & E == E.
759     // If we can prove that (B & D) & (C ^ E) == 0, that is, the bits of
760     // C and E, which are shared by both the mask B and the mask D, don't
761     // contradict, then we can transform to
762     // -> (icmp eq (A & (B|D)), (C|E))
763     // Currently, we only handle the case of B, C, D, and E being constant.
764     // we can't simply use C and E, because we might actually handle
765     //   (icmp ne (A & B), B) & (icmp eq (A & D), D)
766     // with B and D, having a single bit set
767     ConstantInt *CCst = dyn_cast<ConstantInt>(C);
768     if (!CCst) return nullptr;
769     if (LHSCC != NEWCC)
770       CCst = dyn_cast<ConstantInt>( ConstantExpr::getXor(BCst, CCst) );
771     ConstantInt *ECst = dyn_cast<ConstantInt>(E);
772     if (!ECst) return nullptr;
773     if (RHSCC != NEWCC)
774       ECst = dyn_cast<ConstantInt>( ConstantExpr::getXor(DCst, ECst) );
775     ConstantInt* MCst = dyn_cast<ConstantInt>(
776       ConstantExpr::getAnd(ConstantExpr::getAnd(BCst, DCst),
777                            ConstantExpr::getXor(CCst, ECst)) );
778     // if there is a conflict we should actually return a false for the
779     // whole construct
780     if (!MCst->isZero())
781       return nullptr;
782     Value *newOr1 = Builder->CreateOr(B, D);
783     Value *newOr2 = ConstantExpr::getOr(CCst, ECst);
784     Value *newAnd = Builder->CreateAnd(A, newOr1);
785     return Builder->CreateICmp(NEWCC, newAnd, newOr2);
786   }
787   return nullptr;
788 }
789
790 /// FoldAndOfICmps - Fold (icmp)&(icmp) if possible.
791 Value *InstCombiner::FoldAndOfICmps(ICmpInst *LHS, ICmpInst *RHS) {
792   ICmpInst::Predicate LHSCC = LHS->getPredicate(), RHSCC = RHS->getPredicate();
793
794   // (icmp1 A, B) & (icmp2 A, B) --> (icmp3 A, B)
795   if (PredicatesFoldable(LHSCC, RHSCC)) {
796     if (LHS->getOperand(0) == RHS->getOperand(1) &&
797         LHS->getOperand(1) == RHS->getOperand(0))
798       LHS->swapOperands();
799     if (LHS->getOperand(0) == RHS->getOperand(0) &&
800         LHS->getOperand(1) == RHS->getOperand(1)) {
801       Value *Op0 = LHS->getOperand(0), *Op1 = LHS->getOperand(1);
802       unsigned Code = getICmpCode(LHS) & getICmpCode(RHS);
803       bool isSigned = LHS->isSigned() || RHS->isSigned();
804       return getNewICmpValue(isSigned, Code, Op0, Op1, Builder);
805     }
806   }
807
808   // handle (roughly):  (icmp eq (A & B), C) & (icmp eq (A & D), E)
809   if (Value *V = foldLogOpOfMaskedICmps(LHS, RHS, true, Builder))
810     return V;
811
812   // This only handles icmp of constants: (icmp1 A, C1) & (icmp2 B, C2).
813   Value *Val = LHS->getOperand(0), *Val2 = RHS->getOperand(0);
814   ConstantInt *LHSCst = dyn_cast<ConstantInt>(LHS->getOperand(1));
815   ConstantInt *RHSCst = dyn_cast<ConstantInt>(RHS->getOperand(1));
816   if (!LHSCst || !RHSCst) return nullptr;
817
818   if (LHSCst == RHSCst && LHSCC == RHSCC) {
819     // (icmp ult A, C) & (icmp ult B, C) --> (icmp ult (A|B), C)
820     // where C is a power of 2
821     if (LHSCC == ICmpInst::ICMP_ULT &&
822         LHSCst->getValue().isPowerOf2()) {
823       Value *NewOr = Builder->CreateOr(Val, Val2);
824       return Builder->CreateICmp(LHSCC, NewOr, LHSCst);
825     }
826
827     // (icmp eq A, 0) & (icmp eq B, 0) --> (icmp eq (A|B), 0)
828     if (LHSCC == ICmpInst::ICMP_EQ && LHSCst->isZero()) {
829       Value *NewOr = Builder->CreateOr(Val, Val2);
830       return Builder->CreateICmp(LHSCC, NewOr, LHSCst);
831     }
832   }
833
834   // (trunc x) == C1 & (and x, CA) == C2 -> (and x, CA|CMAX) == C1|C2
835   // where CMAX is the all ones value for the truncated type,
836   // iff the lower bits of C2 and CA are zero.
837   if (LHSCC == ICmpInst::ICMP_EQ && LHSCC == RHSCC &&
838       LHS->hasOneUse() && RHS->hasOneUse()) {
839     Value *V;
840     ConstantInt *AndCst, *SmallCst = nullptr, *BigCst = nullptr;
841
842     // (trunc x) == C1 & (and x, CA) == C2
843     // (and x, CA) == C2 & (trunc x) == C1
844     if (match(Val2, m_Trunc(m_Value(V))) &&
845         match(Val, m_And(m_Specific(V), m_ConstantInt(AndCst)))) {
846       SmallCst = RHSCst;
847       BigCst = LHSCst;
848     } else if (match(Val, m_Trunc(m_Value(V))) &&
849                match(Val2, m_And(m_Specific(V), m_ConstantInt(AndCst)))) {
850       SmallCst = LHSCst;
851       BigCst = RHSCst;
852     }
853
854     if (SmallCst && BigCst) {
855       unsigned BigBitSize = BigCst->getType()->getBitWidth();
856       unsigned SmallBitSize = SmallCst->getType()->getBitWidth();
857
858       // Check that the low bits are zero.
859       APInt Low = APInt::getLowBitsSet(BigBitSize, SmallBitSize);
860       if ((Low & AndCst->getValue()) == 0 && (Low & BigCst->getValue()) == 0) {
861         Value *NewAnd = Builder->CreateAnd(V, Low | AndCst->getValue());
862         APInt N = SmallCst->getValue().zext(BigBitSize) | BigCst->getValue();
863         Value *NewVal = ConstantInt::get(AndCst->getType()->getContext(), N);
864         return Builder->CreateICmp(LHSCC, NewAnd, NewVal);
865       }
866     }
867   }
868
869   // From here on, we only handle:
870   //    (icmp1 A, C1) & (icmp2 A, C2) --> something simpler.
871   if (Val != Val2) return nullptr;
872
873   // ICMP_[US][GL]E X, CST is folded to ICMP_[US][GL]T elsewhere.
874   if (LHSCC == ICmpInst::ICMP_UGE || LHSCC == ICmpInst::ICMP_ULE ||
875       RHSCC == ICmpInst::ICMP_UGE || RHSCC == ICmpInst::ICMP_ULE ||
876       LHSCC == ICmpInst::ICMP_SGE || LHSCC == ICmpInst::ICMP_SLE ||
877       RHSCC == ICmpInst::ICMP_SGE || RHSCC == ICmpInst::ICMP_SLE)
878     return nullptr;
879
880   // Make a constant range that's the intersection of the two icmp ranges.
881   // If the intersection is empty, we know that the result is false.
882   ConstantRange LHSRange =
883     ConstantRange::makeICmpRegion(LHSCC, LHSCst->getValue());
884   ConstantRange RHSRange =
885     ConstantRange::makeICmpRegion(RHSCC, RHSCst->getValue());
886
887   if (LHSRange.intersectWith(RHSRange).isEmptySet())
888     return ConstantInt::get(CmpInst::makeCmpResultType(LHS->getType()), 0);
889
890   // We can't fold (ugt x, C) & (sgt x, C2).
891   if (!PredicatesFoldable(LHSCC, RHSCC))
892     return nullptr;
893
894   // Ensure that the larger constant is on the RHS.
895   bool ShouldSwap;
896   if (CmpInst::isSigned(LHSCC) ||
897       (ICmpInst::isEquality(LHSCC) &&
898        CmpInst::isSigned(RHSCC)))
899     ShouldSwap = LHSCst->getValue().sgt(RHSCst->getValue());
900   else
901     ShouldSwap = LHSCst->getValue().ugt(RHSCst->getValue());
902
903   if (ShouldSwap) {
904     std::swap(LHS, RHS);
905     std::swap(LHSCst, RHSCst);
906     std::swap(LHSCC, RHSCC);
907   }
908
909   // At this point, we know we have two icmp instructions
910   // comparing a value against two constants and and'ing the result
911   // together.  Because of the above check, we know that we only have
912   // icmp eq, icmp ne, icmp [su]lt, and icmp [SU]gt here. We also know
913   // (from the icmp folding check above), that the two constants
914   // are not equal and that the larger constant is on the RHS
915   assert(LHSCst != RHSCst && "Compares not folded above?");
916
917   switch (LHSCC) {
918   default: llvm_unreachable("Unknown integer condition code!");
919   case ICmpInst::ICMP_EQ:
920     switch (RHSCC) {
921     default: llvm_unreachable("Unknown integer condition code!");
922     case ICmpInst::ICMP_NE:         // (X == 13 & X != 15) -> X == 13
923     case ICmpInst::ICMP_ULT:        // (X == 13 & X <  15) -> X == 13
924     case ICmpInst::ICMP_SLT:        // (X == 13 & X <  15) -> X == 13
925       return LHS;
926     }
927   case ICmpInst::ICMP_NE:
928     switch (RHSCC) {
929     default: llvm_unreachable("Unknown integer condition code!");
930     case ICmpInst::ICMP_ULT:
931       if (LHSCst == SubOne(RHSCst)) // (X != 13 & X u< 14) -> X < 13
932         return Builder->CreateICmpULT(Val, LHSCst);
933       break;                        // (X != 13 & X u< 15) -> no change
934     case ICmpInst::ICMP_SLT:
935       if (LHSCst == SubOne(RHSCst)) // (X != 13 & X s< 14) -> X < 13
936         return Builder->CreateICmpSLT(Val, LHSCst);
937       break;                        // (X != 13 & X s< 15) -> no change
938     case ICmpInst::ICMP_EQ:         // (X != 13 & X == 15) -> X == 15
939     case ICmpInst::ICMP_UGT:        // (X != 13 & X u> 15) -> X u> 15
940     case ICmpInst::ICMP_SGT:        // (X != 13 & X s> 15) -> X s> 15
941       return RHS;
942     case ICmpInst::ICMP_NE:
943       // Special case to get the ordering right when the values wrap around
944       // zero.
945       if (LHSCst->getValue() == 0 && RHSCst->getValue().isAllOnesValue())
946         std::swap(LHSCst, RHSCst);
947       if (LHSCst == SubOne(RHSCst)){// (X != 13 & X != 14) -> X-13 >u 1
948         Constant *AddCST = ConstantExpr::getNeg(LHSCst);
949         Value *Add = Builder->CreateAdd(Val, AddCST, Val->getName()+".off");
950         return Builder->CreateICmpUGT(Add, ConstantInt::get(Add->getType(), 1),
951                                       Val->getName()+".cmp");
952       }
953       break;                        // (X != 13 & X != 15) -> no change
954     }
955     break;
956   case ICmpInst::ICMP_ULT:
957     switch (RHSCC) {
958     default: llvm_unreachable("Unknown integer condition code!");
959     case ICmpInst::ICMP_EQ:         // (X u< 13 & X == 15) -> false
960     case ICmpInst::ICMP_UGT:        // (X u< 13 & X u> 15) -> false
961       return ConstantInt::get(CmpInst::makeCmpResultType(LHS->getType()), 0);
962     case ICmpInst::ICMP_SGT:        // (X u< 13 & X s> 15) -> no change
963       break;
964     case ICmpInst::ICMP_NE:         // (X u< 13 & X != 15) -> X u< 13
965     case ICmpInst::ICMP_ULT:        // (X u< 13 & X u< 15) -> X u< 13
966       return LHS;
967     case ICmpInst::ICMP_SLT:        // (X u< 13 & X s< 15) -> no change
968       break;
969     }
970     break;
971   case ICmpInst::ICMP_SLT:
972     switch (RHSCC) {
973     default: llvm_unreachable("Unknown integer condition code!");
974     case ICmpInst::ICMP_UGT:        // (X s< 13 & X u> 15) -> no change
975       break;
976     case ICmpInst::ICMP_NE:         // (X s< 13 & X != 15) -> X < 13
977     case ICmpInst::ICMP_SLT:        // (X s< 13 & X s< 15) -> X < 13
978       return LHS;
979     case ICmpInst::ICMP_ULT:        // (X s< 13 & X u< 15) -> no change
980       break;
981     }
982     break;
983   case ICmpInst::ICMP_UGT:
984     switch (RHSCC) {
985     default: llvm_unreachable("Unknown integer condition code!");
986     case ICmpInst::ICMP_EQ:         // (X u> 13 & X == 15) -> X == 15
987     case ICmpInst::ICMP_UGT:        // (X u> 13 & X u> 15) -> X u> 15
988       return RHS;
989     case ICmpInst::ICMP_SGT:        // (X u> 13 & X s> 15) -> no change
990       break;
991     case ICmpInst::ICMP_NE:
992       if (RHSCst == AddOne(LHSCst)) // (X u> 13 & X != 14) -> X u> 14
993         return Builder->CreateICmp(LHSCC, Val, RHSCst);
994       break;                        // (X u> 13 & X != 15) -> no change
995     case ICmpInst::ICMP_ULT:        // (X u> 13 & X u< 15) -> (X-14) <u 1
996       return InsertRangeTest(Val, AddOne(LHSCst), RHSCst, false, true);
997     case ICmpInst::ICMP_SLT:        // (X u> 13 & X s< 15) -> no change
998       break;
999     }
1000     break;
1001   case ICmpInst::ICMP_SGT:
1002     switch (RHSCC) {
1003     default: llvm_unreachable("Unknown integer condition code!");
1004     case ICmpInst::ICMP_EQ:         // (X s> 13 & X == 15) -> X == 15
1005     case ICmpInst::ICMP_SGT:        // (X s> 13 & X s> 15) -> X s> 15
1006       return RHS;
1007     case ICmpInst::ICMP_UGT:        // (X s> 13 & X u> 15) -> no change
1008       break;
1009     case ICmpInst::ICMP_NE:
1010       if (RHSCst == AddOne(LHSCst)) // (X s> 13 & X != 14) -> X s> 14
1011         return Builder->CreateICmp(LHSCC, Val, RHSCst);
1012       break;                        // (X s> 13 & X != 15) -> no change
1013     case ICmpInst::ICMP_SLT:        // (X s> 13 & X s< 15) -> (X-14) s< 1
1014       return InsertRangeTest(Val, AddOne(LHSCst), RHSCst, true, true);
1015     case ICmpInst::ICMP_ULT:        // (X s> 13 & X u< 15) -> no change
1016       break;
1017     }
1018     break;
1019   }
1020
1021   return nullptr;
1022 }
1023
1024 /// FoldAndOfFCmps - Optimize (fcmp)&(fcmp).  NOTE: Unlike the rest of
1025 /// instcombine, this returns a Value which should already be inserted into the
1026 /// function.
1027 Value *InstCombiner::FoldAndOfFCmps(FCmpInst *LHS, FCmpInst *RHS) {
1028   if (LHS->getPredicate() == FCmpInst::FCMP_ORD &&
1029       RHS->getPredicate() == FCmpInst::FCMP_ORD) {
1030     if (LHS->getOperand(0)->getType() != RHS->getOperand(0)->getType())
1031       return nullptr;
1032
1033     // (fcmp ord x, c) & (fcmp ord y, c)  -> (fcmp ord x, y)
1034     if (ConstantFP *LHSC = dyn_cast<ConstantFP>(LHS->getOperand(1)))
1035       if (ConstantFP *RHSC = dyn_cast<ConstantFP>(RHS->getOperand(1))) {
1036         // If either of the constants are nans, then the whole thing returns
1037         // false.
1038         if (LHSC->getValueAPF().isNaN() || RHSC->getValueAPF().isNaN())
1039           return Builder->getFalse();
1040         return Builder->CreateFCmpORD(LHS->getOperand(0), RHS->getOperand(0));
1041       }
1042
1043     // Handle vector zeros.  This occurs because the canonical form of
1044     // "fcmp ord x,x" is "fcmp ord x, 0".
1045     if (isa<ConstantAggregateZero>(LHS->getOperand(1)) &&
1046         isa<ConstantAggregateZero>(RHS->getOperand(1)))
1047       return Builder->CreateFCmpORD(LHS->getOperand(0), RHS->getOperand(0));
1048     return nullptr;
1049   }
1050
1051   Value *Op0LHS = LHS->getOperand(0), *Op0RHS = LHS->getOperand(1);
1052   Value *Op1LHS = RHS->getOperand(0), *Op1RHS = RHS->getOperand(1);
1053   FCmpInst::Predicate Op0CC = LHS->getPredicate(), Op1CC = RHS->getPredicate();
1054
1055
1056   if (Op0LHS == Op1RHS && Op0RHS == Op1LHS) {
1057     // Swap RHS operands to match LHS.
1058     Op1CC = FCmpInst::getSwappedPredicate(Op1CC);
1059     std::swap(Op1LHS, Op1RHS);
1060   }
1061
1062   if (Op0LHS == Op1LHS && Op0RHS == Op1RHS) {
1063     // Simplify (fcmp cc0 x, y) & (fcmp cc1 x, y).
1064     if (Op0CC == Op1CC)
1065       return Builder->CreateFCmp((FCmpInst::Predicate)Op0CC, Op0LHS, Op0RHS);
1066     if (Op0CC == FCmpInst::FCMP_FALSE || Op1CC == FCmpInst::FCMP_FALSE)
1067       return ConstantInt::get(CmpInst::makeCmpResultType(LHS->getType()), 0);
1068     if (Op0CC == FCmpInst::FCMP_TRUE)
1069       return RHS;
1070     if (Op1CC == FCmpInst::FCMP_TRUE)
1071       return LHS;
1072
1073     bool Op0Ordered;
1074     bool Op1Ordered;
1075     unsigned Op0Pred = getFCmpCode(Op0CC, Op0Ordered);
1076     unsigned Op1Pred = getFCmpCode(Op1CC, Op1Ordered);
1077     // uno && ord -> false
1078     if (Op0Pred == 0 && Op1Pred == 0 && Op0Ordered != Op1Ordered)
1079         return ConstantInt::get(CmpInst::makeCmpResultType(LHS->getType()), 0);
1080     if (Op1Pred == 0) {
1081       std::swap(LHS, RHS);
1082       std::swap(Op0Pred, Op1Pred);
1083       std::swap(Op0Ordered, Op1Ordered);
1084     }
1085     if (Op0Pred == 0) {
1086       // uno && ueq -> uno && (uno || eq) -> uno
1087       // ord && olt -> ord && (ord && lt) -> olt
1088       if (!Op0Ordered && (Op0Ordered == Op1Ordered))
1089         return LHS;
1090       if (Op0Ordered && (Op0Ordered == Op1Ordered))
1091         return RHS;
1092
1093       // uno && oeq -> uno && (ord && eq) -> false
1094       if (!Op0Ordered)
1095         return ConstantInt::get(CmpInst::makeCmpResultType(LHS->getType()), 0);
1096       // ord && ueq -> ord && (uno || eq) -> oeq
1097       return getFCmpValue(true, Op1Pred, Op0LHS, Op0RHS, Builder);
1098     }
1099   }
1100
1101   return nullptr;
1102 }
1103
1104
1105 Instruction *InstCombiner::visitAnd(BinaryOperator &I) {
1106   bool Changed = SimplifyAssociativeOrCommutative(I);
1107   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1108
1109   if (Value *V = SimplifyVectorOp(I))
1110     return ReplaceInstUsesWith(I, V);
1111
1112   if (Value *V = SimplifyAndInst(Op0, Op1, DL))
1113     return ReplaceInstUsesWith(I, V);
1114
1115   // (A|B)&(A|C) -> A|(B&C) etc
1116   if (Value *V = SimplifyUsingDistributiveLaws(I))
1117     return ReplaceInstUsesWith(I, V);
1118
1119   // See if we can simplify any instructions used by the instruction whose sole
1120   // purpose is to compute bits we don't care about.
1121   if (SimplifyDemandedInstructionBits(I))
1122     return &I;
1123
1124   if (ConstantInt *AndRHS = dyn_cast<ConstantInt>(Op1)) {
1125     const APInt &AndRHSMask = AndRHS->getValue();
1126
1127     // Optimize a variety of ((val OP C1) & C2) combinations...
1128     if (BinaryOperator *Op0I = dyn_cast<BinaryOperator>(Op0)) {
1129       Value *Op0LHS = Op0I->getOperand(0);
1130       Value *Op0RHS = Op0I->getOperand(1);
1131       switch (Op0I->getOpcode()) {
1132       default: break;
1133       case Instruction::Xor:
1134       case Instruction::Or: {
1135         // If the mask is only needed on one incoming arm, push it up.
1136         if (!Op0I->hasOneUse()) break;
1137
1138         APInt NotAndRHS(~AndRHSMask);
1139         if (MaskedValueIsZero(Op0LHS, NotAndRHS)) {
1140           // Not masking anything out for the LHS, move to RHS.
1141           Value *NewRHS = Builder->CreateAnd(Op0RHS, AndRHS,
1142                                              Op0RHS->getName()+".masked");
1143           return BinaryOperator::Create(Op0I->getOpcode(), Op0LHS, NewRHS);
1144         }
1145         if (!isa<Constant>(Op0RHS) &&
1146             MaskedValueIsZero(Op0RHS, NotAndRHS)) {
1147           // Not masking anything out for the RHS, move to LHS.
1148           Value *NewLHS = Builder->CreateAnd(Op0LHS, AndRHS,
1149                                              Op0LHS->getName()+".masked");
1150           return BinaryOperator::Create(Op0I->getOpcode(), NewLHS, Op0RHS);
1151         }
1152
1153         break;
1154       }
1155       case Instruction::Add:
1156         // ((A & N) + B) & AndRHS -> (A + B) & AndRHS iff N&AndRHS == AndRHS.
1157         // ((A | N) + B) & AndRHS -> (A + B) & AndRHS iff N&AndRHS == 0
1158         // ((A ^ N) + B) & AndRHS -> (A + B) & AndRHS iff N&AndRHS == 0
1159         if (Value *V = FoldLogicalPlusAnd(Op0LHS, Op0RHS, AndRHS, false, I))
1160           return BinaryOperator::CreateAnd(V, AndRHS);
1161         if (Value *V = FoldLogicalPlusAnd(Op0RHS, Op0LHS, AndRHS, false, I))
1162           return BinaryOperator::CreateAnd(V, AndRHS);  // Add commutes
1163         break;
1164
1165       case Instruction::Sub:
1166         // ((A & N) - B) & AndRHS -> (A - B) & AndRHS iff N&AndRHS == AndRHS.
1167         // ((A | N) - B) & AndRHS -> (A - B) & AndRHS iff N&AndRHS == 0
1168         // ((A ^ N) - B) & AndRHS -> (A - B) & AndRHS iff N&AndRHS == 0
1169         if (Value *V = FoldLogicalPlusAnd(Op0LHS, Op0RHS, AndRHS, true, I))
1170           return BinaryOperator::CreateAnd(V, AndRHS);
1171
1172         // (A - N) & AndRHS -> -N & AndRHS iff A&AndRHS==0 and AndRHS
1173         // has 1's for all bits that the subtraction with A might affect.
1174         if (Op0I->hasOneUse() && !match(Op0LHS, m_Zero())) {
1175           uint32_t BitWidth = AndRHSMask.getBitWidth();
1176           uint32_t Zeros = AndRHSMask.countLeadingZeros();
1177           APInt Mask = APInt::getLowBitsSet(BitWidth, BitWidth - Zeros);
1178
1179           if (MaskedValueIsZero(Op0LHS, Mask)) {
1180             Value *NewNeg = Builder->CreateNeg(Op0RHS);
1181             return BinaryOperator::CreateAnd(NewNeg, AndRHS);
1182           }
1183         }
1184         break;
1185
1186       case Instruction::Shl:
1187       case Instruction::LShr:
1188         // (1 << x) & 1 --> zext(x == 0)
1189         // (1 >> x) & 1 --> zext(x == 0)
1190         if (AndRHSMask == 1 && Op0LHS == AndRHS) {
1191           Value *NewICmp =
1192             Builder->CreateICmpEQ(Op0RHS, Constant::getNullValue(I.getType()));
1193           return new ZExtInst(NewICmp, I.getType());
1194         }
1195         break;
1196       }
1197
1198       if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1)))
1199         if (Instruction *Res = OptAndOp(Op0I, Op0CI, AndRHS, I))
1200           return Res;
1201     }
1202
1203     // If this is an integer truncation, and if the source is an 'and' with
1204     // immediate, transform it.  This frequently occurs for bitfield accesses.
1205     {
1206       Value *X = nullptr; ConstantInt *YC = nullptr;
1207       if (match(Op0, m_Trunc(m_And(m_Value(X), m_ConstantInt(YC))))) {
1208         // Change: and (trunc (and X, YC) to T), C2
1209         // into  : and (trunc X to T), trunc(YC) & C2
1210         // This will fold the two constants together, which may allow
1211         // other simplifications.
1212         Value *NewCast = Builder->CreateTrunc(X, I.getType(), "and.shrunk");
1213         Constant *C3 = ConstantExpr::getTrunc(YC, I.getType());
1214         C3 = ConstantExpr::getAnd(C3, AndRHS);
1215         return BinaryOperator::CreateAnd(NewCast, C3);
1216       }
1217     }
1218
1219     // Try to fold constant and into select arguments.
1220     if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
1221       if (Instruction *R = FoldOpIntoSelect(I, SI))
1222         return R;
1223     if (isa<PHINode>(Op0))
1224       if (Instruction *NV = FoldOpIntoPhi(I))
1225         return NV;
1226   }
1227
1228
1229   // (~A & ~B) == (~(A | B)) - De Morgan's Law
1230   if (Value *Op0NotVal = dyn_castNotVal(Op0))
1231     if (Value *Op1NotVal = dyn_castNotVal(Op1))
1232       if (Op0->hasOneUse() && Op1->hasOneUse()) {
1233         Value *Or = Builder->CreateOr(Op0NotVal, Op1NotVal,
1234                                       I.getName()+".demorgan");
1235         return BinaryOperator::CreateNot(Or);
1236       }
1237
1238   {
1239     Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr;
1240     // (A|B) & ~(A&B) -> A^B
1241     if (match(Op0, m_Or(m_Value(A), m_Value(B))) &&
1242         match(Op1, m_Not(m_And(m_Value(C), m_Value(D)))) &&
1243         ((A == C && B == D) || (A == D && B == C)))
1244       return BinaryOperator::CreateXor(A, B);
1245
1246     // ~(A&B) & (A|B) -> A^B
1247     if (match(Op1, m_Or(m_Value(A), m_Value(B))) &&
1248         match(Op0, m_Not(m_And(m_Value(C), m_Value(D)))) &&
1249         ((A == C && B == D) || (A == D && B == C)))
1250       return BinaryOperator::CreateXor(A, B);
1251
1252     // A&(A^B) => A & ~B
1253     {
1254       Value *tmpOp0 = Op0;
1255       Value *tmpOp1 = Op1;
1256       if (Op0->hasOneUse() &&
1257           match(Op0, m_Xor(m_Value(A), m_Value(B)))) {
1258         if (A == Op1 || B == Op1 ) {
1259           tmpOp1 = Op0;
1260           tmpOp0 = Op1;
1261           // Simplify below
1262         }
1263       }
1264
1265       if (tmpOp1->hasOneUse() &&
1266           match(tmpOp1, m_Xor(m_Value(A), m_Value(B)))) {
1267         if (B == tmpOp0) {
1268           std::swap(A, B);
1269         }
1270         // Notice that the patten (A&(~B)) is actually (A&(-1^B)), so if
1271         // A is originally -1 (or a vector of -1 and undefs), then we enter
1272         // an endless loop. By checking that A is non-constant we ensure that
1273         // we will never get to the loop.
1274         if (A == tmpOp0 && !isa<Constant>(A)) // A&(A^B) -> A & ~B
1275           return BinaryOperator::CreateAnd(A, Builder->CreateNot(B));
1276       }
1277     }
1278
1279     // (A&((~A)|B)) -> A&B
1280     if (match(Op0, m_Or(m_Not(m_Specific(Op1)), m_Value(A))) ||
1281         match(Op0, m_Or(m_Value(A), m_Not(m_Specific(Op1)))))
1282       return BinaryOperator::CreateAnd(A, Op1);
1283     if (match(Op1, m_Or(m_Not(m_Specific(Op0)), m_Value(A))) ||
1284         match(Op1, m_Or(m_Value(A), m_Not(m_Specific(Op0)))))
1285       return BinaryOperator::CreateAnd(A, Op0);
1286
1287     // (A ^ B) & ((B ^ C) ^ A) -> (A ^ B) & ~C
1288     if (match(Op0, m_Xor(m_Value(A), m_Value(B))))
1289       if (match(Op1, m_Xor(m_Xor(m_Specific(B), m_Value(C)), m_Specific(A))))
1290         if (Op1->hasOneUse() || cast<BinaryOperator>(Op1)->hasOneUse())
1291           return BinaryOperator::CreateAnd(Op0, Builder->CreateNot(C));
1292
1293     // ((A ^ C) ^ B) & (B ^ A) -> (B ^ A) & ~C
1294     if (match(Op0, m_Xor(m_Xor(m_Value(A), m_Value(C)), m_Value(B))))
1295       if (match(Op1, m_Xor(m_Specific(B), m_Specific(A))))
1296         if (Op0->hasOneUse() || cast<BinaryOperator>(Op0)->hasOneUse())
1297           return BinaryOperator::CreateAnd(Op1, Builder->CreateNot(C));
1298
1299     // (A | B) & ((~A) ^ B) -> (A & B)
1300     if (match(Op0, m_Or(m_Value(A), m_Value(B))) &&
1301         match(Op1, m_Xor(m_Not(m_Specific(A)), m_Specific(B))))
1302       return BinaryOperator::CreateAnd(A, B);
1303
1304     // ((~A) ^ B) & (A | B) -> (A & B)
1305     if (match(Op0, m_Xor(m_Not(m_Value(A)), m_Value(B))) &&
1306         match(Op1, m_Or(m_Specific(A), m_Specific(B))))
1307       return BinaryOperator::CreateAnd(A, B);
1308   }
1309
1310   if (ICmpInst *RHS = dyn_cast<ICmpInst>(Op1))
1311     if (ICmpInst *LHS = dyn_cast<ICmpInst>(Op0))
1312       if (Value *Res = FoldAndOfICmps(LHS, RHS))
1313         return ReplaceInstUsesWith(I, Res);
1314
1315   // If and'ing two fcmp, try combine them into one.
1316   if (FCmpInst *LHS = dyn_cast<FCmpInst>(I.getOperand(0)))
1317     if (FCmpInst *RHS = dyn_cast<FCmpInst>(I.getOperand(1)))
1318       if (Value *Res = FoldAndOfFCmps(LHS, RHS))
1319         return ReplaceInstUsesWith(I, Res);
1320
1321
1322   // fold (and (cast A), (cast B)) -> (cast (and A, B))
1323   if (CastInst *Op0C = dyn_cast<CastInst>(Op0))
1324     if (CastInst *Op1C = dyn_cast<CastInst>(Op1)) {
1325       Type *SrcTy = Op0C->getOperand(0)->getType();
1326       if (Op0C->getOpcode() == Op1C->getOpcode() && // same cast kind ?
1327           SrcTy == Op1C->getOperand(0)->getType() &&
1328           SrcTy->isIntOrIntVectorTy()) {
1329         Value *Op0COp = Op0C->getOperand(0), *Op1COp = Op1C->getOperand(0);
1330
1331         // Only do this if the casts both really cause code to be generated.
1332         if (ShouldOptimizeCast(Op0C->getOpcode(), Op0COp, I.getType()) &&
1333             ShouldOptimizeCast(Op1C->getOpcode(), Op1COp, I.getType())) {
1334           Value *NewOp = Builder->CreateAnd(Op0COp, Op1COp, I.getName());
1335           return CastInst::Create(Op0C->getOpcode(), NewOp, I.getType());
1336         }
1337
1338         // If this is and(cast(icmp), cast(icmp)), try to fold this even if the
1339         // cast is otherwise not optimizable.  This happens for vector sexts.
1340         if (ICmpInst *RHS = dyn_cast<ICmpInst>(Op1COp))
1341           if (ICmpInst *LHS = dyn_cast<ICmpInst>(Op0COp))
1342             if (Value *Res = FoldAndOfICmps(LHS, RHS))
1343               return CastInst::Create(Op0C->getOpcode(), Res, I.getType());
1344
1345         // If this is and(cast(fcmp), cast(fcmp)), try to fold this even if the
1346         // cast is otherwise not optimizable.  This happens for vector sexts.
1347         if (FCmpInst *RHS = dyn_cast<FCmpInst>(Op1COp))
1348           if (FCmpInst *LHS = dyn_cast<FCmpInst>(Op0COp))
1349             if (Value *Res = FoldAndOfFCmps(LHS, RHS))
1350               return CastInst::Create(Op0C->getOpcode(), Res, I.getType());
1351       }
1352     }
1353
1354   // (X >> Z) & (Y >> Z)  -> (X&Y) >> Z  for all shifts.
1355   if (BinaryOperator *SI1 = dyn_cast<BinaryOperator>(Op1)) {
1356     if (BinaryOperator *SI0 = dyn_cast<BinaryOperator>(Op0))
1357       if (SI0->isShift() && SI0->getOpcode() == SI1->getOpcode() &&
1358           SI0->getOperand(1) == SI1->getOperand(1) &&
1359           (SI0->hasOneUse() || SI1->hasOneUse())) {
1360         Value *NewOp =
1361           Builder->CreateAnd(SI0->getOperand(0), SI1->getOperand(0),
1362                              SI0->getName());
1363         return BinaryOperator::Create(SI1->getOpcode(), NewOp,
1364                                       SI1->getOperand(1));
1365       }
1366   }
1367
1368   {
1369     Value *X = nullptr;
1370     bool OpsSwapped = false;
1371     // Canonicalize SExt or Not to the LHS
1372     if (match(Op1, m_SExt(m_Value())) ||
1373         match(Op1, m_Not(m_Value()))) {
1374       std::swap(Op0, Op1);
1375       OpsSwapped = true;
1376     }
1377
1378     // Fold (and (sext bool to A), B) --> (select bool, B, 0)
1379     if (match(Op0, m_SExt(m_Value(X))) &&
1380         X->getType()->getScalarType()->isIntegerTy(1)) {
1381       Value *Zero = Constant::getNullValue(Op1->getType());
1382       return SelectInst::Create(X, Op1, Zero);
1383     }
1384
1385     // Fold (and ~(sext bool to A), B) --> (select bool, 0, B)
1386     if (match(Op0, m_Not(m_SExt(m_Value(X)))) &&
1387         X->getType()->getScalarType()->isIntegerTy(1)) {
1388       Value *Zero = Constant::getNullValue(Op0->getType());
1389       return SelectInst::Create(X, Zero, Op1);
1390     }
1391
1392     if (OpsSwapped)
1393       std::swap(Op0, Op1);
1394   }
1395
1396   return Changed ? &I : nullptr;
1397 }
1398
1399 /// CollectBSwapParts - Analyze the specified subexpression and see if it is
1400 /// capable of providing pieces of a bswap.  The subexpression provides pieces
1401 /// of a bswap if it is proven that each of the non-zero bytes in the output of
1402 /// the expression came from the corresponding "byte swapped" byte in some other
1403 /// value.  For example, if the current subexpression is "(shl i32 %X, 24)" then
1404 /// we know that the expression deposits the low byte of %X into the high byte
1405 /// of the bswap result and that all other bytes are zero.  This expression is
1406 /// accepted, the high byte of ByteValues is set to X to indicate a correct
1407 /// match.
1408 ///
1409 /// This function returns true if the match was unsuccessful and false if so.
1410 /// On entry to the function the "OverallLeftShift" is a signed integer value
1411 /// indicating the number of bytes that the subexpression is later shifted.  For
1412 /// example, if the expression is later right shifted by 16 bits, the
1413 /// OverallLeftShift value would be -2 on entry.  This is used to specify which
1414 /// byte of ByteValues is actually being set.
1415 ///
1416 /// Similarly, ByteMask is a bitmask where a bit is clear if its corresponding
1417 /// byte is masked to zero by a user.  For example, in (X & 255), X will be
1418 /// processed with a bytemask of 1.  Because bytemask is 32-bits, this limits
1419 /// this function to working on up to 32-byte (256 bit) values.  ByteMask is
1420 /// always in the local (OverallLeftShift) coordinate space.
1421 ///
1422 static bool CollectBSwapParts(Value *V, int OverallLeftShift, uint32_t ByteMask,
1423                               SmallVectorImpl<Value *> &ByteValues) {
1424   if (Instruction *I = dyn_cast<Instruction>(V)) {
1425     // If this is an or instruction, it may be an inner node of the bswap.
1426     if (I->getOpcode() == Instruction::Or) {
1427       return CollectBSwapParts(I->getOperand(0), OverallLeftShift, ByteMask,
1428                                ByteValues) ||
1429              CollectBSwapParts(I->getOperand(1), OverallLeftShift, ByteMask,
1430                                ByteValues);
1431     }
1432
1433     // If this is a logical shift by a constant multiple of 8, recurse with
1434     // OverallLeftShift and ByteMask adjusted.
1435     if (I->isLogicalShift() && isa<ConstantInt>(I->getOperand(1))) {
1436       unsigned ShAmt =
1437         cast<ConstantInt>(I->getOperand(1))->getLimitedValue(~0U);
1438       // Ensure the shift amount is defined and of a byte value.
1439       if ((ShAmt & 7) || (ShAmt > 8*ByteValues.size()))
1440         return true;
1441
1442       unsigned ByteShift = ShAmt >> 3;
1443       if (I->getOpcode() == Instruction::Shl) {
1444         // X << 2 -> collect(X, +2)
1445         OverallLeftShift += ByteShift;
1446         ByteMask >>= ByteShift;
1447       } else {
1448         // X >>u 2 -> collect(X, -2)
1449         OverallLeftShift -= ByteShift;
1450         ByteMask <<= ByteShift;
1451         ByteMask &= (~0U >> (32-ByteValues.size()));
1452       }
1453
1454       if (OverallLeftShift >= (int)ByteValues.size()) return true;
1455       if (OverallLeftShift <= -(int)ByteValues.size()) return true;
1456
1457       return CollectBSwapParts(I->getOperand(0), OverallLeftShift, ByteMask,
1458                                ByteValues);
1459     }
1460
1461     // If this is a logical 'and' with a mask that clears bytes, clear the
1462     // corresponding bytes in ByteMask.
1463     if (I->getOpcode() == Instruction::And &&
1464         isa<ConstantInt>(I->getOperand(1))) {
1465       // Scan every byte of the and mask, seeing if the byte is either 0 or 255.
1466       unsigned NumBytes = ByteValues.size();
1467       APInt Byte(I->getType()->getPrimitiveSizeInBits(), 255);
1468       const APInt &AndMask = cast<ConstantInt>(I->getOperand(1))->getValue();
1469
1470       for (unsigned i = 0; i != NumBytes; ++i, Byte <<= 8) {
1471         // If this byte is masked out by a later operation, we don't care what
1472         // the and mask is.
1473         if ((ByteMask & (1 << i)) == 0)
1474           continue;
1475
1476         // If the AndMask is all zeros for this byte, clear the bit.
1477         APInt MaskB = AndMask & Byte;
1478         if (MaskB == 0) {
1479           ByteMask &= ~(1U << i);
1480           continue;
1481         }
1482
1483         // If the AndMask is not all ones for this byte, it's not a bytezap.
1484         if (MaskB != Byte)
1485           return true;
1486
1487         // Otherwise, this byte is kept.
1488       }
1489
1490       return CollectBSwapParts(I->getOperand(0), OverallLeftShift, ByteMask,
1491                                ByteValues);
1492     }
1493   }
1494
1495   // Okay, we got to something that isn't a shift, 'or' or 'and'.  This must be
1496   // the input value to the bswap.  Some observations: 1) if more than one byte
1497   // is demanded from this input, then it could not be successfully assembled
1498   // into a byteswap.  At least one of the two bytes would not be aligned with
1499   // their ultimate destination.
1500   if (!isPowerOf2_32(ByteMask)) return true;
1501   unsigned InputByteNo = countTrailingZeros(ByteMask);
1502
1503   // 2) The input and ultimate destinations must line up: if byte 3 of an i32
1504   // is demanded, it needs to go into byte 0 of the result.  This means that the
1505   // byte needs to be shifted until it lands in the right byte bucket.  The
1506   // shift amount depends on the position: if the byte is coming from the high
1507   // part of the value (e.g. byte 3) then it must be shifted right.  If from the
1508   // low part, it must be shifted left.
1509   unsigned DestByteNo = InputByteNo + OverallLeftShift;
1510   if (ByteValues.size()-1-DestByteNo != InputByteNo)
1511     return true;
1512
1513   // If the destination byte value is already defined, the values are or'd
1514   // together, which isn't a bswap (unless it's an or of the same bits).
1515   if (ByteValues[DestByteNo] && ByteValues[DestByteNo] != V)
1516     return true;
1517   ByteValues[DestByteNo] = V;
1518   return false;
1519 }
1520
1521 /// MatchBSwap - Given an OR instruction, check to see if this is a bswap idiom.
1522 /// If so, insert the new bswap intrinsic and return it.
1523 Instruction *InstCombiner::MatchBSwap(BinaryOperator &I) {
1524   IntegerType *ITy = dyn_cast<IntegerType>(I.getType());
1525   if (!ITy || ITy->getBitWidth() % 16 ||
1526       // ByteMask only allows up to 32-byte values.
1527       ITy->getBitWidth() > 32*8)
1528     return nullptr;   // Can only bswap pairs of bytes.  Can't do vectors.
1529
1530   /// ByteValues - For each byte of the result, we keep track of which value
1531   /// defines each byte.
1532   SmallVector<Value*, 8> ByteValues;
1533   ByteValues.resize(ITy->getBitWidth()/8);
1534
1535   // Try to find all the pieces corresponding to the bswap.
1536   uint32_t ByteMask = ~0U >> (32-ByteValues.size());
1537   if (CollectBSwapParts(&I, 0, ByteMask, ByteValues))
1538     return nullptr;
1539
1540   // Check to see if all of the bytes come from the same value.
1541   Value *V = ByteValues[0];
1542   if (!V) return nullptr;  // Didn't find a byte?  Must be zero.
1543
1544   // Check to make sure that all of the bytes come from the same value.
1545   for (unsigned i = 1, e = ByteValues.size(); i != e; ++i)
1546     if (ByteValues[i] != V)
1547       return nullptr;
1548   Module *M = I.getParent()->getParent()->getParent();
1549   Function *F = Intrinsic::getDeclaration(M, Intrinsic::bswap, ITy);
1550   return CallInst::Create(F, V);
1551 }
1552
1553 /// MatchSelectFromAndOr - We have an expression of the form (A&C)|(B&D).  Check
1554 /// If A is (cond?-1:0) and either B or D is ~(cond?-1,0) or (cond?0,-1), then
1555 /// we can simplify this expression to "cond ? C : D or B".
1556 static Instruction *MatchSelectFromAndOr(Value *A, Value *B,
1557                                          Value *C, Value *D) {
1558   // If A is not a select of -1/0, this cannot match.
1559   Value *Cond = nullptr;
1560   if (!match(A, m_SExt(m_Value(Cond))) ||
1561       !Cond->getType()->isIntegerTy(1))
1562     return nullptr;
1563
1564   // ((cond?-1:0)&C) | (B&(cond?0:-1)) -> cond ? C : B.
1565   if (match(D, m_Not(m_SExt(m_Specific(Cond)))))
1566     return SelectInst::Create(Cond, C, B);
1567   if (match(D, m_SExt(m_Not(m_Specific(Cond)))))
1568     return SelectInst::Create(Cond, C, B);
1569
1570   // ((cond?-1:0)&C) | ((cond?0:-1)&D) -> cond ? C : D.
1571   if (match(B, m_Not(m_SExt(m_Specific(Cond)))))
1572     return SelectInst::Create(Cond, C, D);
1573   if (match(B, m_SExt(m_Not(m_Specific(Cond)))))
1574     return SelectInst::Create(Cond, C, D);
1575   return nullptr;
1576 }
1577
1578 /// FoldOrOfICmps - Fold (icmp)|(icmp) if possible.
1579 Value *InstCombiner::FoldOrOfICmps(ICmpInst *LHS, ICmpInst *RHS) {
1580   ICmpInst::Predicate LHSCC = LHS->getPredicate(), RHSCC = RHS->getPredicate();
1581
1582   // Fold (iszero(A & K1) | iszero(A & K2)) ->  (A & (K1 | K2)) != (K1 | K2)
1583   // if K1 and K2 are a one-bit mask.
1584   ConstantInt *LHSCst = dyn_cast<ConstantInt>(LHS->getOperand(1));
1585   ConstantInt *RHSCst = dyn_cast<ConstantInt>(RHS->getOperand(1));
1586
1587   if (LHS->getPredicate() == ICmpInst::ICMP_EQ && LHSCst && LHSCst->isZero() &&
1588       RHS->getPredicate() == ICmpInst::ICMP_EQ && RHSCst && RHSCst->isZero()) {
1589
1590     BinaryOperator *LAnd = dyn_cast<BinaryOperator>(LHS->getOperand(0));
1591     BinaryOperator *RAnd = dyn_cast<BinaryOperator>(RHS->getOperand(0));
1592     if (LAnd && RAnd && LAnd->hasOneUse() && RHS->hasOneUse() &&
1593         LAnd->getOpcode() == Instruction::And &&
1594         RAnd->getOpcode() == Instruction::And) {
1595
1596       Value *Mask = nullptr;
1597       Value *Masked = nullptr;
1598       if (LAnd->getOperand(0) == RAnd->getOperand(0) &&
1599           isKnownToBeAPowerOfTwo(LAnd->getOperand(1)) &&
1600           isKnownToBeAPowerOfTwo(RAnd->getOperand(1))) {
1601         Mask = Builder->CreateOr(LAnd->getOperand(1), RAnd->getOperand(1));
1602         Masked = Builder->CreateAnd(LAnd->getOperand(0), Mask);
1603       } else if (LAnd->getOperand(1) == RAnd->getOperand(1) &&
1604                  isKnownToBeAPowerOfTwo(LAnd->getOperand(0)) &&
1605                  isKnownToBeAPowerOfTwo(RAnd->getOperand(0))) {
1606         Mask = Builder->CreateOr(LAnd->getOperand(0), RAnd->getOperand(0));
1607         Masked = Builder->CreateAnd(LAnd->getOperand(1), Mask);
1608       }
1609
1610       if (Masked)
1611         return Builder->CreateICmp(ICmpInst::ICMP_NE, Masked, Mask);
1612     }
1613   }
1614
1615   // Fold (icmp ult/ule (A + C1), C3) | (icmp ult/ule (A + C2), C3)
1616   //                   -->  (icmp ult/ule ((A & ~(C1 ^ C2)) + max(C1, C2)), C3)
1617   // The original condition actually refers to the following two ranges:
1618   // [MAX_UINT-C1+1, MAX_UINT-C1+1+C3] and [MAX_UINT-C2+1, MAX_UINT-C2+1+C3]
1619   // We can fold these two ranges if:
1620   // 1) C1 and C2 is unsigned greater than C3.
1621   // 2) The two ranges are separated.
1622   // 3) C1 ^ C2 is one-bit mask.
1623   // 4) LowRange1 ^ LowRange2 and HighRange1 ^ HighRange2 are one-bit mask.
1624   // This implies all values in the two ranges differ by exactly one bit.
1625
1626   if ((LHSCC == ICmpInst::ICMP_ULT || LHSCC == ICmpInst::ICMP_ULE) &&
1627       LHSCC == RHSCC && LHSCst && RHSCst && LHS->hasOneUse() &&
1628       RHS->hasOneUse() && LHSCst->getType() == RHSCst->getType() &&
1629       LHSCst->getValue() == (RHSCst->getValue())) {
1630
1631     Value *LAdd = LHS->getOperand(0);
1632     Value *RAdd = RHS->getOperand(0);
1633
1634     Value *LAddOpnd, *RAddOpnd;
1635     ConstantInt *LAddCst, *RAddCst;
1636     if (match(LAdd, m_Add(m_Value(LAddOpnd), m_ConstantInt(LAddCst))) &&
1637         match(RAdd, m_Add(m_Value(RAddOpnd), m_ConstantInt(RAddCst))) &&
1638         LAddCst->getValue().ugt(LHSCst->getValue()) &&
1639         RAddCst->getValue().ugt(LHSCst->getValue())) {
1640
1641       APInt DiffCst = LAddCst->getValue() ^ RAddCst->getValue();
1642       if (LAddOpnd == RAddOpnd && DiffCst.isPowerOf2()) {
1643         ConstantInt *MaxAddCst = nullptr;
1644         if (LAddCst->getValue().ult(RAddCst->getValue()))
1645           MaxAddCst = RAddCst;
1646         else
1647           MaxAddCst = LAddCst;
1648
1649         APInt RRangeLow = -RAddCst->getValue();
1650         APInt RRangeHigh = RRangeLow + LHSCst->getValue();
1651         APInt LRangeLow = -LAddCst->getValue();
1652         APInt LRangeHigh = LRangeLow + LHSCst->getValue();
1653         APInt LowRangeDiff = RRangeLow ^ LRangeLow;
1654         APInt HighRangeDiff = RRangeHigh ^ LRangeHigh;
1655         APInt RangeDiff = LRangeLow.sgt(RRangeLow) ? LRangeLow - RRangeLow
1656                                                    : RRangeLow - LRangeLow;
1657
1658         if (LowRangeDiff.isPowerOf2() && LowRangeDiff == HighRangeDiff &&
1659             RangeDiff.ugt(LHSCst->getValue())) {
1660           Value *MaskCst = ConstantInt::get(LAddCst->getType(), ~DiffCst);
1661
1662           Value *NewAnd = Builder->CreateAnd(LAddOpnd, MaskCst);
1663           Value *NewAdd = Builder->CreateAdd(NewAnd, MaxAddCst);
1664           return (Builder->CreateICmp(LHS->getPredicate(), NewAdd, LHSCst));
1665         }
1666       }
1667     }
1668   }
1669
1670   // (icmp1 A, B) | (icmp2 A, B) --> (icmp3 A, B)
1671   if (PredicatesFoldable(LHSCC, RHSCC)) {
1672     if (LHS->getOperand(0) == RHS->getOperand(1) &&
1673         LHS->getOperand(1) == RHS->getOperand(0))
1674       LHS->swapOperands();
1675     if (LHS->getOperand(0) == RHS->getOperand(0) &&
1676         LHS->getOperand(1) == RHS->getOperand(1)) {
1677       Value *Op0 = LHS->getOperand(0), *Op1 = LHS->getOperand(1);
1678       unsigned Code = getICmpCode(LHS) | getICmpCode(RHS);
1679       bool isSigned = LHS->isSigned() || RHS->isSigned();
1680       return getNewICmpValue(isSigned, Code, Op0, Op1, Builder);
1681     }
1682   }
1683
1684   // handle (roughly):
1685   // (icmp ne (A & B), C) | (icmp ne (A & D), E)
1686   if (Value *V = foldLogOpOfMaskedICmps(LHS, RHS, false, Builder))
1687     return V;
1688
1689   Value *Val = LHS->getOperand(0), *Val2 = RHS->getOperand(0);
1690   if (LHS->hasOneUse() || RHS->hasOneUse()) {
1691     // (icmp eq B, 0) | (icmp ult A, B) -> (icmp ule A, B-1)
1692     // (icmp eq B, 0) | (icmp ugt B, A) -> (icmp ule A, B-1)
1693     Value *A = nullptr, *B = nullptr;
1694     if (LHSCC == ICmpInst::ICMP_EQ && LHSCst && LHSCst->isZero()) {
1695       B = Val;
1696       if (RHSCC == ICmpInst::ICMP_ULT && Val == RHS->getOperand(1))
1697         A = Val2;
1698       else if (RHSCC == ICmpInst::ICMP_UGT && Val == Val2)
1699         A = RHS->getOperand(1);
1700     }
1701     // (icmp ult A, B) | (icmp eq B, 0) -> (icmp ule A, B-1)
1702     // (icmp ugt B, A) | (icmp eq B, 0) -> (icmp ule A, B-1)
1703     else if (RHSCC == ICmpInst::ICMP_EQ && RHSCst && RHSCst->isZero()) {
1704       B = Val2;
1705       if (LHSCC == ICmpInst::ICMP_ULT && Val2 == LHS->getOperand(1))
1706         A = Val;
1707       else if (LHSCC == ICmpInst::ICMP_UGT && Val2 == Val)
1708         A = LHS->getOperand(1);
1709     }
1710     if (A && B)
1711       return Builder->CreateICmp(
1712           ICmpInst::ICMP_UGE,
1713           Builder->CreateAdd(B, ConstantInt::getSigned(B->getType(), -1)), A);
1714   }
1715
1716   // This only handles icmp of constants: (icmp1 A, C1) | (icmp2 B, C2).
1717   if (!LHSCst || !RHSCst) return nullptr;
1718
1719   if (LHSCst == RHSCst && LHSCC == RHSCC) {
1720     // (icmp ne A, 0) | (icmp ne B, 0) --> (icmp ne (A|B), 0)
1721     if (LHSCC == ICmpInst::ICMP_NE && LHSCst->isZero()) {
1722       Value *NewOr = Builder->CreateOr(Val, Val2);
1723       return Builder->CreateICmp(LHSCC, NewOr, LHSCst);
1724     }
1725   }
1726
1727   // (icmp ult (X + CA), C1) | (icmp eq X, C2) -> (icmp ule (X + CA), C1)
1728   //   iff C2 + CA == C1.
1729   if (LHSCC == ICmpInst::ICMP_ULT && RHSCC == ICmpInst::ICMP_EQ) {
1730     ConstantInt *AddCst;
1731     if (match(Val, m_Add(m_Specific(Val2), m_ConstantInt(AddCst))))
1732       if (RHSCst->getValue() + AddCst->getValue() == LHSCst->getValue())
1733         return Builder->CreateICmpULE(Val, LHSCst);
1734   }
1735
1736   // From here on, we only handle:
1737   //    (icmp1 A, C1) | (icmp2 A, C2) --> something simpler.
1738   if (Val != Val2) return nullptr;
1739
1740   // ICMP_[US][GL]E X, CST is folded to ICMP_[US][GL]T elsewhere.
1741   if (LHSCC == ICmpInst::ICMP_UGE || LHSCC == ICmpInst::ICMP_ULE ||
1742       RHSCC == ICmpInst::ICMP_UGE || RHSCC == ICmpInst::ICMP_ULE ||
1743       LHSCC == ICmpInst::ICMP_SGE || LHSCC == ICmpInst::ICMP_SLE ||
1744       RHSCC == ICmpInst::ICMP_SGE || RHSCC == ICmpInst::ICMP_SLE)
1745     return nullptr;
1746
1747   // We can't fold (ugt x, C) | (sgt x, C2).
1748   if (!PredicatesFoldable(LHSCC, RHSCC))
1749     return nullptr;
1750
1751   // Ensure that the larger constant is on the RHS.
1752   bool ShouldSwap;
1753   if (CmpInst::isSigned(LHSCC) ||
1754       (ICmpInst::isEquality(LHSCC) &&
1755        CmpInst::isSigned(RHSCC)))
1756     ShouldSwap = LHSCst->getValue().sgt(RHSCst->getValue());
1757   else
1758     ShouldSwap = LHSCst->getValue().ugt(RHSCst->getValue());
1759
1760   if (ShouldSwap) {
1761     std::swap(LHS, RHS);
1762     std::swap(LHSCst, RHSCst);
1763     std::swap(LHSCC, RHSCC);
1764   }
1765
1766   // At this point, we know we have two icmp instructions
1767   // comparing a value against two constants and or'ing the result
1768   // together.  Because of the above check, we know that we only have
1769   // ICMP_EQ, ICMP_NE, ICMP_LT, and ICMP_GT here. We also know (from the
1770   // icmp folding check above), that the two constants are not
1771   // equal.
1772   assert(LHSCst != RHSCst && "Compares not folded above?");
1773
1774   switch (LHSCC) {
1775   default: llvm_unreachable("Unknown integer condition code!");
1776   case ICmpInst::ICMP_EQ:
1777     switch (RHSCC) {
1778     default: llvm_unreachable("Unknown integer condition code!");
1779     case ICmpInst::ICMP_EQ:
1780       if (LHS->getOperand(0) == RHS->getOperand(0)) {
1781         // if LHSCst and RHSCst differ only by one bit:
1782         // (A == C1 || A == C2) -> (A & ~(C1 ^ C2)) == C1
1783         assert(LHSCst->getValue().ule(LHSCst->getValue()));
1784
1785         APInt Xor = LHSCst->getValue() ^ RHSCst->getValue();
1786         if (Xor.isPowerOf2()) {
1787           Value *NegCst = Builder->getInt(~Xor);
1788           Value *And = Builder->CreateAnd(LHS->getOperand(0), NegCst);
1789           return Builder->CreateICmp(ICmpInst::ICMP_EQ, And, LHSCst);
1790         }
1791       }
1792
1793       if (LHSCst == SubOne(RHSCst)) {
1794         // (X == 13 | X == 14) -> X-13 <u 2
1795         Constant *AddCST = ConstantExpr::getNeg(LHSCst);
1796         Value *Add = Builder->CreateAdd(Val, AddCST, Val->getName()+".off");
1797         AddCST = ConstantExpr::getSub(AddOne(RHSCst), LHSCst);
1798         return Builder->CreateICmpULT(Add, AddCST);
1799       }
1800
1801       break;                         // (X == 13 | X == 15) -> no change
1802     case ICmpInst::ICMP_UGT:         // (X == 13 | X u> 14) -> no change
1803     case ICmpInst::ICMP_SGT:         // (X == 13 | X s> 14) -> no change
1804       break;
1805     case ICmpInst::ICMP_NE:          // (X == 13 | X != 15) -> X != 15
1806     case ICmpInst::ICMP_ULT:         // (X == 13 | X u< 15) -> X u< 15
1807     case ICmpInst::ICMP_SLT:         // (X == 13 | X s< 15) -> X s< 15
1808       return RHS;
1809     }
1810     break;
1811   case ICmpInst::ICMP_NE:
1812     switch (RHSCC) {
1813     default: llvm_unreachable("Unknown integer condition code!");
1814     case ICmpInst::ICMP_EQ:          // (X != 13 | X == 15) -> X != 13
1815     case ICmpInst::ICMP_UGT:         // (X != 13 | X u> 15) -> X != 13
1816     case ICmpInst::ICMP_SGT:         // (X != 13 | X s> 15) -> X != 13
1817       return LHS;
1818     case ICmpInst::ICMP_NE:          // (X != 13 | X != 15) -> true
1819     case ICmpInst::ICMP_ULT:         // (X != 13 | X u< 15) -> true
1820     case ICmpInst::ICMP_SLT:         // (X != 13 | X s< 15) -> true
1821       return Builder->getTrue();
1822     }
1823   case ICmpInst::ICMP_ULT:
1824     switch (RHSCC) {
1825     default: llvm_unreachable("Unknown integer condition code!");
1826     case ICmpInst::ICMP_EQ:         // (X u< 13 | X == 14) -> no change
1827       break;
1828     case ICmpInst::ICMP_UGT:        // (X u< 13 | X u> 15) -> (X-13) u> 2
1829       // If RHSCst is [us]MAXINT, it is always false.  Not handling
1830       // this can cause overflow.
1831       if (RHSCst->isMaxValue(false))
1832         return LHS;
1833       return InsertRangeTest(Val, LHSCst, AddOne(RHSCst), false, false);
1834     case ICmpInst::ICMP_SGT:        // (X u< 13 | X s> 15) -> no change
1835       break;
1836     case ICmpInst::ICMP_NE:         // (X u< 13 | X != 15) -> X != 15
1837     case ICmpInst::ICMP_ULT:        // (X u< 13 | X u< 15) -> X u< 15
1838       return RHS;
1839     case ICmpInst::ICMP_SLT:        // (X u< 13 | X s< 15) -> no change
1840       break;
1841     }
1842     break;
1843   case ICmpInst::ICMP_SLT:
1844     switch (RHSCC) {
1845     default: llvm_unreachable("Unknown integer condition code!");
1846     case ICmpInst::ICMP_EQ:         // (X s< 13 | X == 14) -> no change
1847       break;
1848     case ICmpInst::ICMP_SGT:        // (X s< 13 | X s> 15) -> (X-13) s> 2
1849       // If RHSCst is [us]MAXINT, it is always false.  Not handling
1850       // this can cause overflow.
1851       if (RHSCst->isMaxValue(true))
1852         return LHS;
1853       return InsertRangeTest(Val, LHSCst, AddOne(RHSCst), true, false);
1854     case ICmpInst::ICMP_UGT:        // (X s< 13 | X u> 15) -> no change
1855       break;
1856     case ICmpInst::ICMP_NE:         // (X s< 13 | X != 15) -> X != 15
1857     case ICmpInst::ICMP_SLT:        // (X s< 13 | X s< 15) -> X s< 15
1858       return RHS;
1859     case ICmpInst::ICMP_ULT:        // (X s< 13 | X u< 15) -> no change
1860       break;
1861     }
1862     break;
1863   case ICmpInst::ICMP_UGT:
1864     switch (RHSCC) {
1865     default: llvm_unreachable("Unknown integer condition code!");
1866     case ICmpInst::ICMP_EQ:         // (X u> 13 | X == 15) -> X u> 13
1867     case ICmpInst::ICMP_UGT:        // (X u> 13 | X u> 15) -> X u> 13
1868       return LHS;
1869     case ICmpInst::ICMP_SGT:        // (X u> 13 | X s> 15) -> no change
1870       break;
1871     case ICmpInst::ICMP_NE:         // (X u> 13 | X != 15) -> true
1872     case ICmpInst::ICMP_ULT:        // (X u> 13 | X u< 15) -> true
1873       return Builder->getTrue();
1874     case ICmpInst::ICMP_SLT:        // (X u> 13 | X s< 15) -> no change
1875       break;
1876     }
1877     break;
1878   case ICmpInst::ICMP_SGT:
1879     switch (RHSCC) {
1880     default: llvm_unreachable("Unknown integer condition code!");
1881     case ICmpInst::ICMP_EQ:         // (X s> 13 | X == 15) -> X > 13
1882     case ICmpInst::ICMP_SGT:        // (X s> 13 | X s> 15) -> X > 13
1883       return LHS;
1884     case ICmpInst::ICMP_UGT:        // (X s> 13 | X u> 15) -> no change
1885       break;
1886     case ICmpInst::ICMP_NE:         // (X s> 13 | X != 15) -> true
1887     case ICmpInst::ICMP_SLT:        // (X s> 13 | X s< 15) -> true
1888       return Builder->getTrue();
1889     case ICmpInst::ICMP_ULT:        // (X s> 13 | X u< 15) -> no change
1890       break;
1891     }
1892     break;
1893   }
1894   return nullptr;
1895 }
1896
1897 /// FoldOrOfFCmps - Optimize (fcmp)|(fcmp).  NOTE: Unlike the rest of
1898 /// instcombine, this returns a Value which should already be inserted into the
1899 /// function.
1900 Value *InstCombiner::FoldOrOfFCmps(FCmpInst *LHS, FCmpInst *RHS) {
1901   if (LHS->getPredicate() == FCmpInst::FCMP_UNO &&
1902       RHS->getPredicate() == FCmpInst::FCMP_UNO &&
1903       LHS->getOperand(0)->getType() == RHS->getOperand(0)->getType()) {
1904     if (ConstantFP *LHSC = dyn_cast<ConstantFP>(LHS->getOperand(1)))
1905       if (ConstantFP *RHSC = dyn_cast<ConstantFP>(RHS->getOperand(1))) {
1906         // If either of the constants are nans, then the whole thing returns
1907         // true.
1908         if (LHSC->getValueAPF().isNaN() || RHSC->getValueAPF().isNaN())
1909           return Builder->getTrue();
1910
1911         // Otherwise, no need to compare the two constants, compare the
1912         // rest.
1913         return Builder->CreateFCmpUNO(LHS->getOperand(0), RHS->getOperand(0));
1914       }
1915
1916     // Handle vector zeros.  This occurs because the canonical form of
1917     // "fcmp uno x,x" is "fcmp uno x, 0".
1918     if (isa<ConstantAggregateZero>(LHS->getOperand(1)) &&
1919         isa<ConstantAggregateZero>(RHS->getOperand(1)))
1920       return Builder->CreateFCmpUNO(LHS->getOperand(0), RHS->getOperand(0));
1921
1922     return nullptr;
1923   }
1924
1925   Value *Op0LHS = LHS->getOperand(0), *Op0RHS = LHS->getOperand(1);
1926   Value *Op1LHS = RHS->getOperand(0), *Op1RHS = RHS->getOperand(1);
1927   FCmpInst::Predicate Op0CC = LHS->getPredicate(), Op1CC = RHS->getPredicate();
1928
1929   if (Op0LHS == Op1RHS && Op0RHS == Op1LHS) {
1930     // Swap RHS operands to match LHS.
1931     Op1CC = FCmpInst::getSwappedPredicate(Op1CC);
1932     std::swap(Op1LHS, Op1RHS);
1933   }
1934   if (Op0LHS == Op1LHS && Op0RHS == Op1RHS) {
1935     // Simplify (fcmp cc0 x, y) | (fcmp cc1 x, y).
1936     if (Op0CC == Op1CC)
1937       return Builder->CreateFCmp((FCmpInst::Predicate)Op0CC, Op0LHS, Op0RHS);
1938     if (Op0CC == FCmpInst::FCMP_TRUE || Op1CC == FCmpInst::FCMP_TRUE)
1939       return ConstantInt::get(CmpInst::makeCmpResultType(LHS->getType()), 1);
1940     if (Op0CC == FCmpInst::FCMP_FALSE)
1941       return RHS;
1942     if (Op1CC == FCmpInst::FCMP_FALSE)
1943       return LHS;
1944     bool Op0Ordered;
1945     bool Op1Ordered;
1946     unsigned Op0Pred = getFCmpCode(Op0CC, Op0Ordered);
1947     unsigned Op1Pred = getFCmpCode(Op1CC, Op1Ordered);
1948     if (Op0Ordered == Op1Ordered) {
1949       // If both are ordered or unordered, return a new fcmp with
1950       // or'ed predicates.
1951       return getFCmpValue(Op0Ordered, Op0Pred|Op1Pred, Op0LHS, Op0RHS, Builder);
1952     }
1953   }
1954   return nullptr;
1955 }
1956
1957 /// FoldOrWithConstants - This helper function folds:
1958 ///
1959 ///     ((A | B) & C1) | (B & C2)
1960 ///
1961 /// into:
1962 ///
1963 ///     (A & C1) | B
1964 ///
1965 /// when the XOR of the two constants is "all ones" (-1).
1966 Instruction *InstCombiner::FoldOrWithConstants(BinaryOperator &I, Value *Op,
1967                                                Value *A, Value *B, Value *C) {
1968   ConstantInt *CI1 = dyn_cast<ConstantInt>(C);
1969   if (!CI1) return nullptr;
1970
1971   Value *V1 = nullptr;
1972   ConstantInt *CI2 = nullptr;
1973   if (!match(Op, m_And(m_Value(V1), m_ConstantInt(CI2)))) return nullptr;
1974
1975   APInt Xor = CI1->getValue() ^ CI2->getValue();
1976   if (!Xor.isAllOnesValue()) return nullptr;
1977
1978   if (V1 == A || V1 == B) {
1979     Value *NewOp = Builder->CreateAnd((V1 == A) ? B : A, CI1);
1980     return BinaryOperator::CreateOr(NewOp, V1);
1981   }
1982
1983   return nullptr;
1984 }
1985
1986 Instruction *InstCombiner::visitOr(BinaryOperator &I) {
1987   bool Changed = SimplifyAssociativeOrCommutative(I);
1988   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1989
1990   if (Value *V = SimplifyVectorOp(I))
1991     return ReplaceInstUsesWith(I, V);
1992
1993   if (Value *V = SimplifyOrInst(Op0, Op1, DL))
1994     return ReplaceInstUsesWith(I, V);
1995
1996   // (A&B)|(A&C) -> A&(B|C) etc
1997   if (Value *V = SimplifyUsingDistributiveLaws(I))
1998     return ReplaceInstUsesWith(I, V);
1999
2000   // See if we can simplify any instructions used by the instruction whose sole
2001   // purpose is to compute bits we don't care about.
2002   if (SimplifyDemandedInstructionBits(I))
2003     return &I;
2004
2005   if (ConstantInt *RHS = dyn_cast<ConstantInt>(Op1)) {
2006     ConstantInt *C1 = nullptr; Value *X = nullptr;
2007     // (X & C1) | C2 --> (X | C2) & (C1|C2)
2008     // iff (C1 & C2) == 0.
2009     if (match(Op0, m_And(m_Value(X), m_ConstantInt(C1))) &&
2010         (RHS->getValue() & C1->getValue()) != 0 &&
2011         Op0->hasOneUse()) {
2012       Value *Or = Builder->CreateOr(X, RHS);
2013       Or->takeName(Op0);
2014       return BinaryOperator::CreateAnd(Or,
2015                              Builder->getInt(RHS->getValue() | C1->getValue()));
2016     }
2017
2018     // (X ^ C1) | C2 --> (X | C2) ^ (C1&~C2)
2019     if (match(Op0, m_Xor(m_Value(X), m_ConstantInt(C1))) &&
2020         Op0->hasOneUse()) {
2021       Value *Or = Builder->CreateOr(X, RHS);
2022       Or->takeName(Op0);
2023       return BinaryOperator::CreateXor(Or,
2024                             Builder->getInt(C1->getValue() & ~RHS->getValue()));
2025     }
2026
2027     // Try to fold constant and into select arguments.
2028     if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
2029       if (Instruction *R = FoldOpIntoSelect(I, SI))
2030         return R;
2031
2032     if (isa<PHINode>(Op0))
2033       if (Instruction *NV = FoldOpIntoPhi(I))
2034         return NV;
2035   }
2036
2037   Value *A = nullptr, *B = nullptr;
2038   ConstantInt *C1 = nullptr, *C2 = nullptr;
2039
2040   // (A | B) | C  and  A | (B | C)                  -> bswap if possible.
2041   // (A >> B) | (C << D)  and  (A << B) | (B >> C)  -> bswap if possible.
2042   if (match(Op0, m_Or(m_Value(), m_Value())) ||
2043       match(Op1, m_Or(m_Value(), m_Value())) ||
2044       (match(Op0, m_LogicalShift(m_Value(), m_Value())) &&
2045        match(Op1, m_LogicalShift(m_Value(), m_Value())))) {
2046     if (Instruction *BSwap = MatchBSwap(I))
2047       return BSwap;
2048   }
2049
2050   // (X^C)|Y -> (X|Y)^C iff Y&C == 0
2051   if (Op0->hasOneUse() &&
2052       match(Op0, m_Xor(m_Value(A), m_ConstantInt(C1))) &&
2053       MaskedValueIsZero(Op1, C1->getValue())) {
2054     Value *NOr = Builder->CreateOr(A, Op1);
2055     NOr->takeName(Op0);
2056     return BinaryOperator::CreateXor(NOr, C1);
2057   }
2058
2059   // Y|(X^C) -> (X|Y)^C iff Y&C == 0
2060   if (Op1->hasOneUse() &&
2061       match(Op1, m_Xor(m_Value(A), m_ConstantInt(C1))) &&
2062       MaskedValueIsZero(Op0, C1->getValue())) {
2063     Value *NOr = Builder->CreateOr(A, Op0);
2064     NOr->takeName(Op0);
2065     return BinaryOperator::CreateXor(NOr, C1);
2066   }
2067
2068   // ((~A & B) | A) -> (A | B)
2069   if (match(Op0, m_And(m_Not(m_Value(A)), m_Value(B))) &&
2070       match(Op1, m_Specific(A)))
2071     return BinaryOperator::CreateOr(A, B);
2072
2073   // ((A & B) | ~A) -> (~A | B)
2074   if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
2075       match(Op1, m_Not(m_Specific(A))))
2076     return BinaryOperator::CreateOr(Builder->CreateNot(A), B);
2077
2078   // (A & (~B)) | (A ^ B) -> (A ^ B)
2079   if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
2080       match(Op1, m_Xor(m_Specific(A), m_Specific(B))))
2081     return BinaryOperator::CreateXor(A, B);
2082
2083   // (A ^ B) | ( A & (~B)) -> (A ^ B)
2084   if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
2085       match(Op1, m_And(m_Specific(A), m_Not(m_Specific(B)))))
2086     return BinaryOperator::CreateXor(A, B);
2087
2088   // (A & C)|(B & D)
2089   Value *C = nullptr, *D = nullptr;
2090   if (match(Op0, m_And(m_Value(A), m_Value(C))) &&
2091       match(Op1, m_And(m_Value(B), m_Value(D)))) {
2092     Value *V1 = nullptr, *V2 = nullptr;
2093     C1 = dyn_cast<ConstantInt>(C);
2094     C2 = dyn_cast<ConstantInt>(D);
2095     if (C1 && C2) {  // (A & C1)|(B & C2)
2096       if ((C1->getValue() & C2->getValue()) == 0) {
2097         // ((V | N) & C1) | (V & C2) --> (V|N) & (C1|C2)
2098         // iff (C1&C2) == 0 and (N&~C1) == 0
2099         if (match(A, m_Or(m_Value(V1), m_Value(V2))) &&
2100             ((V1 == B && MaskedValueIsZero(V2, ~C1->getValue())) ||  // (V|N)
2101              (V2 == B && MaskedValueIsZero(V1, ~C1->getValue()))))   // (N|V)
2102           return BinaryOperator::CreateAnd(A,
2103                                 Builder->getInt(C1->getValue()|C2->getValue()));
2104         // Or commutes, try both ways.
2105         if (match(B, m_Or(m_Value(V1), m_Value(V2))) &&
2106             ((V1 == A && MaskedValueIsZero(V2, ~C2->getValue())) ||  // (V|N)
2107              (V2 == A && MaskedValueIsZero(V1, ~C2->getValue()))))   // (N|V)
2108           return BinaryOperator::CreateAnd(B,
2109                                 Builder->getInt(C1->getValue()|C2->getValue()));
2110
2111         // ((V|C3)&C1) | ((V|C4)&C2) --> (V|C3|C4)&(C1|C2)
2112         // iff (C1&C2) == 0 and (C3&~C1) == 0 and (C4&~C2) == 0.
2113         ConstantInt *C3 = nullptr, *C4 = nullptr;
2114         if (match(A, m_Or(m_Value(V1), m_ConstantInt(C3))) &&
2115             (C3->getValue() & ~C1->getValue()) == 0 &&
2116             match(B, m_Or(m_Specific(V1), m_ConstantInt(C4))) &&
2117             (C4->getValue() & ~C2->getValue()) == 0) {
2118           V2 = Builder->CreateOr(V1, ConstantExpr::getOr(C3, C4), "bitfield");
2119           return BinaryOperator::CreateAnd(V2,
2120                                 Builder->getInt(C1->getValue()|C2->getValue()));
2121         }
2122       }
2123     }
2124
2125     // (A & (C0?-1:0)) | (B & ~(C0?-1:0)) ->  C0 ? A : B, and commuted variants.
2126     // Don't do this for vector select idioms, the code generator doesn't handle
2127     // them well yet.
2128     if (!I.getType()->isVectorTy()) {
2129       if (Instruction *Match = MatchSelectFromAndOr(A, B, C, D))
2130         return Match;
2131       if (Instruction *Match = MatchSelectFromAndOr(B, A, D, C))
2132         return Match;
2133       if (Instruction *Match = MatchSelectFromAndOr(C, B, A, D))
2134         return Match;
2135       if (Instruction *Match = MatchSelectFromAndOr(D, A, B, C))
2136         return Match;
2137     }
2138
2139     // ((A&~B)|(~A&B)) -> A^B
2140     if ((match(C, m_Not(m_Specific(D))) &&
2141          match(B, m_Not(m_Specific(A)))))
2142       return BinaryOperator::CreateXor(A, D);
2143     // ((~B&A)|(~A&B)) -> A^B
2144     if ((match(A, m_Not(m_Specific(D))) &&
2145          match(B, m_Not(m_Specific(C)))))
2146       return BinaryOperator::CreateXor(C, D);
2147     // ((A&~B)|(B&~A)) -> A^B
2148     if ((match(C, m_Not(m_Specific(B))) &&
2149          match(D, m_Not(m_Specific(A)))))
2150       return BinaryOperator::CreateXor(A, B);
2151     // ((~B&A)|(B&~A)) -> A^B
2152     if ((match(A, m_Not(m_Specific(B))) &&
2153          match(D, m_Not(m_Specific(C)))))
2154       return BinaryOperator::CreateXor(C, B);
2155
2156     // ((A|B)&1)|(B&-2) -> (A&1) | B
2157     if (match(A, m_Or(m_Value(V1), m_Specific(B))) ||
2158         match(A, m_Or(m_Specific(B), m_Value(V1)))) {
2159       Instruction *Ret = FoldOrWithConstants(I, Op1, V1, B, C);
2160       if (Ret) return Ret;
2161     }
2162     // (B&-2)|((A|B)&1) -> (A&1) | B
2163     if (match(B, m_Or(m_Specific(A), m_Value(V1))) ||
2164         match(B, m_Or(m_Value(V1), m_Specific(A)))) {
2165       Instruction *Ret = FoldOrWithConstants(I, Op0, A, V1, D);
2166       if (Ret) return Ret;
2167     }
2168   }
2169
2170   // (A ^ B) | ((B ^ C) ^ A) -> (A ^ B) | C
2171   if (match(Op0, m_Xor(m_Value(A), m_Value(B))))
2172     if (match(Op1, m_Xor(m_Xor(m_Specific(B), m_Value(C)), m_Specific(A))))
2173       if (Op1->hasOneUse() || cast<BinaryOperator>(Op1)->hasOneUse())
2174         return BinaryOperator::CreateOr(Op0, C);
2175
2176   // ((A ^ C) ^ B) | (B ^ A) -> (B ^ A) | C
2177   if (match(Op0, m_Xor(m_Xor(m_Value(A), m_Value(C)), m_Value(B))))
2178     if (match(Op1, m_Xor(m_Specific(B), m_Specific(A))))
2179       if (Op0->hasOneUse() || cast<BinaryOperator>(Op0)->hasOneUse())
2180         return BinaryOperator::CreateOr(Op1, C);
2181
2182   // ((B | C) & A) | B -> B | (A & C)
2183   if (match(Op0, m_And(m_Or(m_Specific(Op1), m_Value(C)), m_Value(A))))
2184     return BinaryOperator::CreateOr(Op1, Builder->CreateAnd(A, C));
2185
2186   // (X >> Z) | (Y >> Z)  -> (X|Y) >> Z  for all shifts.
2187   if (BinaryOperator *SI1 = dyn_cast<BinaryOperator>(Op1)) {
2188     if (BinaryOperator *SI0 = dyn_cast<BinaryOperator>(Op0))
2189       if (SI0->isShift() && SI0->getOpcode() == SI1->getOpcode() &&
2190           SI0->getOperand(1) == SI1->getOperand(1) &&
2191           (SI0->hasOneUse() || SI1->hasOneUse())) {
2192         Value *NewOp = Builder->CreateOr(SI0->getOperand(0), SI1->getOperand(0),
2193                                          SI0->getName());
2194         return BinaryOperator::Create(SI1->getOpcode(), NewOp,
2195                                       SI1->getOperand(1));
2196       }
2197   }
2198
2199   // (~A | ~B) == (~(A & B)) - De Morgan's Law
2200   if (Value *Op0NotVal = dyn_castNotVal(Op0))
2201     if (Value *Op1NotVal = dyn_castNotVal(Op1))
2202       if (Op0->hasOneUse() && Op1->hasOneUse()) {
2203         Value *And = Builder->CreateAnd(Op0NotVal, Op1NotVal,
2204                                         I.getName()+".demorgan");
2205         return BinaryOperator::CreateNot(And);
2206       }
2207
2208   // Canonicalize xor to the RHS.
2209   bool SwappedForXor = false;
2210   if (match(Op0, m_Xor(m_Value(), m_Value()))) {
2211     std::swap(Op0, Op1);
2212     SwappedForXor = true;
2213   }
2214
2215   // A | ( A ^ B) -> A |  B
2216   // A | (~A ^ B) -> A | ~B
2217   // (A & B) | (A ^ B)
2218   if (match(Op1, m_Xor(m_Value(A), m_Value(B)))) {
2219     if (Op0 == A || Op0 == B)
2220       return BinaryOperator::CreateOr(A, B);
2221
2222     if (match(Op0, m_And(m_Specific(A), m_Specific(B))) ||
2223         match(Op0, m_And(m_Specific(B), m_Specific(A))))
2224       return BinaryOperator::CreateOr(A, B);
2225
2226     if (Op1->hasOneUse() && match(A, m_Not(m_Specific(Op0)))) {
2227       Value *Not = Builder->CreateNot(B, B->getName()+".not");
2228       return BinaryOperator::CreateOr(Not, Op0);
2229     }
2230     if (Op1->hasOneUse() && match(B, m_Not(m_Specific(Op0)))) {
2231       Value *Not = Builder->CreateNot(A, A->getName()+".not");
2232       return BinaryOperator::CreateOr(Not, Op0);
2233     }
2234   }
2235
2236   // A | ~(A | B) -> A | ~B
2237   // A | ~(A ^ B) -> A | ~B
2238   if (match(Op1, m_Not(m_Value(A))))
2239     if (BinaryOperator *B = dyn_cast<BinaryOperator>(A))
2240       if ((Op0 == B->getOperand(0) || Op0 == B->getOperand(1)) &&
2241           Op1->hasOneUse() && (B->getOpcode() == Instruction::Or ||
2242                                B->getOpcode() == Instruction::Xor)) {
2243         Value *NotOp = Op0 == B->getOperand(0) ? B->getOperand(1) :
2244                                                  B->getOperand(0);
2245         Value *Not = Builder->CreateNot(NotOp, NotOp->getName()+".not");
2246         return BinaryOperator::CreateOr(Not, Op0);
2247       }
2248
2249   // (A & B) | ((~A) ^ B) -> (~A ^ B)
2250   if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
2251       match(Op1, m_Xor(m_Not(m_Specific(A)), m_Specific(B))))
2252     return BinaryOperator::CreateXor(Builder->CreateNot(A), B);
2253
2254   // ((~A) ^ B) | (A & B) -> (~A ^ B)
2255   if (match(Op0, m_Xor(m_Not(m_Value(A)), m_Value(B))) &&
2256       match(Op1, m_And(m_Specific(A), m_Specific(B))))
2257     return BinaryOperator::CreateXor(Builder->CreateNot(A), B);
2258
2259   if (SwappedForXor)
2260     std::swap(Op0, Op1);
2261
2262   if (ICmpInst *RHS = dyn_cast<ICmpInst>(I.getOperand(1)))
2263     if (ICmpInst *LHS = dyn_cast<ICmpInst>(I.getOperand(0)))
2264       if (Value *Res = FoldOrOfICmps(LHS, RHS))
2265         return ReplaceInstUsesWith(I, Res);
2266
2267   // (fcmp uno x, c) | (fcmp uno y, c)  -> (fcmp uno x, y)
2268   if (FCmpInst *LHS = dyn_cast<FCmpInst>(I.getOperand(0)))
2269     if (FCmpInst *RHS = dyn_cast<FCmpInst>(I.getOperand(1)))
2270       if (Value *Res = FoldOrOfFCmps(LHS, RHS))
2271         return ReplaceInstUsesWith(I, Res);
2272
2273   // fold (or (cast A), (cast B)) -> (cast (or A, B))
2274   if (CastInst *Op0C = dyn_cast<CastInst>(Op0)) {
2275     CastInst *Op1C = dyn_cast<CastInst>(Op1);
2276     if (Op1C && Op0C->getOpcode() == Op1C->getOpcode()) {// same cast kind ?
2277       Type *SrcTy = Op0C->getOperand(0)->getType();
2278       if (SrcTy == Op1C->getOperand(0)->getType() &&
2279           SrcTy->isIntOrIntVectorTy()) {
2280         Value *Op0COp = Op0C->getOperand(0), *Op1COp = Op1C->getOperand(0);
2281
2282         if ((!isa<ICmpInst>(Op0COp) || !isa<ICmpInst>(Op1COp)) &&
2283             // Only do this if the casts both really cause code to be
2284             // generated.
2285             ShouldOptimizeCast(Op0C->getOpcode(), Op0COp, I.getType()) &&
2286             ShouldOptimizeCast(Op1C->getOpcode(), Op1COp, I.getType())) {
2287           Value *NewOp = Builder->CreateOr(Op0COp, Op1COp, I.getName());
2288           return CastInst::Create(Op0C->getOpcode(), NewOp, I.getType());
2289         }
2290
2291         // If this is or(cast(icmp), cast(icmp)), try to fold this even if the
2292         // cast is otherwise not optimizable.  This happens for vector sexts.
2293         if (ICmpInst *RHS = dyn_cast<ICmpInst>(Op1COp))
2294           if (ICmpInst *LHS = dyn_cast<ICmpInst>(Op0COp))
2295             if (Value *Res = FoldOrOfICmps(LHS, RHS))
2296               return CastInst::Create(Op0C->getOpcode(), Res, I.getType());
2297
2298         // If this is or(cast(fcmp), cast(fcmp)), try to fold this even if the
2299         // cast is otherwise not optimizable.  This happens for vector sexts.
2300         if (FCmpInst *RHS = dyn_cast<FCmpInst>(Op1COp))
2301           if (FCmpInst *LHS = dyn_cast<FCmpInst>(Op0COp))
2302             if (Value *Res = FoldOrOfFCmps(LHS, RHS))
2303               return CastInst::Create(Op0C->getOpcode(), Res, I.getType());
2304       }
2305     }
2306   }
2307
2308   // or(sext(A), B) -> A ? -1 : B where A is an i1
2309   // or(A, sext(B)) -> B ? -1 : A where B is an i1
2310   if (match(Op0, m_SExt(m_Value(A))) && A->getType()->isIntegerTy(1))
2311     return SelectInst::Create(A, ConstantInt::getSigned(I.getType(), -1), Op1);
2312   if (match(Op1, m_SExt(m_Value(A))) && A->getType()->isIntegerTy(1))
2313     return SelectInst::Create(A, ConstantInt::getSigned(I.getType(), -1), Op0);
2314
2315   // Note: If we've gotten to the point of visiting the outer OR, then the
2316   // inner one couldn't be simplified.  If it was a constant, then it won't
2317   // be simplified by a later pass either, so we try swapping the inner/outer
2318   // ORs in the hopes that we'll be able to simplify it this way.
2319   // (X|C) | V --> (X|V) | C
2320   if (Op0->hasOneUse() && !isa<ConstantInt>(Op1) &&
2321       match(Op0, m_Or(m_Value(A), m_ConstantInt(C1)))) {
2322     Value *Inner = Builder->CreateOr(A, Op1);
2323     Inner->takeName(Op0);
2324     return BinaryOperator::CreateOr(Inner, C1);
2325   }
2326
2327   // Change (or (bool?A:B),(bool?C:D)) --> (bool?(or A,C):(or B,D))
2328   // Since this OR statement hasn't been optimized further yet, we hope
2329   // that this transformation will allow the new ORs to be optimized.
2330   {
2331     Value *X = nullptr, *Y = nullptr;
2332     if (Op0->hasOneUse() && Op1->hasOneUse() &&
2333         match(Op0, m_Select(m_Value(X), m_Value(A), m_Value(B))) &&
2334         match(Op1, m_Select(m_Value(Y), m_Value(C), m_Value(D))) && X == Y) {
2335       Value *orTrue = Builder->CreateOr(A, C);
2336       Value *orFalse = Builder->CreateOr(B, D);
2337       return SelectInst::Create(X, orTrue, orFalse);
2338     }
2339   }
2340
2341   return Changed ? &I : nullptr;
2342 }
2343
2344 Instruction *InstCombiner::visitXor(BinaryOperator &I) {
2345   bool Changed = SimplifyAssociativeOrCommutative(I);
2346   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
2347
2348   if (Value *V = SimplifyVectorOp(I))
2349     return ReplaceInstUsesWith(I, V);
2350
2351   if (Value *V = SimplifyXorInst(Op0, Op1, DL))
2352     return ReplaceInstUsesWith(I, V);
2353
2354   // (A&B)^(A&C) -> A&(B^C) etc
2355   if (Value *V = SimplifyUsingDistributiveLaws(I))
2356     return ReplaceInstUsesWith(I, V);
2357
2358   // See if we can simplify any instructions used by the instruction whose sole
2359   // purpose is to compute bits we don't care about.
2360   if (SimplifyDemandedInstructionBits(I))
2361     return &I;
2362
2363   // Is this a ~ operation?
2364   if (Value *NotOp = dyn_castNotVal(&I)) {
2365     if (BinaryOperator *Op0I = dyn_cast<BinaryOperator>(NotOp)) {
2366       if (Op0I->getOpcode() == Instruction::And ||
2367           Op0I->getOpcode() == Instruction::Or) {
2368         // ~(~X & Y) --> (X | ~Y) - De Morgan's Law
2369         // ~(~X | Y) === (X & ~Y) - De Morgan's Law
2370         if (dyn_castNotVal(Op0I->getOperand(1)))
2371           Op0I->swapOperands();
2372         if (Value *Op0NotVal = dyn_castNotVal(Op0I->getOperand(0))) {
2373           Value *NotY =
2374             Builder->CreateNot(Op0I->getOperand(1),
2375                                Op0I->getOperand(1)->getName()+".not");
2376           if (Op0I->getOpcode() == Instruction::And)
2377             return BinaryOperator::CreateOr(Op0NotVal, NotY);
2378           return BinaryOperator::CreateAnd(Op0NotVal, NotY);
2379         }
2380
2381         // ~(X & Y) --> (~X | ~Y) - De Morgan's Law
2382         // ~(X | Y) === (~X & ~Y) - De Morgan's Law
2383         if (isFreeToInvert(Op0I->getOperand(0)) &&
2384             isFreeToInvert(Op0I->getOperand(1))) {
2385           Value *NotX =
2386             Builder->CreateNot(Op0I->getOperand(0), "notlhs");
2387           Value *NotY =
2388             Builder->CreateNot(Op0I->getOperand(1), "notrhs");
2389           if (Op0I->getOpcode() == Instruction::And)
2390             return BinaryOperator::CreateOr(NotX, NotY);
2391           return BinaryOperator::CreateAnd(NotX, NotY);
2392         }
2393
2394       } else if (Op0I->getOpcode() == Instruction::AShr) {
2395         // ~(~X >>s Y) --> (X >>s Y)
2396         if (Value *Op0NotVal = dyn_castNotVal(Op0I->getOperand(0)))
2397           return BinaryOperator::CreateAShr(Op0NotVal, Op0I->getOperand(1));
2398       }
2399     }
2400   }
2401
2402
2403   if (ConstantInt *RHS = dyn_cast<ConstantInt>(Op1)) {
2404     if (RHS->isOne() && Op0->hasOneUse())
2405       // xor (cmp A, B), true = not (cmp A, B) = !cmp A, B
2406       if (CmpInst *CI = dyn_cast<CmpInst>(Op0))
2407         return CmpInst::Create(CI->getOpcode(),
2408                                CI->getInversePredicate(),
2409                                CI->getOperand(0), CI->getOperand(1));
2410
2411     // fold (xor(zext(cmp)), 1) and (xor(sext(cmp)), -1) to ext(!cmp).
2412     if (CastInst *Op0C = dyn_cast<CastInst>(Op0)) {
2413       if (CmpInst *CI = dyn_cast<CmpInst>(Op0C->getOperand(0))) {
2414         if (CI->hasOneUse() && Op0C->hasOneUse()) {
2415           Instruction::CastOps Opcode = Op0C->getOpcode();
2416           if ((Opcode == Instruction::ZExt || Opcode == Instruction::SExt) &&
2417               (RHS == ConstantExpr::getCast(Opcode, Builder->getTrue(),
2418                                             Op0C->getDestTy()))) {
2419             CI->setPredicate(CI->getInversePredicate());
2420             return CastInst::Create(Opcode, CI, Op0C->getType());
2421           }
2422         }
2423       }
2424     }
2425
2426     if (BinaryOperator *Op0I = dyn_cast<BinaryOperator>(Op0)) {
2427       // ~(c-X) == X-c-1 == X+(-c-1)
2428       if (Op0I->getOpcode() == Instruction::Sub && RHS->isAllOnesValue())
2429         if (Constant *Op0I0C = dyn_cast<Constant>(Op0I->getOperand(0))) {
2430           Constant *NegOp0I0C = ConstantExpr::getNeg(Op0I0C);
2431           Constant *ConstantRHS = ConstantExpr::getSub(NegOp0I0C,
2432                                       ConstantInt::get(I.getType(), 1));
2433           return BinaryOperator::CreateAdd(Op0I->getOperand(1), ConstantRHS);
2434         }
2435
2436       if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1))) {
2437         if (Op0I->getOpcode() == Instruction::Add) {
2438           // ~(X-c) --> (-c-1)-X
2439           if (RHS->isAllOnesValue()) {
2440             Constant *NegOp0CI = ConstantExpr::getNeg(Op0CI);
2441             return BinaryOperator::CreateSub(
2442                            ConstantExpr::getSub(NegOp0CI,
2443                                       ConstantInt::get(I.getType(), 1)),
2444                                       Op0I->getOperand(0));
2445           } else if (RHS->getValue().isSignBit()) {
2446             // (X + C) ^ signbit -> (X + C + signbit)
2447             Constant *C = Builder->getInt(RHS->getValue() + Op0CI->getValue());
2448             return BinaryOperator::CreateAdd(Op0I->getOperand(0), C);
2449
2450           }
2451         } else if (Op0I->getOpcode() == Instruction::Or) {
2452           // (X|C1)^C2 -> X^(C1|C2) iff X&~C1 == 0
2453           if (MaskedValueIsZero(Op0I->getOperand(0), Op0CI->getValue())) {
2454             Constant *NewRHS = ConstantExpr::getOr(Op0CI, RHS);
2455             // Anything in both C1 and C2 is known to be zero, remove it from
2456             // NewRHS.
2457             Constant *CommonBits = ConstantExpr::getAnd(Op0CI, RHS);
2458             NewRHS = ConstantExpr::getAnd(NewRHS,
2459                                        ConstantExpr::getNot(CommonBits));
2460             Worklist.Add(Op0I);
2461             I.setOperand(0, Op0I->getOperand(0));
2462             I.setOperand(1, NewRHS);
2463             return &I;
2464           }
2465         } else if (Op0I->getOpcode() == Instruction::LShr) {
2466           // ((X^C1) >> C2) ^ C3 -> (X>>C2) ^ ((C1>>C2)^C3)
2467           // E1 = "X ^ C1"
2468           BinaryOperator *E1;
2469           ConstantInt *C1;
2470           if (Op0I->hasOneUse() &&
2471               (E1 = dyn_cast<BinaryOperator>(Op0I->getOperand(0))) &&
2472               E1->getOpcode() == Instruction::Xor &&
2473               (C1 = dyn_cast<ConstantInt>(E1->getOperand(1)))) {
2474             // fold (C1 >> C2) ^ C3
2475             ConstantInt *C2 = Op0CI, *C3 = RHS;
2476             APInt FoldConst = C1->getValue().lshr(C2->getValue());
2477             FoldConst ^= C3->getValue();
2478             // Prepare the two operands.
2479             Value *Opnd0 = Builder->CreateLShr(E1->getOperand(0), C2);
2480             Opnd0->takeName(Op0I);
2481             cast<Instruction>(Opnd0)->setDebugLoc(I.getDebugLoc());
2482             Value *FoldVal = ConstantInt::get(Opnd0->getType(), FoldConst);
2483
2484             return BinaryOperator::CreateXor(Opnd0, FoldVal);
2485           }
2486         }
2487       }
2488     }
2489
2490     // Try to fold constant and into select arguments.
2491     if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
2492       if (Instruction *R = FoldOpIntoSelect(I, SI))
2493         return R;
2494     if (isa<PHINode>(Op0))
2495       if (Instruction *NV = FoldOpIntoPhi(I))
2496         return NV;
2497   }
2498
2499   BinaryOperator *Op1I = dyn_cast<BinaryOperator>(Op1);
2500   if (Op1I) {
2501     Value *A, *B;
2502     if (match(Op1I, m_Or(m_Value(A), m_Value(B)))) {
2503       if (A == Op0) {              // B^(B|A) == (A|B)^B
2504         Op1I->swapOperands();
2505         I.swapOperands();
2506         std::swap(Op0, Op1);
2507       } else if (B == Op0) {       // B^(A|B) == (A|B)^B
2508         I.swapOperands();     // Simplified below.
2509         std::swap(Op0, Op1);
2510       }
2511     } else if (match(Op1I, m_And(m_Value(A), m_Value(B))) &&
2512                Op1I->hasOneUse()){
2513       if (A == Op0) {                                      // A^(A&B) -> A^(B&A)
2514         Op1I->swapOperands();
2515         std::swap(A, B);
2516       }
2517       if (B == Op0) {                                      // A^(B&A) -> (B&A)^A
2518         I.swapOperands();     // Simplified below.
2519         std::swap(Op0, Op1);
2520       }
2521     }
2522   }
2523
2524   BinaryOperator *Op0I = dyn_cast<BinaryOperator>(Op0);
2525   if (Op0I) {
2526     Value *A, *B;
2527     if (match(Op0I, m_Or(m_Value(A), m_Value(B))) &&
2528         Op0I->hasOneUse()) {
2529       if (A == Op1)                                  // (B|A)^B == (A|B)^B
2530         std::swap(A, B);
2531       if (B == Op1)                                  // (A|B)^B == A & ~B
2532         return BinaryOperator::CreateAnd(A, Builder->CreateNot(Op1));
2533     } else if (match(Op0I, m_And(m_Value(A), m_Value(B))) &&
2534                Op0I->hasOneUse()){
2535       if (A == Op1)                                        // (A&B)^A -> (B&A)^A
2536         std::swap(A, B);
2537       if (B == Op1 &&                                      // (B&A)^A == ~B & A
2538           !isa<ConstantInt>(Op1)) {  // Canonical form is (B&C)^C
2539         return BinaryOperator::CreateAnd(Builder->CreateNot(A), Op1);
2540       }
2541     }
2542   }
2543
2544   // (X >> Z) ^ (Y >> Z)  -> (X^Y) >> Z  for all shifts.
2545   if (Op0I && Op1I && Op0I->isShift() &&
2546       Op0I->getOpcode() == Op1I->getOpcode() &&
2547       Op0I->getOperand(1) == Op1I->getOperand(1) &&
2548       (Op0I->hasOneUse() || Op1I->hasOneUse())) {
2549     Value *NewOp =
2550       Builder->CreateXor(Op0I->getOperand(0), Op1I->getOperand(0),
2551                          Op0I->getName());
2552     return BinaryOperator::Create(Op1I->getOpcode(), NewOp,
2553                                   Op1I->getOperand(1));
2554   }
2555
2556   if (Op0I && Op1I) {
2557     Value *A, *B, *C, *D;
2558     // (A & B)^(A | B) -> A ^ B
2559     if (match(Op0I, m_And(m_Value(A), m_Value(B))) &&
2560         match(Op1I, m_Or(m_Value(C), m_Value(D)))) {
2561       if ((A == C && B == D) || (A == D && B == C))
2562         return BinaryOperator::CreateXor(A, B);
2563     }
2564     // (A | B)^(A & B) -> A ^ B
2565     if (match(Op0I, m_Or(m_Value(A), m_Value(B))) &&
2566         match(Op1I, m_And(m_Value(C), m_Value(D)))) {
2567       if ((A == C && B == D) || (A == D && B == C))
2568         return BinaryOperator::CreateXor(A, B);
2569     }
2570     // (A | ~B) ^ (~A | B) -> A ^ B
2571     if (match(Op0I, m_Or(m_Value(A), m_Not(m_Value(B)))) &&
2572         match(Op1I, m_Or(m_Not(m_Specific(A)), m_Specific(B)))) {
2573       return BinaryOperator::CreateXor(A, B);
2574     }
2575     // (~A | B) ^ (A | ~B) -> A ^ B
2576     if (match(Op0I, m_Or(m_Not(m_Value(A)), m_Value(B))) &&
2577         match(Op1I, m_Or(m_Specific(A), m_Not(m_Specific(B))))) {
2578       return BinaryOperator::CreateXor(A, B);
2579     }
2580     // (A & ~B) ^ (~A & B) -> A ^ B
2581     if (match(Op0I, m_And(m_Value(A), m_Not(m_Value(B)))) &&
2582         match(Op1I, m_And(m_Not(m_Specific(A)), m_Specific(B)))) {
2583       return BinaryOperator::CreateXor(A, B);
2584     }
2585     // (~A & B) ^ (A & ~B) -> A ^ B
2586     if (match(Op0I, m_And(m_Not(m_Value(A)), m_Value(B))) &&
2587         match(Op1I, m_And(m_Specific(A), m_Not(m_Specific(B))))) {
2588       return BinaryOperator::CreateXor(A, B);
2589     }
2590     // (A ^ B)^(A | B) -> A & B
2591     if (match(Op0I, m_Xor(m_Value(A), m_Value(B))) &&
2592         match(Op1I, m_Or(m_Value(C), m_Value(D)))) {
2593       if ((A == C && B == D) || (A == D && B == C))
2594         return BinaryOperator::CreateAnd(A, B);
2595     }
2596     // (A | B)^(A ^ B) -> A & B
2597     if (match(Op0I, m_Or(m_Value(A), m_Value(B))) &&
2598         match(Op1I, m_Xor(m_Value(C), m_Value(D)))) {
2599       if ((A == C && B == D) || (A == D && B == C))
2600         return BinaryOperator::CreateAnd(A, B);
2601     }
2602     // (A & B) ^ (A ^ B) -> (A | B)
2603     if (match(Op0I, m_And(m_Value(A), m_Value(B))) &&
2604         match(Op1I, m_Xor(m_Specific(A), m_Specific(B))))
2605       return BinaryOperator::CreateOr(A, B);
2606     // (A ^ B) ^ (A & B) -> (A | B)
2607     if (match(Op0I, m_Xor(m_Value(A), m_Value(B))) &&
2608         match(Op1I, m_And(m_Specific(A), m_Specific(B))))
2609       return BinaryOperator::CreateOr(A, B);
2610   }
2611
2612   // (A | B)^(~A) -> (A | ~B)
2613   Value *A = nullptr, *B = nullptr;
2614   if (match(Op0, m_Or(m_Value(A), m_Value(B))) &&
2615       match(Op1, m_Not(m_Specific(A))))
2616     return BinaryOperator::CreateOr(A, Builder->CreateNot(B));
2617
2618   // (A & ~B) ^ (~A) -> ~(A & B)
2619   if (match(Op0, m_And(m_Value(A), m_Not(m_Value(B)))) &&
2620       match(Op1, m_Not(m_Specific(A))))
2621     return BinaryOperator::CreateNot(Builder->CreateAnd(A, B));
2622
2623   // (icmp1 A, B) ^ (icmp2 A, B) --> (icmp3 A, B)
2624   if (ICmpInst *RHS = dyn_cast<ICmpInst>(I.getOperand(1)))
2625     if (ICmpInst *LHS = dyn_cast<ICmpInst>(I.getOperand(0)))
2626       if (PredicatesFoldable(LHS->getPredicate(), RHS->getPredicate())) {
2627         if (LHS->getOperand(0) == RHS->getOperand(1) &&
2628             LHS->getOperand(1) == RHS->getOperand(0))
2629           LHS->swapOperands();
2630         if (LHS->getOperand(0) == RHS->getOperand(0) &&
2631             LHS->getOperand(1) == RHS->getOperand(1)) {
2632           Value *Op0 = LHS->getOperand(0), *Op1 = LHS->getOperand(1);
2633           unsigned Code = getICmpCode(LHS) ^ getICmpCode(RHS);
2634           bool isSigned = LHS->isSigned() || RHS->isSigned();
2635           return ReplaceInstUsesWith(I,
2636                                getNewICmpValue(isSigned, Code, Op0, Op1,
2637                                                Builder));
2638         }
2639       }
2640
2641   // fold (xor (cast A), (cast B)) -> (cast (xor A, B))
2642   if (CastInst *Op0C = dyn_cast<CastInst>(Op0)) {
2643     if (CastInst *Op1C = dyn_cast<CastInst>(Op1))
2644       if (Op0C->getOpcode() == Op1C->getOpcode()) { // same cast kind?
2645         Type *SrcTy = Op0C->getOperand(0)->getType();
2646         if (SrcTy == Op1C->getOperand(0)->getType() && SrcTy->isIntegerTy() &&
2647             // Only do this if the casts both really cause code to be generated.
2648             ShouldOptimizeCast(Op0C->getOpcode(), Op0C->getOperand(0),
2649                                I.getType()) &&
2650             ShouldOptimizeCast(Op1C->getOpcode(), Op1C->getOperand(0),
2651                                I.getType())) {
2652           Value *NewOp = Builder->CreateXor(Op0C->getOperand(0),
2653                                             Op1C->getOperand(0), I.getName());
2654           return CastInst::Create(Op0C->getOpcode(), NewOp, I.getType());
2655         }
2656       }
2657   }
2658
2659   return Changed ? &I : nullptr;
2660 }