1 //===- InstCombineAndOrXor.cpp --------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements the visitAnd, visitOr, and visitXor functions.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "InstCombineInternal.h"
14 #include "llvm/Analysis/CmpInstAnalysis.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/InstCombine/InstCombiner.h"
20 #include "llvm/Transforms/Utils/Local.h"
21 
22 using namespace llvm;
23 using namespace PatternMatch;
24 
25 #define DEBUG_TYPE "instcombine"
26 
27 /// Similar to getICmpCode but for FCmpInst. This encodes a fcmp predicate into
28 /// a four bit mask.
29 static unsigned getFCmpCode(FCmpInst::Predicate CC) {
30   assert(FCmpInst::FCMP_FALSE <= CC && CC <= FCmpInst::FCMP_TRUE &&
31          "Unexpected FCmp predicate!");
32   // Take advantage of the bit pattern of FCmpInst::Predicate here.
33   //                                                 U L G E
34   static_assert(FCmpInst::FCMP_FALSE ==  0, "");  // 0 0 0 0
35   static_assert(FCmpInst::FCMP_OEQ   ==  1, "");  // 0 0 0 1
36   static_assert(FCmpInst::FCMP_OGT   ==  2, "");  // 0 0 1 0
37   static_assert(FCmpInst::FCMP_OGE   ==  3, "");  // 0 0 1 1
38   static_assert(FCmpInst::FCMP_OLT   ==  4, "");  // 0 1 0 0
39   static_assert(FCmpInst::FCMP_OLE   ==  5, "");  // 0 1 0 1
40   static_assert(FCmpInst::FCMP_ONE   ==  6, "");  // 0 1 1 0
41   static_assert(FCmpInst::FCMP_ORD   ==  7, "");  // 0 1 1 1
42   static_assert(FCmpInst::FCMP_UNO   ==  8, "");  // 1 0 0 0
43   static_assert(FCmpInst::FCMP_UEQ   ==  9, "");  // 1 0 0 1
44   static_assert(FCmpInst::FCMP_UGT   == 10, "");  // 1 0 1 0
45   static_assert(FCmpInst::FCMP_UGE   == 11, "");  // 1 0 1 1
46   static_assert(FCmpInst::FCMP_ULT   == 12, "");  // 1 1 0 0
47   static_assert(FCmpInst::FCMP_ULE   == 13, "");  // 1 1 0 1
48   static_assert(FCmpInst::FCMP_UNE   == 14, "");  // 1 1 1 0
49   static_assert(FCmpInst::FCMP_TRUE  == 15, "");  // 1 1 1 1
50   return CC;
51 }
52 
53 /// This is the complement of getICmpCode, which turns an opcode and two
54 /// operands into either a constant true or false, or a brand new ICmp
55 /// instruction. The sign is passed in to determine which kind of predicate to
56 /// use in the new icmp instruction.
57 static Value *getNewICmpValue(unsigned Code, bool Sign, Value *LHS, Value *RHS,
58                               InstCombiner::BuilderTy &Builder) {
59   ICmpInst::Predicate NewPred;
60   if (Constant *TorF = getPredForICmpCode(Code, Sign, LHS->getType(), NewPred))
61     return TorF;
62   return Builder.CreateICmp(NewPred, LHS, RHS);
63 }
64 
65 /// This is the complement of getFCmpCode, which turns an opcode and two
66 /// operands into either a FCmp instruction, or a true/false constant.
67 static Value *getFCmpValue(unsigned Code, Value *LHS, Value *RHS,
68                            InstCombiner::BuilderTy &Builder) {
69   const auto Pred = static_cast<FCmpInst::Predicate>(Code);
70   assert(FCmpInst::FCMP_FALSE <= Pred && Pred <= FCmpInst::FCMP_TRUE &&
71          "Unexpected FCmp predicate!");
72   if (Pred == FCmpInst::FCMP_FALSE)
73     return ConstantInt::get(CmpInst::makeCmpResultType(LHS->getType()), 0);
74   if (Pred == FCmpInst::FCMP_TRUE)
75     return ConstantInt::get(CmpInst::makeCmpResultType(LHS->getType()), 1);
76   return Builder.CreateFCmp(Pred, LHS, RHS);
77 }
78 
79 /// Transform BITWISE_OP(BSWAP(A),BSWAP(B)) or
80 /// BITWISE_OP(BSWAP(A), Constant) to BSWAP(BITWISE_OP(A, B))
81 /// \param I Binary operator to transform.
82 /// \return Pointer to node that must replace the original binary operator, or
83 ///         null pointer if no transformation was made.
84 static Value *SimplifyBSwap(BinaryOperator &I,
85                             InstCombiner::BuilderTy &Builder) {
86   assert(I.isBitwiseLogicOp() && "Unexpected opcode for bswap simplifying");
87 
88   Value *OldLHS = I.getOperand(0);
89   Value *OldRHS = I.getOperand(1);
90 
91   Value *NewLHS;
92   if (!match(OldLHS, m_BSwap(m_Value(NewLHS))))
93     return nullptr;
94 
95   Value *NewRHS;
96   const APInt *C;
97 
98   if (match(OldRHS, m_BSwap(m_Value(NewRHS)))) {
99     // OP( BSWAP(x), BSWAP(y) ) -> BSWAP( OP(x, y) )
100     if (!OldLHS->hasOneUse() && !OldRHS->hasOneUse())
101       return nullptr;
102     // NewRHS initialized by the matcher.
103   } else if (match(OldRHS, m_APInt(C))) {
104     // OP( BSWAP(x), CONSTANT ) -> BSWAP( OP(x, BSWAP(CONSTANT) ) )
105     if (!OldLHS->hasOneUse())
106       return nullptr;
107     NewRHS = ConstantInt::get(I.getType(), C->byteSwap());
108   } else
109     return nullptr;
110 
111   Value *BinOp = Builder.CreateBinOp(I.getOpcode(), NewLHS, NewRHS);
112   Function *F = Intrinsic::getDeclaration(I.getModule(), Intrinsic::bswap,
113                                           I.getType());
114   return Builder.CreateCall(F, BinOp);
115 }
116 
117 /// Emit a computation of: (V >= Lo && V < Hi) if Inside is true, otherwise
118 /// (V < Lo || V >= Hi). This method expects that Lo < Hi. IsSigned indicates
119 /// whether to treat V, Lo, and Hi as signed or not.
120 Value *InstCombinerImpl::insertRangeTest(Value *V, const APInt &Lo,
121                                          const APInt &Hi, bool isSigned,
122                                          bool Inside) {
123   assert((isSigned ? Lo.slt(Hi) : Lo.ult(Hi)) &&
124          "Lo is not < Hi in range emission code!");
125 
126   Type *Ty = V->getType();
127 
128   // V >= Min && V <  Hi --> V <  Hi
129   // V <  Min || V >= Hi --> V >= Hi
130   ICmpInst::Predicate Pred = Inside ? ICmpInst::ICMP_ULT : ICmpInst::ICMP_UGE;
131   if (isSigned ? Lo.isMinSignedValue() : Lo.isMinValue()) {
132     Pred = isSigned ? ICmpInst::getSignedPredicate(Pred) : Pred;
133     return Builder.CreateICmp(Pred, V, ConstantInt::get(Ty, Hi));
134   }
135 
136   // V >= Lo && V <  Hi --> V - Lo u<  Hi - Lo
137   // V <  Lo || V >= Hi --> V - Lo u>= Hi - Lo
138   Value *VMinusLo =
139       Builder.CreateSub(V, ConstantInt::get(Ty, Lo), V->getName() + ".off");
140   Constant *HiMinusLo = ConstantInt::get(Ty, Hi - Lo);
141   return Builder.CreateICmp(Pred, VMinusLo, HiMinusLo);
142 }
143 
144 /// Classify (icmp eq (A & B), C) and (icmp ne (A & B), C) as matching patterns
145 /// that can be simplified.
146 /// One of A and B is considered the mask. The other is the value. This is
147 /// described as the "AMask" or "BMask" part of the enum. If the enum contains
148 /// only "Mask", then both A and B can be considered masks. If A is the mask,
149 /// then it was proven that (A & C) == C. This is trivial if C == A or C == 0.
150 /// If both A and C are constants, this proof is also easy.
151 /// For the following explanations, we assume that A is the mask.
152 ///
153 /// "AllOnes" declares that the comparison is true only if (A & B) == A or all
154 /// bits of A are set in B.
155 ///   Example: (icmp eq (A & 3), 3) -> AMask_AllOnes
156 ///
157 /// "AllZeros" declares that the comparison is true only if (A & B) == 0 or all
158 /// bits of A are cleared in B.
159 ///   Example: (icmp eq (A & 3), 0) -> Mask_AllZeroes
160 ///
161 /// "Mixed" declares that (A & B) == C and C might or might not contain any
162 /// number of one bits and zero bits.
163 ///   Example: (icmp eq (A & 3), 1) -> AMask_Mixed
164 ///
165 /// "Not" means that in above descriptions "==" should be replaced by "!=".
166 ///   Example: (icmp ne (A & 3), 3) -> AMask_NotAllOnes
167 ///
168 /// If the mask A contains a single bit, then the following is equivalent:
169 ///    (icmp eq (A & B), A) equals (icmp ne (A & B), 0)
170 ///    (icmp ne (A & B), A) equals (icmp eq (A & B), 0)
171 enum MaskedICmpType {
172   AMask_AllOnes           =     1,
173   AMask_NotAllOnes        =     2,
174   BMask_AllOnes           =     4,
175   BMask_NotAllOnes        =     8,
176   Mask_AllZeros           =    16,
177   Mask_NotAllZeros        =    32,
178   AMask_Mixed             =    64,
179   AMask_NotMixed          =   128,
180   BMask_Mixed             =   256,
181   BMask_NotMixed          =   512
182 };
183 
184 /// Return the set of patterns (from MaskedICmpType) that (icmp SCC (A & B), C)
185 /// satisfies.
186 static unsigned getMaskedICmpType(Value *A, Value *B, Value *C,
187                                   ICmpInst::Predicate Pred) {
188   const APInt *ConstA = nullptr, *ConstB = nullptr, *ConstC = nullptr;
189   match(A, m_APInt(ConstA));
190   match(B, m_APInt(ConstB));
191   match(C, m_APInt(ConstC));
192   bool IsEq = (Pred == ICmpInst::ICMP_EQ);
193   bool IsAPow2 = ConstA && ConstA->isPowerOf2();
194   bool IsBPow2 = ConstB && ConstB->isPowerOf2();
195   unsigned MaskVal = 0;
196   if (ConstC && ConstC->isZero()) {
197     // if C is zero, then both A and B qualify as mask
198     MaskVal |= (IsEq ? (Mask_AllZeros | AMask_Mixed | BMask_Mixed)
199                      : (Mask_NotAllZeros | AMask_NotMixed | BMask_NotMixed));
200     if (IsAPow2)
201       MaskVal |= (IsEq ? (AMask_NotAllOnes | AMask_NotMixed)
202                        : (AMask_AllOnes | AMask_Mixed));
203     if (IsBPow2)
204       MaskVal |= (IsEq ? (BMask_NotAllOnes | BMask_NotMixed)
205                        : (BMask_AllOnes | BMask_Mixed));
206     return MaskVal;
207   }
208 
209   if (A == C) {
210     MaskVal |= (IsEq ? (AMask_AllOnes | AMask_Mixed)
211                      : (AMask_NotAllOnes | AMask_NotMixed));
212     if (IsAPow2)
213       MaskVal |= (IsEq ? (Mask_NotAllZeros | AMask_NotMixed)
214                        : (Mask_AllZeros | AMask_Mixed));
215   } else if (ConstA && ConstC && ConstC->isSubsetOf(*ConstA)) {
216     MaskVal |= (IsEq ? AMask_Mixed : AMask_NotMixed);
217   }
218 
219   if (B == C) {
220     MaskVal |= (IsEq ? (BMask_AllOnes | BMask_Mixed)
221                      : (BMask_NotAllOnes | BMask_NotMixed));
222     if (IsBPow2)
223       MaskVal |= (IsEq ? (Mask_NotAllZeros | BMask_NotMixed)
224                        : (Mask_AllZeros | BMask_Mixed));
225   } else if (ConstB && ConstC && ConstC->isSubsetOf(*ConstB)) {
226     MaskVal |= (IsEq ? BMask_Mixed : BMask_NotMixed);
227   }
228 
229   return MaskVal;
230 }
231 
232 /// Convert an analysis of a masked ICmp into its equivalent if all boolean
233 /// operations had the opposite sense. Since each "NotXXX" flag (recording !=)
234 /// is adjacent to the corresponding normal flag (recording ==), this just
235 /// involves swapping those bits over.
236 static unsigned conjugateICmpMask(unsigned Mask) {
237   unsigned NewMask;
238   NewMask = (Mask & (AMask_AllOnes | BMask_AllOnes | Mask_AllZeros |
239                      AMask_Mixed | BMask_Mixed))
240             << 1;
241 
242   NewMask |= (Mask & (AMask_NotAllOnes | BMask_NotAllOnes | Mask_NotAllZeros |
243                       AMask_NotMixed | BMask_NotMixed))
244              >> 1;
245 
246   return NewMask;
247 }
248 
249 // Adapts the external decomposeBitTestICmp for local use.
250 static bool decomposeBitTestICmp(Value *LHS, Value *RHS, CmpInst::Predicate &Pred,
251                                  Value *&X, Value *&Y, Value *&Z) {
252   APInt Mask;
253   if (!llvm::decomposeBitTestICmp(LHS, RHS, Pred, X, Mask))
254     return false;
255 
256   Y = ConstantInt::get(X->getType(), Mask);
257   Z = ConstantInt::get(X->getType(), 0);
258   return true;
259 }
260 
261 /// Handle (icmp(A & B) ==/!= C) &/| (icmp(A & D) ==/!= E).
262 /// Return the pattern classes (from MaskedICmpType) for the left hand side and
263 /// the right hand side as a pair.
264 /// LHS and RHS are the left hand side and the right hand side ICmps and PredL
265 /// and PredR are their predicates, respectively.
266 static
267 Optional<std::pair<unsigned, unsigned>>
268 getMaskedTypeForICmpPair(Value *&A, Value *&B, Value *&C,
269                          Value *&D, Value *&E, ICmpInst *LHS,
270                          ICmpInst *RHS,
271                          ICmpInst::Predicate &PredL,
272                          ICmpInst::Predicate &PredR) {
273   // Don't allow pointers. Splat vectors are fine.
274   if (!LHS->getOperand(0)->getType()->isIntOrIntVectorTy() ||
275       !RHS->getOperand(0)->getType()->isIntOrIntVectorTy())
276     return None;
277 
278   // Here comes the tricky part:
279   // LHS might be of the form L11 & L12 == X, X == L21 & L22,
280   // and L11 & L12 == L21 & L22. The same goes for RHS.
281   // Now we must find those components L** and R**, that are equal, so
282   // that we can extract the parameters A, B, C, D, and E for the canonical
283   // above.
284   Value *L1 = LHS->getOperand(0);
285   Value *L2 = LHS->getOperand(1);
286   Value *L11, *L12, *L21, *L22;
287   // Check whether the icmp can be decomposed into a bit test.
288   if (decomposeBitTestICmp(L1, L2, PredL, L11, L12, L2)) {
289     L21 = L22 = L1 = nullptr;
290   } else {
291     // Look for ANDs in the LHS icmp.
292     if (!match(L1, m_And(m_Value(L11), m_Value(L12)))) {
293       // Any icmp can be viewed as being trivially masked; if it allows us to
294       // remove one, it's worth it.
295       L11 = L1;
296       L12 = Constant::getAllOnesValue(L1->getType());
297     }
298 
299     if (!match(L2, m_And(m_Value(L21), m_Value(L22)))) {
300       L21 = L2;
301       L22 = Constant::getAllOnesValue(L2->getType());
302     }
303   }
304 
305   // Bail if LHS was a icmp that can't be decomposed into an equality.
306   if (!ICmpInst::isEquality(PredL))
307     return None;
308 
309   Value *R1 = RHS->getOperand(0);
310   Value *R2 = RHS->getOperand(1);
311   Value *R11, *R12;
312   bool Ok = false;
313   if (decomposeBitTestICmp(R1, R2, PredR, R11, R12, R2)) {
314     if (R11 == L11 || R11 == L12 || R11 == L21 || R11 == L22) {
315       A = R11;
316       D = R12;
317     } else if (R12 == L11 || R12 == L12 || R12 == L21 || R12 == L22) {
318       A = R12;
319       D = R11;
320     } else {
321       return None;
322     }
323     E = R2;
324     R1 = nullptr;
325     Ok = true;
326   } else {
327     if (!match(R1, m_And(m_Value(R11), m_Value(R12)))) {
328       // As before, model no mask as a trivial mask if it'll let us do an
329       // optimization.
330       R11 = R1;
331       R12 = Constant::getAllOnesValue(R1->getType());
332     }
333 
334     if (R11 == L11 || R11 == L12 || R11 == L21 || R11 == L22) {
335       A = R11;
336       D = R12;
337       E = R2;
338       Ok = true;
339     } else if (R12 == L11 || R12 == L12 || R12 == L21 || R12 == L22) {
340       A = R12;
341       D = R11;
342       E = R2;
343       Ok = true;
344     }
345   }
346 
347   // Bail if RHS was a icmp that can't be decomposed into an equality.
348   if (!ICmpInst::isEquality(PredR))
349     return None;
350 
351   // Look for ANDs on the right side of the RHS icmp.
352   if (!Ok) {
353     if (!match(R2, m_And(m_Value(R11), m_Value(R12)))) {
354       R11 = R2;
355       R12 = Constant::getAllOnesValue(R2->getType());
356     }
357 
358     if (R11 == L11 || R11 == L12 || R11 == L21 || R11 == L22) {
359       A = R11;
360       D = R12;
361       E = R1;
362       Ok = true;
363     } else if (R12 == L11 || R12 == L12 || R12 == L21 || R12 == L22) {
364       A = R12;
365       D = R11;
366       E = R1;
367       Ok = true;
368     } else {
369       return None;
370     }
371 
372     assert(Ok && "Failed to find AND on the right side of the RHS icmp.");
373   }
374 
375   if (L11 == A) {
376     B = L12;
377     C = L2;
378   } else if (L12 == A) {
379     B = L11;
380     C = L2;
381   } else if (L21 == A) {
382     B = L22;
383     C = L1;
384   } else if (L22 == A) {
385     B = L21;
386     C = L1;
387   }
388 
389   unsigned LeftType = getMaskedICmpType(A, B, C, PredL);
390   unsigned RightType = getMaskedICmpType(A, D, E, PredR);
391   return Optional<std::pair<unsigned, unsigned>>(std::make_pair(LeftType, RightType));
392 }
393 
394 /// Try to fold (icmp(A & B) ==/!= C) &/| (icmp(A & D) ==/!= E) into a single
395 /// (icmp(A & X) ==/!= Y), where the left-hand side is of type Mask_NotAllZeros
396 /// and the right hand side is of type BMask_Mixed. For example,
397 /// (icmp (A & 12) != 0) & (icmp (A & 15) == 8) -> (icmp (A & 15) == 8).
398 static Value *foldLogOpOfMaskedICmps_NotAllZeros_BMask_Mixed(
399     ICmpInst *LHS, ICmpInst *RHS, bool IsAnd, Value *A, Value *B, Value *C,
400     Value *D, Value *E, ICmpInst::Predicate PredL, ICmpInst::Predicate PredR,
401     InstCombiner::BuilderTy &Builder) {
402   // We are given the canonical form:
403   //   (icmp ne (A & B), 0) & (icmp eq (A & D), E).
404   // where D & E == E.
405   //
406   // If IsAnd is false, we get it in negated form:
407   //   (icmp eq (A & B), 0) | (icmp ne (A & D), E) ->
408   //      !((icmp ne (A & B), 0) & (icmp eq (A & D), E)).
409   //
410   // We currently handle the case of B, C, D, E are constant.
411   //
412   ConstantInt *BCst, *CCst, *DCst, *ECst;
413   if (!match(B, m_ConstantInt(BCst)) || !match(C, m_ConstantInt(CCst)) ||
414       !match(D, m_ConstantInt(DCst)) || !match(E, m_ConstantInt(ECst)))
415     return nullptr;
416 
417   ICmpInst::Predicate NewCC = IsAnd ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE;
418 
419   // Update E to the canonical form when D is a power of two and RHS is
420   // canonicalized as,
421   // (icmp ne (A & D), 0) -> (icmp eq (A & D), D) or
422   // (icmp ne (A & D), D) -> (icmp eq (A & D), 0).
423   if (PredR != NewCC)
424     ECst = cast<ConstantInt>(ConstantExpr::getXor(DCst, ECst));
425 
426   // If B or D is zero, skip because if LHS or RHS can be trivially folded by
427   // other folding rules and this pattern won't apply any more.
428   if (BCst->getValue() == 0 || DCst->getValue() == 0)
429     return nullptr;
430 
431   // If B and D don't intersect, ie. (B & D) == 0, no folding because we can't
432   // deduce anything from it.
433   // For example,
434   // (icmp ne (A & 12), 0) & (icmp eq (A & 3), 1) -> no folding.
435   if ((BCst->getValue() & DCst->getValue()) == 0)
436     return nullptr;
437 
438   // If the following two conditions are met:
439   //
440   // 1. mask B covers only a single bit that's not covered by mask D, that is,
441   // (B & (B ^ D)) is a power of 2 (in other words, B minus the intersection of
442   // B and D has only one bit set) and,
443   //
444   // 2. RHS (and E) indicates that the rest of B's bits are zero (in other
445   // words, the intersection of B and D is zero), that is, ((B & D) & E) == 0
446   //
447   // then that single bit in B must be one and thus the whole expression can be
448   // folded to
449   //   (A & (B | D)) == (B & (B ^ D)) | E.
450   //
451   // For example,
452   // (icmp ne (A & 12), 0) & (icmp eq (A & 7), 1) -> (icmp eq (A & 15), 9)
453   // (icmp ne (A & 15), 0) & (icmp eq (A & 7), 0) -> (icmp eq (A & 15), 8)
454   if ((((BCst->getValue() & DCst->getValue()) & ECst->getValue()) == 0) &&
455       (BCst->getValue() & (BCst->getValue() ^ DCst->getValue())).isPowerOf2()) {
456     APInt BorD = BCst->getValue() | DCst->getValue();
457     APInt BandBxorDorE = (BCst->getValue() & (BCst->getValue() ^ DCst->getValue())) |
458         ECst->getValue();
459     Value *NewMask = ConstantInt::get(BCst->getType(), BorD);
460     Value *NewMaskedValue = ConstantInt::get(BCst->getType(), BandBxorDorE);
461     Value *NewAnd = Builder.CreateAnd(A, NewMask);
462     return Builder.CreateICmp(NewCC, NewAnd, NewMaskedValue);
463   }
464 
465   auto IsSubSetOrEqual = [](ConstantInt *C1, ConstantInt *C2) {
466     return (C1->getValue() & C2->getValue()) == C1->getValue();
467   };
468   auto IsSuperSetOrEqual = [](ConstantInt *C1, ConstantInt *C2) {
469     return (C1->getValue() & C2->getValue()) == C2->getValue();
470   };
471 
472   // In the following, we consider only the cases where B is a superset of D, B
473   // is a subset of D, or B == D because otherwise there's at least one bit
474   // covered by B but not D, in which case we can't deduce much from it, so
475   // no folding (aside from the single must-be-one bit case right above.)
476   // For example,
477   // (icmp ne (A & 14), 0) & (icmp eq (A & 3), 1) -> no folding.
478   if (!IsSubSetOrEqual(BCst, DCst) && !IsSuperSetOrEqual(BCst, DCst))
479     return nullptr;
480 
481   // At this point, either B is a superset of D, B is a subset of D or B == D.
482 
483   // If E is zero, if B is a subset of (or equal to) D, LHS and RHS contradict
484   // and the whole expression becomes false (or true if negated), otherwise, no
485   // folding.
486   // For example,
487   // (icmp ne (A & 3), 0) & (icmp eq (A & 7), 0) -> false.
488   // (icmp ne (A & 15), 0) & (icmp eq (A & 3), 0) -> no folding.
489   if (ECst->isZero()) {
490     if (IsSubSetOrEqual(BCst, DCst))
491       return ConstantInt::get(LHS->getType(), !IsAnd);
492     return nullptr;
493   }
494 
495   // At this point, B, D, E aren't zero and (B & D) == B, (B & D) == D or B ==
496   // D. If B is a superset of (or equal to) D, since E is not zero, LHS is
497   // subsumed by RHS (RHS implies LHS.) So the whole expression becomes
498   // RHS. For example,
499   // (icmp ne (A & 255), 0) & (icmp eq (A & 15), 8) -> (icmp eq (A & 15), 8).
500   // (icmp ne (A & 15), 0) & (icmp eq (A & 15), 8) -> (icmp eq (A & 15), 8).
501   if (IsSuperSetOrEqual(BCst, DCst))
502     return RHS;
503   // Otherwise, B is a subset of D. If B and E have a common bit set,
504   // ie. (B & E) != 0, then LHS is subsumed by RHS. For example.
505   // (icmp ne (A & 12), 0) & (icmp eq (A & 15), 8) -> (icmp eq (A & 15), 8).
506   assert(IsSubSetOrEqual(BCst, DCst) && "Precondition due to above code");
507   if ((BCst->getValue() & ECst->getValue()) != 0)
508     return RHS;
509   // Otherwise, LHS and RHS contradict and the whole expression becomes false
510   // (or true if negated.) For example,
511   // (icmp ne (A & 7), 0) & (icmp eq (A & 15), 8) -> false.
512   // (icmp ne (A & 6), 0) & (icmp eq (A & 15), 8) -> false.
513   return ConstantInt::get(LHS->getType(), !IsAnd);
514 }
515 
516 /// Try to fold (icmp(A & B) ==/!= 0) &/| (icmp(A & D) ==/!= E) into a single
517 /// (icmp(A & X) ==/!= Y), where the left-hand side and the right hand side
518 /// aren't of the common mask pattern type.
519 static Value *foldLogOpOfMaskedICmpsAsymmetric(
520     ICmpInst *LHS, ICmpInst *RHS, bool IsAnd, Value *A, Value *B, Value *C,
521     Value *D, Value *E, ICmpInst::Predicate PredL, ICmpInst::Predicate PredR,
522     unsigned LHSMask, unsigned RHSMask, InstCombiner::BuilderTy &Builder) {
523   assert(ICmpInst::isEquality(PredL) && ICmpInst::isEquality(PredR) &&
524          "Expected equality predicates for masked type of icmps.");
525   // Handle Mask_NotAllZeros-BMask_Mixed cases.
526   // (icmp ne/eq (A & B), C) &/| (icmp eq/ne (A & D), E), or
527   // (icmp eq/ne (A & B), C) &/| (icmp ne/eq (A & D), E)
528   //    which gets swapped to
529   //    (icmp ne/eq (A & D), E) &/| (icmp eq/ne (A & B), C).
530   if (!IsAnd) {
531     LHSMask = conjugateICmpMask(LHSMask);
532     RHSMask = conjugateICmpMask(RHSMask);
533   }
534   if ((LHSMask & Mask_NotAllZeros) && (RHSMask & BMask_Mixed)) {
535     if (Value *V = foldLogOpOfMaskedICmps_NotAllZeros_BMask_Mixed(
536             LHS, RHS, IsAnd, A, B, C, D, E,
537             PredL, PredR, Builder)) {
538       return V;
539     }
540   } else if ((LHSMask & BMask_Mixed) && (RHSMask & Mask_NotAllZeros)) {
541     if (Value *V = foldLogOpOfMaskedICmps_NotAllZeros_BMask_Mixed(
542             RHS, LHS, IsAnd, A, D, E, B, C,
543             PredR, PredL, Builder)) {
544       return V;
545     }
546   }
547   return nullptr;
548 }
549 
550 /// Try to fold (icmp(A & B) ==/!= C) &/| (icmp(A & D) ==/!= E)
551 /// into a single (icmp(A & X) ==/!= Y).
552 static Value *foldLogOpOfMaskedICmps(ICmpInst *LHS, ICmpInst *RHS, bool IsAnd,
553                                      InstCombiner::BuilderTy &Builder) {
554   Value *A = nullptr, *B = nullptr, *C = nullptr, *D = nullptr, *E = nullptr;
555   ICmpInst::Predicate PredL = LHS->getPredicate(), PredR = RHS->getPredicate();
556   Optional<std::pair<unsigned, unsigned>> MaskPair =
557       getMaskedTypeForICmpPair(A, B, C, D, E, LHS, RHS, PredL, PredR);
558   if (!MaskPair)
559     return nullptr;
560   assert(ICmpInst::isEquality(PredL) && ICmpInst::isEquality(PredR) &&
561          "Expected equality predicates for masked type of icmps.");
562   unsigned LHSMask = MaskPair->first;
563   unsigned RHSMask = MaskPair->second;
564   unsigned Mask = LHSMask & RHSMask;
565   if (Mask == 0) {
566     // Even if the two sides don't share a common pattern, check if folding can
567     // still happen.
568     if (Value *V = foldLogOpOfMaskedICmpsAsymmetric(
569             LHS, RHS, IsAnd, A, B, C, D, E, PredL, PredR, LHSMask, RHSMask,
570             Builder))
571       return V;
572     return nullptr;
573   }
574 
575   // In full generality:
576   //     (icmp (A & B) Op C) | (icmp (A & D) Op E)
577   // ==  ![ (icmp (A & B) !Op C) & (icmp (A & D) !Op E) ]
578   //
579   // If the latter can be converted into (icmp (A & X) Op Y) then the former is
580   // equivalent to (icmp (A & X) !Op Y).
581   //
582   // Therefore, we can pretend for the rest of this function that we're dealing
583   // with the conjunction, provided we flip the sense of any comparisons (both
584   // input and output).
585 
586   // In most cases we're going to produce an EQ for the "&&" case.
587   ICmpInst::Predicate NewCC = IsAnd ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE;
588   if (!IsAnd) {
589     // Convert the masking analysis into its equivalent with negated
590     // comparisons.
591     Mask = conjugateICmpMask(Mask);
592   }
593 
594   if (Mask & Mask_AllZeros) {
595     // (icmp eq (A & B), 0) & (icmp eq (A & D), 0)
596     // -> (icmp eq (A & (B|D)), 0)
597     Value *NewOr = Builder.CreateOr(B, D);
598     Value *NewAnd = Builder.CreateAnd(A, NewOr);
599     // We can't use C as zero because we might actually handle
600     //   (icmp ne (A & B), B) & (icmp ne (A & D), D)
601     // with B and D, having a single bit set.
602     Value *Zero = Constant::getNullValue(A->getType());
603     return Builder.CreateICmp(NewCC, NewAnd, Zero);
604   }
605   if (Mask & BMask_AllOnes) {
606     // (icmp eq (A & B), B) & (icmp eq (A & D), D)
607     // -> (icmp eq (A & (B|D)), (B|D))
608     Value *NewOr = Builder.CreateOr(B, D);
609     Value *NewAnd = Builder.CreateAnd(A, NewOr);
610     return Builder.CreateICmp(NewCC, NewAnd, NewOr);
611   }
612   if (Mask & AMask_AllOnes) {
613     // (icmp eq (A & B), A) & (icmp eq (A & D), A)
614     // -> (icmp eq (A & (B&D)), A)
615     Value *NewAnd1 = Builder.CreateAnd(B, D);
616     Value *NewAnd2 = Builder.CreateAnd(A, NewAnd1);
617     return Builder.CreateICmp(NewCC, NewAnd2, A);
618   }
619 
620   // Remaining cases assume at least that B and D are constant, and depend on
621   // their actual values. This isn't strictly necessary, just a "handle the
622   // easy cases for now" decision.
623   const APInt *ConstB, *ConstD;
624   if (!match(B, m_APInt(ConstB)) || !match(D, m_APInt(ConstD)))
625     return nullptr;
626 
627   if (Mask & (Mask_NotAllZeros | BMask_NotAllOnes)) {
628     // (icmp ne (A & B), 0) & (icmp ne (A & D), 0) and
629     // (icmp ne (A & B), B) & (icmp ne (A & D), D)
630     //     -> (icmp ne (A & B), 0) or (icmp ne (A & D), 0)
631     // Only valid if one of the masks is a superset of the other (check "B&D" is
632     // the same as either B or D).
633     APInt NewMask = *ConstB & *ConstD;
634     if (NewMask == *ConstB)
635       return LHS;
636     else if (NewMask == *ConstD)
637       return RHS;
638   }
639 
640   if (Mask & AMask_NotAllOnes) {
641     // (icmp ne (A & B), B) & (icmp ne (A & D), D)
642     //     -> (icmp ne (A & B), A) or (icmp ne (A & D), A)
643     // Only valid if one of the masks is a superset of the other (check "B|D" is
644     // the same as either B or D).
645     APInt NewMask = *ConstB | *ConstD;
646     if (NewMask == *ConstB)
647       return LHS;
648     else if (NewMask == *ConstD)
649       return RHS;
650   }
651 
652   if (Mask & BMask_Mixed) {
653     // (icmp eq (A & B), C) & (icmp eq (A & D), E)
654     // We already know that B & C == C && D & E == E.
655     // If we can prove that (B & D) & (C ^ E) == 0, that is, the bits of
656     // C and E, which are shared by both the mask B and the mask D, don't
657     // contradict, then we can transform to
658     // -> (icmp eq (A & (B|D)), (C|E))
659     // Currently, we only handle the case of B, C, D, and E being constant.
660     // We can't simply use C and E because we might actually handle
661     //   (icmp ne (A & B), B) & (icmp eq (A & D), D)
662     // with B and D, having a single bit set.
663     const APInt *OldConstC, *OldConstE;
664     if (!match(C, m_APInt(OldConstC)) || !match(E, m_APInt(OldConstE)))
665       return nullptr;
666 
667     const APInt ConstC = PredL != NewCC ? *ConstB ^ *OldConstC : *OldConstC;
668     const APInt ConstE = PredR != NewCC ? *ConstD ^ *OldConstE : *OldConstE;
669 
670     // If there is a conflict, we should actually return a false for the
671     // whole construct.
672     if (((*ConstB & *ConstD) & (ConstC ^ ConstE)).getBoolValue())
673       return ConstantInt::get(LHS->getType(), !IsAnd);
674 
675     Value *NewOr1 = Builder.CreateOr(B, D);
676     Value *NewAnd = Builder.CreateAnd(A, NewOr1);
677     Constant *NewOr2 = ConstantInt::get(A->getType(), ConstC | ConstE);
678     return Builder.CreateICmp(NewCC, NewAnd, NewOr2);
679   }
680 
681   return nullptr;
682 }
683 
684 /// Try to fold a signed range checked with lower bound 0 to an unsigned icmp.
685 /// Example: (icmp sge x, 0) & (icmp slt x, n) --> icmp ult x, n
686 /// If \p Inverted is true then the check is for the inverted range, e.g.
687 /// (icmp slt x, 0) | (icmp sgt x, n) --> icmp ugt x, n
688 Value *InstCombinerImpl::simplifyRangeCheck(ICmpInst *Cmp0, ICmpInst *Cmp1,
689                                             bool Inverted) {
690   // Check the lower range comparison, e.g. x >= 0
691   // InstCombine already ensured that if there is a constant it's on the RHS.
692   ConstantInt *RangeStart = dyn_cast<ConstantInt>(Cmp0->getOperand(1));
693   if (!RangeStart)
694     return nullptr;
695 
696   ICmpInst::Predicate Pred0 = (Inverted ? Cmp0->getInversePredicate() :
697                                Cmp0->getPredicate());
698 
699   // Accept x > -1 or x >= 0 (after potentially inverting the predicate).
700   if (!((Pred0 == ICmpInst::ICMP_SGT && RangeStart->isMinusOne()) ||
701         (Pred0 == ICmpInst::ICMP_SGE && RangeStart->isZero())))
702     return nullptr;
703 
704   ICmpInst::Predicate Pred1 = (Inverted ? Cmp1->getInversePredicate() :
705                                Cmp1->getPredicate());
706 
707   Value *Input = Cmp0->getOperand(0);
708   Value *RangeEnd;
709   if (Cmp1->getOperand(0) == Input) {
710     // For the upper range compare we have: icmp x, n
711     RangeEnd = Cmp1->getOperand(1);
712   } else if (Cmp1->getOperand(1) == Input) {
713     // For the upper range compare we have: icmp n, x
714     RangeEnd = Cmp1->getOperand(0);
715     Pred1 = ICmpInst::getSwappedPredicate(Pred1);
716   } else {
717     return nullptr;
718   }
719 
720   // Check the upper range comparison, e.g. x < n
721   ICmpInst::Predicate NewPred;
722   switch (Pred1) {
723     case ICmpInst::ICMP_SLT: NewPred = ICmpInst::ICMP_ULT; break;
724     case ICmpInst::ICMP_SLE: NewPred = ICmpInst::ICMP_ULE; break;
725     default: return nullptr;
726   }
727 
728   // This simplification is only valid if the upper range is not negative.
729   KnownBits Known = computeKnownBits(RangeEnd, /*Depth=*/0, Cmp1);
730   if (!Known.isNonNegative())
731     return nullptr;
732 
733   if (Inverted)
734     NewPred = ICmpInst::getInversePredicate(NewPred);
735 
736   return Builder.CreateICmp(NewPred, Input, RangeEnd);
737 }
738 
739 static Value *
740 foldAndOrOfEqualityCmpsWithConstants(ICmpInst *LHS, ICmpInst *RHS,
741                                      bool JoinedByAnd,
742                                      InstCombiner::BuilderTy &Builder) {
743   Value *X = LHS->getOperand(0);
744   if (X != RHS->getOperand(0))
745     return nullptr;
746 
747   const APInt *C1, *C2;
748   if (!match(LHS->getOperand(1), m_APInt(C1)) ||
749       !match(RHS->getOperand(1), m_APInt(C2)))
750     return nullptr;
751 
752   // We only handle (X != C1 && X != C2) and (X == C1 || X == C2).
753   ICmpInst::Predicate Pred = LHS->getPredicate();
754   if (Pred !=  RHS->getPredicate())
755     return nullptr;
756   if (JoinedByAnd && Pred != ICmpInst::ICMP_NE)
757     return nullptr;
758   if (!JoinedByAnd && Pred != ICmpInst::ICMP_EQ)
759     return nullptr;
760 
761   // The larger unsigned constant goes on the right.
762   if (C1->ugt(*C2))
763     std::swap(C1, C2);
764 
765   APInt Xor = *C1 ^ *C2;
766   if (Xor.isPowerOf2()) {
767     // If LHSC and RHSC differ by only one bit, then set that bit in X and
768     // compare against the larger constant:
769     // (X == C1 || X == C2) --> (X | (C1 ^ C2)) == C2
770     // (X != C1 && X != C2) --> (X | (C1 ^ C2)) != C2
771     // We choose an 'or' with a Pow2 constant rather than the inverse mask with
772     // 'and' because that may lead to smaller codegen from a smaller constant.
773     Value *Or = Builder.CreateOr(X, ConstantInt::get(X->getType(), Xor));
774     return Builder.CreateICmp(Pred, Or, ConstantInt::get(X->getType(), *C2));
775   }
776 
777   return nullptr;
778 }
779 
780 // Fold (iszero(A & K1) | iszero(A & K2)) -> (A & (K1 | K2)) != (K1 | K2)
781 // Fold (!iszero(A & K1) & !iszero(A & K2)) -> (A & (K1 | K2)) == (K1 | K2)
782 Value *InstCombinerImpl::foldAndOrOfICmpsOfAndWithPow2(ICmpInst *LHS,
783                                                        ICmpInst *RHS,
784                                                        Instruction *CxtI,
785                                                        bool IsAnd,
786                                                        bool IsLogical) {
787   CmpInst::Predicate Pred = IsAnd ? CmpInst::ICMP_NE : CmpInst::ICMP_EQ;
788   if (LHS->getPredicate() != Pred || RHS->getPredicate() != Pred)
789     return nullptr;
790 
791   if (!match(LHS->getOperand(1), m_Zero()) ||
792       !match(RHS->getOperand(1), m_Zero()))
793     return nullptr;
794 
795   Value *L1, *L2, *R1, *R2;
796   if (match(LHS->getOperand(0), m_And(m_Value(L1), m_Value(L2))) &&
797       match(RHS->getOperand(0), m_And(m_Value(R1), m_Value(R2)))) {
798     if (L1 == R2 || L2 == R2)
799       std::swap(R1, R2);
800     if (L2 == R1)
801       std::swap(L1, L2);
802 
803     if (L1 == R1 &&
804         isKnownToBeAPowerOfTwo(L2, false, 0, CxtI) &&
805         isKnownToBeAPowerOfTwo(R2, false, 0, CxtI)) {
806       // If this is a logical and/or, then we must prevent propagation of a
807       // poison value from the RHS by inserting freeze.
808       if (IsLogical)
809         R2 = Builder.CreateFreeze(R2);
810       Value *Mask = Builder.CreateOr(L2, R2);
811       Value *Masked = Builder.CreateAnd(L1, Mask);
812       auto NewPred = IsAnd ? CmpInst::ICMP_EQ : CmpInst::ICMP_NE;
813       return Builder.CreateICmp(NewPred, Masked, Mask);
814     }
815   }
816 
817   return nullptr;
818 }
819 
820 /// General pattern:
821 ///   X & Y
822 ///
823 /// Where Y is checking that all the high bits (covered by a mask 4294967168)
824 /// are uniform, i.e.  %arg & 4294967168  can be either  4294967168  or  0
825 /// Pattern can be one of:
826 ///   %t = add        i32 %arg,    128
827 ///   %r = icmp   ult i32 %t,      256
828 /// Or
829 ///   %t0 = shl       i32 %arg,    24
830 ///   %t1 = ashr      i32 %t0,     24
831 ///   %r  = icmp  eq  i32 %t1,     %arg
832 /// Or
833 ///   %t0 = trunc     i32 %arg  to i8
834 ///   %t1 = sext      i8  %t0   to i32
835 ///   %r  = icmp  eq  i32 %t1,     %arg
836 /// This pattern is a signed truncation check.
837 ///
838 /// And X is checking that some bit in that same mask is zero.
839 /// I.e. can be one of:
840 ///   %r = icmp sgt i32   %arg,    -1
841 /// Or
842 ///   %t = and      i32   %arg,    2147483648
843 ///   %r = icmp eq  i32   %t,      0
844 ///
845 /// Since we are checking that all the bits in that mask are the same,
846 /// and a particular bit is zero, what we are really checking is that all the
847 /// masked bits are zero.
848 /// So this should be transformed to:
849 ///   %r = icmp ult i32 %arg, 128
850 static Value *foldSignedTruncationCheck(ICmpInst *ICmp0, ICmpInst *ICmp1,
851                                         Instruction &CxtI,
852                                         InstCombiner::BuilderTy &Builder) {
853   assert(CxtI.getOpcode() == Instruction::And);
854 
855   // Match  icmp ult (add %arg, C01), C1   (C1 == C01 << 1; powers of two)
856   auto tryToMatchSignedTruncationCheck = [](ICmpInst *ICmp, Value *&X,
857                                             APInt &SignBitMask) -> bool {
858     CmpInst::Predicate Pred;
859     const APInt *I01, *I1; // powers of two; I1 == I01 << 1
860     if (!(match(ICmp,
861                 m_ICmp(Pred, m_Add(m_Value(X), m_Power2(I01)), m_Power2(I1))) &&
862           Pred == ICmpInst::ICMP_ULT && I1->ugt(*I01) && I01->shl(1) == *I1))
863       return false;
864     // Which bit is the new sign bit as per the 'signed truncation' pattern?
865     SignBitMask = *I01;
866     return true;
867   };
868 
869   // One icmp needs to be 'signed truncation check'.
870   // We need to match this first, else we will mismatch commutative cases.
871   Value *X1;
872   APInt HighestBit;
873   ICmpInst *OtherICmp;
874   if (tryToMatchSignedTruncationCheck(ICmp1, X1, HighestBit))
875     OtherICmp = ICmp0;
876   else if (tryToMatchSignedTruncationCheck(ICmp0, X1, HighestBit))
877     OtherICmp = ICmp1;
878   else
879     return nullptr;
880 
881   assert(HighestBit.isPowerOf2() && "expected to be power of two (non-zero)");
882 
883   // Try to match/decompose into:  icmp eq (X & Mask), 0
884   auto tryToDecompose = [](ICmpInst *ICmp, Value *&X,
885                            APInt &UnsetBitsMask) -> bool {
886     CmpInst::Predicate Pred = ICmp->getPredicate();
887     // Can it be decomposed into  icmp eq (X & Mask), 0  ?
888     if (llvm::decomposeBitTestICmp(ICmp->getOperand(0), ICmp->getOperand(1),
889                                    Pred, X, UnsetBitsMask,
890                                    /*LookThroughTrunc=*/false) &&
891         Pred == ICmpInst::ICMP_EQ)
892       return true;
893     // Is it  icmp eq (X & Mask), 0  already?
894     const APInt *Mask;
895     if (match(ICmp, m_ICmp(Pred, m_And(m_Value(X), m_APInt(Mask)), m_Zero())) &&
896         Pred == ICmpInst::ICMP_EQ) {
897       UnsetBitsMask = *Mask;
898       return true;
899     }
900     return false;
901   };
902 
903   // And the other icmp needs to be decomposable into a bit test.
904   Value *X0;
905   APInt UnsetBitsMask;
906   if (!tryToDecompose(OtherICmp, X0, UnsetBitsMask))
907     return nullptr;
908 
909   assert(!UnsetBitsMask.isZero() && "empty mask makes no sense.");
910 
911   // Are they working on the same value?
912   Value *X;
913   if (X1 == X0) {
914     // Ok as is.
915     X = X1;
916   } else if (match(X0, m_Trunc(m_Specific(X1)))) {
917     UnsetBitsMask = UnsetBitsMask.zext(X1->getType()->getScalarSizeInBits());
918     X = X1;
919   } else
920     return nullptr;
921 
922   // So which bits should be uniform as per the 'signed truncation check'?
923   // (all the bits starting with (i.e. including) HighestBit)
924   APInt SignBitsMask = ~(HighestBit - 1U);
925 
926   // UnsetBitsMask must have some common bits with SignBitsMask,
927   if (!UnsetBitsMask.intersects(SignBitsMask))
928     return nullptr;
929 
930   // Does UnsetBitsMask contain any bits outside of SignBitsMask?
931   if (!UnsetBitsMask.isSubsetOf(SignBitsMask)) {
932     APInt OtherHighestBit = (~UnsetBitsMask) + 1U;
933     if (!OtherHighestBit.isPowerOf2())
934       return nullptr;
935     HighestBit = APIntOps::umin(HighestBit, OtherHighestBit);
936   }
937   // Else, if it does not, then all is ok as-is.
938 
939   // %r = icmp ult %X, SignBit
940   return Builder.CreateICmpULT(X, ConstantInt::get(X->getType(), HighestBit),
941                                CxtI.getName() + ".simplified");
942 }
943 
944 /// Reduce a pair of compares that check if a value has exactly 1 bit set.
945 static Value *foldIsPowerOf2(ICmpInst *Cmp0, ICmpInst *Cmp1, bool JoinedByAnd,
946                              InstCombiner::BuilderTy &Builder) {
947   // Handle 'and' / 'or' commutation: make the equality check the first operand.
948   if (JoinedByAnd && Cmp1->getPredicate() == ICmpInst::ICMP_NE)
949     std::swap(Cmp0, Cmp1);
950   else if (!JoinedByAnd && Cmp1->getPredicate() == ICmpInst::ICMP_EQ)
951     std::swap(Cmp0, Cmp1);
952 
953   // (X != 0) && (ctpop(X) u< 2) --> ctpop(X) == 1
954   CmpInst::Predicate Pred0, Pred1;
955   Value *X;
956   if (JoinedByAnd && match(Cmp0, m_ICmp(Pred0, m_Value(X), m_ZeroInt())) &&
957       match(Cmp1, m_ICmp(Pred1, m_Intrinsic<Intrinsic::ctpop>(m_Specific(X)),
958                          m_SpecificInt(2))) &&
959       Pred0 == ICmpInst::ICMP_NE && Pred1 == ICmpInst::ICMP_ULT) {
960     Value *CtPop = Cmp1->getOperand(0);
961     return Builder.CreateICmpEQ(CtPop, ConstantInt::get(CtPop->getType(), 1));
962   }
963   // (X == 0) || (ctpop(X) u> 1) --> ctpop(X) != 1
964   if (!JoinedByAnd && match(Cmp0, m_ICmp(Pred0, m_Value(X), m_ZeroInt())) &&
965       match(Cmp1, m_ICmp(Pred1, m_Intrinsic<Intrinsic::ctpop>(m_Specific(X)),
966                          m_SpecificInt(1))) &&
967       Pred0 == ICmpInst::ICMP_EQ && Pred1 == ICmpInst::ICMP_UGT) {
968     Value *CtPop = Cmp1->getOperand(0);
969     return Builder.CreateICmpNE(CtPop, ConstantInt::get(CtPop->getType(), 1));
970   }
971   return nullptr;
972 }
973 
974 /// Commuted variants are assumed to be handled by calling this function again
975 /// with the parameters swapped.
976 static Value *foldUnsignedUnderflowCheck(ICmpInst *ZeroICmp,
977                                          ICmpInst *UnsignedICmp, bool IsAnd,
978                                          const SimplifyQuery &Q,
979                                          InstCombiner::BuilderTy &Builder) {
980   Value *ZeroCmpOp;
981   ICmpInst::Predicate EqPred;
982   if (!match(ZeroICmp, m_ICmp(EqPred, m_Value(ZeroCmpOp), m_Zero())) ||
983       !ICmpInst::isEquality(EqPred))
984     return nullptr;
985 
986   auto IsKnownNonZero = [&](Value *V) {
987     return isKnownNonZero(V, Q.DL, /*Depth=*/0, Q.AC, Q.CxtI, Q.DT);
988   };
989 
990   ICmpInst::Predicate UnsignedPred;
991 
992   Value *A, *B;
993   if (match(UnsignedICmp,
994             m_c_ICmp(UnsignedPred, m_Specific(ZeroCmpOp), m_Value(A))) &&
995       match(ZeroCmpOp, m_c_Add(m_Specific(A), m_Value(B))) &&
996       (ZeroICmp->hasOneUse() || UnsignedICmp->hasOneUse())) {
997     auto GetKnownNonZeroAndOther = [&](Value *&NonZero, Value *&Other) {
998       if (!IsKnownNonZero(NonZero))
999         std::swap(NonZero, Other);
1000       return IsKnownNonZero(NonZero);
1001     };
1002 
1003     // Given  ZeroCmpOp = (A + B)
1004     //   ZeroCmpOp <= A && ZeroCmpOp != 0  -->  (0-B) <  A
1005     //   ZeroCmpOp >  A || ZeroCmpOp == 0  -->  (0-B) >= A
1006     //
1007     //   ZeroCmpOp <  A && ZeroCmpOp != 0  -->  (0-X) <  Y  iff
1008     //   ZeroCmpOp >= A || ZeroCmpOp == 0  -->  (0-X) >= Y  iff
1009     //     with X being the value (A/B) that is known to be non-zero,
1010     //     and Y being remaining value.
1011     if (UnsignedPred == ICmpInst::ICMP_ULE && EqPred == ICmpInst::ICMP_NE &&
1012         IsAnd)
1013       return Builder.CreateICmpULT(Builder.CreateNeg(B), A);
1014     if (UnsignedPred == ICmpInst::ICMP_ULT && EqPred == ICmpInst::ICMP_NE &&
1015         IsAnd && GetKnownNonZeroAndOther(B, A))
1016       return Builder.CreateICmpULT(Builder.CreateNeg(B), A);
1017     if (UnsignedPred == ICmpInst::ICMP_UGT && EqPred == ICmpInst::ICMP_EQ &&
1018         !IsAnd)
1019       return Builder.CreateICmpUGE(Builder.CreateNeg(B), A);
1020     if (UnsignedPred == ICmpInst::ICMP_UGE && EqPred == ICmpInst::ICMP_EQ &&
1021         !IsAnd && GetKnownNonZeroAndOther(B, A))
1022       return Builder.CreateICmpUGE(Builder.CreateNeg(B), A);
1023   }
1024 
1025   Value *Base, *Offset;
1026   if (!match(ZeroCmpOp, m_Sub(m_Value(Base), m_Value(Offset))))
1027     return nullptr;
1028 
1029   if (!match(UnsignedICmp,
1030              m_c_ICmp(UnsignedPred, m_Specific(Base), m_Specific(Offset))) ||
1031       !ICmpInst::isUnsigned(UnsignedPred))
1032     return nullptr;
1033 
1034   // Base >=/> Offset && (Base - Offset) != 0  <-->  Base > Offset
1035   // (no overflow and not null)
1036   if ((UnsignedPred == ICmpInst::ICMP_UGE ||
1037        UnsignedPred == ICmpInst::ICMP_UGT) &&
1038       EqPred == ICmpInst::ICMP_NE && IsAnd)
1039     return Builder.CreateICmpUGT(Base, Offset);
1040 
1041   // Base <=/< Offset || (Base - Offset) == 0  <-->  Base <= Offset
1042   // (overflow or null)
1043   if ((UnsignedPred == ICmpInst::ICMP_ULE ||
1044        UnsignedPred == ICmpInst::ICMP_ULT) &&
1045       EqPred == ICmpInst::ICMP_EQ && !IsAnd)
1046     return Builder.CreateICmpULE(Base, Offset);
1047 
1048   // Base <= Offset && (Base - Offset) != 0  -->  Base < Offset
1049   if (UnsignedPred == ICmpInst::ICMP_ULE && EqPred == ICmpInst::ICMP_NE &&
1050       IsAnd)
1051     return Builder.CreateICmpULT(Base, Offset);
1052 
1053   // Base > Offset || (Base - Offset) == 0  -->  Base >= Offset
1054   if (UnsignedPred == ICmpInst::ICMP_UGT && EqPred == ICmpInst::ICMP_EQ &&
1055       !IsAnd)
1056     return Builder.CreateICmpUGE(Base, Offset);
1057 
1058   return nullptr;
1059 }
1060 
1061 struct IntPart {
1062   Value *From;
1063   unsigned StartBit;
1064   unsigned NumBits;
1065 };
1066 
1067 /// Match an extraction of bits from an integer.
1068 static Optional<IntPart> matchIntPart(Value *V) {
1069   Value *X;
1070   if (!match(V, m_OneUse(m_Trunc(m_Value(X)))))
1071     return None;
1072 
1073   unsigned NumOriginalBits = X->getType()->getScalarSizeInBits();
1074   unsigned NumExtractedBits = V->getType()->getScalarSizeInBits();
1075   Value *Y;
1076   const APInt *Shift;
1077   // For a trunc(lshr Y, Shift) pattern, make sure we're only extracting bits
1078   // from Y, not any shifted-in zeroes.
1079   if (match(X, m_OneUse(m_LShr(m_Value(Y), m_APInt(Shift)))) &&
1080       Shift->ule(NumOriginalBits - NumExtractedBits))
1081     return {{Y, (unsigned)Shift->getZExtValue(), NumExtractedBits}};
1082   return {{X, 0, NumExtractedBits}};
1083 }
1084 
1085 /// Materialize an extraction of bits from an integer in IR.
1086 static Value *extractIntPart(const IntPart &P, IRBuilderBase &Builder) {
1087   Value *V = P.From;
1088   if (P.StartBit)
1089     V = Builder.CreateLShr(V, P.StartBit);
1090   Type *TruncTy = V->getType()->getWithNewBitWidth(P.NumBits);
1091   if (TruncTy != V->getType())
1092     V = Builder.CreateTrunc(V, TruncTy);
1093   return V;
1094 }
1095 
1096 /// (icmp eq X0, Y0) & (icmp eq X1, Y1) -> icmp eq X01, Y01
1097 /// (icmp ne X0, Y0) | (icmp ne X1, Y1) -> icmp ne X01, Y01
1098 /// where X0, X1 and Y0, Y1 are adjacent parts extracted from an integer.
1099 Value *InstCombinerImpl::foldEqOfParts(ICmpInst *Cmp0, ICmpInst *Cmp1,
1100                                        bool IsAnd) {
1101   if (!Cmp0->hasOneUse() || !Cmp1->hasOneUse())
1102     return nullptr;
1103 
1104   CmpInst::Predicate Pred = IsAnd ? CmpInst::ICMP_EQ : CmpInst::ICMP_NE;
1105   if (Cmp0->getPredicate() != Pred || Cmp1->getPredicate() != Pred)
1106     return nullptr;
1107 
1108   Optional<IntPart> L0 = matchIntPart(Cmp0->getOperand(0));
1109   Optional<IntPart> R0 = matchIntPart(Cmp0->getOperand(1));
1110   Optional<IntPart> L1 = matchIntPart(Cmp1->getOperand(0));
1111   Optional<IntPart> R1 = matchIntPart(Cmp1->getOperand(1));
1112   if (!L0 || !R0 || !L1 || !R1)
1113     return nullptr;
1114 
1115   // Make sure the LHS/RHS compare a part of the same value, possibly after
1116   // an operand swap.
1117   if (L0->From != L1->From || R0->From != R1->From) {
1118     if (L0->From != R1->From || R0->From != L1->From)
1119       return nullptr;
1120     std::swap(L1, R1);
1121   }
1122 
1123   // Make sure the extracted parts are adjacent, canonicalizing to L0/R0 being
1124   // the low part and L1/R1 being the high part.
1125   if (L0->StartBit + L0->NumBits != L1->StartBit ||
1126       R0->StartBit + R0->NumBits != R1->StartBit) {
1127     if (L1->StartBit + L1->NumBits != L0->StartBit ||
1128         R1->StartBit + R1->NumBits != R0->StartBit)
1129       return nullptr;
1130     std::swap(L0, L1);
1131     std::swap(R0, R1);
1132   }
1133 
1134   // We can simplify to a comparison of these larger parts of the integers.
1135   IntPart L = {L0->From, L0->StartBit, L0->NumBits + L1->NumBits};
1136   IntPart R = {R0->From, R0->StartBit, R0->NumBits + R1->NumBits};
1137   Value *LValue = extractIntPart(L, Builder);
1138   Value *RValue = extractIntPart(R, Builder);
1139   return Builder.CreateICmp(Pred, LValue, RValue);
1140 }
1141 
1142 /// Reduce logic-of-compares with equality to a constant by substituting a
1143 /// common operand with the constant. Callers are expected to call this with
1144 /// Cmp0/Cmp1 switched to handle logic op commutativity.
1145 static Value *foldAndOrOfICmpsWithConstEq(ICmpInst *Cmp0, ICmpInst *Cmp1,
1146                                           BinaryOperator &Logic,
1147                                           InstCombiner::BuilderTy &Builder,
1148                                           const SimplifyQuery &Q) {
1149   bool IsAnd = Logic.getOpcode() == Instruction::And;
1150   assert((IsAnd || Logic.getOpcode() == Instruction::Or) && "Wrong logic op");
1151 
1152   // Match an equality compare with a non-poison constant as Cmp0.
1153   // Also, give up if the compare can be constant-folded to avoid looping.
1154   ICmpInst::Predicate Pred0;
1155   Value *X;
1156   Constant *C;
1157   if (!match(Cmp0, m_ICmp(Pred0, m_Value(X), m_Constant(C))) ||
1158       !isGuaranteedNotToBeUndefOrPoison(C) || isa<Constant>(X))
1159     return nullptr;
1160   if ((IsAnd && Pred0 != ICmpInst::ICMP_EQ) ||
1161       (!IsAnd && Pred0 != ICmpInst::ICMP_NE))
1162     return nullptr;
1163 
1164   // The other compare must include a common operand (X). Canonicalize the
1165   // common operand as operand 1 (Pred1 is swapped if the common operand was
1166   // operand 0).
1167   Value *Y;
1168   ICmpInst::Predicate Pred1;
1169   if (!match(Cmp1, m_c_ICmp(Pred1, m_Value(Y), m_Deferred(X))))
1170     return nullptr;
1171 
1172   // Replace variable with constant value equivalence to remove a variable use:
1173   // (X == C) && (Y Pred1 X) --> (X == C) && (Y Pred1 C)
1174   // (X != C) || (Y Pred1 X) --> (X != C) || (Y Pred1 C)
1175   // Can think of the 'or' substitution with the 'and' bool equivalent:
1176   // A || B --> A || (!A && B)
1177   Value *SubstituteCmp = SimplifyICmpInst(Pred1, Y, C, Q);
1178   if (!SubstituteCmp) {
1179     // If we need to create a new instruction, require that the old compare can
1180     // be removed.
1181     if (!Cmp1->hasOneUse())
1182       return nullptr;
1183     SubstituteCmp = Builder.CreateICmp(Pred1, Y, C);
1184   }
1185   return Builder.CreateBinOp(Logic.getOpcode(), Cmp0, SubstituteCmp);
1186 }
1187 
1188 /// Fold (icmp Pred1 V1, C1) & (icmp Pred2 V2, C2)
1189 /// or   (icmp Pred1 V1, C1) | (icmp Pred2 V2, C2)
1190 /// into a single comparison using range-based reasoning.
1191 static Value *foldAndOrOfICmpsUsingRanges(
1192     ICmpInst::Predicate Pred1, Value *V1, const APInt &C1,
1193     ICmpInst::Predicate Pred2, Value *V2, const APInt &C2,
1194     IRBuilderBase &Builder, bool IsAnd) {
1195   // Look through add of a constant offset on V1, V2, or both operands. This
1196   // allows us to interpret the V + C' < C'' range idiom into a proper range.
1197   const APInt *Offset1 = nullptr, *Offset2 = nullptr;
1198   if (V1 != V2) {
1199     Value *X;
1200     if (match(V1, m_Add(m_Value(X), m_APInt(Offset1))))
1201       V1 = X;
1202     if (match(V2, m_Add(m_Value(X), m_APInt(Offset2))))
1203       V2 = X;
1204   }
1205 
1206   if (V1 != V2)
1207     return nullptr;
1208 
1209   ConstantRange CR1 = ConstantRange::makeExactICmpRegion(Pred1, C1);
1210   if (Offset1)
1211     CR1 = CR1.subtract(*Offset1);
1212 
1213   ConstantRange CR2 = ConstantRange::makeExactICmpRegion(Pred2, C2);
1214   if (Offset2)
1215     CR2 = CR2.subtract(*Offset2);
1216 
1217   Optional<ConstantRange> CR =
1218       IsAnd ? CR1.exactIntersectWith(CR2) : CR1.exactUnionWith(CR2);
1219   if (!CR)
1220     return nullptr;
1221 
1222   CmpInst::Predicate NewPred;
1223   APInt NewC, Offset;
1224   CR->getEquivalentICmp(NewPred, NewC, Offset);
1225 
1226   Type *Ty = V1->getType();
1227   Value *NewV = V1;
1228   if (Offset != 0)
1229     NewV = Builder.CreateAdd(NewV, ConstantInt::get(Ty, Offset));
1230   return Builder.CreateICmp(NewPred, NewV, ConstantInt::get(Ty, NewC));
1231 }
1232 
1233 /// Fold (icmp)&(icmp) if possible.
1234 Value *InstCombinerImpl::foldAndOfICmps(ICmpInst *LHS, ICmpInst *RHS,
1235                                         BinaryOperator &And) {
1236   const SimplifyQuery Q = SQ.getWithInstruction(&And);
1237 
1238   // Fold (!iszero(A & K1) & !iszero(A & K2)) ->  (A & (K1 | K2)) == (K1 | K2)
1239   // if K1 and K2 are a one-bit mask.
1240   if (Value *V = foldAndOrOfICmpsOfAndWithPow2(LHS, RHS, &And,
1241                                                /* IsAnd */ true))
1242     return V;
1243 
1244   ICmpInst::Predicate PredL = LHS->getPredicate(), PredR = RHS->getPredicate();
1245 
1246   // (icmp1 A, B) & (icmp2 A, B) --> (icmp3 A, B)
1247   if (predicatesFoldable(PredL, PredR)) {
1248     if (LHS->getOperand(0) == RHS->getOperand(1) &&
1249         LHS->getOperand(1) == RHS->getOperand(0))
1250       LHS->swapOperands();
1251     if (LHS->getOperand(0) == RHS->getOperand(0) &&
1252         LHS->getOperand(1) == RHS->getOperand(1)) {
1253       Value *Op0 = LHS->getOperand(0), *Op1 = LHS->getOperand(1);
1254       unsigned Code = getICmpCode(LHS) & getICmpCode(RHS);
1255       bool IsSigned = LHS->isSigned() || RHS->isSigned();
1256       return getNewICmpValue(Code, IsSigned, Op0, Op1, Builder);
1257     }
1258   }
1259 
1260   // handle (roughly):  (icmp eq (A & B), C) & (icmp eq (A & D), E)
1261   if (Value *V = foldLogOpOfMaskedICmps(LHS, RHS, true, Builder))
1262     return V;
1263 
1264   if (Value *V = foldAndOrOfICmpsWithConstEq(LHS, RHS, And, Builder, Q))
1265     return V;
1266   if (Value *V = foldAndOrOfICmpsWithConstEq(RHS, LHS, And, Builder, Q))
1267     return V;
1268 
1269   // E.g. (icmp sge x, 0) & (icmp slt x, n) --> icmp ult x, n
1270   if (Value *V = simplifyRangeCheck(LHS, RHS, /*Inverted=*/false))
1271     return V;
1272 
1273   // E.g. (icmp slt x, n) & (icmp sge x, 0) --> icmp ult x, n
1274   if (Value *V = simplifyRangeCheck(RHS, LHS, /*Inverted=*/false))
1275     return V;
1276 
1277   if (Value *V = foldAndOrOfEqualityCmpsWithConstants(LHS, RHS, true, Builder))
1278     return V;
1279 
1280   if (Value *V = foldSignedTruncationCheck(LHS, RHS, And, Builder))
1281     return V;
1282 
1283   if (Value *V = foldIsPowerOf2(LHS, RHS, true /* JoinedByAnd */, Builder))
1284     return V;
1285 
1286   if (Value *X =
1287           foldUnsignedUnderflowCheck(LHS, RHS, /*IsAnd=*/true, Q, Builder))
1288     return X;
1289   if (Value *X =
1290           foldUnsignedUnderflowCheck(RHS, LHS, /*IsAnd=*/true, Q, Builder))
1291     return X;
1292 
1293   if (Value *X = foldEqOfParts(LHS, RHS, /*IsAnd=*/true))
1294     return X;
1295 
1296   // This only handles icmp of constants: (icmp1 A, C1) & (icmp2 B, C2).
1297   Value *LHS0 = LHS->getOperand(0), *RHS0 = RHS->getOperand(0);
1298 
1299   // (icmp eq A, 0) & (icmp eq B, 0) --> (icmp eq (A|B), 0)
1300   // TODO: Remove this when foldLogOpOfMaskedICmps can handle undefs.
1301   if (PredL == ICmpInst::ICMP_EQ && match(LHS->getOperand(1), m_ZeroInt()) &&
1302       PredR == ICmpInst::ICMP_EQ && match(RHS->getOperand(1), m_ZeroInt()) &&
1303       LHS0->getType() == RHS0->getType()) {
1304     Value *NewOr = Builder.CreateOr(LHS0, RHS0);
1305     return Builder.CreateICmp(PredL, NewOr,
1306                               Constant::getNullValue(NewOr->getType()));
1307   }
1308 
1309   const APInt *LHSC, *RHSC;
1310   if (!match(LHS->getOperand(1), m_APInt(LHSC)) ||
1311       !match(RHS->getOperand(1), m_APInt(RHSC)))
1312     return nullptr;
1313 
1314   // (trunc x) == C1 & (and x, CA) == C2 -> (and x, CA|CMAX) == C1|C2
1315   // where CMAX is the all ones value for the truncated type,
1316   // iff the lower bits of C2 and CA are zero.
1317   if (PredL == ICmpInst::ICMP_EQ && PredL == PredR && LHS->hasOneUse() &&
1318       RHS->hasOneUse()) {
1319     Value *V;
1320     const APInt *AndC, *SmallC = nullptr, *BigC = nullptr;
1321 
1322     // (trunc x) == C1 & (and x, CA) == C2
1323     // (and x, CA) == C2 & (trunc x) == C1
1324     if (match(RHS0, m_Trunc(m_Value(V))) &&
1325         match(LHS0, m_And(m_Specific(V), m_APInt(AndC)))) {
1326       SmallC = RHSC;
1327       BigC = LHSC;
1328     } else if (match(LHS0, m_Trunc(m_Value(V))) &&
1329                match(RHS0, m_And(m_Specific(V), m_APInt(AndC)))) {
1330       SmallC = LHSC;
1331       BigC = RHSC;
1332     }
1333 
1334     if (SmallC && BigC) {
1335       unsigned BigBitSize = BigC->getBitWidth();
1336       unsigned SmallBitSize = SmallC->getBitWidth();
1337 
1338       // Check that the low bits are zero.
1339       APInt Low = APInt::getLowBitsSet(BigBitSize, SmallBitSize);
1340       if ((Low & *AndC).isZero() && (Low & *BigC).isZero()) {
1341         Value *NewAnd = Builder.CreateAnd(V, Low | *AndC);
1342         APInt N = SmallC->zext(BigBitSize) | *BigC;
1343         Value *NewVal = ConstantInt::get(NewAnd->getType(), N);
1344         return Builder.CreateICmp(PredL, NewAnd, NewVal);
1345       }
1346     }
1347   }
1348 
1349   return foldAndOrOfICmpsUsingRanges(PredL, LHS0, *LHSC, PredR, RHS0, *RHSC,
1350                                      Builder, /* IsAnd */ true);
1351 }
1352 
1353 Value *InstCombinerImpl::foldLogicOfFCmps(FCmpInst *LHS, FCmpInst *RHS,
1354                                           bool IsAnd) {
1355   Value *LHS0 = LHS->getOperand(0), *LHS1 = LHS->getOperand(1);
1356   Value *RHS0 = RHS->getOperand(0), *RHS1 = RHS->getOperand(1);
1357   FCmpInst::Predicate PredL = LHS->getPredicate(), PredR = RHS->getPredicate();
1358 
1359   if (LHS0 == RHS1 && RHS0 == LHS1) {
1360     // Swap RHS operands to match LHS.
1361     PredR = FCmpInst::getSwappedPredicate(PredR);
1362     std::swap(RHS0, RHS1);
1363   }
1364 
1365   // Simplify (fcmp cc0 x, y) & (fcmp cc1 x, y).
1366   // Suppose the relation between x and y is R, where R is one of
1367   // U(1000), L(0100), G(0010) or E(0001), and CC0 and CC1 are the bitmasks for
1368   // testing the desired relations.
1369   //
1370   // Since (R & CC0) and (R & CC1) are either R or 0, we actually have this:
1371   //    bool(R & CC0) && bool(R & CC1)
1372   //  = bool((R & CC0) & (R & CC1))
1373   //  = bool(R & (CC0 & CC1)) <= by re-association, commutation, and idempotency
1374   //
1375   // Since (R & CC0) and (R & CC1) are either R or 0, we actually have this:
1376   //    bool(R & CC0) || bool(R & CC1)
1377   //  = bool((R & CC0) | (R & CC1))
1378   //  = bool(R & (CC0 | CC1)) <= by reversed distribution (contribution? ;)
1379   if (LHS0 == RHS0 && LHS1 == RHS1) {
1380     unsigned FCmpCodeL = getFCmpCode(PredL);
1381     unsigned FCmpCodeR = getFCmpCode(PredR);
1382     unsigned NewPred = IsAnd ? FCmpCodeL & FCmpCodeR : FCmpCodeL | FCmpCodeR;
1383     return getFCmpValue(NewPred, LHS0, LHS1, Builder);
1384   }
1385 
1386   if ((PredL == FCmpInst::FCMP_ORD && PredR == FCmpInst::FCMP_ORD && IsAnd) ||
1387       (PredL == FCmpInst::FCMP_UNO && PredR == FCmpInst::FCMP_UNO && !IsAnd)) {
1388     if (LHS0->getType() != RHS0->getType())
1389       return nullptr;
1390 
1391     // FCmp canonicalization ensures that (fcmp ord/uno X, X) and
1392     // (fcmp ord/uno X, C) will be transformed to (fcmp X, +0.0).
1393     if (match(LHS1, m_PosZeroFP()) && match(RHS1, m_PosZeroFP()))
1394       // Ignore the constants because they are obviously not NANs:
1395       // (fcmp ord x, 0.0) & (fcmp ord y, 0.0)  -> (fcmp ord x, y)
1396       // (fcmp uno x, 0.0) | (fcmp uno y, 0.0)  -> (fcmp uno x, y)
1397       return Builder.CreateFCmp(PredL, LHS0, RHS0);
1398   }
1399 
1400   return nullptr;
1401 }
1402 
1403 /// This a limited reassociation for a special case (see above) where we are
1404 /// checking if two values are either both NAN (unordered) or not-NAN (ordered).
1405 /// This could be handled more generally in '-reassociation', but it seems like
1406 /// an unlikely pattern for a large number of logic ops and fcmps.
1407 static Instruction *reassociateFCmps(BinaryOperator &BO,
1408                                      InstCombiner::BuilderTy &Builder) {
1409   Instruction::BinaryOps Opcode = BO.getOpcode();
1410   assert((Opcode == Instruction::And || Opcode == Instruction::Or) &&
1411          "Expecting and/or op for fcmp transform");
1412 
1413   // There are 4 commuted variants of the pattern. Canonicalize operands of this
1414   // logic op so an fcmp is operand 0 and a matching logic op is operand 1.
1415   Value *Op0 = BO.getOperand(0), *Op1 = BO.getOperand(1), *X;
1416   FCmpInst::Predicate Pred;
1417   if (match(Op1, m_FCmp(Pred, m_Value(), m_AnyZeroFP())))
1418     std::swap(Op0, Op1);
1419 
1420   // Match inner binop and the predicate for combining 2 NAN checks into 1.
1421   BinaryOperator *BO1;
1422   FCmpInst::Predicate NanPred = Opcode == Instruction::And ? FCmpInst::FCMP_ORD
1423                                                            : FCmpInst::FCMP_UNO;
1424   if (!match(Op0, m_FCmp(Pred, m_Value(X), m_AnyZeroFP())) || Pred != NanPred ||
1425       !match(Op1, m_BinOp(BO1)) || BO1->getOpcode() != Opcode)
1426     return nullptr;
1427 
1428   // The inner logic op must have a matching fcmp operand.
1429   Value *BO10 = BO1->getOperand(0), *BO11 = BO1->getOperand(1), *Y;
1430   if (!match(BO10, m_FCmp(Pred, m_Value(Y), m_AnyZeroFP())) ||
1431       Pred != NanPred || X->getType() != Y->getType())
1432     std::swap(BO10, BO11);
1433 
1434   if (!match(BO10, m_FCmp(Pred, m_Value(Y), m_AnyZeroFP())) ||
1435       Pred != NanPred || X->getType() != Y->getType())
1436     return nullptr;
1437 
1438   // and (fcmp ord X, 0), (and (fcmp ord Y, 0), Z) --> and (fcmp ord X, Y), Z
1439   // or  (fcmp uno X, 0), (or  (fcmp uno Y, 0), Z) --> or  (fcmp uno X, Y), Z
1440   Value *NewFCmp = Builder.CreateFCmp(Pred, X, Y);
1441   if (auto *NewFCmpInst = dyn_cast<FCmpInst>(NewFCmp)) {
1442     // Intersect FMF from the 2 source fcmps.
1443     NewFCmpInst->copyIRFlags(Op0);
1444     NewFCmpInst->andIRFlags(BO10);
1445   }
1446   return BinaryOperator::Create(Opcode, NewFCmp, BO11);
1447 }
1448 
1449 /// Match variations of De Morgan's Laws:
1450 /// (~A & ~B) == (~(A | B))
1451 /// (~A | ~B) == (~(A & B))
1452 static Instruction *matchDeMorgansLaws(BinaryOperator &I,
1453                                        InstCombiner::BuilderTy &Builder) {
1454   const Instruction::BinaryOps Opcode = I.getOpcode();
1455   assert((Opcode == Instruction::And || Opcode == Instruction::Or) &&
1456          "Trying to match De Morgan's Laws with something other than and/or");
1457 
1458   // Flip the logic operation.
1459   const Instruction::BinaryOps FlippedOpcode =
1460       (Opcode == Instruction::And) ? Instruction::Or : Instruction::And;
1461 
1462   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1463   Value *A, *B;
1464   if (match(Op0, m_OneUse(m_Not(m_Value(A)))) &&
1465       match(Op1, m_OneUse(m_Not(m_Value(B)))) &&
1466       !InstCombiner::isFreeToInvert(A, A->hasOneUse()) &&
1467       !InstCombiner::isFreeToInvert(B, B->hasOneUse())) {
1468     Value *AndOr =
1469         Builder.CreateBinOp(FlippedOpcode, A, B, I.getName() + ".demorgan");
1470     return BinaryOperator::CreateNot(AndOr);
1471   }
1472 
1473   // The 'not' ops may require reassociation.
1474   // (A & ~B) & ~C --> A & ~(B | C)
1475   // (~B & A) & ~C --> A & ~(B | C)
1476   // (A | ~B) | ~C --> A | ~(B & C)
1477   // (~B | A) | ~C --> A | ~(B & C)
1478   BinaryOperator *BO;
1479   if (match(Op0, m_OneUse(m_BinOp(BO))) && BO->getOpcode() == Opcode) {
1480     Value *C;
1481     if (match(BO, m_c_BinOp(m_Value(A), m_Not(m_Value(B)))) &&
1482         match(Op1, m_Not(m_Value(C)))) {
1483       Value *FlippedBO = Builder.CreateBinOp(FlippedOpcode, B, C);
1484       return BinaryOperator::Create(Opcode, A, Builder.CreateNot(FlippedBO));
1485     }
1486   }
1487 
1488   return nullptr;
1489 }
1490 
1491 bool InstCombinerImpl::shouldOptimizeCast(CastInst *CI) {
1492   Value *CastSrc = CI->getOperand(0);
1493 
1494   // Noop casts and casts of constants should be eliminated trivially.
1495   if (CI->getSrcTy() == CI->getDestTy() || isa<Constant>(CastSrc))
1496     return false;
1497 
1498   // If this cast is paired with another cast that can be eliminated, we prefer
1499   // to have it eliminated.
1500   if (const auto *PrecedingCI = dyn_cast<CastInst>(CastSrc))
1501     if (isEliminableCastPair(PrecedingCI, CI))
1502       return false;
1503 
1504   return true;
1505 }
1506 
1507 /// Fold {and,or,xor} (cast X), C.
1508 static Instruction *foldLogicCastConstant(BinaryOperator &Logic, CastInst *Cast,
1509                                           InstCombiner::BuilderTy &Builder) {
1510   Constant *C = dyn_cast<Constant>(Logic.getOperand(1));
1511   if (!C)
1512     return nullptr;
1513 
1514   auto LogicOpc = Logic.getOpcode();
1515   Type *DestTy = Logic.getType();
1516   Type *SrcTy = Cast->getSrcTy();
1517 
1518   // Move the logic operation ahead of a zext or sext if the constant is
1519   // unchanged in the smaller source type. Performing the logic in a smaller
1520   // type may provide more information to later folds, and the smaller logic
1521   // instruction may be cheaper (particularly in the case of vectors).
1522   Value *X;
1523   if (match(Cast, m_OneUse(m_ZExt(m_Value(X))))) {
1524     Constant *TruncC = ConstantExpr::getTrunc(C, SrcTy);
1525     Constant *ZextTruncC = ConstantExpr::getZExt(TruncC, DestTy);
1526     if (ZextTruncC == C) {
1527       // LogicOpc (zext X), C --> zext (LogicOpc X, C)
1528       Value *NewOp = Builder.CreateBinOp(LogicOpc, X, TruncC);
1529       return new ZExtInst(NewOp, DestTy);
1530     }
1531   }
1532 
1533   if (match(Cast, m_OneUse(m_SExt(m_Value(X))))) {
1534     Constant *TruncC = ConstantExpr::getTrunc(C, SrcTy);
1535     Constant *SextTruncC = ConstantExpr::getSExt(TruncC, DestTy);
1536     if (SextTruncC == C) {
1537       // LogicOpc (sext X), C --> sext (LogicOpc X, C)
1538       Value *NewOp = Builder.CreateBinOp(LogicOpc, X, TruncC);
1539       return new SExtInst(NewOp, DestTy);
1540     }
1541   }
1542 
1543   return nullptr;
1544 }
1545 
1546 /// Fold {and,or,xor} (cast X), Y.
1547 Instruction *InstCombinerImpl::foldCastedBitwiseLogic(BinaryOperator &I) {
1548   auto LogicOpc = I.getOpcode();
1549   assert(I.isBitwiseLogicOp() && "Unexpected opcode for bitwise logic folding");
1550 
1551   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1552   CastInst *Cast0 = dyn_cast<CastInst>(Op0);
1553   if (!Cast0)
1554     return nullptr;
1555 
1556   // This must be a cast from an integer or integer vector source type to allow
1557   // transformation of the logic operation to the source type.
1558   Type *DestTy = I.getType();
1559   Type *SrcTy = Cast0->getSrcTy();
1560   if (!SrcTy->isIntOrIntVectorTy())
1561     return nullptr;
1562 
1563   if (Instruction *Ret = foldLogicCastConstant(I, Cast0, Builder))
1564     return Ret;
1565 
1566   CastInst *Cast1 = dyn_cast<CastInst>(Op1);
1567   if (!Cast1)
1568     return nullptr;
1569 
1570   // Both operands of the logic operation are casts. The casts must be of the
1571   // same type for reduction.
1572   auto CastOpcode = Cast0->getOpcode();
1573   if (CastOpcode != Cast1->getOpcode() || SrcTy != Cast1->getSrcTy())
1574     return nullptr;
1575 
1576   Value *Cast0Src = Cast0->getOperand(0);
1577   Value *Cast1Src = Cast1->getOperand(0);
1578 
1579   // fold logic(cast(A), cast(B)) -> cast(logic(A, B))
1580   if (shouldOptimizeCast(Cast0) && shouldOptimizeCast(Cast1)) {
1581     Value *NewOp = Builder.CreateBinOp(LogicOpc, Cast0Src, Cast1Src,
1582                                         I.getName());
1583     return CastInst::Create(CastOpcode, NewOp, DestTy);
1584   }
1585 
1586   // For now, only 'and'/'or' have optimizations after this.
1587   if (LogicOpc == Instruction::Xor)
1588     return nullptr;
1589 
1590   // If this is logic(cast(icmp), cast(icmp)), try to fold this even if the
1591   // cast is otherwise not optimizable.  This happens for vector sexts.
1592   ICmpInst *ICmp0 = dyn_cast<ICmpInst>(Cast0Src);
1593   ICmpInst *ICmp1 = dyn_cast<ICmpInst>(Cast1Src);
1594   if (ICmp0 && ICmp1) {
1595     Value *Res = LogicOpc == Instruction::And ? foldAndOfICmps(ICmp0, ICmp1, I)
1596                                               : foldOrOfICmps(ICmp0, ICmp1, I);
1597     if (Res)
1598       return CastInst::Create(CastOpcode, Res, DestTy);
1599     return nullptr;
1600   }
1601 
1602   // If this is logic(cast(fcmp), cast(fcmp)), try to fold this even if the
1603   // cast is otherwise not optimizable.  This happens for vector sexts.
1604   FCmpInst *FCmp0 = dyn_cast<FCmpInst>(Cast0Src);
1605   FCmpInst *FCmp1 = dyn_cast<FCmpInst>(Cast1Src);
1606   if (FCmp0 && FCmp1)
1607     if (Value *R = foldLogicOfFCmps(FCmp0, FCmp1, LogicOpc == Instruction::And))
1608       return CastInst::Create(CastOpcode, R, DestTy);
1609 
1610   return nullptr;
1611 }
1612 
1613 static Instruction *foldAndToXor(BinaryOperator &I,
1614                                  InstCombiner::BuilderTy &Builder) {
1615   assert(I.getOpcode() == Instruction::And);
1616   Value *Op0 = I.getOperand(0);
1617   Value *Op1 = I.getOperand(1);
1618   Value *A, *B;
1619 
1620   // Operand complexity canonicalization guarantees that the 'or' is Op0.
1621   // (A | B) & ~(A & B) --> A ^ B
1622   // (A | B) & ~(B & A) --> A ^ B
1623   if (match(&I, m_BinOp(m_Or(m_Value(A), m_Value(B)),
1624                         m_Not(m_c_And(m_Deferred(A), m_Deferred(B))))))
1625     return BinaryOperator::CreateXor(A, B);
1626 
1627   // (A | ~B) & (~A | B) --> ~(A ^ B)
1628   // (A | ~B) & (B | ~A) --> ~(A ^ B)
1629   // (~B | A) & (~A | B) --> ~(A ^ B)
1630   // (~B | A) & (B | ~A) --> ~(A ^ B)
1631   if (Op0->hasOneUse() || Op1->hasOneUse())
1632     if (match(&I, m_BinOp(m_c_Or(m_Value(A), m_Not(m_Value(B))),
1633                           m_c_Or(m_Not(m_Deferred(A)), m_Deferred(B)))))
1634       return BinaryOperator::CreateNot(Builder.CreateXor(A, B));
1635 
1636   return nullptr;
1637 }
1638 
1639 static Instruction *foldOrToXor(BinaryOperator &I,
1640                                 InstCombiner::BuilderTy &Builder) {
1641   assert(I.getOpcode() == Instruction::Or);
1642   Value *Op0 = I.getOperand(0);
1643   Value *Op1 = I.getOperand(1);
1644   Value *A, *B;
1645 
1646   // Operand complexity canonicalization guarantees that the 'and' is Op0.
1647   // (A & B) | ~(A | B) --> ~(A ^ B)
1648   // (A & B) | ~(B | A) --> ~(A ^ B)
1649   if (Op0->hasOneUse() || Op1->hasOneUse())
1650     if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
1651         match(Op1, m_Not(m_c_Or(m_Specific(A), m_Specific(B)))))
1652       return BinaryOperator::CreateNot(Builder.CreateXor(A, B));
1653 
1654   // Operand complexity canonicalization guarantees that the 'xor' is Op0.
1655   // (A ^ B) | ~(A | B) --> ~(A & B)
1656   // (A ^ B) | ~(B | A) --> ~(A & B)
1657   if (Op0->hasOneUse() || Op1->hasOneUse())
1658     if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
1659         match(Op1, m_Not(m_c_Or(m_Specific(A), m_Specific(B)))))
1660       return BinaryOperator::CreateNot(Builder.CreateAnd(A, B));
1661 
1662   // (A & ~B) | (~A & B) --> A ^ B
1663   // (A & ~B) | (B & ~A) --> A ^ B
1664   // (~B & A) | (~A & B) --> A ^ B
1665   // (~B & A) | (B & ~A) --> A ^ B
1666   if (match(Op0, m_c_And(m_Value(A), m_Not(m_Value(B)))) &&
1667       match(Op1, m_c_And(m_Not(m_Specific(A)), m_Specific(B))))
1668     return BinaryOperator::CreateXor(A, B);
1669 
1670   return nullptr;
1671 }
1672 
1673 /// Return true if a constant shift amount is always less than the specified
1674 /// bit-width. If not, the shift could create poison in the narrower type.
1675 static bool canNarrowShiftAmt(Constant *C, unsigned BitWidth) {
1676   APInt Threshold(C->getType()->getScalarSizeInBits(), BitWidth);
1677   return match(C, m_SpecificInt_ICMP(ICmpInst::ICMP_ULT, Threshold));
1678 }
1679 
1680 /// Try to use narrower ops (sink zext ops) for an 'and' with binop operand and
1681 /// a common zext operand: and (binop (zext X), C), (zext X).
1682 Instruction *InstCombinerImpl::narrowMaskedBinOp(BinaryOperator &And) {
1683   // This transform could also apply to {or, and, xor}, but there are better
1684   // folds for those cases, so we don't expect those patterns here. AShr is not
1685   // handled because it should always be transformed to LShr in this sequence.
1686   // The subtract transform is different because it has a constant on the left.
1687   // Add/mul commute the constant to RHS; sub with constant RHS becomes add.
1688   Value *Op0 = And.getOperand(0), *Op1 = And.getOperand(1);
1689   Constant *C;
1690   if (!match(Op0, m_OneUse(m_Add(m_Specific(Op1), m_Constant(C)))) &&
1691       !match(Op0, m_OneUse(m_Mul(m_Specific(Op1), m_Constant(C)))) &&
1692       !match(Op0, m_OneUse(m_LShr(m_Specific(Op1), m_Constant(C)))) &&
1693       !match(Op0, m_OneUse(m_Shl(m_Specific(Op1), m_Constant(C)))) &&
1694       !match(Op0, m_OneUse(m_Sub(m_Constant(C), m_Specific(Op1)))))
1695     return nullptr;
1696 
1697   Value *X;
1698   if (!match(Op1, m_ZExt(m_Value(X))) || Op1->hasNUsesOrMore(3))
1699     return nullptr;
1700 
1701   Type *Ty = And.getType();
1702   if (!isa<VectorType>(Ty) && !shouldChangeType(Ty, X->getType()))
1703     return nullptr;
1704 
1705   // If we're narrowing a shift, the shift amount must be safe (less than the
1706   // width) in the narrower type. If the shift amount is greater, instsimplify
1707   // usually handles that case, but we can't guarantee/assert it.
1708   Instruction::BinaryOps Opc = cast<BinaryOperator>(Op0)->getOpcode();
1709   if (Opc == Instruction::LShr || Opc == Instruction::Shl)
1710     if (!canNarrowShiftAmt(C, X->getType()->getScalarSizeInBits()))
1711       return nullptr;
1712 
1713   // and (sub C, (zext X)), (zext X) --> zext (and (sub C', X), X)
1714   // and (binop (zext X), C), (zext X) --> zext (and (binop X, C'), X)
1715   Value *NewC = ConstantExpr::getTrunc(C, X->getType());
1716   Value *NewBO = Opc == Instruction::Sub ? Builder.CreateBinOp(Opc, NewC, X)
1717                                          : Builder.CreateBinOp(Opc, X, NewC);
1718   return new ZExtInst(Builder.CreateAnd(NewBO, X), Ty);
1719 }
1720 
1721 // FIXME: We use commutative matchers (m_c_*) for some, but not all, matches
1722 // here. We should standardize that construct where it is needed or choose some
1723 // other way to ensure that commutated variants of patterns are not missed.
1724 Instruction *InstCombinerImpl::visitAnd(BinaryOperator &I) {
1725   Type *Ty = I.getType();
1726 
1727   if (Value *V = SimplifyAndInst(I.getOperand(0), I.getOperand(1),
1728                                  SQ.getWithInstruction(&I)))
1729     return replaceInstUsesWith(I, V);
1730 
1731   if (SimplifyAssociativeOrCommutative(I))
1732     return &I;
1733 
1734   if (Instruction *X = foldVectorBinop(I))
1735     return X;
1736 
1737   // See if we can simplify any instructions used by the instruction whose sole
1738   // purpose is to compute bits we don't care about.
1739   if (SimplifyDemandedInstructionBits(I))
1740     return &I;
1741 
1742   // Do this before using distributive laws to catch simple and/or/not patterns.
1743   if (Instruction *Xor = foldAndToXor(I, Builder))
1744     return Xor;
1745 
1746   // (A|B)&(A|C) -> A|(B&C) etc
1747   if (Value *V = SimplifyUsingDistributiveLaws(I))
1748     return replaceInstUsesWith(I, V);
1749 
1750   if (Value *V = SimplifyBSwap(I, Builder))
1751     return replaceInstUsesWith(I, V);
1752 
1753   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1754 
1755   Value *X, *Y;
1756   if (match(Op0, m_OneUse(m_LogicalShift(m_One(), m_Value(X)))) &&
1757       match(Op1, m_One())) {
1758     // (1 << X) & 1 --> zext(X == 0)
1759     // (1 >> X) & 1 --> zext(X == 0)
1760     Value *IsZero = Builder.CreateICmpEQ(X, ConstantInt::get(Ty, 0));
1761     return new ZExtInst(IsZero, Ty);
1762   }
1763 
1764   const APInt *C;
1765   if (match(Op1, m_APInt(C))) {
1766     const APInt *XorC;
1767     if (match(Op0, m_OneUse(m_Xor(m_Value(X), m_APInt(XorC))))) {
1768       // (X ^ C1) & C2 --> (X & C2) ^ (C1&C2)
1769       Constant *NewC = ConstantInt::get(Ty, *C & *XorC);
1770       Value *And = Builder.CreateAnd(X, Op1);
1771       And->takeName(Op0);
1772       return BinaryOperator::CreateXor(And, NewC);
1773     }
1774 
1775     const APInt *OrC;
1776     if (match(Op0, m_OneUse(m_Or(m_Value(X), m_APInt(OrC))))) {
1777       // (X | C1) & C2 --> (X & C2^(C1&C2)) | (C1&C2)
1778       // NOTE: This reduces the number of bits set in the & mask, which
1779       // can expose opportunities for store narrowing for scalars.
1780       // NOTE: SimplifyDemandedBits should have already removed bits from C1
1781       // that aren't set in C2. Meaning we can replace (C1&C2) with C1 in
1782       // above, but this feels safer.
1783       APInt Together = *C & *OrC;
1784       Value *And = Builder.CreateAnd(X, ConstantInt::get(Ty, Together ^ *C));
1785       And->takeName(Op0);
1786       return BinaryOperator::CreateOr(And, ConstantInt::get(Ty, Together));
1787     }
1788 
1789     // If the mask is only needed on one incoming arm, push the 'and' op up.
1790     if (match(Op0, m_OneUse(m_Xor(m_Value(X), m_Value(Y)))) ||
1791         match(Op0, m_OneUse(m_Or(m_Value(X), m_Value(Y))))) {
1792       APInt NotAndMask(~(*C));
1793       BinaryOperator::BinaryOps BinOp = cast<BinaryOperator>(Op0)->getOpcode();
1794       if (MaskedValueIsZero(X, NotAndMask, 0, &I)) {
1795         // Not masking anything out for the LHS, move mask to RHS.
1796         // and ({x}or X, Y), C --> {x}or X, (and Y, C)
1797         Value *NewRHS = Builder.CreateAnd(Y, Op1, Y->getName() + ".masked");
1798         return BinaryOperator::Create(BinOp, X, NewRHS);
1799       }
1800       if (!isa<Constant>(Y) && MaskedValueIsZero(Y, NotAndMask, 0, &I)) {
1801         // Not masking anything out for the RHS, move mask to LHS.
1802         // and ({x}or X, Y), C --> {x}or (and X, C), Y
1803         Value *NewLHS = Builder.CreateAnd(X, Op1, X->getName() + ".masked");
1804         return BinaryOperator::Create(BinOp, NewLHS, Y);
1805       }
1806     }
1807 
1808     unsigned Width = Ty->getScalarSizeInBits();
1809     const APInt *ShiftC;
1810     if (match(Op0, m_OneUse(m_SExt(m_AShr(m_Value(X), m_APInt(ShiftC)))))) {
1811       if (*C == APInt::getLowBitsSet(Width, Width - ShiftC->getZExtValue())) {
1812         // We are clearing high bits that were potentially set by sext+ashr:
1813         // and (sext (ashr X, ShiftC)), C --> lshr (sext X), ShiftC
1814         Value *Sext = Builder.CreateSExt(X, Ty);
1815         Constant *ShAmtC = ConstantInt::get(Ty, ShiftC->zext(Width));
1816         return BinaryOperator::CreateLShr(Sext, ShAmtC);
1817       }
1818     }
1819 
1820     const APInt *AddC;
1821     if (match(Op0, m_Add(m_Value(X), m_APInt(AddC)))) {
1822       // If we add zeros to every bit below a mask, the add has no effect:
1823       // (X + AddC) & LowMaskC --> X & LowMaskC
1824       unsigned Ctlz = C->countLeadingZeros();
1825       APInt LowMask(APInt::getLowBitsSet(Width, Width - Ctlz));
1826       if ((*AddC & LowMask).isZero())
1827         return BinaryOperator::CreateAnd(X, Op1);
1828 
1829       // If we are masking the result of the add down to exactly one bit and
1830       // the constant we are adding has no bits set below that bit, then the
1831       // add is flipping a single bit. Example:
1832       // (X + 4) & 4 --> (X & 4) ^ 4
1833       if (Op0->hasOneUse() && C->isPowerOf2() && (*AddC & (*C - 1)) == 0) {
1834         assert((*C & *AddC) != 0 && "Expected common bit");
1835         Value *NewAnd = Builder.CreateAnd(X, Op1);
1836         return BinaryOperator::CreateXor(NewAnd, Op1);
1837       }
1838     }
1839 
1840     // ((C1 OP zext(X)) & C2) -> zext((C1 OP X) & C2) if C2 fits in the
1841     // bitwidth of X and OP behaves well when given trunc(C1) and X.
1842     auto isSuitableBinOpcode = [](BinaryOperator *B) {
1843       switch (B->getOpcode()) {
1844       case Instruction::Xor:
1845       case Instruction::Or:
1846       case Instruction::Mul:
1847       case Instruction::Add:
1848       case Instruction::Sub:
1849         return true;
1850       default:
1851         return false;
1852       }
1853     };
1854     BinaryOperator *BO;
1855     if (match(Op0, m_OneUse(m_BinOp(BO))) && isSuitableBinOpcode(BO)) {
1856       Value *X;
1857       const APInt *C1;
1858       // TODO: The one-use restrictions could be relaxed a little if the AND
1859       // is going to be removed.
1860       if (match(BO, m_c_BinOp(m_OneUse(m_ZExt(m_Value(X))), m_APInt(C1))) &&
1861           C->isIntN(X->getType()->getScalarSizeInBits())) {
1862         unsigned XWidth = X->getType()->getScalarSizeInBits();
1863         Constant *TruncC1 = ConstantInt::get(X->getType(), C1->trunc(XWidth));
1864         Value *BinOp = isa<ZExtInst>(BO->getOperand(0))
1865                            ? Builder.CreateBinOp(BO->getOpcode(), X, TruncC1)
1866                            : Builder.CreateBinOp(BO->getOpcode(), TruncC1, X);
1867         Constant *TruncC = ConstantInt::get(X->getType(), C->trunc(XWidth));
1868         Value *And = Builder.CreateAnd(BinOp, TruncC);
1869         return new ZExtInst(And, Ty);
1870       }
1871     }
1872   }
1873 
1874   if (match(&I, m_And(m_OneUse(m_Shl(m_ZExt(m_Value(X)), m_Value(Y))),
1875                       m_SignMask())) &&
1876       match(Y, m_SpecificInt_ICMP(
1877                    ICmpInst::Predicate::ICMP_EQ,
1878                    APInt(Ty->getScalarSizeInBits(),
1879                          Ty->getScalarSizeInBits() -
1880                              X->getType()->getScalarSizeInBits())))) {
1881     auto *SExt = Builder.CreateSExt(X, Ty, X->getName() + ".signext");
1882     auto *SanitizedSignMask = cast<Constant>(Op1);
1883     // We must be careful with the undef elements of the sign bit mask, however:
1884     // the mask elt can be undef iff the shift amount for that lane was undef,
1885     // otherwise we need to sanitize undef masks to zero.
1886     SanitizedSignMask = Constant::replaceUndefsWith(
1887         SanitizedSignMask, ConstantInt::getNullValue(Ty->getScalarType()));
1888     SanitizedSignMask =
1889         Constant::mergeUndefsWith(SanitizedSignMask, cast<Constant>(Y));
1890     return BinaryOperator::CreateAnd(SExt, SanitizedSignMask);
1891   }
1892 
1893   if (Instruction *Z = narrowMaskedBinOp(I))
1894     return Z;
1895 
1896   if (I.getType()->isIntOrIntVectorTy(1)) {
1897     if (auto *SI0 = dyn_cast<SelectInst>(Op0)) {
1898       if (auto *I =
1899               foldAndOrOfSelectUsingImpliedCond(Op1, *SI0, /* IsAnd */ true))
1900         return I;
1901     }
1902     if (auto *SI1 = dyn_cast<SelectInst>(Op1)) {
1903       if (auto *I =
1904               foldAndOrOfSelectUsingImpliedCond(Op0, *SI1, /* IsAnd */ true))
1905         return I;
1906     }
1907   }
1908 
1909   if (Instruction *FoldedLogic = foldBinOpIntoSelectOrPhi(I))
1910     return FoldedLogic;
1911 
1912   if (Instruction *DeMorgan = matchDeMorgansLaws(I, Builder))
1913     return DeMorgan;
1914 
1915   {
1916     Value *A, *B, *C;
1917     // A & (A ^ B) --> A & ~B
1918     if (match(Op1, m_OneUse(m_c_Xor(m_Specific(Op0), m_Value(B)))))
1919       return BinaryOperator::CreateAnd(Op0, Builder.CreateNot(B));
1920     // (A ^ B) & A --> A & ~B
1921     if (match(Op0, m_OneUse(m_c_Xor(m_Specific(Op1), m_Value(B)))))
1922       return BinaryOperator::CreateAnd(Op1, Builder.CreateNot(B));
1923 
1924     // A & ~(A ^ B) --> A & B
1925     if (match(Op1, m_Not(m_c_Xor(m_Specific(Op0), m_Value(B)))))
1926       return BinaryOperator::CreateAnd(Op0, B);
1927     // ~(A ^ B) & A --> A & B
1928     if (match(Op0, m_Not(m_c_Xor(m_Specific(Op1), m_Value(B)))))
1929       return BinaryOperator::CreateAnd(Op1, B);
1930 
1931     // (A ^ B) & ((B ^ C) ^ A) -> (A ^ B) & ~C
1932     if (match(Op0, m_Xor(m_Value(A), m_Value(B))))
1933       if (match(Op1, m_Xor(m_Xor(m_Specific(B), m_Value(C)), m_Specific(A))))
1934         if (Op1->hasOneUse() || isFreeToInvert(C, C->hasOneUse()))
1935           return BinaryOperator::CreateAnd(Op0, Builder.CreateNot(C));
1936 
1937     // ((A ^ C) ^ B) & (B ^ A) -> (B ^ A) & ~C
1938     if (match(Op0, m_Xor(m_Xor(m_Value(A), m_Value(C)), m_Value(B))))
1939       if (match(Op1, m_Xor(m_Specific(B), m_Specific(A))))
1940         if (Op0->hasOneUse() || isFreeToInvert(C, C->hasOneUse()))
1941           return BinaryOperator::CreateAnd(Op1, Builder.CreateNot(C));
1942 
1943     // (A | B) & ((~A) ^ B) -> (A & B)
1944     // (A | B) & (B ^ (~A)) -> (A & B)
1945     // (B | A) & ((~A) ^ B) -> (A & B)
1946     // (B | A) & (B ^ (~A)) -> (A & B)
1947     if (match(Op1, m_c_Xor(m_Not(m_Value(A)), m_Value(B))) &&
1948         match(Op0, m_c_Or(m_Specific(A), m_Specific(B))))
1949       return BinaryOperator::CreateAnd(A, B);
1950 
1951     // ((~A) ^ B) & (A | B) -> (A & B)
1952     // ((~A) ^ B) & (B | A) -> (A & B)
1953     // (B ^ (~A)) & (A | B) -> (A & B)
1954     // (B ^ (~A)) & (B | A) -> (A & B)
1955     if (match(Op0, m_c_Xor(m_Not(m_Value(A)), m_Value(B))) &&
1956         match(Op1, m_c_Or(m_Specific(A), m_Specific(B))))
1957       return BinaryOperator::CreateAnd(A, B);
1958   }
1959 
1960   {
1961     ICmpInst *LHS = dyn_cast<ICmpInst>(Op0);
1962     ICmpInst *RHS = dyn_cast<ICmpInst>(Op1);
1963     if (LHS && RHS)
1964       if (Value *Res = foldAndOfICmps(LHS, RHS, I))
1965         return replaceInstUsesWith(I, Res);
1966 
1967     // TODO: Make this recursive; it's a little tricky because an arbitrary
1968     // number of 'and' instructions might have to be created.
1969     if (LHS && match(Op1, m_OneUse(m_And(m_Value(X), m_Value(Y))))) {
1970       if (auto *Cmp = dyn_cast<ICmpInst>(X))
1971         if (Value *Res = foldAndOfICmps(LHS, Cmp, I))
1972           return replaceInstUsesWith(I, Builder.CreateAnd(Res, Y));
1973       if (auto *Cmp = dyn_cast<ICmpInst>(Y))
1974         if (Value *Res = foldAndOfICmps(LHS, Cmp, I))
1975           return replaceInstUsesWith(I, Builder.CreateAnd(Res, X));
1976     }
1977     if (RHS && match(Op0, m_OneUse(m_And(m_Value(X), m_Value(Y))))) {
1978       if (auto *Cmp = dyn_cast<ICmpInst>(X))
1979         if (Value *Res = foldAndOfICmps(Cmp, RHS, I))
1980           return replaceInstUsesWith(I, Builder.CreateAnd(Res, Y));
1981       if (auto *Cmp = dyn_cast<ICmpInst>(Y))
1982         if (Value *Res = foldAndOfICmps(Cmp, RHS, I))
1983           return replaceInstUsesWith(I, Builder.CreateAnd(Res, X));
1984     }
1985   }
1986 
1987   if (FCmpInst *LHS = dyn_cast<FCmpInst>(I.getOperand(0)))
1988     if (FCmpInst *RHS = dyn_cast<FCmpInst>(I.getOperand(1)))
1989       if (Value *Res = foldLogicOfFCmps(LHS, RHS, true))
1990         return replaceInstUsesWith(I, Res);
1991 
1992   if (Instruction *FoldedFCmps = reassociateFCmps(I, Builder))
1993     return FoldedFCmps;
1994 
1995   if (Instruction *CastedAnd = foldCastedBitwiseLogic(I))
1996     return CastedAnd;
1997 
1998   // and(sext(A), B) / and(B, sext(A)) --> A ? B : 0, where A is i1 or <N x i1>.
1999   Value *A;
2000   if (match(Op0, m_OneUse(m_SExt(m_Value(A)))) &&
2001       A->getType()->isIntOrIntVectorTy(1))
2002     return SelectInst::Create(A, Op1, Constant::getNullValue(Ty));
2003   if (match(Op1, m_OneUse(m_SExt(m_Value(A)))) &&
2004       A->getType()->isIntOrIntVectorTy(1))
2005     return SelectInst::Create(A, Op0, Constant::getNullValue(Ty));
2006 
2007   // (iN X s>> (N-1)) & Y --> (X s< 0) ? Y : 0
2008   unsigned FullShift = Ty->getScalarSizeInBits() - 1;
2009   if (match(&I, m_c_And(m_OneUse(m_AShr(m_Value(X), m_SpecificInt(FullShift))),
2010                         m_Value(Y)))) {
2011     Constant *Zero = ConstantInt::getNullValue(Ty);
2012     Value *Cmp = Builder.CreateICmpSLT(X, Zero, "isneg");
2013     return SelectInst::Create(Cmp, Y, Zero);
2014   }
2015 
2016   // (~x) & y  -->  ~(x | (~y))  iff that gets rid of inversions
2017   if (sinkNotIntoOtherHandOfAndOrOr(I))
2018     return &I;
2019 
2020   // An and recurrence w/loop invariant step is equivelent to (and start, step)
2021   PHINode *PN = nullptr;
2022   Value *Start = nullptr, *Step = nullptr;
2023   if (matchSimpleRecurrence(&I, PN, Start, Step) && DT.dominates(Step, PN))
2024     return replaceInstUsesWith(I, Builder.CreateAnd(Start, Step));
2025 
2026   return nullptr;
2027 }
2028 
2029 Instruction *InstCombinerImpl::matchBSwapOrBitReverse(Instruction &I,
2030                                                       bool MatchBSwaps,
2031                                                       bool MatchBitReversals) {
2032   SmallVector<Instruction *, 4> Insts;
2033   if (!recognizeBSwapOrBitReverseIdiom(&I, MatchBSwaps, MatchBitReversals,
2034                                        Insts))
2035     return nullptr;
2036   Instruction *LastInst = Insts.pop_back_val();
2037   LastInst->removeFromParent();
2038 
2039   for (auto *Inst : Insts)
2040     Worklist.push(Inst);
2041   return LastInst;
2042 }
2043 
2044 /// Match UB-safe variants of the funnel shift intrinsic.
2045 static Instruction *matchFunnelShift(Instruction &Or, InstCombinerImpl &IC) {
2046   // TODO: Can we reduce the code duplication between this and the related
2047   // rotate matching code under visitSelect and visitTrunc?
2048   unsigned Width = Or.getType()->getScalarSizeInBits();
2049 
2050   // First, find an or'd pair of opposite shifts:
2051   // or (lshr ShVal0, ShAmt0), (shl ShVal1, ShAmt1)
2052   BinaryOperator *Or0, *Or1;
2053   if (!match(Or.getOperand(0), m_BinOp(Or0)) ||
2054       !match(Or.getOperand(1), m_BinOp(Or1)))
2055     return nullptr;
2056 
2057   Value *ShVal0, *ShVal1, *ShAmt0, *ShAmt1;
2058   if (!match(Or0, m_OneUse(m_LogicalShift(m_Value(ShVal0), m_Value(ShAmt0)))) ||
2059       !match(Or1, m_OneUse(m_LogicalShift(m_Value(ShVal1), m_Value(ShAmt1)))) ||
2060       Or0->getOpcode() == Or1->getOpcode())
2061     return nullptr;
2062 
2063   // Canonicalize to or(shl(ShVal0, ShAmt0), lshr(ShVal1, ShAmt1)).
2064   if (Or0->getOpcode() == BinaryOperator::LShr) {
2065     std::swap(Or0, Or1);
2066     std::swap(ShVal0, ShVal1);
2067     std::swap(ShAmt0, ShAmt1);
2068   }
2069   assert(Or0->getOpcode() == BinaryOperator::Shl &&
2070          Or1->getOpcode() == BinaryOperator::LShr &&
2071          "Illegal or(shift,shift) pair");
2072 
2073   // Match the shift amount operands for a funnel shift pattern. This always
2074   // matches a subtraction on the R operand.
2075   auto matchShiftAmount = [&](Value *L, Value *R, unsigned Width) -> Value * {
2076     // Check for constant shift amounts that sum to the bitwidth.
2077     const APInt *LI, *RI;
2078     if (match(L, m_APIntAllowUndef(LI)) && match(R, m_APIntAllowUndef(RI)))
2079       if (LI->ult(Width) && RI->ult(Width) && (*LI + *RI) == Width)
2080         return ConstantInt::get(L->getType(), *LI);
2081 
2082     Constant *LC, *RC;
2083     if (match(L, m_Constant(LC)) && match(R, m_Constant(RC)) &&
2084         match(L, m_SpecificInt_ICMP(ICmpInst::ICMP_ULT, APInt(Width, Width))) &&
2085         match(R, m_SpecificInt_ICMP(ICmpInst::ICMP_ULT, APInt(Width, Width))) &&
2086         match(ConstantExpr::getAdd(LC, RC), m_SpecificIntAllowUndef(Width)))
2087       return ConstantExpr::mergeUndefsWith(LC, RC);
2088 
2089     // (shl ShVal, X) | (lshr ShVal, (Width - x)) iff X < Width.
2090     // We limit this to X < Width in case the backend re-expands the intrinsic,
2091     // and has to reintroduce a shift modulo operation (InstCombine might remove
2092     // it after this fold). This still doesn't guarantee that the final codegen
2093     // will match this original pattern.
2094     if (match(R, m_OneUse(m_Sub(m_SpecificInt(Width), m_Specific(L))))) {
2095       KnownBits KnownL = IC.computeKnownBits(L, /*Depth*/ 0, &Or);
2096       return KnownL.getMaxValue().ult(Width) ? L : nullptr;
2097     }
2098 
2099     // For non-constant cases, the following patterns currently only work for
2100     // rotation patterns.
2101     // TODO: Add general funnel-shift compatible patterns.
2102     if (ShVal0 != ShVal1)
2103       return nullptr;
2104 
2105     // For non-constant cases we don't support non-pow2 shift masks.
2106     // TODO: Is it worth matching urem as well?
2107     if (!isPowerOf2_32(Width))
2108       return nullptr;
2109 
2110     // The shift amount may be masked with negation:
2111     // (shl ShVal, (X & (Width - 1))) | (lshr ShVal, ((-X) & (Width - 1)))
2112     Value *X;
2113     unsigned Mask = Width - 1;
2114     if (match(L, m_And(m_Value(X), m_SpecificInt(Mask))) &&
2115         match(R, m_And(m_Neg(m_Specific(X)), m_SpecificInt(Mask))))
2116       return X;
2117 
2118     // Similar to above, but the shift amount may be extended after masking,
2119     // so return the extended value as the parameter for the intrinsic.
2120     if (match(L, m_ZExt(m_And(m_Value(X), m_SpecificInt(Mask)))) &&
2121         match(R, m_And(m_Neg(m_ZExt(m_And(m_Specific(X), m_SpecificInt(Mask)))),
2122                        m_SpecificInt(Mask))))
2123       return L;
2124 
2125     if (match(L, m_ZExt(m_And(m_Value(X), m_SpecificInt(Mask)))) &&
2126         match(R, m_ZExt(m_And(m_Neg(m_Specific(X)), m_SpecificInt(Mask)))))
2127       return L;
2128 
2129     return nullptr;
2130   };
2131 
2132   Value *ShAmt = matchShiftAmount(ShAmt0, ShAmt1, Width);
2133   bool IsFshl = true; // Sub on LSHR.
2134   if (!ShAmt) {
2135     ShAmt = matchShiftAmount(ShAmt1, ShAmt0, Width);
2136     IsFshl = false; // Sub on SHL.
2137   }
2138   if (!ShAmt)
2139     return nullptr;
2140 
2141   Intrinsic::ID IID = IsFshl ? Intrinsic::fshl : Intrinsic::fshr;
2142   Function *F = Intrinsic::getDeclaration(Or.getModule(), IID, Or.getType());
2143   return CallInst::Create(F, {ShVal0, ShVal1, ShAmt});
2144 }
2145 
2146 /// Attempt to combine or(zext(x),shl(zext(y),bw/2) concat packing patterns.
2147 static Instruction *matchOrConcat(Instruction &Or,
2148                                   InstCombiner::BuilderTy &Builder) {
2149   assert(Or.getOpcode() == Instruction::Or && "bswap requires an 'or'");
2150   Value *Op0 = Or.getOperand(0), *Op1 = Or.getOperand(1);
2151   Type *Ty = Or.getType();
2152 
2153   unsigned Width = Ty->getScalarSizeInBits();
2154   if ((Width & 1) != 0)
2155     return nullptr;
2156   unsigned HalfWidth = Width / 2;
2157 
2158   // Canonicalize zext (lower half) to LHS.
2159   if (!isa<ZExtInst>(Op0))
2160     std::swap(Op0, Op1);
2161 
2162   // Find lower/upper half.
2163   Value *LowerSrc, *ShlVal, *UpperSrc;
2164   const APInt *C;
2165   if (!match(Op0, m_OneUse(m_ZExt(m_Value(LowerSrc)))) ||
2166       !match(Op1, m_OneUse(m_Shl(m_Value(ShlVal), m_APInt(C)))) ||
2167       !match(ShlVal, m_OneUse(m_ZExt(m_Value(UpperSrc)))))
2168     return nullptr;
2169   if (*C != HalfWidth || LowerSrc->getType() != UpperSrc->getType() ||
2170       LowerSrc->getType()->getScalarSizeInBits() != HalfWidth)
2171     return nullptr;
2172 
2173   auto ConcatIntrinsicCalls = [&](Intrinsic::ID id, Value *Lo, Value *Hi) {
2174     Value *NewLower = Builder.CreateZExt(Lo, Ty);
2175     Value *NewUpper = Builder.CreateZExt(Hi, Ty);
2176     NewUpper = Builder.CreateShl(NewUpper, HalfWidth);
2177     Value *BinOp = Builder.CreateOr(NewLower, NewUpper);
2178     Function *F = Intrinsic::getDeclaration(Or.getModule(), id, Ty);
2179     return Builder.CreateCall(F, BinOp);
2180   };
2181 
2182   // BSWAP: Push the concat down, swapping the lower/upper sources.
2183   // concat(bswap(x),bswap(y)) -> bswap(concat(x,y))
2184   Value *LowerBSwap, *UpperBSwap;
2185   if (match(LowerSrc, m_BSwap(m_Value(LowerBSwap))) &&
2186       match(UpperSrc, m_BSwap(m_Value(UpperBSwap))))
2187     return ConcatIntrinsicCalls(Intrinsic::bswap, UpperBSwap, LowerBSwap);
2188 
2189   // BITREVERSE: Push the concat down, swapping the lower/upper sources.
2190   // concat(bitreverse(x),bitreverse(y)) -> bitreverse(concat(x,y))
2191   Value *LowerBRev, *UpperBRev;
2192   if (match(LowerSrc, m_BitReverse(m_Value(LowerBRev))) &&
2193       match(UpperSrc, m_BitReverse(m_Value(UpperBRev))))
2194     return ConcatIntrinsicCalls(Intrinsic::bitreverse, UpperBRev, LowerBRev);
2195 
2196   return nullptr;
2197 }
2198 
2199 /// If all elements of two constant vectors are 0/-1 and inverses, return true.
2200 static bool areInverseVectorBitmasks(Constant *C1, Constant *C2) {
2201   unsigned NumElts = cast<FixedVectorType>(C1->getType())->getNumElements();
2202   for (unsigned i = 0; i != NumElts; ++i) {
2203     Constant *EltC1 = C1->getAggregateElement(i);
2204     Constant *EltC2 = C2->getAggregateElement(i);
2205     if (!EltC1 || !EltC2)
2206       return false;
2207 
2208     // One element must be all ones, and the other must be all zeros.
2209     if (!((match(EltC1, m_Zero()) && match(EltC2, m_AllOnes())) ||
2210           (match(EltC2, m_Zero()) && match(EltC1, m_AllOnes()))))
2211       return false;
2212   }
2213   return true;
2214 }
2215 
2216 /// We have an expression of the form (A & C) | (B & D). If A is a scalar or
2217 /// vector composed of all-zeros or all-ones values and is the bitwise 'not' of
2218 /// B, it can be used as the condition operand of a select instruction.
2219 Value *InstCombinerImpl::getSelectCondition(Value *A, Value *B) {
2220   // We may have peeked through bitcasts in the caller.
2221   // Exit immediately if we don't have (vector) integer types.
2222   Type *Ty = A->getType();
2223   if (!Ty->isIntOrIntVectorTy() || !B->getType()->isIntOrIntVectorTy())
2224     return nullptr;
2225 
2226   // If A is the 'not' operand of B and has enough signbits, we have our answer.
2227   if (match(B, m_Not(m_Specific(A)))) {
2228     // If these are scalars or vectors of i1, A can be used directly.
2229     if (Ty->isIntOrIntVectorTy(1))
2230       return A;
2231 
2232     // If we look through a vector bitcast, the caller will bitcast the operands
2233     // to match the condition's number of bits (N x i1).
2234     // To make this poison-safe, disallow bitcast from wide element to narrow
2235     // element. That could allow poison in lanes where it was not present in the
2236     // original code.
2237     A = peekThroughBitcast(A);
2238     if (A->getType()->isIntOrIntVectorTy()) {
2239       unsigned NumSignBits = ComputeNumSignBits(A);
2240       if (NumSignBits == A->getType()->getScalarSizeInBits() &&
2241           NumSignBits <= Ty->getScalarSizeInBits())
2242         return Builder.CreateTrunc(A, CmpInst::makeCmpResultType(A->getType()));
2243     }
2244     return nullptr;
2245   }
2246 
2247   // If both operands are constants, see if the constants are inverse bitmasks.
2248   Constant *AConst, *BConst;
2249   if (match(A, m_Constant(AConst)) && match(B, m_Constant(BConst)))
2250     if (AConst == ConstantExpr::getNot(BConst) &&
2251         ComputeNumSignBits(A) == Ty->getScalarSizeInBits())
2252       return Builder.CreateZExtOrTrunc(A, CmpInst::makeCmpResultType(Ty));
2253 
2254   // Look for more complex patterns. The 'not' op may be hidden behind various
2255   // casts. Look through sexts and bitcasts to find the booleans.
2256   Value *Cond;
2257   Value *NotB;
2258   if (match(A, m_SExt(m_Value(Cond))) &&
2259       Cond->getType()->isIntOrIntVectorTy(1) &&
2260       match(B, m_OneUse(m_Not(m_Value(NotB))))) {
2261     NotB = peekThroughBitcast(NotB, true);
2262     if (match(NotB, m_SExt(m_Specific(Cond))))
2263       return Cond;
2264   }
2265 
2266   // All scalar (and most vector) possibilities should be handled now.
2267   // Try more matches that only apply to non-splat constant vectors.
2268   if (!Ty->isVectorTy())
2269     return nullptr;
2270 
2271   // If both operands are xor'd with constants using the same sexted boolean
2272   // operand, see if the constants are inverse bitmasks.
2273   // TODO: Use ConstantExpr::getNot()?
2274   if (match(A, (m_Xor(m_SExt(m_Value(Cond)), m_Constant(AConst)))) &&
2275       match(B, (m_Xor(m_SExt(m_Specific(Cond)), m_Constant(BConst)))) &&
2276       Cond->getType()->isIntOrIntVectorTy(1) &&
2277       areInverseVectorBitmasks(AConst, BConst)) {
2278     AConst = ConstantExpr::getTrunc(AConst, CmpInst::makeCmpResultType(Ty));
2279     return Builder.CreateXor(Cond, AConst);
2280   }
2281   return nullptr;
2282 }
2283 
2284 /// We have an expression of the form (A & C) | (B & D). Try to simplify this
2285 /// to "A' ? C : D", where A' is a boolean or vector of booleans.
2286 Value *InstCombinerImpl::matchSelectFromAndOr(Value *A, Value *C, Value *B,
2287                                               Value *D) {
2288   // The potential condition of the select may be bitcasted. In that case, look
2289   // through its bitcast and the corresponding bitcast of the 'not' condition.
2290   Type *OrigType = A->getType();
2291   A = peekThroughBitcast(A, true);
2292   B = peekThroughBitcast(B, true);
2293   if (Value *Cond = getSelectCondition(A, B)) {
2294     // ((bc Cond) & C) | ((bc ~Cond) & D) --> bc (select Cond, (bc C), (bc D))
2295     // If this is a vector, we may need to cast to match the condition's length.
2296     // The bitcasts will either all exist or all not exist. The builder will
2297     // not create unnecessary casts if the types already match.
2298     Type *SelTy = A->getType();
2299     if (auto *VecTy = dyn_cast<VectorType>(Cond->getType())) {
2300       unsigned Elts = VecTy->getElementCount().getKnownMinValue();
2301       Type *EltTy = Builder.getIntNTy(SelTy->getPrimitiveSizeInBits() / Elts);
2302       SelTy = VectorType::get(EltTy, VecTy->getElementCount());
2303     }
2304     Value *BitcastC = Builder.CreateBitCast(C, SelTy);
2305     Value *BitcastD = Builder.CreateBitCast(D, SelTy);
2306     Value *Select = Builder.CreateSelect(Cond, BitcastC, BitcastD);
2307     return Builder.CreateBitCast(Select, OrigType);
2308   }
2309 
2310   return nullptr;
2311 }
2312 
2313 /// Fold (icmp)|(icmp) if possible.
2314 Value *InstCombinerImpl::foldOrOfICmps(ICmpInst *LHS, ICmpInst *RHS,
2315                                        BinaryOperator &Or) {
2316   const SimplifyQuery Q = SQ.getWithInstruction(&Or);
2317 
2318   // Fold (iszero(A & K1) | iszero(A & K2)) ->  (A & (K1 | K2)) != (K1 | K2)
2319   // if K1 and K2 are a one-bit mask.
2320   if (Value *V = foldAndOrOfICmpsOfAndWithPow2(LHS, RHS, &Or,
2321                                                /* IsAnd */ false))
2322     return V;
2323 
2324   ICmpInst::Predicate PredL = LHS->getPredicate(), PredR = RHS->getPredicate();
2325   Value *LHS0 = LHS->getOperand(0), *RHS0 = RHS->getOperand(0);
2326   Value *LHS1 = LHS->getOperand(1), *RHS1 = RHS->getOperand(1);
2327   const APInt *LHSC = nullptr, *RHSC = nullptr;
2328   match(LHS1, m_APInt(LHSC));
2329   match(RHS1, m_APInt(RHSC));
2330 
2331   // Fold (icmp ult/ule (A + C1), C3) | (icmp ult/ule (A + C2), C3)
2332   //                   -->  (icmp ult/ule ((A & ~(C1 ^ C2)) + max(C1, C2)), C3)
2333   // The original condition actually refers to the following two ranges:
2334   // [MAX_UINT-C1+1, MAX_UINT-C1+1+C3] and [MAX_UINT-C2+1, MAX_UINT-C2+1+C3]
2335   // We can fold these two ranges if:
2336   // 1) C1 and C2 is unsigned greater than C3.
2337   // 2) The two ranges are separated.
2338   // 3) C1 ^ C2 is one-bit mask.
2339   // 4) LowRange1 ^ LowRange2 and HighRange1 ^ HighRange2 are one-bit mask.
2340   // This implies all values in the two ranges differ by exactly one bit.
2341   if ((PredL == ICmpInst::ICMP_ULT || PredL == ICmpInst::ICMP_ULE) &&
2342       PredL == PredR && LHSC && RHSC && LHS->hasOneUse() && RHS->hasOneUse() &&
2343       LHSC->getBitWidth() == RHSC->getBitWidth() && *LHSC == *RHSC) {
2344 
2345     Value *AddOpnd;
2346     const APInt *LAddC, *RAddC;
2347     if (match(LHS0, m_Add(m_Value(AddOpnd), m_APInt(LAddC))) &&
2348         match(RHS0, m_Add(m_Specific(AddOpnd), m_APInt(RAddC))) &&
2349         LAddC->ugt(*LHSC) && RAddC->ugt(*LHSC)) {
2350 
2351       APInt DiffC = *LAddC ^ *RAddC;
2352       if (DiffC.isPowerOf2()) {
2353         const APInt *MaxAddC = nullptr;
2354         if (LAddC->ult(*RAddC))
2355           MaxAddC = RAddC;
2356         else
2357           MaxAddC = LAddC;
2358 
2359         APInt RRangeLow = -*RAddC;
2360         APInt RRangeHigh = RRangeLow + *LHSC;
2361         APInt LRangeLow = -*LAddC;
2362         APInt LRangeHigh = LRangeLow + *LHSC;
2363         APInt LowRangeDiff = RRangeLow ^ LRangeLow;
2364         APInt HighRangeDiff = RRangeHigh ^ LRangeHigh;
2365         APInt RangeDiff = LRangeLow.sgt(RRangeLow) ? LRangeLow - RRangeLow
2366                                                    : RRangeLow - LRangeLow;
2367 
2368         if (LowRangeDiff.isPowerOf2() && LowRangeDiff == HighRangeDiff &&
2369             RangeDiff.ugt(*LHSC)) {
2370           Type *Ty = AddOpnd->getType();
2371           Value *MaskC = ConstantInt::get(Ty, ~DiffC);
2372 
2373           Value *NewAnd = Builder.CreateAnd(AddOpnd, MaskC);
2374           Value *NewAdd = Builder.CreateAdd(NewAnd,
2375                                             ConstantInt::get(Ty, *MaxAddC));
2376           return Builder.CreateICmp(LHS->getPredicate(), NewAdd,
2377                                     ConstantInt::get(Ty, *LHSC));
2378         }
2379       }
2380     }
2381   }
2382 
2383   // (icmp1 A, B) | (icmp2 A, B) --> (icmp3 A, B)
2384   if (predicatesFoldable(PredL, PredR)) {
2385     if (LHS0 == RHS1 && LHS1 == RHS0)
2386       LHS->swapOperands();
2387     if (LHS0 == RHS0 && LHS1 == RHS1) {
2388       unsigned Code = getICmpCode(LHS) | getICmpCode(RHS);
2389       bool IsSigned = LHS->isSigned() || RHS->isSigned();
2390       return getNewICmpValue(Code, IsSigned, LHS0, LHS1, Builder);
2391     }
2392   }
2393 
2394   // handle (roughly):
2395   // (icmp ne (A & B), C) | (icmp ne (A & D), E)
2396   if (Value *V = foldLogOpOfMaskedICmps(LHS, RHS, false, Builder))
2397     return V;
2398 
2399   if (LHS->hasOneUse() || RHS->hasOneUse()) {
2400     // (icmp eq B, 0) | (icmp ult A, B) -> (icmp ule A, B-1)
2401     // (icmp eq B, 0) | (icmp ugt B, A) -> (icmp ule A, B-1)
2402     Value *A = nullptr, *B = nullptr;
2403     if (PredL == ICmpInst::ICMP_EQ && match(LHS1, m_Zero())) {
2404       B = LHS0;
2405       if (PredR == ICmpInst::ICMP_ULT && LHS0 == RHS1)
2406         A = RHS0;
2407       else if (PredR == ICmpInst::ICMP_UGT && LHS0 == RHS0)
2408         A = RHS1;
2409     }
2410     // (icmp ult A, B) | (icmp eq B, 0) -> (icmp ule A, B-1)
2411     // (icmp ugt B, A) | (icmp eq B, 0) -> (icmp ule A, B-1)
2412     else if (PredR == ICmpInst::ICMP_EQ && match(RHS1, m_Zero())) {
2413       B = RHS0;
2414       if (PredL == ICmpInst::ICMP_ULT && RHS0 == LHS1)
2415         A = LHS0;
2416       else if (PredL == ICmpInst::ICMP_UGT && RHS0 == LHS0)
2417         A = LHS1;
2418     }
2419     if (A && B && B->getType()->isIntOrIntVectorTy())
2420       return Builder.CreateICmp(
2421           ICmpInst::ICMP_UGE,
2422           Builder.CreateAdd(B, Constant::getAllOnesValue(B->getType())), A);
2423   }
2424 
2425   if (Value *V = foldAndOrOfICmpsWithConstEq(LHS, RHS, Or, Builder, Q))
2426     return V;
2427   if (Value *V = foldAndOrOfICmpsWithConstEq(RHS, LHS, Or, Builder, Q))
2428     return V;
2429 
2430   // E.g. (icmp slt x, 0) | (icmp sgt x, n) --> icmp ugt x, n
2431   if (Value *V = simplifyRangeCheck(LHS, RHS, /*Inverted=*/true))
2432     return V;
2433 
2434   // E.g. (icmp sgt x, n) | (icmp slt x, 0) --> icmp ugt x, n
2435   if (Value *V = simplifyRangeCheck(RHS, LHS, /*Inverted=*/true))
2436     return V;
2437 
2438   if (Value *V = foldAndOrOfEqualityCmpsWithConstants(LHS, RHS, false, Builder))
2439     return V;
2440 
2441   if (Value *V = foldIsPowerOf2(LHS, RHS, false /* JoinedByAnd */, Builder))
2442     return V;
2443 
2444   if (Value *X =
2445           foldUnsignedUnderflowCheck(LHS, RHS, /*IsAnd=*/false, Q, Builder))
2446     return X;
2447   if (Value *X =
2448           foldUnsignedUnderflowCheck(RHS, LHS, /*IsAnd=*/false, Q, Builder))
2449     return X;
2450 
2451   if (Value *X = foldEqOfParts(LHS, RHS, /*IsAnd=*/false))
2452     return X;
2453 
2454   // (icmp ne A, 0) | (icmp ne B, 0) --> (icmp ne (A|B), 0)
2455   // TODO: Remove this when foldLogOpOfMaskedICmps can handle undefs.
2456   if (PredL == ICmpInst::ICMP_NE && match(LHS1, m_ZeroInt()) &&
2457       PredR == ICmpInst::ICMP_NE && match(RHS1, m_ZeroInt()) &&
2458       LHS0->getType() == RHS0->getType()) {
2459     Value *NewOr = Builder.CreateOr(LHS0, RHS0);
2460     return Builder.CreateICmp(PredL, NewOr,
2461                               Constant::getNullValue(NewOr->getType()));
2462   }
2463 
2464   // This only handles icmp of constants: (icmp1 A, C1) | (icmp2 B, C2).
2465   if (!LHSC || !RHSC)
2466     return nullptr;
2467 
2468   return foldAndOrOfICmpsUsingRanges(PredL, LHS0, *LHSC, PredR, RHS0, *RHSC,
2469                                      Builder, /* IsAnd */ false);
2470 }
2471 
2472 // FIXME: We use commutative matchers (m_c_*) for some, but not all, matches
2473 // here. We should standardize that construct where it is needed or choose some
2474 // other way to ensure that commutated variants of patterns are not missed.
2475 Instruction *InstCombinerImpl::visitOr(BinaryOperator &I) {
2476   if (Value *V = SimplifyOrInst(I.getOperand(0), I.getOperand(1),
2477                                 SQ.getWithInstruction(&I)))
2478     return replaceInstUsesWith(I, V);
2479 
2480   if (SimplifyAssociativeOrCommutative(I))
2481     return &I;
2482 
2483   if (Instruction *X = foldVectorBinop(I))
2484     return X;
2485 
2486   // See if we can simplify any instructions used by the instruction whose sole
2487   // purpose is to compute bits we don't care about.
2488   if (SimplifyDemandedInstructionBits(I))
2489     return &I;
2490 
2491   // Do this before using distributive laws to catch simple and/or/not patterns.
2492   if (Instruction *Xor = foldOrToXor(I, Builder))
2493     return Xor;
2494 
2495   // (A&B)|(A&C) -> A&(B|C) etc
2496   if (Value *V = SimplifyUsingDistributiveLaws(I))
2497     return replaceInstUsesWith(I, V);
2498 
2499   if (Value *V = SimplifyBSwap(I, Builder))
2500     return replaceInstUsesWith(I, V);
2501 
2502   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
2503   if (I.getType()->isIntOrIntVectorTy(1)) {
2504     if (auto *SI0 = dyn_cast<SelectInst>(Op0)) {
2505       if (auto *I =
2506               foldAndOrOfSelectUsingImpliedCond(Op1, *SI0, /* IsAnd */ false))
2507         return I;
2508     }
2509     if (auto *SI1 = dyn_cast<SelectInst>(Op1)) {
2510       if (auto *I =
2511               foldAndOrOfSelectUsingImpliedCond(Op0, *SI1, /* IsAnd */ false))
2512         return I;
2513     }
2514   }
2515 
2516   if (Instruction *FoldedLogic = foldBinOpIntoSelectOrPhi(I))
2517     return FoldedLogic;
2518 
2519   if (Instruction *BitOp = matchBSwapOrBitReverse(I, /*MatchBSwaps*/ true,
2520                                                   /*MatchBitReversals*/ true))
2521     return BitOp;
2522 
2523   if (Instruction *Funnel = matchFunnelShift(I, *this))
2524     return Funnel;
2525 
2526   if (Instruction *Concat = matchOrConcat(I, Builder))
2527     return replaceInstUsesWith(I, Concat);
2528 
2529   Value *X, *Y;
2530   const APInt *CV;
2531   if (match(&I, m_c_Or(m_OneUse(m_Xor(m_Value(X), m_APInt(CV))), m_Value(Y))) &&
2532       !CV->isAllOnes() && MaskedValueIsZero(Y, *CV, 0, &I)) {
2533     // (X ^ C) | Y -> (X | Y) ^ C iff Y & C == 0
2534     // The check for a 'not' op is for efficiency (if Y is known zero --> ~X).
2535     Value *Or = Builder.CreateOr(X, Y);
2536     return BinaryOperator::CreateXor(Or, ConstantInt::get(I.getType(), *CV));
2537   }
2538 
2539   // (A & C) | (B & D)
2540   Value *A, *B, *C, *D;
2541   if (match(Op0, m_And(m_Value(A), m_Value(C))) &&
2542       match(Op1, m_And(m_Value(B), m_Value(D)))) {
2543 
2544     // (A & C0) | (B & C1)
2545     const APInt *C0, *C1;
2546     if (match(C, m_APInt(C0)) && match(D, m_APInt(C1))) {
2547       Value *X;
2548       if (*C0 == ~*C1) {
2549         // ((X | B) & MaskC) | (B & ~MaskC) -> (X & MaskC) | B
2550         if (match(A, m_c_Or(m_Value(X), m_Specific(B))))
2551           return BinaryOperator::CreateOr(Builder.CreateAnd(X, *C0), B);
2552         // (A & MaskC) | ((X | A) & ~MaskC) -> (X & ~MaskC) | A
2553         if (match(B, m_c_Or(m_Specific(A), m_Value(X))))
2554           return BinaryOperator::CreateOr(Builder.CreateAnd(X, *C1), A);
2555 
2556         // ((X ^ B) & MaskC) | (B & ~MaskC) -> (X & MaskC) ^ B
2557         if (match(A, m_c_Xor(m_Value(X), m_Specific(B))))
2558           return BinaryOperator::CreateXor(Builder.CreateAnd(X, *C0), B);
2559         // (A & MaskC) | ((X ^ A) & ~MaskC) -> (X & ~MaskC) ^ A
2560         if (match(B, m_c_Xor(m_Specific(A), m_Value(X))))
2561           return BinaryOperator::CreateXor(Builder.CreateAnd(X, *C1), A);
2562       }
2563 
2564       if ((*C0 & *C1).isZero()) {
2565         // ((X | B) & C0) | (B & C1) --> (X | B) & (C0 | C1)
2566         // iff (C0 & C1) == 0 and (X & ~C0) == 0
2567         if (match(A, m_c_Or(m_Value(X), m_Specific(B))) &&
2568             MaskedValueIsZero(X, ~*C0, 0, &I)) {
2569           Constant *C01 = ConstantInt::get(I.getType(), *C0 | *C1);
2570           return BinaryOperator::CreateAnd(A, C01);
2571         }
2572         // (A & C0) | ((X | A) & C1) --> (X | A) & (C0 | C1)
2573         // iff (C0 & C1) == 0 and (X & ~C1) == 0
2574         if (match(B, m_c_Or(m_Value(X), m_Specific(A))) &&
2575             MaskedValueIsZero(X, ~*C1, 0, &I)) {
2576           Constant *C01 = ConstantInt::get(I.getType(), *C0 | *C1);
2577           return BinaryOperator::CreateAnd(B, C01);
2578         }
2579         // ((X | C2) & C0) | ((X | C3) & C1) --> (X | C2 | C3) & (C0 | C1)
2580         // iff (C0 & C1) == 0 and (C2 & ~C0) == 0 and (C3 & ~C1) == 0.
2581         const APInt *C2, *C3;
2582         if (match(A, m_Or(m_Value(X), m_APInt(C2))) &&
2583             match(B, m_Or(m_Specific(X), m_APInt(C3))) &&
2584             (*C2 & ~*C0).isZero() && (*C3 & ~*C1).isZero()) {
2585           Value *Or = Builder.CreateOr(X, *C2 | *C3, "bitfield");
2586           Constant *C01 = ConstantInt::get(I.getType(), *C0 | *C1);
2587           return BinaryOperator::CreateAnd(Or, C01);
2588         }
2589       }
2590     }
2591 
2592     // Don't try to form a select if it's unlikely that we'll get rid of at
2593     // least one of the operands. A select is generally more expensive than the
2594     // 'or' that it is replacing.
2595     if (Op0->hasOneUse() || Op1->hasOneUse()) {
2596       // (Cond & C) | (~Cond & D) -> Cond ? C : D, and commuted variants.
2597       if (Value *V = matchSelectFromAndOr(A, C, B, D))
2598         return replaceInstUsesWith(I, V);
2599       if (Value *V = matchSelectFromAndOr(A, C, D, B))
2600         return replaceInstUsesWith(I, V);
2601       if (Value *V = matchSelectFromAndOr(C, A, B, D))
2602         return replaceInstUsesWith(I, V);
2603       if (Value *V = matchSelectFromAndOr(C, A, D, B))
2604         return replaceInstUsesWith(I, V);
2605       if (Value *V = matchSelectFromAndOr(B, D, A, C))
2606         return replaceInstUsesWith(I, V);
2607       if (Value *V = matchSelectFromAndOr(B, D, C, A))
2608         return replaceInstUsesWith(I, V);
2609       if (Value *V = matchSelectFromAndOr(D, B, A, C))
2610         return replaceInstUsesWith(I, V);
2611       if (Value *V = matchSelectFromAndOr(D, B, C, A))
2612         return replaceInstUsesWith(I, V);
2613     }
2614   }
2615 
2616   // (A ^ B) | ((B ^ C) ^ A) -> (A ^ B) | C
2617   if (match(Op0, m_Xor(m_Value(A), m_Value(B))))
2618     if (match(Op1, m_Xor(m_Xor(m_Specific(B), m_Value(C)), m_Specific(A))))
2619       return BinaryOperator::CreateOr(Op0, C);
2620 
2621   // ((A ^ C) ^ B) | (B ^ A) -> (B ^ A) | C
2622   if (match(Op0, m_Xor(m_Xor(m_Value(A), m_Value(C)), m_Value(B))))
2623     if (match(Op1, m_Xor(m_Specific(B), m_Specific(A))))
2624       return BinaryOperator::CreateOr(Op1, C);
2625 
2626   // ((B | C) & A) | B -> B | (A & C)
2627   if (match(Op0, m_And(m_Or(m_Specific(Op1), m_Value(C)), m_Value(A))))
2628     return BinaryOperator::CreateOr(Op1, Builder.CreateAnd(A, C));
2629 
2630   // (~(A | B) & C) | ... --> ...
2631   // TODO: One use checks are conservative. We just need to check that a total
2632   //       number of multiple used values does not exceed reduction
2633   //       in operations.
2634   if (match(Op0, m_c_And(m_Not(m_Or(m_Value(A), m_Value(B))), m_Value(C)))) {
2635     // (~(A | B) & C) | (~(A | C) & B) --> (B ^ C) & ~A
2636     if (match(Op1, m_OneUse(m_c_And(
2637                        m_OneUse(m_Not(m_c_Or(m_Specific(A), m_Specific(C)))),
2638                        m_Specific(B))))) {
2639       Value *Xor = Builder.CreateXor(B, C);
2640       return BinaryOperator::CreateAnd(Xor, Builder.CreateNot(A));
2641     }
2642 
2643     // (~(A | B) & C) | (~(B | C) & A) --> (A ^ C) & ~B
2644     if (match(Op1, m_OneUse(m_c_And(
2645                        m_OneUse(m_Not(m_c_Or(m_Specific(B), m_Specific(C)))),
2646                        m_Specific(A))))) {
2647       Value *Xor = Builder.CreateXor(A, C);
2648       return BinaryOperator::CreateAnd(Xor, Builder.CreateNot(B));
2649     }
2650 
2651     // (~(A | B) & C) | ~(A | C) --> ~((B & C) | A)
2652     if (match(Op1,
2653               m_OneUse(m_Not(m_OneUse(m_c_Or(m_Specific(A), m_Specific(C)))))))
2654       return BinaryOperator::CreateNot(
2655           Builder.CreateOr(Builder.CreateAnd(B, C), A));
2656 
2657     // (~(A | B) & C) | ~(B | C) --> ~((A & C) | B)
2658     if (match(Op1,
2659               m_OneUse(m_Not(m_OneUse(m_c_Or(m_Specific(B), m_Specific(C)))))))
2660       return BinaryOperator::CreateNot(
2661           Builder.CreateOr(Builder.CreateAnd(A, C), B));
2662   }
2663 
2664   if (Instruction *DeMorgan = matchDeMorgansLaws(I, Builder))
2665     return DeMorgan;
2666 
2667   // Canonicalize xor to the RHS.
2668   bool SwappedForXor = false;
2669   if (match(Op0, m_Xor(m_Value(), m_Value()))) {
2670     std::swap(Op0, Op1);
2671     SwappedForXor = true;
2672   }
2673 
2674   // A | ( A ^ B) -> A |  B
2675   // A | (~A ^ B) -> A | ~B
2676   // (A & B) | (A ^ B)
2677   if (match(Op1, m_Xor(m_Value(A), m_Value(B)))) {
2678     if (Op0 == A || Op0 == B)
2679       return BinaryOperator::CreateOr(A, B);
2680 
2681     if (match(Op0, m_And(m_Specific(A), m_Specific(B))) ||
2682         match(Op0, m_And(m_Specific(B), m_Specific(A))))
2683       return BinaryOperator::CreateOr(A, B);
2684 
2685     if (Op1->hasOneUse() && match(A, m_Not(m_Specific(Op0)))) {
2686       Value *Not = Builder.CreateNot(B, B->getName() + ".not");
2687       return BinaryOperator::CreateOr(Not, Op0);
2688     }
2689     if (Op1->hasOneUse() && match(B, m_Not(m_Specific(Op0)))) {
2690       Value *Not = Builder.CreateNot(A, A->getName() + ".not");
2691       return BinaryOperator::CreateOr(Not, Op0);
2692     }
2693   }
2694 
2695   // A | ~(A | B) -> A | ~B
2696   // A | ~(A ^ B) -> A | ~B
2697   if (match(Op1, m_Not(m_Value(A))))
2698     if (BinaryOperator *B = dyn_cast<BinaryOperator>(A))
2699       if ((Op0 == B->getOperand(0) || Op0 == B->getOperand(1)) &&
2700           Op1->hasOneUse() && (B->getOpcode() == Instruction::Or ||
2701                                B->getOpcode() == Instruction::Xor)) {
2702         Value *NotOp = Op0 == B->getOperand(0) ? B->getOperand(1) :
2703                                                  B->getOperand(0);
2704         Value *Not = Builder.CreateNot(NotOp, NotOp->getName() + ".not");
2705         return BinaryOperator::CreateOr(Not, Op0);
2706       }
2707 
2708   if (SwappedForXor)
2709     std::swap(Op0, Op1);
2710 
2711   {
2712     ICmpInst *LHS = dyn_cast<ICmpInst>(Op0);
2713     ICmpInst *RHS = dyn_cast<ICmpInst>(Op1);
2714     if (LHS && RHS)
2715       if (Value *Res = foldOrOfICmps(LHS, RHS, I))
2716         return replaceInstUsesWith(I, Res);
2717 
2718     // TODO: Make this recursive; it's a little tricky because an arbitrary
2719     // number of 'or' instructions might have to be created.
2720     Value *X, *Y;
2721     if (LHS && match(Op1, m_OneUse(m_Or(m_Value(X), m_Value(Y))))) {
2722       if (auto *Cmp = dyn_cast<ICmpInst>(X))
2723         if (Value *Res = foldOrOfICmps(LHS, Cmp, I))
2724           return replaceInstUsesWith(I, Builder.CreateOr(Res, Y));
2725       if (auto *Cmp = dyn_cast<ICmpInst>(Y))
2726         if (Value *Res = foldOrOfICmps(LHS, Cmp, I))
2727           return replaceInstUsesWith(I, Builder.CreateOr(Res, X));
2728     }
2729     if (RHS && match(Op0, m_OneUse(m_Or(m_Value(X), m_Value(Y))))) {
2730       if (auto *Cmp = dyn_cast<ICmpInst>(X))
2731         if (Value *Res = foldOrOfICmps(Cmp, RHS, I))
2732           return replaceInstUsesWith(I, Builder.CreateOr(Res, Y));
2733       if (auto *Cmp = dyn_cast<ICmpInst>(Y))
2734         if (Value *Res = foldOrOfICmps(Cmp, RHS, I))
2735           return replaceInstUsesWith(I, Builder.CreateOr(Res, X));
2736     }
2737   }
2738 
2739   if (FCmpInst *LHS = dyn_cast<FCmpInst>(I.getOperand(0)))
2740     if (FCmpInst *RHS = dyn_cast<FCmpInst>(I.getOperand(1)))
2741       if (Value *Res = foldLogicOfFCmps(LHS, RHS, false))
2742         return replaceInstUsesWith(I, Res);
2743 
2744   if (Instruction *FoldedFCmps = reassociateFCmps(I, Builder))
2745     return FoldedFCmps;
2746 
2747   if (Instruction *CastedOr = foldCastedBitwiseLogic(I))
2748     return CastedOr;
2749 
2750   // or(sext(A), B) / or(B, sext(A)) --> A ? -1 : B, where A is i1 or <N x i1>.
2751   if (match(Op0, m_OneUse(m_SExt(m_Value(A)))) &&
2752       A->getType()->isIntOrIntVectorTy(1))
2753     return SelectInst::Create(A, ConstantInt::getSigned(I.getType(), -1), Op1);
2754   if (match(Op1, m_OneUse(m_SExt(m_Value(A)))) &&
2755       A->getType()->isIntOrIntVectorTy(1))
2756     return SelectInst::Create(A, ConstantInt::getSigned(I.getType(), -1), Op0);
2757 
2758   // Note: If we've gotten to the point of visiting the outer OR, then the
2759   // inner one couldn't be simplified.  If it was a constant, then it won't
2760   // be simplified by a later pass either, so we try swapping the inner/outer
2761   // ORs in the hopes that we'll be able to simplify it this way.
2762   // (X|C) | V --> (X|V) | C
2763   ConstantInt *CI;
2764   if (Op0->hasOneUse() && !match(Op1, m_ConstantInt()) &&
2765       match(Op0, m_Or(m_Value(A), m_ConstantInt(CI)))) {
2766     Value *Inner = Builder.CreateOr(A, Op1);
2767     Inner->takeName(Op0);
2768     return BinaryOperator::CreateOr(Inner, CI);
2769   }
2770 
2771   // Change (or (bool?A:B),(bool?C:D)) --> (bool?(or A,C):(or B,D))
2772   // Since this OR statement hasn't been optimized further yet, we hope
2773   // that this transformation will allow the new ORs to be optimized.
2774   {
2775     Value *X = nullptr, *Y = nullptr;
2776     if (Op0->hasOneUse() && Op1->hasOneUse() &&
2777         match(Op0, m_Select(m_Value(X), m_Value(A), m_Value(B))) &&
2778         match(Op1, m_Select(m_Value(Y), m_Value(C), m_Value(D))) && X == Y) {
2779       Value *orTrue = Builder.CreateOr(A, C);
2780       Value *orFalse = Builder.CreateOr(B, D);
2781       return SelectInst::Create(X, orTrue, orFalse);
2782     }
2783   }
2784 
2785   // or(ashr(subNSW(Y, X), ScalarSizeInBits(Y) - 1), X)  --> X s> Y ? -1 : X.
2786   {
2787     Value *X, *Y;
2788     Type *Ty = I.getType();
2789     if (match(&I, m_c_Or(m_OneUse(m_AShr(
2790                              m_NSWSub(m_Value(Y), m_Value(X)),
2791                              m_SpecificInt(Ty->getScalarSizeInBits() - 1))),
2792                          m_Deferred(X)))) {
2793       Value *NewICmpInst = Builder.CreateICmpSGT(X, Y);
2794       Value *AllOnes = ConstantInt::getAllOnesValue(Ty);
2795       return SelectInst::Create(NewICmpInst, AllOnes, X);
2796     }
2797   }
2798 
2799   if (Instruction *V =
2800           canonicalizeCondSignextOfHighBitExtractToSignextHighBitExtract(I))
2801     return V;
2802 
2803   CmpInst::Predicate Pred;
2804   Value *Mul, *Ov, *MulIsNotZero, *UMulWithOv;
2805   // Check if the OR weakens the overflow condition for umul.with.overflow by
2806   // treating any non-zero result as overflow. In that case, we overflow if both
2807   // umul.with.overflow operands are != 0, as in that case the result can only
2808   // be 0, iff the multiplication overflows.
2809   if (match(&I,
2810             m_c_Or(m_CombineAnd(m_ExtractValue<1>(m_Value(UMulWithOv)),
2811                                 m_Value(Ov)),
2812                    m_CombineAnd(m_ICmp(Pred,
2813                                        m_CombineAnd(m_ExtractValue<0>(
2814                                                         m_Deferred(UMulWithOv)),
2815                                                     m_Value(Mul)),
2816                                        m_ZeroInt()),
2817                                 m_Value(MulIsNotZero)))) &&
2818       (Ov->hasOneUse() || (MulIsNotZero->hasOneUse() && Mul->hasOneUse())) &&
2819       Pred == CmpInst::ICMP_NE) {
2820     Value *A, *B;
2821     if (match(UMulWithOv, m_Intrinsic<Intrinsic::umul_with_overflow>(
2822                               m_Value(A), m_Value(B)))) {
2823       Value *NotNullA = Builder.CreateIsNotNull(A);
2824       Value *NotNullB = Builder.CreateIsNotNull(B);
2825       return BinaryOperator::CreateAnd(NotNullA, NotNullB);
2826     }
2827   }
2828 
2829   // (~x) | y  -->  ~(x & (~y))  iff that gets rid of inversions
2830   if (sinkNotIntoOtherHandOfAndOrOr(I))
2831     return &I;
2832 
2833   // Improve "get low bit mask up to and including bit X" pattern:
2834   //   (1 << X) | ((1 << X) + -1)  -->  -1 l>> (bitwidth(x) - 1 - X)
2835   if (match(&I, m_c_Or(m_Add(m_Shl(m_One(), m_Value(X)), m_AllOnes()),
2836                        m_Shl(m_One(), m_Deferred(X)))) &&
2837       match(&I, m_c_Or(m_OneUse(m_Value()), m_Value()))) {
2838     Type *Ty = X->getType();
2839     Value *Sub = Builder.CreateSub(
2840         ConstantInt::get(Ty, Ty->getScalarSizeInBits() - 1), X);
2841     return BinaryOperator::CreateLShr(Constant::getAllOnesValue(Ty), Sub);
2842   }
2843 
2844   // An or recurrence w/loop invariant step is equivelent to (or start, step)
2845   PHINode *PN = nullptr;
2846   Value *Start = nullptr, *Step = nullptr;
2847   if (matchSimpleRecurrence(&I, PN, Start, Step) && DT.dominates(Step, PN))
2848     return replaceInstUsesWith(I, Builder.CreateOr(Start, Step));
2849 
2850   return nullptr;
2851 }
2852 
2853 /// A ^ B can be specified using other logic ops in a variety of patterns. We
2854 /// can fold these early and efficiently by morphing an existing instruction.
2855 static Instruction *foldXorToXor(BinaryOperator &I,
2856                                  InstCombiner::BuilderTy &Builder) {
2857   assert(I.getOpcode() == Instruction::Xor);
2858   Value *Op0 = I.getOperand(0);
2859   Value *Op1 = I.getOperand(1);
2860   Value *A, *B;
2861 
2862   // There are 4 commuted variants for each of the basic patterns.
2863 
2864   // (A & B) ^ (A | B) -> A ^ B
2865   // (A & B) ^ (B | A) -> A ^ B
2866   // (A | B) ^ (A & B) -> A ^ B
2867   // (A | B) ^ (B & A) -> A ^ B
2868   if (match(&I, m_c_Xor(m_And(m_Value(A), m_Value(B)),
2869                         m_c_Or(m_Deferred(A), m_Deferred(B)))))
2870     return BinaryOperator::CreateXor(A, B);
2871 
2872   // (A | ~B) ^ (~A | B) -> A ^ B
2873   // (~B | A) ^ (~A | B) -> A ^ B
2874   // (~A | B) ^ (A | ~B) -> A ^ B
2875   // (B | ~A) ^ (A | ~B) -> A ^ B
2876   if (match(&I, m_Xor(m_c_Or(m_Value(A), m_Not(m_Value(B))),
2877                       m_c_Or(m_Not(m_Deferred(A)), m_Deferred(B)))))
2878     return BinaryOperator::CreateXor(A, B);
2879 
2880   // (A & ~B) ^ (~A & B) -> A ^ B
2881   // (~B & A) ^ (~A & B) -> A ^ B
2882   // (~A & B) ^ (A & ~B) -> A ^ B
2883   // (B & ~A) ^ (A & ~B) -> A ^ B
2884   if (match(&I, m_Xor(m_c_And(m_Value(A), m_Not(m_Value(B))),
2885                       m_c_And(m_Not(m_Deferred(A)), m_Deferred(B)))))
2886     return BinaryOperator::CreateXor(A, B);
2887 
2888   // For the remaining cases we need to get rid of one of the operands.
2889   if (!Op0->hasOneUse() && !Op1->hasOneUse())
2890     return nullptr;
2891 
2892   // (A | B) ^ ~(A & B) -> ~(A ^ B)
2893   // (A | B) ^ ~(B & A) -> ~(A ^ B)
2894   // (A & B) ^ ~(A | B) -> ~(A ^ B)
2895   // (A & B) ^ ~(B | A) -> ~(A ^ B)
2896   // Complexity sorting ensures the not will be on the right side.
2897   if ((match(Op0, m_Or(m_Value(A), m_Value(B))) &&
2898        match(Op1, m_Not(m_c_And(m_Specific(A), m_Specific(B))))) ||
2899       (match(Op0, m_And(m_Value(A), m_Value(B))) &&
2900        match(Op1, m_Not(m_c_Or(m_Specific(A), m_Specific(B))))))
2901     return BinaryOperator::CreateNot(Builder.CreateXor(A, B));
2902 
2903   return nullptr;
2904 }
2905 
2906 Value *InstCombinerImpl::foldXorOfICmps(ICmpInst *LHS, ICmpInst *RHS,
2907                                         BinaryOperator &I) {
2908   assert(I.getOpcode() == Instruction::Xor && I.getOperand(0) == LHS &&
2909          I.getOperand(1) == RHS && "Should be 'xor' with these operands");
2910 
2911   if (predicatesFoldable(LHS->getPredicate(), RHS->getPredicate())) {
2912     if (LHS->getOperand(0) == RHS->getOperand(1) &&
2913         LHS->getOperand(1) == RHS->getOperand(0))
2914       LHS->swapOperands();
2915     if (LHS->getOperand(0) == RHS->getOperand(0) &&
2916         LHS->getOperand(1) == RHS->getOperand(1)) {
2917       // (icmp1 A, B) ^ (icmp2 A, B) --> (icmp3 A, B)
2918       Value *Op0 = LHS->getOperand(0), *Op1 = LHS->getOperand(1);
2919       unsigned Code = getICmpCode(LHS) ^ getICmpCode(RHS);
2920       bool IsSigned = LHS->isSigned() || RHS->isSigned();
2921       return getNewICmpValue(Code, IsSigned, Op0, Op1, Builder);
2922     }
2923   }
2924 
2925   // TODO: This can be generalized to compares of non-signbits using
2926   // decomposeBitTestICmp(). It could be enhanced more by using (something like)
2927   // foldLogOpOfMaskedICmps().
2928   ICmpInst::Predicate PredL = LHS->getPredicate(), PredR = RHS->getPredicate();
2929   Value *LHS0 = LHS->getOperand(0), *LHS1 = LHS->getOperand(1);
2930   Value *RHS0 = RHS->getOperand(0), *RHS1 = RHS->getOperand(1);
2931   if ((LHS->hasOneUse() || RHS->hasOneUse()) &&
2932       LHS0->getType() == RHS0->getType() &&
2933       LHS0->getType()->isIntOrIntVectorTy()) {
2934     // (X > -1) ^ (Y > -1) --> (X ^ Y) < 0
2935     // (X <  0) ^ (Y <  0) --> (X ^ Y) < 0
2936     if ((PredL == CmpInst::ICMP_SGT && match(LHS1, m_AllOnes()) &&
2937          PredR == CmpInst::ICMP_SGT && match(RHS1, m_AllOnes())) ||
2938         (PredL == CmpInst::ICMP_SLT && match(LHS1, m_Zero()) &&
2939          PredR == CmpInst::ICMP_SLT && match(RHS1, m_Zero()))) {
2940       Value *Zero = ConstantInt::getNullValue(LHS0->getType());
2941       return Builder.CreateICmpSLT(Builder.CreateXor(LHS0, RHS0), Zero);
2942     }
2943     // (X > -1) ^ (Y <  0) --> (X ^ Y) > -1
2944     // (X <  0) ^ (Y > -1) --> (X ^ Y) > -1
2945     if ((PredL == CmpInst::ICMP_SGT && match(LHS1, m_AllOnes()) &&
2946          PredR == CmpInst::ICMP_SLT && match(RHS1, m_Zero())) ||
2947         (PredL == CmpInst::ICMP_SLT && match(LHS1, m_Zero()) &&
2948          PredR == CmpInst::ICMP_SGT && match(RHS1, m_AllOnes()))) {
2949       Value *MinusOne = ConstantInt::getAllOnesValue(LHS0->getType());
2950       return Builder.CreateICmpSGT(Builder.CreateXor(LHS0, RHS0), MinusOne);
2951     }
2952   }
2953 
2954   // Instead of trying to imitate the folds for and/or, decompose this 'xor'
2955   // into those logic ops. That is, try to turn this into an and-of-icmps
2956   // because we have many folds for that pattern.
2957   //
2958   // This is based on a truth table definition of xor:
2959   // X ^ Y --> (X | Y) & !(X & Y)
2960   if (Value *OrICmp = SimplifyBinOp(Instruction::Or, LHS, RHS, SQ)) {
2961     // TODO: If OrICmp is true, then the definition of xor simplifies to !(X&Y).
2962     // TODO: If OrICmp is false, the whole thing is false (InstSimplify?).
2963     if (Value *AndICmp = SimplifyBinOp(Instruction::And, LHS, RHS, SQ)) {
2964       // TODO: Independently handle cases where the 'and' side is a constant.
2965       ICmpInst *X = nullptr, *Y = nullptr;
2966       if (OrICmp == LHS && AndICmp == RHS) {
2967         // (LHS | RHS) & !(LHS & RHS) --> LHS & !RHS  --> X & !Y
2968         X = LHS;
2969         Y = RHS;
2970       }
2971       if (OrICmp == RHS && AndICmp == LHS) {
2972         // !(LHS & RHS) & (LHS | RHS) --> !LHS & RHS  --> !Y & X
2973         X = RHS;
2974         Y = LHS;
2975       }
2976       if (X && Y && (Y->hasOneUse() || canFreelyInvertAllUsersOf(Y, &I))) {
2977         // Invert the predicate of 'Y', thus inverting its output.
2978         Y->setPredicate(Y->getInversePredicate());
2979         // So, are there other uses of Y?
2980         if (!Y->hasOneUse()) {
2981           // We need to adapt other uses of Y though. Get a value that matches
2982           // the original value of Y before inversion. While this increases
2983           // immediate instruction count, we have just ensured that all the
2984           // users are freely-invertible, so that 'not' *will* get folded away.
2985           BuilderTy::InsertPointGuard Guard(Builder);
2986           // Set insertion point to right after the Y.
2987           Builder.SetInsertPoint(Y->getParent(), ++(Y->getIterator()));
2988           Value *NotY = Builder.CreateNot(Y, Y->getName() + ".not");
2989           // Replace all uses of Y (excluding the one in NotY!) with NotY.
2990           Worklist.pushUsersToWorkList(*Y);
2991           Y->replaceUsesWithIf(NotY,
2992                                [NotY](Use &U) { return U.getUser() != NotY; });
2993         }
2994         // All done.
2995         return Builder.CreateAnd(LHS, RHS);
2996       }
2997     }
2998   }
2999 
3000   return nullptr;
3001 }
3002 
3003 /// If we have a masked merge, in the canonical form of:
3004 /// (assuming that A only has one use.)
3005 ///   |        A  |  |B|
3006 ///   ((x ^ y) & M) ^ y
3007 ///    |  D  |
3008 /// * If M is inverted:
3009 ///      |  D  |
3010 ///     ((x ^ y) & ~M) ^ y
3011 ///   We can canonicalize by swapping the final xor operand
3012 ///   to eliminate the 'not' of the mask.
3013 ///     ((x ^ y) & M) ^ x
3014 /// * If M is a constant, and D has one use, we transform to 'and' / 'or' ops
3015 ///   because that shortens the dependency chain and improves analysis:
3016 ///     (x & M) | (y & ~M)
3017 static Instruction *visitMaskedMerge(BinaryOperator &I,
3018                                      InstCombiner::BuilderTy &Builder) {
3019   Value *B, *X, *D;
3020   Value *M;
3021   if (!match(&I, m_c_Xor(m_Value(B),
3022                          m_OneUse(m_c_And(
3023                              m_CombineAnd(m_c_Xor(m_Deferred(B), m_Value(X)),
3024                                           m_Value(D)),
3025                              m_Value(M))))))
3026     return nullptr;
3027 
3028   Value *NotM;
3029   if (match(M, m_Not(m_Value(NotM)))) {
3030     // De-invert the mask and swap the value in B part.
3031     Value *NewA = Builder.CreateAnd(D, NotM);
3032     return BinaryOperator::CreateXor(NewA, X);
3033   }
3034 
3035   Constant *C;
3036   if (D->hasOneUse() && match(M, m_Constant(C))) {
3037     // Propagating undef is unsafe. Clamp undef elements to -1.
3038     Type *EltTy = C->getType()->getScalarType();
3039     C = Constant::replaceUndefsWith(C, ConstantInt::getAllOnesValue(EltTy));
3040     // Unfold.
3041     Value *LHS = Builder.CreateAnd(X, C);
3042     Value *NotC = Builder.CreateNot(C);
3043     Value *RHS = Builder.CreateAnd(B, NotC);
3044     return BinaryOperator::CreateOr(LHS, RHS);
3045   }
3046 
3047   return nullptr;
3048 }
3049 
3050 // Transform
3051 //   ~(x ^ y)
3052 // into:
3053 //   (~x) ^ y
3054 // or into
3055 //   x ^ (~y)
3056 static Instruction *sinkNotIntoXor(BinaryOperator &I,
3057                                    InstCombiner::BuilderTy &Builder) {
3058   Value *X, *Y;
3059   // FIXME: one-use check is not needed in general, but currently we are unable
3060   // to fold 'not' into 'icmp', if that 'icmp' has multiple uses. (D35182)
3061   if (!match(&I, m_Not(m_OneUse(m_Xor(m_Value(X), m_Value(Y))))))
3062     return nullptr;
3063 
3064   // We only want to do the transform if it is free to do.
3065   if (InstCombiner::isFreeToInvert(X, X->hasOneUse())) {
3066     // Ok, good.
3067   } else if (InstCombiner::isFreeToInvert(Y, Y->hasOneUse())) {
3068     std::swap(X, Y);
3069   } else
3070     return nullptr;
3071 
3072   Value *NotX = Builder.CreateNot(X, X->getName() + ".not");
3073   return BinaryOperator::CreateXor(NotX, Y, I.getName() + ".demorgan");
3074 }
3075 
3076 /// Canonicalize a shifty way to code absolute value to the more common pattern
3077 /// that uses negation and select.
3078 static Instruction *canonicalizeAbs(BinaryOperator &Xor,
3079                                     InstCombiner::BuilderTy &Builder) {
3080   assert(Xor.getOpcode() == Instruction::Xor && "Expected an xor instruction.");
3081 
3082   // There are 4 potential commuted variants. Move the 'ashr' candidate to Op1.
3083   // We're relying on the fact that we only do this transform when the shift has
3084   // exactly 2 uses and the add has exactly 1 use (otherwise, we might increase
3085   // instructions).
3086   Value *Op0 = Xor.getOperand(0), *Op1 = Xor.getOperand(1);
3087   if (Op0->hasNUses(2))
3088     std::swap(Op0, Op1);
3089 
3090   Type *Ty = Xor.getType();
3091   Value *A;
3092   const APInt *ShAmt;
3093   if (match(Op1, m_AShr(m_Value(A), m_APInt(ShAmt))) &&
3094       Op1->hasNUses(2) && *ShAmt == Ty->getScalarSizeInBits() - 1 &&
3095       match(Op0, m_OneUse(m_c_Add(m_Specific(A), m_Specific(Op1))))) {
3096     // Op1 = ashr i32 A, 31   ; smear the sign bit
3097     // xor (add A, Op1), Op1  ; add -1 and flip bits if negative
3098     // --> (A < 0) ? -A : A
3099     Value *Cmp = Builder.CreateICmpSLT(A, ConstantInt::getNullValue(Ty));
3100     // Copy the nuw/nsw flags from the add to the negate.
3101     auto *Add = cast<BinaryOperator>(Op0);
3102     Value *Neg = Builder.CreateNeg(A, "", Add->hasNoUnsignedWrap(),
3103                                    Add->hasNoSignedWrap());
3104     return SelectInst::Create(Cmp, Neg, A);
3105   }
3106   return nullptr;
3107 }
3108 
3109 // Transform
3110 //   z = (~x) &/| y
3111 // into:
3112 //   z = ~(x |/& (~y))
3113 // iff y is free to invert and all uses of z can be freely updated.
3114 bool InstCombinerImpl::sinkNotIntoOtherHandOfAndOrOr(BinaryOperator &I) {
3115   Instruction::BinaryOps NewOpc;
3116   switch (I.getOpcode()) {
3117   case Instruction::And:
3118     NewOpc = Instruction::Or;
3119     break;
3120   case Instruction::Or:
3121     NewOpc = Instruction::And;
3122     break;
3123   default:
3124     return false;
3125   };
3126 
3127   Value *X, *Y;
3128   if (!match(&I, m_c_BinOp(m_Not(m_Value(X)), m_Value(Y))))
3129     return false;
3130 
3131   // Will we be able to fold the `not` into Y eventually?
3132   if (!InstCombiner::isFreeToInvert(Y, Y->hasOneUse()))
3133     return false;
3134 
3135   // And can our users be adapted?
3136   if (!InstCombiner::canFreelyInvertAllUsersOf(&I, /*IgnoredUser=*/nullptr))
3137     return false;
3138 
3139   Value *NotY = Builder.CreateNot(Y, Y->getName() + ".not");
3140   Value *NewBinOp =
3141       BinaryOperator::Create(NewOpc, X, NotY, I.getName() + ".not");
3142   Builder.Insert(NewBinOp);
3143   replaceInstUsesWith(I, NewBinOp);
3144   // We can not just create an outer `not`, it will most likely be immediately
3145   // folded back, reconstructing our initial pattern, and causing an
3146   // infinite combine loop, so immediately manually fold it away.
3147   freelyInvertAllUsersOf(NewBinOp);
3148   return true;
3149 }
3150 
3151 Instruction *InstCombinerImpl::foldNot(BinaryOperator &I) {
3152   Value *NotOp;
3153   if (!match(&I, m_Not(m_Value(NotOp))))
3154     return nullptr;
3155 
3156   // Apply DeMorgan's Law for 'nand' / 'nor' logic with an inverted operand.
3157   // We must eliminate the and/or (one-use) for these transforms to not increase
3158   // the instruction count.
3159   //
3160   // ~(~X & Y) --> (X | ~Y)
3161   // ~(Y & ~X) --> (X | ~Y)
3162   //
3163   // Note: The logical matches do not check for the commuted patterns because
3164   //       those are handled via SimplifySelectsFeedingBinaryOp().
3165   Type *Ty = I.getType();
3166   Value *X, *Y;
3167   if (match(NotOp, m_OneUse(m_c_And(m_Not(m_Value(X)), m_Value(Y))))) {
3168     Value *NotY = Builder.CreateNot(Y, Y->getName() + ".not");
3169     return BinaryOperator::CreateOr(X, NotY);
3170   }
3171   if (match(NotOp, m_OneUse(m_LogicalAnd(m_Not(m_Value(X)), m_Value(Y))))) {
3172     Value *NotY = Builder.CreateNot(Y, Y->getName() + ".not");
3173     return SelectInst::Create(X, ConstantInt::getTrue(Ty), NotY);
3174   }
3175 
3176   // ~(~X | Y) --> (X & ~Y)
3177   // ~(Y | ~X) --> (X & ~Y)
3178   if (match(NotOp, m_OneUse(m_c_Or(m_Not(m_Value(X)), m_Value(Y))))) {
3179     Value *NotY = Builder.CreateNot(Y, Y->getName() + ".not");
3180     return BinaryOperator::CreateAnd(X, NotY);
3181   }
3182   if (match(NotOp, m_OneUse(m_LogicalOr(m_Not(m_Value(X)), m_Value(Y))))) {
3183     Value *NotY = Builder.CreateNot(Y, Y->getName() + ".not");
3184     return SelectInst::Create(X, NotY, ConstantInt::getFalse(Ty));
3185   }
3186 
3187   // Is this a 'not' (~) fed by a binary operator?
3188   BinaryOperator *NotVal;
3189   if (match(NotOp, m_BinOp(NotVal))) {
3190     if (NotVal->getOpcode() == Instruction::And ||
3191         NotVal->getOpcode() == Instruction::Or) {
3192       // Apply DeMorgan's Law when inverts are free:
3193       // ~(X & Y) --> (~X | ~Y)
3194       // ~(X | Y) --> (~X & ~Y)
3195       if (isFreeToInvert(NotVal->getOperand(0),
3196                          NotVal->getOperand(0)->hasOneUse()) &&
3197           isFreeToInvert(NotVal->getOperand(1),
3198                          NotVal->getOperand(1)->hasOneUse())) {
3199         Value *NotX = Builder.CreateNot(NotVal->getOperand(0), "notlhs");
3200         Value *NotY = Builder.CreateNot(NotVal->getOperand(1), "notrhs");
3201         if (NotVal->getOpcode() == Instruction::And)
3202           return BinaryOperator::CreateOr(NotX, NotY);
3203         return BinaryOperator::CreateAnd(NotX, NotY);
3204       }
3205     }
3206 
3207     // ~((-X) | Y) --> (X - 1) & (~Y)
3208     if (match(NotVal,
3209               m_OneUse(m_c_Or(m_OneUse(m_Neg(m_Value(X))), m_Value(Y))))) {
3210       Value *DecX = Builder.CreateAdd(X, ConstantInt::getAllOnesValue(Ty));
3211       Value *NotY = Builder.CreateNot(Y);
3212       return BinaryOperator::CreateAnd(DecX, NotY);
3213     }
3214 
3215     // ~(~X >>s Y) --> (X >>s Y)
3216     if (match(NotVal, m_AShr(m_Not(m_Value(X)), m_Value(Y))))
3217       return BinaryOperator::CreateAShr(X, Y);
3218 
3219     // If we are inverting a right-shifted constant, we may be able to eliminate
3220     // the 'not' by inverting the constant and using the opposite shift type.
3221     // Canonicalization rules ensure that only a negative constant uses 'ashr',
3222     // but we must check that in case that transform has not fired yet.
3223 
3224     // ~(C >>s Y) --> ~C >>u Y (when inverting the replicated sign bits)
3225     Constant *C;
3226     if (match(NotVal, m_AShr(m_Constant(C), m_Value(Y))) &&
3227         match(C, m_Negative())) {
3228       // We matched a negative constant, so propagating undef is unsafe.
3229       // Clamp undef elements to -1.
3230       Type *EltTy = Ty->getScalarType();
3231       C = Constant::replaceUndefsWith(C, ConstantInt::getAllOnesValue(EltTy));
3232       return BinaryOperator::CreateLShr(ConstantExpr::getNot(C), Y);
3233     }
3234 
3235     // ~(C >>u Y) --> ~C >>s Y (when inverting the replicated sign bits)
3236     if (match(NotVal, m_LShr(m_Constant(C), m_Value(Y))) &&
3237         match(C, m_NonNegative())) {
3238       // We matched a non-negative constant, so propagating undef is unsafe.
3239       // Clamp undef elements to 0.
3240       Type *EltTy = Ty->getScalarType();
3241       C = Constant::replaceUndefsWith(C, ConstantInt::getNullValue(EltTy));
3242       return BinaryOperator::CreateAShr(ConstantExpr::getNot(C), Y);
3243     }
3244 
3245     // ~(X + C) --> ~C - X
3246     if (match(NotVal, m_c_Add(m_Value(X), m_ImmConstant(C))))
3247       return BinaryOperator::CreateSub(ConstantExpr::getNot(C), X);
3248 
3249     // ~(X - Y) --> ~X + Y
3250     // FIXME: is it really beneficial to sink the `not` here?
3251     if (match(NotVal, m_Sub(m_Value(X), m_Value(Y))))
3252       if (isa<Constant>(X) || NotVal->hasOneUse())
3253         return BinaryOperator::CreateAdd(Builder.CreateNot(X), Y);
3254 
3255     // ~(~X + Y) --> X - Y
3256     if (match(NotVal, m_c_Add(m_Not(m_Value(X)), m_Value(Y))))
3257       return BinaryOperator::CreateWithCopiedFlags(Instruction::Sub, X, Y,
3258                                                    NotVal);
3259   }
3260 
3261   // not (cmp A, B) = !cmp A, B
3262   CmpInst::Predicate Pred;
3263   if (match(NotOp, m_OneUse(m_Cmp(Pred, m_Value(), m_Value())))) {
3264     cast<CmpInst>(NotOp)->setPredicate(CmpInst::getInversePredicate(Pred));
3265     return replaceInstUsesWith(I, NotOp);
3266   }
3267 
3268   // Eliminate a bitwise 'not' op of 'not' min/max by inverting the min/max:
3269   // ~min(~X, ~Y) --> max(X, Y)
3270   // ~max(~X, Y) --> min(X, ~Y)
3271   auto *II = dyn_cast<IntrinsicInst>(NotOp);
3272   if (II && II->hasOneUse()) {
3273     if (match(NotOp, m_MaxOrMin(m_Value(X), m_Value(Y))) &&
3274         isFreeToInvert(X, X->hasOneUse()) &&
3275         isFreeToInvert(Y, Y->hasOneUse())) {
3276       Intrinsic::ID InvID = getInverseMinMaxIntrinsic(II->getIntrinsicID());
3277       Value *NotX = Builder.CreateNot(X);
3278       Value *NotY = Builder.CreateNot(Y);
3279       Value *InvMaxMin = Builder.CreateBinaryIntrinsic(InvID, NotX, NotY);
3280       return replaceInstUsesWith(I, InvMaxMin);
3281     }
3282     if (match(NotOp, m_c_MaxOrMin(m_Not(m_Value(X)), m_Value(Y)))) {
3283       Intrinsic::ID InvID = getInverseMinMaxIntrinsic(II->getIntrinsicID());
3284       Value *NotY = Builder.CreateNot(Y);
3285       Value *InvMaxMin = Builder.CreateBinaryIntrinsic(InvID, X, NotY);
3286       return replaceInstUsesWith(I, InvMaxMin);
3287     }
3288   }
3289 
3290   // TODO: Remove folds if we canonicalize to intrinsics (see above).
3291   // Eliminate a bitwise 'not' op of 'not' min/max by inverting the min/max:
3292   //
3293   //   %notx = xor i32 %x, -1
3294   //   %cmp1 = icmp sgt i32 %notx, %y
3295   //   %smax = select i1 %cmp1, i32 %notx, i32 %y
3296   //   %res = xor i32 %smax, -1
3297   // =>
3298   //   %noty = xor i32 %y, -1
3299   //   %cmp2 = icmp slt %x, %noty
3300   //   %res = select i1 %cmp2, i32 %x, i32 %noty
3301   //
3302   // Same is applicable for smin/umax/umin.
3303   if (NotOp->hasOneUse()) {
3304     Value *LHS, *RHS;
3305     SelectPatternFlavor SPF = matchSelectPattern(NotOp, LHS, RHS).Flavor;
3306     if (SelectPatternResult::isMinOrMax(SPF)) {
3307       // It's possible we get here before the not has been simplified, so make
3308       // sure the input to the not isn't freely invertible.
3309       if (match(LHS, m_Not(m_Value(X))) && !isFreeToInvert(X, X->hasOneUse())) {
3310         Value *NotY = Builder.CreateNot(RHS);
3311         return SelectInst::Create(
3312             Builder.CreateICmp(getInverseMinMaxPred(SPF), X, NotY), X, NotY);
3313       }
3314 
3315       // It's possible we get here before the not has been simplified, so make
3316       // sure the input to the not isn't freely invertible.
3317       if (match(RHS, m_Not(m_Value(Y))) && !isFreeToInvert(Y, Y->hasOneUse())) {
3318         Value *NotX = Builder.CreateNot(LHS);
3319         return SelectInst::Create(
3320             Builder.CreateICmp(getInverseMinMaxPred(SPF), NotX, Y), NotX, Y);
3321       }
3322 
3323       // If both sides are freely invertible, then we can get rid of the xor
3324       // completely.
3325       if (isFreeToInvert(LHS, !LHS->hasNUsesOrMore(3)) &&
3326           isFreeToInvert(RHS, !RHS->hasNUsesOrMore(3))) {
3327         Value *NotLHS = Builder.CreateNot(LHS);
3328         Value *NotRHS = Builder.CreateNot(RHS);
3329         return SelectInst::Create(
3330             Builder.CreateICmp(getInverseMinMaxPred(SPF), NotLHS, NotRHS),
3331             NotLHS, NotRHS);
3332       }
3333     }
3334 
3335     // Pull 'not' into operands of select if both operands are one-use compares
3336     // or one is one-use compare and the other one is a constant.
3337     // Inverting the predicates eliminates the 'not' operation.
3338     // Example:
3339     //   not (select ?, (cmp TPred, ?, ?), (cmp FPred, ?, ?) -->
3340     //     select ?, (cmp InvTPred, ?, ?), (cmp InvFPred, ?, ?)
3341     //   not (select ?, (cmp TPred, ?, ?), true -->
3342     //     select ?, (cmp InvTPred, ?, ?), false
3343     if (auto *Sel = dyn_cast<SelectInst>(NotOp)) {
3344       Value *TV = Sel->getTrueValue();
3345       Value *FV = Sel->getFalseValue();
3346       auto *CmpT = dyn_cast<CmpInst>(TV);
3347       auto *CmpF = dyn_cast<CmpInst>(FV);
3348       bool InvertibleT = (CmpT && CmpT->hasOneUse()) || isa<Constant>(TV);
3349       bool InvertibleF = (CmpF && CmpF->hasOneUse()) || isa<Constant>(FV);
3350       if (InvertibleT && InvertibleF) {
3351         if (CmpT)
3352           CmpT->setPredicate(CmpT->getInversePredicate());
3353         else
3354           Sel->setTrueValue(ConstantExpr::getNot(cast<Constant>(TV)));
3355         if (CmpF)
3356           CmpF->setPredicate(CmpF->getInversePredicate());
3357         else
3358           Sel->setFalseValue(ConstantExpr::getNot(cast<Constant>(FV)));
3359         return replaceInstUsesWith(I, Sel);
3360       }
3361     }
3362   }
3363 
3364   if (Instruction *NewXor = sinkNotIntoXor(I, Builder))
3365     return NewXor;
3366 
3367   return nullptr;
3368 }
3369 
3370 // FIXME: We use commutative matchers (m_c_*) for some, but not all, matches
3371 // here. We should standardize that construct where it is needed or choose some
3372 // other way to ensure that commutated variants of patterns are not missed.
3373 Instruction *InstCombinerImpl::visitXor(BinaryOperator &I) {
3374   if (Value *V = SimplifyXorInst(I.getOperand(0), I.getOperand(1),
3375                                  SQ.getWithInstruction(&I)))
3376     return replaceInstUsesWith(I, V);
3377 
3378   if (SimplifyAssociativeOrCommutative(I))
3379     return &I;
3380 
3381   if (Instruction *X = foldVectorBinop(I))
3382     return X;
3383 
3384   if (Instruction *NewXor = foldXorToXor(I, Builder))
3385     return NewXor;
3386 
3387   // (A&B)^(A&C) -> A&(B^C) etc
3388   if (Value *V = SimplifyUsingDistributiveLaws(I))
3389     return replaceInstUsesWith(I, V);
3390 
3391   // See if we can simplify any instructions used by the instruction whose sole
3392   // purpose is to compute bits we don't care about.
3393   if (SimplifyDemandedInstructionBits(I))
3394     return &I;
3395 
3396   if (Value *V = SimplifyBSwap(I, Builder))
3397     return replaceInstUsesWith(I, V);
3398 
3399   if (Instruction *R = foldNot(I))
3400     return R;
3401 
3402   // Fold (X & M) ^ (Y & ~M) -> (X & M) | (Y & ~M)
3403   // This it a special case in haveNoCommonBitsSet, but the computeKnownBits
3404   // calls in there are unnecessary as SimplifyDemandedInstructionBits should
3405   // have already taken care of those cases.
3406   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
3407   Value *M;
3408   if (match(&I, m_c_Xor(m_c_And(m_Not(m_Value(M)), m_Value()),
3409                         m_c_And(m_Deferred(M), m_Value()))))
3410     return BinaryOperator::CreateOr(Op0, Op1);
3411 
3412   if (Instruction *Xor = visitMaskedMerge(I, Builder))
3413     return Xor;
3414 
3415   Value *X, *Y;
3416   Constant *C1;
3417   if (match(Op1, m_Constant(C1))) {
3418     // Use DeMorgan and reassociation to eliminate a 'not' op.
3419     Constant *C2;
3420     if (match(Op0, m_OneUse(m_Or(m_Not(m_Value(X)), m_Constant(C2))))) {
3421       // (~X | C2) ^ C1 --> ((X & ~C2) ^ -1) ^ C1 --> (X & ~C2) ^ ~C1
3422       Value *And = Builder.CreateAnd(X, ConstantExpr::getNot(C2));
3423       return BinaryOperator::CreateXor(And, ConstantExpr::getNot(C1));
3424     }
3425     if (match(Op0, m_OneUse(m_And(m_Not(m_Value(X)), m_Constant(C2))))) {
3426       // (~X & C2) ^ C1 --> ((X | ~C2) ^ -1) ^ C1 --> (X | ~C2) ^ ~C1
3427       Value *Or = Builder.CreateOr(X, ConstantExpr::getNot(C2));
3428       return BinaryOperator::CreateXor(Or, ConstantExpr::getNot(C1));
3429     }
3430 
3431     // Convert xor ([trunc] (ashr X, BW-1)), C =>
3432     //   select(X >s -1, C, ~C)
3433     // The ashr creates "AllZeroOrAllOne's", which then optionally inverses the
3434     // constant depending on whether this input is less than 0.
3435     const APInt *CA;
3436     if (match(Op0, m_OneUse(m_TruncOrSelf(
3437                        m_AShr(m_Value(X), m_APIntAllowUndef(CA))))) &&
3438         *CA == X->getType()->getScalarSizeInBits() - 1 &&
3439         !match(C1, m_AllOnes())) {
3440       assert(!C1->isZeroValue() && "Unexpected xor with 0");
3441       Value *ICmp =
3442           Builder.CreateICmpSGT(X, Constant::getAllOnesValue(X->getType()));
3443       return SelectInst::Create(ICmp, Op1, Builder.CreateNot(Op1));
3444     }
3445   }
3446 
3447   Type *Ty = I.getType();
3448   {
3449     const APInt *RHSC;
3450     if (match(Op1, m_APInt(RHSC))) {
3451       Value *X;
3452       const APInt *C;
3453       // (C - X) ^ signmaskC --> (C + signmaskC) - X
3454       if (RHSC->isSignMask() && match(Op0, m_Sub(m_APInt(C), m_Value(X))))
3455         return BinaryOperator::CreateSub(ConstantInt::get(Ty, *C + *RHSC), X);
3456 
3457       // (X + C) ^ signmaskC --> X + (C + signmaskC)
3458       if (RHSC->isSignMask() && match(Op0, m_Add(m_Value(X), m_APInt(C))))
3459         return BinaryOperator::CreateAdd(X, ConstantInt::get(Ty, *C + *RHSC));
3460 
3461       // (X | C) ^ RHSC --> X ^ (C ^ RHSC) iff X & C == 0
3462       if (match(Op0, m_Or(m_Value(X), m_APInt(C))) &&
3463           MaskedValueIsZero(X, *C, 0, &I))
3464         return BinaryOperator::CreateXor(X, ConstantInt::get(Ty, *C ^ *RHSC));
3465 
3466       // If RHSC is inverting the remaining bits of shifted X,
3467       // canonicalize to a 'not' before the shift to help SCEV and codegen:
3468       // (X << C) ^ RHSC --> ~X << C
3469       if (match(Op0, m_OneUse(m_Shl(m_Value(X), m_APInt(C)))) &&
3470           *RHSC == APInt::getAllOnes(Ty->getScalarSizeInBits()).shl(*C)) {
3471         Value *NotX = Builder.CreateNot(X);
3472         return BinaryOperator::CreateShl(NotX, ConstantInt::get(Ty, *C));
3473       }
3474       // (X >>u C) ^ RHSC --> ~X >>u C
3475       if (match(Op0, m_OneUse(m_LShr(m_Value(X), m_APInt(C)))) &&
3476           *RHSC == APInt::getAllOnes(Ty->getScalarSizeInBits()).lshr(*C)) {
3477         Value *NotX = Builder.CreateNot(X);
3478         return BinaryOperator::CreateLShr(NotX, ConstantInt::get(Ty, *C));
3479       }
3480       // TODO: We could handle 'ashr' here as well. That would be matching
3481       //       a 'not' op and moving it before the shift. Doing that requires
3482       //       preventing the inverse fold in canShiftBinOpWithConstantRHS().
3483     }
3484   }
3485 
3486   // FIXME: This should not be limited to scalar (pull into APInt match above).
3487   {
3488     Value *X;
3489     ConstantInt *C1, *C2, *C3;
3490     // ((X^C1) >> C2) ^ C3 -> (X>>C2) ^ ((C1>>C2)^C3)
3491     if (match(Op1, m_ConstantInt(C3)) &&
3492         match(Op0, m_LShr(m_Xor(m_Value(X), m_ConstantInt(C1)),
3493                           m_ConstantInt(C2))) &&
3494         Op0->hasOneUse()) {
3495       // fold (C1 >> C2) ^ C3
3496       APInt FoldConst = C1->getValue().lshr(C2->getValue());
3497       FoldConst ^= C3->getValue();
3498       // Prepare the two operands.
3499       auto *Opnd0 = cast<Instruction>(Builder.CreateLShr(X, C2));
3500       Opnd0->takeName(cast<Instruction>(Op0));
3501       Opnd0->setDebugLoc(I.getDebugLoc());
3502       return BinaryOperator::CreateXor(Opnd0, ConstantInt::get(Ty, FoldConst));
3503     }
3504   }
3505 
3506   if (Instruction *FoldedLogic = foldBinOpIntoSelectOrPhi(I))
3507     return FoldedLogic;
3508 
3509   // Y ^ (X | Y) --> X & ~Y
3510   // Y ^ (Y | X) --> X & ~Y
3511   if (match(Op1, m_OneUse(m_c_Or(m_Value(X), m_Specific(Op0)))))
3512     return BinaryOperator::CreateAnd(X, Builder.CreateNot(Op0));
3513   // (X | Y) ^ Y --> X & ~Y
3514   // (Y | X) ^ Y --> X & ~Y
3515   if (match(Op0, m_OneUse(m_c_Or(m_Value(X), m_Specific(Op1)))))
3516     return BinaryOperator::CreateAnd(X, Builder.CreateNot(Op1));
3517 
3518   // Y ^ (X & Y) --> ~X & Y
3519   // Y ^ (Y & X) --> ~X & Y
3520   if (match(Op1, m_OneUse(m_c_And(m_Value(X), m_Specific(Op0)))))
3521     return BinaryOperator::CreateAnd(Op0, Builder.CreateNot(X));
3522   // (X & Y) ^ Y --> ~X & Y
3523   // (Y & X) ^ Y --> ~X & Y
3524   // Canonical form is (X & C) ^ C; don't touch that.
3525   // TODO: A 'not' op is better for analysis and codegen, but demanded bits must
3526   //       be fixed to prefer that (otherwise we get infinite looping).
3527   if (!match(Op1, m_Constant()) &&
3528       match(Op0, m_OneUse(m_c_And(m_Value(X), m_Specific(Op1)))))
3529     return BinaryOperator::CreateAnd(Op1, Builder.CreateNot(X));
3530 
3531   Value *A, *B, *C;
3532   // (A ^ B) ^ (A | C) --> (~A & C) ^ B -- There are 4 commuted variants.
3533   if (match(&I, m_c_Xor(m_OneUse(m_Xor(m_Value(A), m_Value(B))),
3534                         m_OneUse(m_c_Or(m_Deferred(A), m_Value(C))))))
3535       return BinaryOperator::CreateXor(
3536           Builder.CreateAnd(Builder.CreateNot(A), C), B);
3537 
3538   // (A ^ B) ^ (B | C) --> (~B & C) ^ A -- There are 4 commuted variants.
3539   if (match(&I, m_c_Xor(m_OneUse(m_Xor(m_Value(A), m_Value(B))),
3540                         m_OneUse(m_c_Or(m_Deferred(B), m_Value(C))))))
3541       return BinaryOperator::CreateXor(
3542           Builder.CreateAnd(Builder.CreateNot(B), C), A);
3543 
3544   // (A & B) ^ (A ^ B) -> (A | B)
3545   if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
3546       match(Op1, m_c_Xor(m_Specific(A), m_Specific(B))))
3547     return BinaryOperator::CreateOr(A, B);
3548   // (A ^ B) ^ (A & B) -> (A | B)
3549   if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
3550       match(Op1, m_c_And(m_Specific(A), m_Specific(B))))
3551     return BinaryOperator::CreateOr(A, B);
3552 
3553   // (A & ~B) ^ ~A -> ~(A & B)
3554   // (~B & A) ^ ~A -> ~(A & B)
3555   if (match(Op0, m_c_And(m_Value(A), m_Not(m_Value(B)))) &&
3556       match(Op1, m_Not(m_Specific(A))))
3557     return BinaryOperator::CreateNot(Builder.CreateAnd(A, B));
3558 
3559   // (~A & B) ^ A --> A | B -- There are 4 commuted variants.
3560   if (match(&I, m_c_Xor(m_c_And(m_Not(m_Value(A)), m_Value(B)), m_Deferred(A))))
3561     return BinaryOperator::CreateOr(A, B);
3562 
3563   // (A | B) ^ (A | C) --> (B ^ C) & ~A -- There are 4 commuted variants.
3564   // TODO: Loosen one-use restriction if common operand is a constant.
3565   Value *D;
3566   if (match(Op0, m_OneUse(m_Or(m_Value(A), m_Value(B)))) &&
3567       match(Op1, m_OneUse(m_Or(m_Value(C), m_Value(D))))) {
3568     if (B == C || B == D)
3569       std::swap(A, B);
3570     if (A == C)
3571       std::swap(C, D);
3572     if (A == D) {
3573       Value *NotA = Builder.CreateNot(A);
3574       return BinaryOperator::CreateAnd(Builder.CreateXor(B, C), NotA);
3575     }
3576   }
3577 
3578   if (auto *LHS = dyn_cast<ICmpInst>(I.getOperand(0)))
3579     if (auto *RHS = dyn_cast<ICmpInst>(I.getOperand(1)))
3580       if (Value *V = foldXorOfICmps(LHS, RHS, I))
3581         return replaceInstUsesWith(I, V);
3582 
3583   if (Instruction *CastedXor = foldCastedBitwiseLogic(I))
3584     return CastedXor;
3585 
3586   if (Instruction *Abs = canonicalizeAbs(I, Builder))
3587     return Abs;
3588 
3589   // Otherwise, if all else failed, try to hoist the xor-by-constant:
3590   //   (X ^ C) ^ Y --> (X ^ Y) ^ C
3591   // Just like we do in other places, we completely avoid the fold
3592   // for constantexprs, at least to avoid endless combine loop.
3593   if (match(&I, m_c_Xor(m_OneUse(m_Xor(m_CombineAnd(m_Value(X),
3594                                                     m_Unless(m_ConstantExpr())),
3595                                        m_ImmConstant(C1))),
3596                         m_Value(Y))))
3597     return BinaryOperator::CreateXor(Builder.CreateXor(X, Y), C1);
3598 
3599   return nullptr;
3600 }
3601