xref: /llvm-project/llvm/lib/Transforms/InstCombine/InstCombineAddSub.cpp (revision 4a7abfe0a7b9b43cc60115caab810f4c24e53f1c)
1 //===- InstCombineAddSub.cpp ------------------------------------*- C++ -*-===//
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 visit functions for add, fadd, sub, and fsub.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "InstCombineInternal.h"
14 #include "llvm/ADT/APFloat.h"
15 #include "llvm/ADT/APInt.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/SmallVector.h"
18 #include "llvm/Analysis/InstructionSimplify.h"
19 #include "llvm/Analysis/ValueTracking.h"
20 #include "llvm/IR/Constant.h"
21 #include "llvm/IR/Constants.h"
22 #include "llvm/IR/InstrTypes.h"
23 #include "llvm/IR/Instruction.h"
24 #include "llvm/IR/Instructions.h"
25 #include "llvm/IR/Operator.h"
26 #include "llvm/IR/PatternMatch.h"
27 #include "llvm/IR/Type.h"
28 #include "llvm/IR/Value.h"
29 #include "llvm/Support/AlignOf.h"
30 #include "llvm/Support/Casting.h"
31 #include "llvm/Support/KnownBits.h"
32 #include "llvm/Transforms/InstCombine/InstCombiner.h"
33 #include <cassert>
34 #include <utility>
35 
36 using namespace llvm;
37 using namespace PatternMatch;
38 
39 #define DEBUG_TYPE "instcombine"
40 
41 namespace {
42 
43   /// Class representing coefficient of floating-point addend.
44   /// This class needs to be highly efficient, which is especially true for
45   /// the constructor. As of I write this comment, the cost of the default
46   /// constructor is merely 4-byte-store-zero (Assuming compiler is able to
47   /// perform write-merging).
48   ///
49   class FAddendCoef {
50   public:
51     // The constructor has to initialize a APFloat, which is unnecessary for
52     // most addends which have coefficient either 1 or -1. So, the constructor
53     // is expensive. In order to avoid the cost of the constructor, we should
54     // reuse some instances whenever possible. The pre-created instances
55     // FAddCombine::Add[0-5] embodies this idea.
56     FAddendCoef() = default;
57     ~FAddendCoef();
58 
59     // If possible, don't define operator+/operator- etc because these
60     // operators inevitably call FAddendCoef's constructor which is not cheap.
61     void operator=(const FAddendCoef &A);
62     void operator+=(const FAddendCoef &A);
63     void operator*=(const FAddendCoef &S);
64 
65     void set(short C) {
66       assert(!insaneIntVal(C) && "Insane coefficient");
67       IsFp = false; IntVal = C;
68     }
69 
70     void set(const APFloat& C);
71 
72     void negate();
73 
74     bool isZero() const { return isInt() ? !IntVal : getFpVal().isZero(); }
75     Value *getValue(Type *) const;
76 
77     bool isOne() const { return isInt() && IntVal == 1; }
78     bool isTwo() const { return isInt() && IntVal == 2; }
79     bool isMinusOne() const { return isInt() && IntVal == -1; }
80     bool isMinusTwo() const { return isInt() && IntVal == -2; }
81 
82   private:
83     bool insaneIntVal(int V) { return V > 4 || V < -4; }
84 
85     APFloat *getFpValPtr() { return reinterpret_cast<APFloat *>(&FpValBuf); }
86 
87     const APFloat *getFpValPtr() const {
88       return reinterpret_cast<const APFloat *>(&FpValBuf);
89     }
90 
91     const APFloat &getFpVal() const {
92       assert(IsFp && BufHasFpVal && "Incorret state");
93       return *getFpValPtr();
94     }
95 
96     APFloat &getFpVal() {
97       assert(IsFp && BufHasFpVal && "Incorret state");
98       return *getFpValPtr();
99     }
100 
101     bool isInt() const { return !IsFp; }
102 
103     // If the coefficient is represented by an integer, promote it to a
104     // floating point.
105     void convertToFpType(const fltSemantics &Sem);
106 
107     // Construct an APFloat from a signed integer.
108     // TODO: We should get rid of this function when APFloat can be constructed
109     //       from an *SIGNED* integer.
110     APFloat createAPFloatFromInt(const fltSemantics &Sem, int Val);
111 
112     bool IsFp = false;
113 
114     // True iff FpValBuf contains an instance of APFloat.
115     bool BufHasFpVal = false;
116 
117     // The integer coefficient of an individual addend is either 1 or -1,
118     // and we try to simplify at most 4 addends from neighboring at most
119     // two instructions. So the range of <IntVal> falls in [-4, 4]. APInt
120     // is overkill of this end.
121     short IntVal = 0;
122 
123     AlignedCharArrayUnion<APFloat> FpValBuf;
124   };
125 
126   /// FAddend is used to represent floating-point addend. An addend is
127   /// represented as <C, V>, where the V is a symbolic value, and C is a
128   /// constant coefficient. A constant addend is represented as <C, 0>.
129   class FAddend {
130   public:
131     FAddend() = default;
132 
133     void operator+=(const FAddend &T) {
134       assert((Val == T.Val) && "Symbolic-values disagree");
135       Coeff += T.Coeff;
136     }
137 
138     Value *getSymVal() const { return Val; }
139     const FAddendCoef &getCoef() const { return Coeff; }
140 
141     bool isConstant() const { return Val == nullptr; }
142     bool isZero() const { return Coeff.isZero(); }
143 
144     void set(short Coefficient, Value *V) {
145       Coeff.set(Coefficient);
146       Val = V;
147     }
148     void set(const APFloat &Coefficient, Value *V) {
149       Coeff.set(Coefficient);
150       Val = V;
151     }
152     void set(const ConstantFP *Coefficient, Value *V) {
153       Coeff.set(Coefficient->getValueAPF());
154       Val = V;
155     }
156 
157     void negate() { Coeff.negate(); }
158 
159     /// Drill down the U-D chain one step to find the definition of V, and
160     /// try to break the definition into one or two addends.
161     static unsigned drillValueDownOneStep(Value* V, FAddend &A0, FAddend &A1);
162 
163     /// Similar to FAddend::drillDownOneStep() except that the value being
164     /// splitted is the addend itself.
165     unsigned drillAddendDownOneStep(FAddend &Addend0, FAddend &Addend1) const;
166 
167   private:
168     void Scale(const FAddendCoef& ScaleAmt) { Coeff *= ScaleAmt; }
169 
170     // This addend has the value of "Coeff * Val".
171     Value *Val = nullptr;
172     FAddendCoef Coeff;
173   };
174 
175   /// FAddCombine is the class for optimizing an unsafe fadd/fsub along
176   /// with its neighboring at most two instructions.
177   ///
178   class FAddCombine {
179   public:
180     FAddCombine(InstCombiner::BuilderTy &B) : Builder(B) {}
181 
182     Value *simplify(Instruction *FAdd);
183 
184   private:
185     using AddendVect = SmallVector<const FAddend *, 4>;
186 
187     Value *simplifyFAdd(AddendVect& V, unsigned InstrQuota);
188 
189     /// Convert given addend to a Value
190     Value *createAddendVal(const FAddend &A, bool& NeedNeg);
191 
192     /// Return the number of instructions needed to emit the N-ary addition.
193     unsigned calcInstrNumber(const AddendVect& Vect);
194 
195     Value *createFSub(Value *Opnd0, Value *Opnd1);
196     Value *createFAdd(Value *Opnd0, Value *Opnd1);
197     Value *createFMul(Value *Opnd0, Value *Opnd1);
198     Value *createFNeg(Value *V);
199     Value *createNaryFAdd(const AddendVect& Opnds, unsigned InstrQuota);
200     void createInstPostProc(Instruction *NewInst, bool NoNumber = false);
201 
202      // Debugging stuff are clustered here.
203     #ifndef NDEBUG
204       unsigned CreateInstrNum;
205       void initCreateInstNum() { CreateInstrNum = 0; }
206       void incCreateInstNum() { CreateInstrNum++; }
207     #else
208       void initCreateInstNum() {}
209       void incCreateInstNum() {}
210     #endif
211 
212     InstCombiner::BuilderTy &Builder;
213     Instruction *Instr = nullptr;
214   };
215 
216 } // end anonymous namespace
217 
218 //===----------------------------------------------------------------------===//
219 //
220 // Implementation of
221 //    {FAddendCoef, FAddend, FAddition, FAddCombine}.
222 //
223 //===----------------------------------------------------------------------===//
224 FAddendCoef::~FAddendCoef() {
225   if (BufHasFpVal)
226     getFpValPtr()->~APFloat();
227 }
228 
229 void FAddendCoef::set(const APFloat& C) {
230   APFloat *P = getFpValPtr();
231 
232   if (isInt()) {
233     // As the buffer is meanless byte stream, we cannot call
234     // APFloat::operator=().
235     new(P) APFloat(C);
236   } else
237     *P = C;
238 
239   IsFp = BufHasFpVal = true;
240 }
241 
242 void FAddendCoef::convertToFpType(const fltSemantics &Sem) {
243   if (!isInt())
244     return;
245 
246   APFloat *P = getFpValPtr();
247   if (IntVal > 0)
248     new(P) APFloat(Sem, IntVal);
249   else {
250     new(P) APFloat(Sem, 0 - IntVal);
251     P->changeSign();
252   }
253   IsFp = BufHasFpVal = true;
254 }
255 
256 APFloat FAddendCoef::createAPFloatFromInt(const fltSemantics &Sem, int Val) {
257   if (Val >= 0)
258     return APFloat(Sem, Val);
259 
260   APFloat T(Sem, 0 - Val);
261   T.changeSign();
262 
263   return T;
264 }
265 
266 void FAddendCoef::operator=(const FAddendCoef &That) {
267   if (That.isInt())
268     set(That.IntVal);
269   else
270     set(That.getFpVal());
271 }
272 
273 void FAddendCoef::operator+=(const FAddendCoef &That) {
274   RoundingMode RndMode = RoundingMode::NearestTiesToEven;
275   if (isInt() == That.isInt()) {
276     if (isInt())
277       IntVal += That.IntVal;
278     else
279       getFpVal().add(That.getFpVal(), RndMode);
280     return;
281   }
282 
283   if (isInt()) {
284     const APFloat &T = That.getFpVal();
285     convertToFpType(T.getSemantics());
286     getFpVal().add(T, RndMode);
287     return;
288   }
289 
290   APFloat &T = getFpVal();
291   T.add(createAPFloatFromInt(T.getSemantics(), That.IntVal), RndMode);
292 }
293 
294 void FAddendCoef::operator*=(const FAddendCoef &That) {
295   if (That.isOne())
296     return;
297 
298   if (That.isMinusOne()) {
299     negate();
300     return;
301   }
302 
303   if (isInt() && That.isInt()) {
304     int Res = IntVal * (int)That.IntVal;
305     assert(!insaneIntVal(Res) && "Insane int value");
306     IntVal = Res;
307     return;
308   }
309 
310   const fltSemantics &Semantic =
311     isInt() ? That.getFpVal().getSemantics() : getFpVal().getSemantics();
312 
313   if (isInt())
314     convertToFpType(Semantic);
315   APFloat &F0 = getFpVal();
316 
317   if (That.isInt())
318     F0.multiply(createAPFloatFromInt(Semantic, That.IntVal),
319                 APFloat::rmNearestTiesToEven);
320   else
321     F0.multiply(That.getFpVal(), APFloat::rmNearestTiesToEven);
322 }
323 
324 void FAddendCoef::negate() {
325   if (isInt())
326     IntVal = 0 - IntVal;
327   else
328     getFpVal().changeSign();
329 }
330 
331 Value *FAddendCoef::getValue(Type *Ty) const {
332   return isInt() ?
333     ConstantFP::get(Ty, float(IntVal)) :
334     ConstantFP::get(Ty->getContext(), getFpVal());
335 }
336 
337 // The definition of <Val>     Addends
338 // =========================================
339 //  A + B                     <1, A>, <1,B>
340 //  A - B                     <1, A>, <1,B>
341 //  0 - B                     <-1, B>
342 //  C * A,                    <C, A>
343 //  A + C                     <1, A> <C, NULL>
344 //  0 +/- 0                   <0, NULL> (corner case)
345 //
346 // Legend: A and B are not constant, C is constant
347 unsigned FAddend::drillValueDownOneStep
348   (Value *Val, FAddend &Addend0, FAddend &Addend1) {
349   Instruction *I = nullptr;
350   if (!Val || !(I = dyn_cast<Instruction>(Val)))
351     return 0;
352 
353   unsigned Opcode = I->getOpcode();
354 
355   if (Opcode == Instruction::FAdd || Opcode == Instruction::FSub) {
356     ConstantFP *C0, *C1;
357     Value *Opnd0 = I->getOperand(0);
358     Value *Opnd1 = I->getOperand(1);
359     if ((C0 = dyn_cast<ConstantFP>(Opnd0)) && C0->isZero())
360       Opnd0 = nullptr;
361 
362     if ((C1 = dyn_cast<ConstantFP>(Opnd1)) && C1->isZero())
363       Opnd1 = nullptr;
364 
365     if (Opnd0) {
366       if (!C0)
367         Addend0.set(1, Opnd0);
368       else
369         Addend0.set(C0, nullptr);
370     }
371 
372     if (Opnd1) {
373       FAddend &Addend = Opnd0 ? Addend1 : Addend0;
374       if (!C1)
375         Addend.set(1, Opnd1);
376       else
377         Addend.set(C1, nullptr);
378       if (Opcode == Instruction::FSub)
379         Addend.negate();
380     }
381 
382     if (Opnd0 || Opnd1)
383       return Opnd0 && Opnd1 ? 2 : 1;
384 
385     // Both operands are zero. Weird!
386     Addend0.set(APFloat(C0->getValueAPF().getSemantics()), nullptr);
387     return 1;
388   }
389 
390   if (I->getOpcode() == Instruction::FMul) {
391     Value *V0 = I->getOperand(0);
392     Value *V1 = I->getOperand(1);
393     if (ConstantFP *C = dyn_cast<ConstantFP>(V0)) {
394       Addend0.set(C, V1);
395       return 1;
396     }
397 
398     if (ConstantFP *C = dyn_cast<ConstantFP>(V1)) {
399       Addend0.set(C, V0);
400       return 1;
401     }
402   }
403 
404   return 0;
405 }
406 
407 // Try to break *this* addend into two addends. e.g. Suppose this addend is
408 // <2.3, V>, and V = X + Y, by calling this function, we obtain two addends,
409 // i.e. <2.3, X> and <2.3, Y>.
410 unsigned FAddend::drillAddendDownOneStep
411   (FAddend &Addend0, FAddend &Addend1) const {
412   if (isConstant())
413     return 0;
414 
415   unsigned BreakNum = FAddend::drillValueDownOneStep(Val, Addend0, Addend1);
416   if (!BreakNum || Coeff.isOne())
417     return BreakNum;
418 
419   Addend0.Scale(Coeff);
420 
421   if (BreakNum == 2)
422     Addend1.Scale(Coeff);
423 
424   return BreakNum;
425 }
426 
427 Value *FAddCombine::simplify(Instruction *I) {
428   assert(I->hasAllowReassoc() && I->hasNoSignedZeros() &&
429          "Expected 'reassoc'+'nsz' instruction");
430 
431   // Currently we are not able to handle vector type.
432   if (I->getType()->isVectorTy())
433     return nullptr;
434 
435   assert((I->getOpcode() == Instruction::FAdd ||
436           I->getOpcode() == Instruction::FSub) && "Expect add/sub");
437 
438   // Save the instruction before calling other member-functions.
439   Instr = I;
440 
441   FAddend Opnd0, Opnd1, Opnd0_0, Opnd0_1, Opnd1_0, Opnd1_1;
442 
443   unsigned OpndNum = FAddend::drillValueDownOneStep(I, Opnd0, Opnd1);
444 
445   // Step 1: Expand the 1st addend into Opnd0_0 and Opnd0_1.
446   unsigned Opnd0_ExpNum = 0;
447   unsigned Opnd1_ExpNum = 0;
448 
449   if (!Opnd0.isConstant())
450     Opnd0_ExpNum = Opnd0.drillAddendDownOneStep(Opnd0_0, Opnd0_1);
451 
452   // Step 2: Expand the 2nd addend into Opnd1_0 and Opnd1_1.
453   if (OpndNum == 2 && !Opnd1.isConstant())
454     Opnd1_ExpNum = Opnd1.drillAddendDownOneStep(Opnd1_0, Opnd1_1);
455 
456   // Step 3: Try to optimize Opnd0_0 + Opnd0_1 + Opnd1_0 + Opnd1_1
457   if (Opnd0_ExpNum && Opnd1_ExpNum) {
458     AddendVect AllOpnds;
459     AllOpnds.push_back(&Opnd0_0);
460     AllOpnds.push_back(&Opnd1_0);
461     if (Opnd0_ExpNum == 2)
462       AllOpnds.push_back(&Opnd0_1);
463     if (Opnd1_ExpNum == 2)
464       AllOpnds.push_back(&Opnd1_1);
465 
466     // Compute instruction quota. We should save at least one instruction.
467     unsigned InstQuota = 0;
468 
469     Value *V0 = I->getOperand(0);
470     Value *V1 = I->getOperand(1);
471     InstQuota = ((!isa<Constant>(V0) && V0->hasOneUse()) &&
472                  (!isa<Constant>(V1) && V1->hasOneUse())) ? 2 : 1;
473 
474     if (Value *R = simplifyFAdd(AllOpnds, InstQuota))
475       return R;
476   }
477 
478   if (OpndNum != 2) {
479     // The input instruction is : "I=0.0 +/- V". If the "V" were able to be
480     // splitted into two addends, say "V = X - Y", the instruction would have
481     // been optimized into "I = Y - X" in the previous steps.
482     //
483     const FAddendCoef &CE = Opnd0.getCoef();
484     return CE.isOne() ? Opnd0.getSymVal() : nullptr;
485   }
486 
487   // step 4: Try to optimize Opnd0 + Opnd1_0 [+ Opnd1_1]
488   if (Opnd1_ExpNum) {
489     AddendVect AllOpnds;
490     AllOpnds.push_back(&Opnd0);
491     AllOpnds.push_back(&Opnd1_0);
492     if (Opnd1_ExpNum == 2)
493       AllOpnds.push_back(&Opnd1_1);
494 
495     if (Value *R = simplifyFAdd(AllOpnds, 1))
496       return R;
497   }
498 
499   // step 5: Try to optimize Opnd1 + Opnd0_0 [+ Opnd0_1]
500   if (Opnd0_ExpNum) {
501     AddendVect AllOpnds;
502     AllOpnds.push_back(&Opnd1);
503     AllOpnds.push_back(&Opnd0_0);
504     if (Opnd0_ExpNum == 2)
505       AllOpnds.push_back(&Opnd0_1);
506 
507     if (Value *R = simplifyFAdd(AllOpnds, 1))
508       return R;
509   }
510 
511   return nullptr;
512 }
513 
514 Value *FAddCombine::simplifyFAdd(AddendVect& Addends, unsigned InstrQuota) {
515   unsigned AddendNum = Addends.size();
516   assert(AddendNum <= 4 && "Too many addends");
517 
518   // For saving intermediate results;
519   unsigned NextTmpIdx = 0;
520   FAddend TmpResult[3];
521 
522   // Simplified addends are placed <SimpVect>.
523   AddendVect SimpVect;
524 
525   // The outer loop works on one symbolic-value at a time. Suppose the input
526   // addends are : <a1, x>, <b1, y>, <a2, x>, <c1, z>, <b2, y>, ...
527   // The symbolic-values will be processed in this order: x, y, z.
528   for (unsigned SymIdx = 0; SymIdx < AddendNum; SymIdx++) {
529 
530     const FAddend *ThisAddend = Addends[SymIdx];
531     if (!ThisAddend) {
532       // This addend was processed before.
533       continue;
534     }
535 
536     Value *Val = ThisAddend->getSymVal();
537 
538     // If the resulting expr has constant-addend, this constant-addend is
539     // desirable to reside at the top of the resulting expression tree. Placing
540     // constant close to super-expr(s) will potentially reveal some
541     // optimization opportunities in super-expr(s). Here we do not implement
542     // this logic intentionally and rely on SimplifyAssociativeOrCommutative
543     // call later.
544 
545     unsigned StartIdx = SimpVect.size();
546     SimpVect.push_back(ThisAddend);
547 
548     // The inner loop collects addends sharing same symbolic-value, and these
549     // addends will be later on folded into a single addend. Following above
550     // example, if the symbolic value "y" is being processed, the inner loop
551     // will collect two addends "<b1,y>" and "<b2,Y>". These two addends will
552     // be later on folded into "<b1+b2, y>".
553     for (unsigned SameSymIdx = SymIdx + 1;
554          SameSymIdx < AddendNum; SameSymIdx++) {
555       const FAddend *T = Addends[SameSymIdx];
556       if (T && T->getSymVal() == Val) {
557         // Set null such that next iteration of the outer loop will not process
558         // this addend again.
559         Addends[SameSymIdx] = nullptr;
560         SimpVect.push_back(T);
561       }
562     }
563 
564     // If multiple addends share same symbolic value, fold them together.
565     if (StartIdx + 1 != SimpVect.size()) {
566       FAddend &R = TmpResult[NextTmpIdx ++];
567       R = *SimpVect[StartIdx];
568       for (unsigned Idx = StartIdx + 1; Idx < SimpVect.size(); Idx++)
569         R += *SimpVect[Idx];
570 
571       // Pop all addends being folded and push the resulting folded addend.
572       SimpVect.resize(StartIdx);
573       if (!R.isZero()) {
574         SimpVect.push_back(&R);
575       }
576     }
577   }
578 
579   assert((NextTmpIdx <= std::size(TmpResult) + 1) && "out-of-bound access");
580 
581   Value *Result;
582   if (!SimpVect.empty())
583     Result = createNaryFAdd(SimpVect, InstrQuota);
584   else {
585     // The addition is folded to 0.0.
586     Result = ConstantFP::get(Instr->getType(), 0.0);
587   }
588 
589   return Result;
590 }
591 
592 Value *FAddCombine::createNaryFAdd
593   (const AddendVect &Opnds, unsigned InstrQuota) {
594   assert(!Opnds.empty() && "Expect at least one addend");
595 
596   // Step 1: Check if the # of instructions needed exceeds the quota.
597 
598   unsigned InstrNeeded = calcInstrNumber(Opnds);
599   if (InstrNeeded > InstrQuota)
600     return nullptr;
601 
602   initCreateInstNum();
603 
604   // step 2: Emit the N-ary addition.
605   // Note that at most three instructions are involved in Fadd-InstCombine: the
606   // addition in question, and at most two neighboring instructions.
607   // The resulting optimized addition should have at least one less instruction
608   // than the original addition expression tree. This implies that the resulting
609   // N-ary addition has at most two instructions, and we don't need to worry
610   // about tree-height when constructing the N-ary addition.
611 
612   Value *LastVal = nullptr;
613   bool LastValNeedNeg = false;
614 
615   // Iterate the addends, creating fadd/fsub using adjacent two addends.
616   for (const FAddend *Opnd : Opnds) {
617     bool NeedNeg;
618     Value *V = createAddendVal(*Opnd, NeedNeg);
619     if (!LastVal) {
620       LastVal = V;
621       LastValNeedNeg = NeedNeg;
622       continue;
623     }
624 
625     if (LastValNeedNeg == NeedNeg) {
626       LastVal = createFAdd(LastVal, V);
627       continue;
628     }
629 
630     if (LastValNeedNeg)
631       LastVal = createFSub(V, LastVal);
632     else
633       LastVal = createFSub(LastVal, V);
634 
635     LastValNeedNeg = false;
636   }
637 
638   if (LastValNeedNeg) {
639     LastVal = createFNeg(LastVal);
640   }
641 
642 #ifndef NDEBUG
643   assert(CreateInstrNum == InstrNeeded &&
644          "Inconsistent in instruction numbers");
645 #endif
646 
647   return LastVal;
648 }
649 
650 Value *FAddCombine::createFSub(Value *Opnd0, Value *Opnd1) {
651   Value *V = Builder.CreateFSub(Opnd0, Opnd1);
652   if (Instruction *I = dyn_cast<Instruction>(V))
653     createInstPostProc(I);
654   return V;
655 }
656 
657 Value *FAddCombine::createFNeg(Value *V) {
658   Value *NewV = Builder.CreateFNeg(V);
659   if (Instruction *I = dyn_cast<Instruction>(NewV))
660     createInstPostProc(I, true); // fneg's don't receive instruction numbers.
661   return NewV;
662 }
663 
664 Value *FAddCombine::createFAdd(Value *Opnd0, Value *Opnd1) {
665   Value *V = Builder.CreateFAdd(Opnd0, Opnd1);
666   if (Instruction *I = dyn_cast<Instruction>(V))
667     createInstPostProc(I);
668   return V;
669 }
670 
671 Value *FAddCombine::createFMul(Value *Opnd0, Value *Opnd1) {
672   Value *V = Builder.CreateFMul(Opnd0, Opnd1);
673   if (Instruction *I = dyn_cast<Instruction>(V))
674     createInstPostProc(I);
675   return V;
676 }
677 
678 void FAddCombine::createInstPostProc(Instruction *NewInstr, bool NoNumber) {
679   NewInstr->setDebugLoc(Instr->getDebugLoc());
680 
681   // Keep track of the number of instruction created.
682   if (!NoNumber)
683     incCreateInstNum();
684 
685   // Propagate fast-math flags
686   NewInstr->setFastMathFlags(Instr->getFastMathFlags());
687 }
688 
689 // Return the number of instruction needed to emit the N-ary addition.
690 // NOTE: Keep this function in sync with createAddendVal().
691 unsigned FAddCombine::calcInstrNumber(const AddendVect &Opnds) {
692   unsigned OpndNum = Opnds.size();
693   unsigned InstrNeeded = OpndNum - 1;
694 
695   // Adjust the number of instructions needed to emit the N-ary add.
696   for (const FAddend *Opnd : Opnds) {
697     if (Opnd->isConstant())
698       continue;
699 
700     // The constant check above is really for a few special constant
701     // coefficients.
702     if (isa<UndefValue>(Opnd->getSymVal()))
703       continue;
704 
705     const FAddendCoef &CE = Opnd->getCoef();
706     // Let the addend be "c * x". If "c == +/-1", the value of the addend
707     // is immediately available; otherwise, it needs exactly one instruction
708     // to evaluate the value.
709     if (!CE.isMinusOne() && !CE.isOne())
710       InstrNeeded++;
711   }
712   return InstrNeeded;
713 }
714 
715 // Input Addend        Value           NeedNeg(output)
716 // ================================================================
717 // Constant C          C               false
718 // <+/-1, V>           V               coefficient is -1
719 // <2/-2, V>          "fadd V, V"      coefficient is -2
720 // <C, V>             "fmul V, C"      false
721 //
722 // NOTE: Keep this function in sync with FAddCombine::calcInstrNumber.
723 Value *FAddCombine::createAddendVal(const FAddend &Opnd, bool &NeedNeg) {
724   const FAddendCoef &Coeff = Opnd.getCoef();
725 
726   if (Opnd.isConstant()) {
727     NeedNeg = false;
728     return Coeff.getValue(Instr->getType());
729   }
730 
731   Value *OpndVal = Opnd.getSymVal();
732 
733   if (Coeff.isMinusOne() || Coeff.isOne()) {
734     NeedNeg = Coeff.isMinusOne();
735     return OpndVal;
736   }
737 
738   if (Coeff.isTwo() || Coeff.isMinusTwo()) {
739     NeedNeg = Coeff.isMinusTwo();
740     return createFAdd(OpndVal, OpndVal);
741   }
742 
743   NeedNeg = false;
744   return createFMul(OpndVal, Coeff.getValue(Instr->getType()));
745 }
746 
747 // Checks if any operand is negative and we can convert add to sub.
748 // This function checks for following negative patterns
749 //   ADD(XOR(OR(Z, NOT(C)), C)), 1) == NEG(AND(Z, C))
750 //   ADD(XOR(AND(Z, C), C), 1) == NEG(OR(Z, ~C))
751 //   XOR(AND(Z, C), (C + 1)) == NEG(OR(Z, ~C)) if C is even
752 static Value *checkForNegativeOperand(BinaryOperator &I,
753                                       InstCombiner::BuilderTy &Builder) {
754   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
755 
756   // This function creates 2 instructions to replace ADD, we need at least one
757   // of LHS or RHS to have one use to ensure benefit in transform.
758   if (!LHS->hasOneUse() && !RHS->hasOneUse())
759     return nullptr;
760 
761   Value *X = nullptr, *Y = nullptr, *Z = nullptr;
762   const APInt *C1 = nullptr, *C2 = nullptr;
763 
764   // if ONE is on other side, swap
765   if (match(RHS, m_Add(m_Value(X), m_One())))
766     std::swap(LHS, RHS);
767 
768   if (match(LHS, m_Add(m_Value(X), m_One()))) {
769     // if XOR on other side, swap
770     if (match(RHS, m_Xor(m_Value(Y), m_APInt(C1))))
771       std::swap(X, RHS);
772 
773     if (match(X, m_Xor(m_Value(Y), m_APInt(C1)))) {
774       // X = XOR(Y, C1), Y = OR(Z, C2), C2 = NOT(C1) ==> X == NOT(AND(Z, C1))
775       // ADD(ADD(X, 1), RHS) == ADD(X, ADD(RHS, 1)) == SUB(RHS, AND(Z, C1))
776       if (match(Y, m_Or(m_Value(Z), m_APInt(C2))) && (*C2 == ~(*C1))) {
777         Value *NewAnd = Builder.CreateAnd(Z, *C1);
778         return Builder.CreateSub(RHS, NewAnd, "sub");
779       } else if (match(Y, m_And(m_Value(Z), m_APInt(C2))) && (*C1 == *C2)) {
780         // X = XOR(Y, C1), Y = AND(Z, C2), C2 == C1 ==> X == NOT(OR(Z, ~C1))
781         // ADD(ADD(X, 1), RHS) == ADD(X, ADD(RHS, 1)) == SUB(RHS, OR(Z, ~C1))
782         Value *NewOr = Builder.CreateOr(Z, ~(*C1));
783         return Builder.CreateSub(RHS, NewOr, "sub");
784       }
785     }
786   }
787 
788   // Restore LHS and RHS
789   LHS = I.getOperand(0);
790   RHS = I.getOperand(1);
791 
792   // if XOR is on other side, swap
793   if (match(RHS, m_Xor(m_Value(Y), m_APInt(C1))))
794     std::swap(LHS, RHS);
795 
796   // C2 is ODD
797   // LHS = XOR(Y, C1), Y = AND(Z, C2), C1 == (C2 + 1) => LHS == NEG(OR(Z, ~C2))
798   // ADD(LHS, RHS) == SUB(RHS, OR(Z, ~C2))
799   if (match(LHS, m_Xor(m_Value(Y), m_APInt(C1))))
800     if (C1->countr_zero() == 0)
801       if (match(Y, m_And(m_Value(Z), m_APInt(C2))) && *C1 == (*C2 + 1)) {
802         Value *NewOr = Builder.CreateOr(Z, ~(*C2));
803         return Builder.CreateSub(RHS, NewOr, "sub");
804       }
805   return nullptr;
806 }
807 
808 /// Wrapping flags may allow combining constants separated by an extend.
809 static Instruction *foldNoWrapAdd(BinaryOperator &Add,
810                                   InstCombiner::BuilderTy &Builder) {
811   Value *Op0 = Add.getOperand(0), *Op1 = Add.getOperand(1);
812   Type *Ty = Add.getType();
813   Constant *Op1C;
814   if (!match(Op1, m_Constant(Op1C)))
815     return nullptr;
816 
817   // Try this match first because it results in an add in the narrow type.
818   // (zext (X +nuw C2)) + C1 --> zext (X + (C2 + trunc(C1)))
819   Value *X;
820   const APInt *C1, *C2;
821   if (match(Op1, m_APInt(C1)) &&
822       match(Op0, m_ZExt(m_NUWAddLike(m_Value(X), m_APInt(C2)))) &&
823       C1->isNegative() && C1->sge(-C2->sext(C1->getBitWidth()))) {
824     APInt NewC = *C2 + C1->trunc(C2->getBitWidth());
825     // If the smaller add will fold to zero, we don't need to check one use.
826     if (NewC.isZero())
827       return new ZExtInst(X, Ty);
828     // Otherwise only do this if the existing zero extend will be removed.
829     if (Op0->hasOneUse())
830       return new ZExtInst(
831           Builder.CreateNUWAdd(X, ConstantInt::get(X->getType(), NewC)), Ty);
832   }
833 
834   // More general combining of constants in the wide type.
835   // (sext (X +nsw NarrowC)) + C --> (sext X) + (sext(NarrowC) + C)
836   // or (zext nneg (X +nsw NarrowC)) + C --> (sext X) + (sext(NarrowC) + C)
837   Constant *NarrowC;
838   if (match(Op0, m_OneUse(m_SExtLike(
839                      m_NSWAddLike(m_Value(X), m_Constant(NarrowC)))))) {
840     Value *WideC = Builder.CreateSExt(NarrowC, Ty);
841     Value *NewC = Builder.CreateAdd(WideC, Op1C);
842     Value *WideX = Builder.CreateSExt(X, Ty);
843     return BinaryOperator::CreateAdd(WideX, NewC);
844   }
845   // (zext (X +nuw NarrowC)) + C --> (zext X) + (zext(NarrowC) + C)
846   if (match(Op0,
847             m_OneUse(m_ZExt(m_NUWAddLike(m_Value(X), m_Constant(NarrowC)))))) {
848     Value *WideC = Builder.CreateZExt(NarrowC, Ty);
849     Value *NewC = Builder.CreateAdd(WideC, Op1C);
850     Value *WideX = Builder.CreateZExt(X, Ty);
851     return BinaryOperator::CreateAdd(WideX, NewC);
852   }
853   return nullptr;
854 }
855 
856 Instruction *InstCombinerImpl::foldAddWithConstant(BinaryOperator &Add) {
857   Value *Op0 = Add.getOperand(0), *Op1 = Add.getOperand(1);
858   Type *Ty = Add.getType();
859   Constant *Op1C;
860   if (!match(Op1, m_ImmConstant(Op1C)))
861     return nullptr;
862 
863   if (Instruction *NV = foldBinOpIntoSelectOrPhi(Add))
864     return NV;
865 
866   Value *X;
867   Constant *Op00C;
868 
869   // add (sub C1, X), C2 --> sub (add C1, C2), X
870   if (match(Op0, m_Sub(m_Constant(Op00C), m_Value(X))))
871     return BinaryOperator::CreateSub(ConstantExpr::getAdd(Op00C, Op1C), X);
872 
873   Value *Y;
874 
875   // add (sub X, Y), -1 --> add (not Y), X
876   if (match(Op0, m_OneUse(m_Sub(m_Value(X), m_Value(Y)))) &&
877       match(Op1, m_AllOnes()))
878     return BinaryOperator::CreateAdd(Builder.CreateNot(Y), X);
879 
880   // zext(bool) + C -> bool ? C + 1 : C
881   if (match(Op0, m_ZExt(m_Value(X))) &&
882       X->getType()->getScalarSizeInBits() == 1)
883     return SelectInst::Create(X, InstCombiner::AddOne(Op1C), Op1);
884   // sext(bool) + C -> bool ? C - 1 : C
885   if (match(Op0, m_SExt(m_Value(X))) &&
886       X->getType()->getScalarSizeInBits() == 1)
887     return SelectInst::Create(X, InstCombiner::SubOne(Op1C), Op1);
888 
889   // ~X + C --> (C-1) - X
890   if (match(Op0, m_Not(m_Value(X)))) {
891     // ~X + C has NSW and (C-1) won't oveflow => (C-1)-X can have NSW
892     auto *COne = ConstantInt::get(Op1C->getType(), 1);
893     bool WillNotSOV = willNotOverflowSignedSub(Op1C, COne, Add);
894     BinaryOperator *Res =
895         BinaryOperator::CreateSub(ConstantExpr::getSub(Op1C, COne), X);
896     Res->setHasNoSignedWrap(Add.hasNoSignedWrap() && WillNotSOV);
897     return Res;
898   }
899 
900   // (iN X s>> (N - 1)) + 1 --> zext (X > -1)
901   const APInt *C;
902   unsigned BitWidth = Ty->getScalarSizeInBits();
903   if (match(Op0, m_OneUse(m_AShr(m_Value(X),
904                                  m_SpecificIntAllowPoison(BitWidth - 1)))) &&
905       match(Op1, m_One()))
906     return new ZExtInst(Builder.CreateIsNotNeg(X, "isnotneg"), Ty);
907 
908   if (!match(Op1, m_APInt(C)))
909     return nullptr;
910 
911   // (X | Op01C) + Op1C --> X + (Op01C + Op1C) iff the `or` is actually an `add`
912   Constant *Op01C;
913   if (match(Op0, m_DisjointOr(m_Value(X), m_ImmConstant(Op01C)))) {
914     BinaryOperator *NewAdd =
915         BinaryOperator::CreateAdd(X, ConstantExpr::getAdd(Op01C, Op1C));
916     NewAdd->setHasNoSignedWrap(Add.hasNoSignedWrap() &&
917                                willNotOverflowSignedAdd(Op01C, Op1C, Add));
918     NewAdd->setHasNoUnsignedWrap(Add.hasNoUnsignedWrap());
919     return NewAdd;
920   }
921 
922   // (X | C2) + C --> (X | C2) ^ C2 iff (C2 == -C)
923   const APInt *C2;
924   if (match(Op0, m_Or(m_Value(), m_APInt(C2))) && *C2 == -*C)
925     return BinaryOperator::CreateXor(Op0, ConstantInt::get(Add.getType(), *C2));
926 
927   if (C->isSignMask()) {
928     // If wrapping is not allowed, then the addition must set the sign bit:
929     // X + (signmask) --> X | signmask
930     if (Add.hasNoSignedWrap() || Add.hasNoUnsignedWrap())
931       return BinaryOperator::CreateOr(Op0, Op1);
932 
933     // If wrapping is allowed, then the addition flips the sign bit of LHS:
934     // X + (signmask) --> X ^ signmask
935     return BinaryOperator::CreateXor(Op0, Op1);
936   }
937 
938   // Is this add the last step in a convoluted sext?
939   // add(zext(xor i16 X, -32768), -32768) --> sext X
940   if (match(Op0, m_ZExt(m_Xor(m_Value(X), m_APInt(C2)))) &&
941       C2->isMinSignedValue() && C2->sext(Ty->getScalarSizeInBits()) == *C)
942     return CastInst::Create(Instruction::SExt, X, Ty);
943 
944   if (match(Op0, m_Xor(m_Value(X), m_APInt(C2)))) {
945     // (X ^ signmask) + C --> (X + (signmask ^ C))
946     if (C2->isSignMask())
947       return BinaryOperator::CreateAdd(X, ConstantInt::get(Ty, *C2 ^ *C));
948 
949     // If X has no high-bits set above an xor mask:
950     // add (xor X, LowMaskC), C --> sub (LowMaskC + C), X
951     if (C2->isMask()) {
952       KnownBits LHSKnown = computeKnownBits(X, 0, &Add);
953       if ((*C2 | LHSKnown.Zero).isAllOnes())
954         return BinaryOperator::CreateSub(ConstantInt::get(Ty, *C2 + *C), X);
955     }
956 
957     // Look for a math+logic pattern that corresponds to sext-in-register of a
958     // value with cleared high bits. Convert that into a pair of shifts:
959     // add (xor X, 0x80), 0xF..F80 --> (X << ShAmtC) >>s ShAmtC
960     // add (xor X, 0xF..F80), 0x80 --> (X << ShAmtC) >>s ShAmtC
961     if (Op0->hasOneUse() && *C2 == -(*C)) {
962       unsigned BitWidth = Ty->getScalarSizeInBits();
963       unsigned ShAmt = 0;
964       if (C->isPowerOf2())
965         ShAmt = BitWidth - C->logBase2() - 1;
966       else if (C2->isPowerOf2())
967         ShAmt = BitWidth - C2->logBase2() - 1;
968       if (ShAmt && MaskedValueIsZero(X, APInt::getHighBitsSet(BitWidth, ShAmt),
969                                      0, &Add)) {
970         Constant *ShAmtC = ConstantInt::get(Ty, ShAmt);
971         Value *NewShl = Builder.CreateShl(X, ShAmtC, "sext");
972         return BinaryOperator::CreateAShr(NewShl, ShAmtC);
973       }
974     }
975   }
976 
977   if (C->isOne() && Op0->hasOneUse()) {
978     // add (sext i1 X), 1 --> zext (not X)
979     // TODO: The smallest IR representation is (select X, 0, 1), and that would
980     // not require the one-use check. But we need to remove a transform in
981     // visitSelect and make sure that IR value tracking for select is equal or
982     // better than for these ops.
983     if (match(Op0, m_SExt(m_Value(X))) &&
984         X->getType()->getScalarSizeInBits() == 1)
985       return new ZExtInst(Builder.CreateNot(X), Ty);
986 
987     // Shifts and add used to flip and mask off the low bit:
988     // add (ashr (shl i32 X, 31), 31), 1 --> and (not X), 1
989     const APInt *C3;
990     if (match(Op0, m_AShr(m_Shl(m_Value(X), m_APInt(C2)), m_APInt(C3))) &&
991         C2 == C3 && *C2 == Ty->getScalarSizeInBits() - 1) {
992       Value *NotX = Builder.CreateNot(X);
993       return BinaryOperator::CreateAnd(NotX, ConstantInt::get(Ty, 1));
994     }
995   }
996 
997   // umax(X, C) + -C --> usub.sat(X, C)
998   if (match(Op0, m_OneUse(m_UMax(m_Value(X), m_SpecificInt(-*C)))))
999     return replaceInstUsesWith(
1000         Add, Builder.CreateBinaryIntrinsic(
1001                  Intrinsic::usub_sat, X, ConstantInt::get(Add.getType(), -*C)));
1002 
1003   // Fold (add (zext (add X, -1)), 1) -> (zext X) if X is non-zero.
1004   // TODO: There's a general form for any constant on the outer add.
1005   if (C->isOne()) {
1006     if (match(Op0, m_ZExt(m_Add(m_Value(X), m_AllOnes())))) {
1007       const SimplifyQuery Q = SQ.getWithInstruction(&Add);
1008       if (llvm::isKnownNonZero(X, Q))
1009         return new ZExtInst(X, Ty);
1010     }
1011   }
1012 
1013   return nullptr;
1014 }
1015 
1016 // match variations of a^2 + 2*a*b + b^2
1017 //
1018 // to reuse the code between the FP and Int versions, the instruction OpCodes
1019 //  and constant types have been turned into template parameters.
1020 //
1021 // Mul2Rhs: The constant to perform the multiplicative equivalent of X*2 with;
1022 //  should be `m_SpecificFP(2.0)` for FP and `m_SpecificInt(1)` for Int
1023 //  (we're matching `X<<1` instead of `X*2` for Int)
1024 template <bool FP, typename Mul2Rhs>
1025 static bool matchesSquareSum(BinaryOperator &I, Mul2Rhs M2Rhs, Value *&A,
1026                              Value *&B) {
1027   constexpr unsigned MulOp = FP ? Instruction::FMul : Instruction::Mul;
1028   constexpr unsigned AddOp = FP ? Instruction::FAdd : Instruction::Add;
1029   constexpr unsigned Mul2Op = FP ? Instruction::FMul : Instruction::Shl;
1030 
1031   // (a * a) + (((a * 2) + b) * b)
1032   if (match(&I, m_c_BinOp(
1033                     AddOp, m_OneUse(m_BinOp(MulOp, m_Value(A), m_Deferred(A))),
1034                     m_OneUse(m_c_BinOp(
1035                         MulOp,
1036                         m_c_BinOp(AddOp, m_BinOp(Mul2Op, m_Deferred(A), M2Rhs),
1037                                   m_Value(B)),
1038                         m_Deferred(B))))))
1039     return true;
1040 
1041   // ((a * b) * 2)  or ((a * 2) * b)
1042   // +
1043   // (a * a + b * b) or (b * b + a * a)
1044   return match(
1045       &I, m_c_BinOp(
1046               AddOp,
1047               m_CombineOr(
1048                   m_OneUse(m_BinOp(
1049                       Mul2Op, m_BinOp(MulOp, m_Value(A), m_Value(B)), M2Rhs)),
1050                   m_OneUse(m_c_BinOp(MulOp, m_BinOp(Mul2Op, m_Value(A), M2Rhs),
1051                                      m_Value(B)))),
1052               m_OneUse(
1053                   m_c_BinOp(AddOp, m_BinOp(MulOp, m_Deferred(A), m_Deferred(A)),
1054                             m_BinOp(MulOp, m_Deferred(B), m_Deferred(B))))));
1055 }
1056 
1057 // Fold integer variations of a^2 + 2*a*b + b^2 -> (a + b)^2
1058 Instruction *InstCombinerImpl::foldSquareSumInt(BinaryOperator &I) {
1059   Value *A, *B;
1060   if (matchesSquareSum</*FP*/ false>(I, m_SpecificInt(1), A, B)) {
1061     Value *AB = Builder.CreateAdd(A, B);
1062     return BinaryOperator::CreateMul(AB, AB);
1063   }
1064   return nullptr;
1065 }
1066 
1067 // Fold floating point variations of a^2 + 2*a*b + b^2 -> (a + b)^2
1068 // Requires `nsz` and `reassoc`.
1069 Instruction *InstCombinerImpl::foldSquareSumFP(BinaryOperator &I) {
1070   assert(I.hasAllowReassoc() && I.hasNoSignedZeros() && "Assumption mismatch");
1071   Value *A, *B;
1072   if (matchesSquareSum</*FP*/ true>(I, m_SpecificFP(2.0), A, B)) {
1073     Value *AB = Builder.CreateFAddFMF(A, B, &I);
1074     return BinaryOperator::CreateFMulFMF(AB, AB, &I);
1075   }
1076   return nullptr;
1077 }
1078 
1079 // Matches multiplication expression Op * C where C is a constant. Returns the
1080 // constant value in C and the other operand in Op. Returns true if such a
1081 // match is found.
1082 static bool MatchMul(Value *E, Value *&Op, APInt &C) {
1083   const APInt *AI;
1084   if (match(E, m_Mul(m_Value(Op), m_APInt(AI)))) {
1085     C = *AI;
1086     return true;
1087   }
1088   if (match(E, m_Shl(m_Value(Op), m_APInt(AI)))) {
1089     C = APInt(AI->getBitWidth(), 1);
1090     C <<= *AI;
1091     return true;
1092   }
1093   return false;
1094 }
1095 
1096 // Matches remainder expression Op % C where C is a constant. Returns the
1097 // constant value in C and the other operand in Op. Returns the signedness of
1098 // the remainder operation in IsSigned. Returns true if such a match is
1099 // found.
1100 static bool MatchRem(Value *E, Value *&Op, APInt &C, bool &IsSigned) {
1101   const APInt *AI;
1102   IsSigned = false;
1103   if (match(E, m_SRem(m_Value(Op), m_APInt(AI)))) {
1104     IsSigned = true;
1105     C = *AI;
1106     return true;
1107   }
1108   if (match(E, m_URem(m_Value(Op), m_APInt(AI)))) {
1109     C = *AI;
1110     return true;
1111   }
1112   if (match(E, m_And(m_Value(Op), m_APInt(AI))) && (*AI + 1).isPowerOf2()) {
1113     C = *AI + 1;
1114     return true;
1115   }
1116   return false;
1117 }
1118 
1119 // Matches division expression Op / C with the given signedness as indicated
1120 // by IsSigned, where C is a constant. Returns the constant value in C and the
1121 // other operand in Op. Returns true if such a match is found.
1122 static bool MatchDiv(Value *E, Value *&Op, APInt &C, bool IsSigned) {
1123   const APInt *AI;
1124   if (IsSigned && match(E, m_SDiv(m_Value(Op), m_APInt(AI)))) {
1125     C = *AI;
1126     return true;
1127   }
1128   if (!IsSigned) {
1129     if (match(E, m_UDiv(m_Value(Op), m_APInt(AI)))) {
1130       C = *AI;
1131       return true;
1132     }
1133     if (match(E, m_LShr(m_Value(Op), m_APInt(AI)))) {
1134       C = APInt(AI->getBitWidth(), 1);
1135       C <<= *AI;
1136       return true;
1137     }
1138   }
1139   return false;
1140 }
1141 
1142 // Returns whether C0 * C1 with the given signedness overflows.
1143 static bool MulWillOverflow(APInt &C0, APInt &C1, bool IsSigned) {
1144   bool overflow;
1145   if (IsSigned)
1146     (void)C0.smul_ov(C1, overflow);
1147   else
1148     (void)C0.umul_ov(C1, overflow);
1149   return overflow;
1150 }
1151 
1152 // Simplifies X % C0 + (( X / C0 ) % C1) * C0 to X % (C0 * C1), where (C0 * C1)
1153 // does not overflow.
1154 // Simplifies (X / C0) * C1 + (X % C0) * C2 to
1155 // (X / C0) * (C1 - C2 * C0) + X * C2
1156 Value *InstCombinerImpl::SimplifyAddWithRemainder(BinaryOperator &I) {
1157   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
1158   Value *X, *MulOpV;
1159   APInt C0, MulOpC;
1160   bool IsSigned;
1161   // Match I = X % C0 + MulOpV * C0
1162   if (((MatchRem(LHS, X, C0, IsSigned) && MatchMul(RHS, MulOpV, MulOpC)) ||
1163        (MatchRem(RHS, X, C0, IsSigned) && MatchMul(LHS, MulOpV, MulOpC))) &&
1164       C0 == MulOpC) {
1165     Value *RemOpV;
1166     APInt C1;
1167     bool Rem2IsSigned;
1168     // Match MulOpC = RemOpV % C1
1169     if (MatchRem(MulOpV, RemOpV, C1, Rem2IsSigned) &&
1170         IsSigned == Rem2IsSigned) {
1171       Value *DivOpV;
1172       APInt DivOpC;
1173       // Match RemOpV = X / C0
1174       if (MatchDiv(RemOpV, DivOpV, DivOpC, IsSigned) && X == DivOpV &&
1175           C0 == DivOpC && !MulWillOverflow(C0, C1, IsSigned)) {
1176         Value *NewDivisor = ConstantInt::get(X->getType(), C0 * C1);
1177         return IsSigned ? Builder.CreateSRem(X, NewDivisor, "srem")
1178                         : Builder.CreateURem(X, NewDivisor, "urem");
1179       }
1180     }
1181   }
1182 
1183   // Match I = (X / C0) * C1 + (X % C0) * C2
1184   Value *Div, *Rem;
1185   APInt C1, C2;
1186   if (!LHS->hasOneUse() || !MatchMul(LHS, Div, C1))
1187     Div = LHS, C1 = APInt(I.getType()->getScalarSizeInBits(), 1);
1188   if (!RHS->hasOneUse() || !MatchMul(RHS, Rem, C2))
1189     Rem = RHS, C2 = APInt(I.getType()->getScalarSizeInBits(), 1);
1190   if (match(Div, m_IRem(m_Value(), m_Value()))) {
1191     std::swap(Div, Rem);
1192     std::swap(C1, C2);
1193   }
1194   Value *DivOpV;
1195   APInt DivOpC;
1196   if (MatchRem(Rem, X, C0, IsSigned) &&
1197       MatchDiv(Div, DivOpV, DivOpC, IsSigned) && X == DivOpV && C0 == DivOpC) {
1198     APInt NewC = C1 - C2 * C0;
1199     if (!NewC.isZero() && !Rem->hasOneUse())
1200       return nullptr;
1201     if (!isGuaranteedNotToBeUndef(X, &AC, &I, &DT))
1202       return nullptr;
1203     Value *MulXC2 = Builder.CreateMul(X, ConstantInt::get(X->getType(), C2));
1204     if (NewC.isZero())
1205       return MulXC2;
1206     return Builder.CreateAdd(
1207         Builder.CreateMul(Div, ConstantInt::get(X->getType(), NewC)), MulXC2);
1208   }
1209 
1210   return nullptr;
1211 }
1212 
1213 /// Fold
1214 ///   (1 << NBits) - 1
1215 /// Into:
1216 ///   ~(-(1 << NBits))
1217 /// Because a 'not' is better for bit-tracking analysis and other transforms
1218 /// than an 'add'. The new shl is always nsw, and is nuw if old `and` was.
1219 static Instruction *canonicalizeLowbitMask(BinaryOperator &I,
1220                                            InstCombiner::BuilderTy &Builder) {
1221   Value *NBits;
1222   if (!match(&I, m_Add(m_OneUse(m_Shl(m_One(), m_Value(NBits))), m_AllOnes())))
1223     return nullptr;
1224 
1225   Constant *MinusOne = Constant::getAllOnesValue(NBits->getType());
1226   Value *NotMask = Builder.CreateShl(MinusOne, NBits, "notmask");
1227   // Be wary of constant folding.
1228   if (auto *BOp = dyn_cast<BinaryOperator>(NotMask)) {
1229     // Always NSW. But NUW propagates from `add`.
1230     BOp->setHasNoSignedWrap();
1231     BOp->setHasNoUnsignedWrap(I.hasNoUnsignedWrap());
1232   }
1233 
1234   return BinaryOperator::CreateNot(NotMask, I.getName());
1235 }
1236 
1237 static Instruction *foldToUnsignedSaturatedAdd(BinaryOperator &I) {
1238   assert(I.getOpcode() == Instruction::Add && "Expecting add instruction");
1239   Type *Ty = I.getType();
1240   auto getUAddSat = [&]() {
1241     return Intrinsic::getOrInsertDeclaration(I.getModule(), Intrinsic::uadd_sat,
1242                                              Ty);
1243   };
1244 
1245   // add (umin X, ~Y), Y --> uaddsat X, Y
1246   Value *X, *Y;
1247   if (match(&I, m_c_Add(m_c_UMin(m_Value(X), m_Not(m_Value(Y))),
1248                         m_Deferred(Y))))
1249     return CallInst::Create(getUAddSat(), { X, Y });
1250 
1251   // add (umin X, ~C), C --> uaddsat X, C
1252   const APInt *C, *NotC;
1253   if (match(&I, m_Add(m_UMin(m_Value(X), m_APInt(NotC)), m_APInt(C))) &&
1254       *C == ~*NotC)
1255     return CallInst::Create(getUAddSat(), { X, ConstantInt::get(Ty, *C) });
1256 
1257   return nullptr;
1258 }
1259 
1260 // Transform:
1261 //  (add A, (shl (neg B), Y))
1262 //      -> (sub A, (shl B, Y))
1263 static Instruction *combineAddSubWithShlAddSub(InstCombiner::BuilderTy &Builder,
1264                                                const BinaryOperator &I) {
1265   Value *A, *B, *Cnt;
1266   if (match(&I,
1267             m_c_Add(m_OneUse(m_Shl(m_OneUse(m_Neg(m_Value(B))), m_Value(Cnt))),
1268                     m_Value(A)))) {
1269     Value *NewShl = Builder.CreateShl(B, Cnt);
1270     return BinaryOperator::CreateSub(A, NewShl);
1271   }
1272   return nullptr;
1273 }
1274 
1275 /// Try to reduce signed division by power-of-2 to an arithmetic shift right.
1276 static Instruction *foldAddToAshr(BinaryOperator &Add) {
1277   // Division must be by power-of-2, but not the minimum signed value.
1278   Value *X;
1279   const APInt *DivC;
1280   if (!match(Add.getOperand(0), m_SDiv(m_Value(X), m_Power2(DivC))) ||
1281       DivC->isNegative())
1282     return nullptr;
1283 
1284   // Rounding is done by adding -1 if the dividend (X) is negative and has any
1285   // low bits set. It recognizes two canonical patterns:
1286   // 1. For an 'ugt' cmp with the signed minimum value (SMIN), the
1287   //    pattern is: sext (icmp ugt (X & (DivC - 1)), SMIN).
1288   // 2. For an 'eq' cmp, the pattern's: sext (icmp eq X & (SMIN + 1), SMIN + 1).
1289   // Note that, by the time we end up here, if possible, ugt has been
1290   // canonicalized into eq.
1291   const APInt *MaskC, *MaskCCmp;
1292   ICmpInst::Predicate Pred;
1293   if (!match(Add.getOperand(1),
1294              m_SExt(m_ICmp(Pred, m_And(m_Specific(X), m_APInt(MaskC)),
1295                            m_APInt(MaskCCmp)))))
1296     return nullptr;
1297 
1298   if ((Pred != ICmpInst::ICMP_UGT || !MaskCCmp->isSignMask()) &&
1299       (Pred != ICmpInst::ICMP_EQ || *MaskCCmp != *MaskC))
1300     return nullptr;
1301 
1302   APInt SMin = APInt::getSignedMinValue(Add.getType()->getScalarSizeInBits());
1303   bool IsMaskValid = Pred == ICmpInst::ICMP_UGT
1304                          ? (*MaskC == (SMin | (*DivC - 1)))
1305                          : (*DivC == 2 && *MaskC == SMin + 1);
1306   if (!IsMaskValid)
1307     return nullptr;
1308 
1309   // (X / DivC) + sext ((X & (SMin | (DivC - 1)) >u SMin) --> X >>s log2(DivC)
1310   return BinaryOperator::CreateAShr(
1311       X, ConstantInt::get(Add.getType(), DivC->exactLogBase2()));
1312 }
1313 
1314 Instruction *InstCombinerImpl::foldAddLikeCommutative(Value *LHS, Value *RHS,
1315                                                       bool NSW, bool NUW) {
1316   Value *A, *B, *C;
1317   if (match(LHS, m_Sub(m_Value(A), m_Value(B))) &&
1318       match(RHS, m_Sub(m_Value(C), m_Specific(A)))) {
1319     Instruction *R = BinaryOperator::CreateSub(C, B);
1320     bool NSWOut = NSW && match(LHS, m_NSWSub(m_Value(), m_Value())) &&
1321                   match(RHS, m_NSWSub(m_Value(), m_Value()));
1322 
1323     bool NUWOut = match(LHS, m_NUWSub(m_Value(), m_Value())) &&
1324                   match(RHS, m_NUWSub(m_Value(), m_Value()));
1325     R->setHasNoSignedWrap(NSWOut);
1326     R->setHasNoUnsignedWrap(NUWOut);
1327     return R;
1328   }
1329   return nullptr;
1330 }
1331 
1332 Instruction *InstCombinerImpl::
1333     canonicalizeCondSignextOfHighBitExtractToSignextHighBitExtract(
1334         BinaryOperator &I) {
1335   assert((I.getOpcode() == Instruction::Add ||
1336           I.getOpcode() == Instruction::Or ||
1337           I.getOpcode() == Instruction::Sub) &&
1338          "Expecting add/or/sub instruction");
1339 
1340   // We have a subtraction/addition between a (potentially truncated) *logical*
1341   // right-shift of X and a "select".
1342   Value *X, *Select;
1343   Instruction *LowBitsToSkip, *Extract;
1344   if (!match(&I, m_c_BinOp(m_TruncOrSelf(m_CombineAnd(
1345                                m_LShr(m_Value(X), m_Instruction(LowBitsToSkip)),
1346                                m_Instruction(Extract))),
1347                            m_Value(Select))))
1348     return nullptr;
1349 
1350   // `add`/`or` is commutative; but for `sub`, "select" *must* be on RHS.
1351   if (I.getOpcode() == Instruction::Sub && I.getOperand(1) != Select)
1352     return nullptr;
1353 
1354   Type *XTy = X->getType();
1355   bool HadTrunc = I.getType() != XTy;
1356 
1357   // If there was a truncation of extracted value, then we'll need to produce
1358   // one extra instruction, so we need to ensure one instruction will go away.
1359   if (HadTrunc && !match(&I, m_c_BinOp(m_OneUse(m_Value()), m_Value())))
1360     return nullptr;
1361 
1362   // Extraction should extract high NBits bits, with shift amount calculated as:
1363   //   low bits to skip = shift bitwidth - high bits to extract
1364   // The shift amount itself may be extended, and we need to look past zero-ext
1365   // when matching NBits, that will matter for matching later.
1366   Value *NBits;
1367   if (!match(LowBitsToSkip,
1368              m_ZExtOrSelf(m_Sub(m_SpecificInt(XTy->getScalarSizeInBits()),
1369                                 m_ZExtOrSelf(m_Value(NBits))))))
1370     return nullptr;
1371 
1372   // Sign-extending value can be zero-extended if we `sub`tract it,
1373   // or sign-extended otherwise.
1374   auto SkipExtInMagic = [&I](Value *&V) {
1375     if (I.getOpcode() == Instruction::Sub)
1376       match(V, m_ZExtOrSelf(m_Value(V)));
1377     else
1378       match(V, m_SExtOrSelf(m_Value(V)));
1379   };
1380 
1381   // Now, finally validate the sign-extending magic.
1382   // `select` itself may be appropriately extended, look past that.
1383   SkipExtInMagic(Select);
1384 
1385   ICmpInst::Predicate Pred;
1386   const APInt *Thr;
1387   Value *SignExtendingValue, *Zero;
1388   bool ShouldSignext;
1389   // It must be a select between two values we will later establish to be a
1390   // sign-extending value and a zero constant. The condition guarding the
1391   // sign-extension must be based on a sign bit of the same X we had in `lshr`.
1392   if (!match(Select, m_Select(m_ICmp(Pred, m_Specific(X), m_APInt(Thr)),
1393                               m_Value(SignExtendingValue), m_Value(Zero))) ||
1394       !isSignBitCheck(Pred, *Thr, ShouldSignext))
1395     return nullptr;
1396 
1397   // icmp-select pair is commutative.
1398   if (!ShouldSignext)
1399     std::swap(SignExtendingValue, Zero);
1400 
1401   // If we should not perform sign-extension then we must add/or/subtract zero.
1402   if (!match(Zero, m_Zero()))
1403     return nullptr;
1404   // Otherwise, it should be some constant, left-shifted by the same NBits we
1405   // had in `lshr`. Said left-shift can also be appropriately extended.
1406   // Again, we must look past zero-ext when looking for NBits.
1407   SkipExtInMagic(SignExtendingValue);
1408   Constant *SignExtendingValueBaseConstant;
1409   if (!match(SignExtendingValue,
1410              m_Shl(m_Constant(SignExtendingValueBaseConstant),
1411                    m_ZExtOrSelf(m_Specific(NBits)))))
1412     return nullptr;
1413   // If we `sub`, then the constant should be one, else it should be all-ones.
1414   if (I.getOpcode() == Instruction::Sub
1415           ? !match(SignExtendingValueBaseConstant, m_One())
1416           : !match(SignExtendingValueBaseConstant, m_AllOnes()))
1417     return nullptr;
1418 
1419   auto *NewAShr = BinaryOperator::CreateAShr(X, LowBitsToSkip,
1420                                              Extract->getName() + ".sext");
1421   NewAShr->copyIRFlags(Extract); // Preserve `exact`-ness.
1422   if (!HadTrunc)
1423     return NewAShr;
1424 
1425   Builder.Insert(NewAShr);
1426   return TruncInst::CreateTruncOrBitCast(NewAShr, I.getType());
1427 }
1428 
1429 /// This is a specialization of a more general transform from
1430 /// foldUsingDistributiveLaws. If that code can be made to work optimally
1431 /// for multi-use cases or propagating nsw/nuw, then we would not need this.
1432 static Instruction *factorizeMathWithShlOps(BinaryOperator &I,
1433                                             InstCombiner::BuilderTy &Builder) {
1434   // TODO: Also handle mul by doubling the shift amount?
1435   assert((I.getOpcode() == Instruction::Add ||
1436           I.getOpcode() == Instruction::Sub) &&
1437          "Expected add/sub");
1438   auto *Op0 = dyn_cast<BinaryOperator>(I.getOperand(0));
1439   auto *Op1 = dyn_cast<BinaryOperator>(I.getOperand(1));
1440   if (!Op0 || !Op1 || !(Op0->hasOneUse() || Op1->hasOneUse()))
1441     return nullptr;
1442 
1443   Value *X, *Y, *ShAmt;
1444   if (!match(Op0, m_Shl(m_Value(X), m_Value(ShAmt))) ||
1445       !match(Op1, m_Shl(m_Value(Y), m_Specific(ShAmt))))
1446     return nullptr;
1447 
1448   // No-wrap propagates only when all ops have no-wrap.
1449   bool HasNSW = I.hasNoSignedWrap() && Op0->hasNoSignedWrap() &&
1450                 Op1->hasNoSignedWrap();
1451   bool HasNUW = I.hasNoUnsignedWrap() && Op0->hasNoUnsignedWrap() &&
1452                 Op1->hasNoUnsignedWrap();
1453 
1454   // add/sub (X << ShAmt), (Y << ShAmt) --> (add/sub X, Y) << ShAmt
1455   Value *NewMath = Builder.CreateBinOp(I.getOpcode(), X, Y);
1456   if (auto *NewI = dyn_cast<BinaryOperator>(NewMath)) {
1457     NewI->setHasNoSignedWrap(HasNSW);
1458     NewI->setHasNoUnsignedWrap(HasNUW);
1459   }
1460   auto *NewShl = BinaryOperator::CreateShl(NewMath, ShAmt);
1461   NewShl->setHasNoSignedWrap(HasNSW);
1462   NewShl->setHasNoUnsignedWrap(HasNUW);
1463   return NewShl;
1464 }
1465 
1466 /// Reduce a sequence of masked half-width multiplies to a single multiply.
1467 /// ((XLow * YHigh) + (YLow * XHigh)) << HalfBits) + (XLow * YLow) --> X * Y
1468 static Instruction *foldBoxMultiply(BinaryOperator &I) {
1469   unsigned BitWidth = I.getType()->getScalarSizeInBits();
1470   // Skip the odd bitwidth types.
1471   if ((BitWidth & 0x1))
1472     return nullptr;
1473 
1474   unsigned HalfBits = BitWidth >> 1;
1475   APInt HalfMask = APInt::getMaxValue(HalfBits);
1476 
1477   // ResLo = (CrossSum << HalfBits) + (YLo * XLo)
1478   Value *XLo, *YLo;
1479   Value *CrossSum;
1480   // Require one-use on the multiply to avoid increasing the number of
1481   // multiplications.
1482   if (!match(&I, m_c_Add(m_Shl(m_Value(CrossSum), m_SpecificInt(HalfBits)),
1483                          m_OneUse(m_Mul(m_Value(YLo), m_Value(XLo))))))
1484     return nullptr;
1485 
1486   // XLo = X & HalfMask
1487   // YLo = Y & HalfMask
1488   // TODO: Refactor with SimplifyDemandedBits or KnownBits known leading zeros
1489   // to enhance robustness
1490   Value *X, *Y;
1491   if (!match(XLo, m_And(m_Value(X), m_SpecificInt(HalfMask))) ||
1492       !match(YLo, m_And(m_Value(Y), m_SpecificInt(HalfMask))))
1493     return nullptr;
1494 
1495   // CrossSum = (X' * (Y >> Halfbits)) + (Y' * (X >> HalfBits))
1496   // X' can be either X or XLo in the pattern (and the same for Y')
1497   if (match(CrossSum,
1498             m_c_Add(m_c_Mul(m_LShr(m_Specific(Y), m_SpecificInt(HalfBits)),
1499                             m_CombineOr(m_Specific(X), m_Specific(XLo))),
1500                     m_c_Mul(m_LShr(m_Specific(X), m_SpecificInt(HalfBits)),
1501                             m_CombineOr(m_Specific(Y), m_Specific(YLo))))))
1502     return BinaryOperator::CreateMul(X, Y);
1503 
1504   return nullptr;
1505 }
1506 
1507 Instruction *InstCombinerImpl::visitAdd(BinaryOperator &I) {
1508   if (Value *V = simplifyAddInst(I.getOperand(0), I.getOperand(1),
1509                                  I.hasNoSignedWrap(), I.hasNoUnsignedWrap(),
1510                                  SQ.getWithInstruction(&I)))
1511     return replaceInstUsesWith(I, V);
1512 
1513   if (SimplifyAssociativeOrCommutative(I))
1514     return &I;
1515 
1516   if (Instruction *X = foldVectorBinop(I))
1517     return X;
1518 
1519   if (Instruction *Phi = foldBinopWithPhiOperands(I))
1520     return Phi;
1521 
1522   // (A*B)+(A*C) -> A*(B+C) etc
1523   if (Value *V = foldUsingDistributiveLaws(I))
1524     return replaceInstUsesWith(I, V);
1525 
1526   if (Instruction *R = foldBoxMultiply(I))
1527     return R;
1528 
1529   if (Instruction *R = factorizeMathWithShlOps(I, Builder))
1530     return R;
1531 
1532   if (Instruction *X = foldAddWithConstant(I))
1533     return X;
1534 
1535   if (Instruction *X = foldNoWrapAdd(I, Builder))
1536     return X;
1537 
1538   if (Instruction *R = foldBinOpShiftWithShift(I))
1539     return R;
1540 
1541   if (Instruction *R = combineAddSubWithShlAddSub(Builder, I))
1542     return R;
1543 
1544   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
1545   if (Instruction *R = foldAddLikeCommutative(LHS, RHS, I.hasNoSignedWrap(),
1546                                               I.hasNoUnsignedWrap()))
1547     return R;
1548   if (Instruction *R = foldAddLikeCommutative(RHS, LHS, I.hasNoSignedWrap(),
1549                                               I.hasNoUnsignedWrap()))
1550     return R;
1551   Type *Ty = I.getType();
1552   if (Ty->isIntOrIntVectorTy(1))
1553     return BinaryOperator::CreateXor(LHS, RHS);
1554 
1555   // X + X --> X << 1
1556   if (LHS == RHS) {
1557     auto *Shl = BinaryOperator::CreateShl(LHS, ConstantInt::get(Ty, 1));
1558     Shl->setHasNoSignedWrap(I.hasNoSignedWrap());
1559     Shl->setHasNoUnsignedWrap(I.hasNoUnsignedWrap());
1560     return Shl;
1561   }
1562 
1563   Value *A, *B;
1564   if (match(LHS, m_Neg(m_Value(A)))) {
1565     // -A + -B --> -(A + B)
1566     if (match(RHS, m_Neg(m_Value(B))))
1567       return BinaryOperator::CreateNeg(Builder.CreateAdd(A, B));
1568 
1569     // -A + B --> B - A
1570     auto *Sub = BinaryOperator::CreateSub(RHS, A);
1571     auto *OB0 = cast<OverflowingBinaryOperator>(LHS);
1572     Sub->setHasNoSignedWrap(I.hasNoSignedWrap() && OB0->hasNoSignedWrap());
1573 
1574     return Sub;
1575   }
1576 
1577   // A + -B  -->  A - B
1578   if (match(RHS, m_Neg(m_Value(B)))) {
1579     auto *Sub = BinaryOperator::CreateSub(LHS, B);
1580     auto *OBO = cast<OverflowingBinaryOperator>(RHS);
1581     Sub->setHasNoSignedWrap(I.hasNoSignedWrap() && OBO->hasNoSignedWrap());
1582     return Sub;
1583   }
1584 
1585   if (Value *V = checkForNegativeOperand(I, Builder))
1586     return replaceInstUsesWith(I, V);
1587 
1588   // (A + 1) + ~B --> A - B
1589   // ~B + (A + 1) --> A - B
1590   // (~B + A) + 1 --> A - B
1591   // (A + ~B) + 1 --> A - B
1592   if (match(&I, m_c_BinOp(m_Add(m_Value(A), m_One()), m_Not(m_Value(B)))) ||
1593       match(&I, m_BinOp(m_c_Add(m_Not(m_Value(B)), m_Value(A)), m_One())))
1594     return BinaryOperator::CreateSub(A, B);
1595 
1596   // (A + RHS) + RHS --> A + (RHS << 1)
1597   if (match(LHS, m_OneUse(m_c_Add(m_Value(A), m_Specific(RHS)))))
1598     return BinaryOperator::CreateAdd(A, Builder.CreateShl(RHS, 1, "reass.add"));
1599 
1600   // LHS + (A + LHS) --> A + (LHS << 1)
1601   if (match(RHS, m_OneUse(m_c_Add(m_Value(A), m_Specific(LHS)))))
1602     return BinaryOperator::CreateAdd(A, Builder.CreateShl(LHS, 1, "reass.add"));
1603 
1604   {
1605     // (A + C1) + (C2 - B) --> (A - B) + (C1 + C2)
1606     Constant *C1, *C2;
1607     if (match(&I, m_c_Add(m_Add(m_Value(A), m_ImmConstant(C1)),
1608                           m_Sub(m_ImmConstant(C2), m_Value(B)))) &&
1609         (LHS->hasOneUse() || RHS->hasOneUse())) {
1610       Value *Sub = Builder.CreateSub(A, B);
1611       return BinaryOperator::CreateAdd(Sub, ConstantExpr::getAdd(C1, C2));
1612     }
1613 
1614     // Canonicalize a constant sub operand as an add operand for better folding:
1615     // (C1 - A) + B --> (B - A) + C1
1616     if (match(&I, m_c_Add(m_OneUse(m_Sub(m_ImmConstant(C1), m_Value(A))),
1617                           m_Value(B)))) {
1618       Value *Sub = Builder.CreateSub(B, A, "reass.sub");
1619       return BinaryOperator::CreateAdd(Sub, C1);
1620     }
1621   }
1622 
1623   // X % C0 + (( X / C0 ) % C1) * C0 => X % (C0 * C1)
1624   if (Value *V = SimplifyAddWithRemainder(I)) return replaceInstUsesWith(I, V);
1625 
1626   // ((X s/ C1) << C2) + X => X s% -C1 where -C1 is 1 << C2
1627   const APInt *C1, *C2;
1628   if (match(LHS, m_Shl(m_SDiv(m_Specific(RHS), m_APInt(C1)), m_APInt(C2)))) {
1629     APInt one(C2->getBitWidth(), 1);
1630     APInt minusC1 = -(*C1);
1631     if (minusC1 == (one << *C2)) {
1632       Constant *NewRHS = ConstantInt::get(RHS->getType(), minusC1);
1633       return BinaryOperator::CreateSRem(RHS, NewRHS);
1634     }
1635   }
1636 
1637   // (A & 2^C1) + A => A & (2^C1 - 1) iff bit C1 in A is a sign bit
1638   if (match(&I, m_c_Add(m_And(m_Value(A), m_APInt(C1)), m_Deferred(A))) &&
1639       C1->isPowerOf2() && (ComputeNumSignBits(A) > C1->countl_zero())) {
1640     Constant *NewMask = ConstantInt::get(RHS->getType(), *C1 - 1);
1641     return BinaryOperator::CreateAnd(A, NewMask);
1642   }
1643 
1644   // ZExt (B - A) + ZExt(A) --> ZExt(B)
1645   if ((match(RHS, m_ZExt(m_Value(A))) &&
1646        match(LHS, m_ZExt(m_NUWSub(m_Value(B), m_Specific(A))))) ||
1647       (match(LHS, m_ZExt(m_Value(A))) &&
1648        match(RHS, m_ZExt(m_NUWSub(m_Value(B), m_Specific(A))))))
1649     return new ZExtInst(B, LHS->getType());
1650 
1651   // zext(A) + sext(A) --> 0 if A is i1
1652   if (match(&I, m_c_BinOp(m_ZExt(m_Value(A)), m_SExt(m_Deferred(A)))) &&
1653       A->getType()->isIntOrIntVectorTy(1))
1654     return replaceInstUsesWith(I, Constant::getNullValue(I.getType()));
1655 
1656   // sext(A < B) + zext(A > B) => ucmp/scmp(A, B)
1657   ICmpInst::Predicate LTPred, GTPred;
1658   if (match(&I,
1659             m_c_Add(m_SExt(m_c_ICmp(LTPred, m_Value(A), m_Value(B))),
1660                     m_ZExt(m_c_ICmp(GTPred, m_Deferred(A), m_Deferred(B))))) &&
1661       A->getType()->isIntOrIntVectorTy()) {
1662     if (ICmpInst::isGT(LTPred)) {
1663       std::swap(LTPred, GTPred);
1664       std::swap(A, B);
1665     }
1666 
1667     if (ICmpInst::isLT(LTPred) && ICmpInst::isGT(GTPred) &&
1668         ICmpInst::isSigned(LTPred) == ICmpInst::isSigned(GTPred))
1669       return replaceInstUsesWith(
1670           I, Builder.CreateIntrinsic(
1671                  Ty,
1672                  ICmpInst::isSigned(LTPred) ? Intrinsic::scmp : Intrinsic::ucmp,
1673                  {A, B}));
1674   }
1675 
1676   // A+B --> A|B iff A and B have no bits set in common.
1677   WithCache<const Value *> LHSCache(LHS), RHSCache(RHS);
1678   if (haveNoCommonBitsSet(LHSCache, RHSCache, SQ.getWithInstruction(&I)))
1679     return BinaryOperator::CreateDisjointOr(LHS, RHS);
1680 
1681   if (Instruction *Ext = narrowMathIfNoOverflow(I))
1682     return Ext;
1683 
1684   // (add (xor A, B) (and A, B)) --> (or A, B)
1685   // (add (and A, B) (xor A, B)) --> (or A, B)
1686   if (match(&I, m_c_BinOp(m_Xor(m_Value(A), m_Value(B)),
1687                           m_c_And(m_Deferred(A), m_Deferred(B)))))
1688     return BinaryOperator::CreateOr(A, B);
1689 
1690   // (add (or A, B) (and A, B)) --> (add A, B)
1691   // (add (and A, B) (or A, B)) --> (add A, B)
1692   if (match(&I, m_c_BinOp(m_Or(m_Value(A), m_Value(B)),
1693                           m_c_And(m_Deferred(A), m_Deferred(B))))) {
1694     // Replacing operands in-place to preserve nuw/nsw flags.
1695     replaceOperand(I, 0, A);
1696     replaceOperand(I, 1, B);
1697     return &I;
1698   }
1699 
1700   // (add A (or A, -A)) --> (and (add A, -1) A)
1701   // (add A (or -A, A)) --> (and (add A, -1) A)
1702   // (add (or A, -A) A) --> (and (add A, -1) A)
1703   // (add (or -A, A) A) --> (and (add A, -1) A)
1704   if (match(&I, m_c_BinOp(m_Value(A), m_OneUse(m_c_Or(m_Neg(m_Deferred(A)),
1705                                                       m_Deferred(A)))))) {
1706     Value *Add =
1707         Builder.CreateAdd(A, Constant::getAllOnesValue(A->getType()), "",
1708                           I.hasNoUnsignedWrap(), I.hasNoSignedWrap());
1709     return BinaryOperator::CreateAnd(Add, A);
1710   }
1711 
1712   // Canonicalize ((A & -A) - 1) --> ((A - 1) & ~A)
1713   // Forms all commutable operations, and simplifies ctpop -> cttz folds.
1714   if (match(&I,
1715             m_Add(m_OneUse(m_c_And(m_Value(A), m_OneUse(m_Neg(m_Deferred(A))))),
1716                   m_AllOnes()))) {
1717     Constant *AllOnes = ConstantInt::getAllOnesValue(RHS->getType());
1718     Value *Dec = Builder.CreateAdd(A, AllOnes);
1719     Value *Not = Builder.CreateXor(A, AllOnes);
1720     return BinaryOperator::CreateAnd(Dec, Not);
1721   }
1722 
1723   // Disguised reassociation/factorization:
1724   // ~(A * C1) + A
1725   // ((A * -C1) - 1) + A
1726   // ((A * -C1) + A) - 1
1727   // (A * (1 - C1)) - 1
1728   if (match(&I,
1729             m_c_Add(m_OneUse(m_Not(m_OneUse(m_Mul(m_Value(A), m_APInt(C1))))),
1730                     m_Deferred(A)))) {
1731     Type *Ty = I.getType();
1732     Constant *NewMulC = ConstantInt::get(Ty, 1 - *C1);
1733     Value *NewMul = Builder.CreateMul(A, NewMulC);
1734     return BinaryOperator::CreateAdd(NewMul, ConstantInt::getAllOnesValue(Ty));
1735   }
1736 
1737   // (A * -2**C) + B --> B - (A << C)
1738   const APInt *NegPow2C;
1739   if (match(&I, m_c_Add(m_OneUse(m_Mul(m_Value(A), m_NegatedPower2(NegPow2C))),
1740                         m_Value(B)))) {
1741     Constant *ShiftAmtC = ConstantInt::get(Ty, NegPow2C->countr_zero());
1742     Value *Shl = Builder.CreateShl(A, ShiftAmtC);
1743     return BinaryOperator::CreateSub(B, Shl);
1744   }
1745 
1746   // Canonicalize signum variant that ends in add:
1747   // (A s>> (BW - 1)) + (zext (A s> 0)) --> (A s>> (BW - 1)) | (zext (A != 0))
1748   uint64_t BitWidth = Ty->getScalarSizeInBits();
1749   if (match(LHS, m_AShr(m_Value(A), m_SpecificIntAllowPoison(BitWidth - 1))) &&
1750       match(RHS, m_OneUse(m_ZExt(m_OneUse(m_SpecificICmp(
1751                      CmpInst::ICMP_SGT, m_Specific(A), m_ZeroInt())))))) {
1752     Value *NotZero = Builder.CreateIsNotNull(A, "isnotnull");
1753     Value *Zext = Builder.CreateZExt(NotZero, Ty, "isnotnull.zext");
1754     return BinaryOperator::CreateOr(LHS, Zext);
1755   }
1756 
1757   {
1758     Value *Cond, *Ext;
1759     Constant *C;
1760     // (add X, (sext/zext (icmp eq X, C)))
1761     //    -> (select (icmp eq X, C), (add C, (sext/zext 1)), X)
1762     auto CondMatcher = m_CombineAnd(
1763         m_Value(Cond),
1764         m_SpecificICmp(ICmpInst::ICMP_EQ, m_Deferred(A), m_ImmConstant(C)));
1765 
1766     if (match(&I,
1767               m_c_Add(m_Value(A),
1768                       m_CombineAnd(m_Value(Ext), m_ZExtOrSExt(CondMatcher)))) &&
1769         Ext->hasOneUse()) {
1770       Value *Add = isa<ZExtInst>(Ext) ? InstCombiner::AddOne(C)
1771                                       : InstCombiner::SubOne(C);
1772       return replaceInstUsesWith(I, Builder.CreateSelect(Cond, Add, A));
1773     }
1774   }
1775 
1776   if (Instruction *Ashr = foldAddToAshr(I))
1777     return Ashr;
1778 
1779   // (~X) + (~Y) --> -2 - (X + Y)
1780   {
1781     // To ensure we can save instructions we need to ensure that we consume both
1782     // LHS/RHS (i.e they have a `not`).
1783     bool ConsumesLHS, ConsumesRHS;
1784     if (isFreeToInvert(LHS, LHS->hasOneUse(), ConsumesLHS) && ConsumesLHS &&
1785         isFreeToInvert(RHS, RHS->hasOneUse(), ConsumesRHS) && ConsumesRHS) {
1786       Value *NotLHS = getFreelyInverted(LHS, LHS->hasOneUse(), &Builder);
1787       Value *NotRHS = getFreelyInverted(RHS, RHS->hasOneUse(), &Builder);
1788       assert(NotLHS != nullptr && NotRHS != nullptr &&
1789              "isFreeToInvert desynced with getFreelyInverted");
1790       Value *LHSPlusRHS = Builder.CreateAdd(NotLHS, NotRHS);
1791       return BinaryOperator::CreateSub(
1792           ConstantInt::getSigned(RHS->getType(), -2), LHSPlusRHS);
1793     }
1794   }
1795 
1796   if (Instruction *R = tryFoldInstWithCtpopWithNot(&I))
1797     return R;
1798 
1799   // TODO(jingyue): Consider willNotOverflowSignedAdd and
1800   // willNotOverflowUnsignedAdd to reduce the number of invocations of
1801   // computeKnownBits.
1802   bool Changed = false;
1803   if (!I.hasNoSignedWrap() && willNotOverflowSignedAdd(LHSCache, RHSCache, I)) {
1804     Changed = true;
1805     I.setHasNoSignedWrap(true);
1806   }
1807   if (!I.hasNoUnsignedWrap() &&
1808       willNotOverflowUnsignedAdd(LHSCache, RHSCache, I)) {
1809     Changed = true;
1810     I.setHasNoUnsignedWrap(true);
1811   }
1812 
1813   if (Instruction *V = canonicalizeLowbitMask(I, Builder))
1814     return V;
1815 
1816   if (Instruction *V =
1817           canonicalizeCondSignextOfHighBitExtractToSignextHighBitExtract(I))
1818     return V;
1819 
1820   if (Instruction *SatAdd = foldToUnsignedSaturatedAdd(I))
1821     return SatAdd;
1822 
1823   // usub.sat(A, B) + B => umax(A, B)
1824   if (match(&I, m_c_BinOp(
1825           m_OneUse(m_Intrinsic<Intrinsic::usub_sat>(m_Value(A), m_Value(B))),
1826           m_Deferred(B)))) {
1827     return replaceInstUsesWith(I,
1828         Builder.CreateIntrinsic(Intrinsic::umax, {I.getType()}, {A, B}));
1829   }
1830 
1831   // ctpop(A) + ctpop(B) => ctpop(A | B) if A and B have no bits set in common.
1832   if (match(LHS, m_OneUse(m_Intrinsic<Intrinsic::ctpop>(m_Value(A)))) &&
1833       match(RHS, m_OneUse(m_Intrinsic<Intrinsic::ctpop>(m_Value(B)))) &&
1834       haveNoCommonBitsSet(A, B, SQ.getWithInstruction(&I)))
1835     return replaceInstUsesWith(
1836         I, Builder.CreateIntrinsic(Intrinsic::ctpop, {I.getType()},
1837                                    {Builder.CreateOr(A, B)}));
1838 
1839   // Fold the log2_ceil idiom:
1840   // zext(ctpop(A) >u/!= 1) + (ctlz(A, true) ^ (BW - 1))
1841   // -->
1842   // BW - ctlz(A - 1, false)
1843   const APInt *XorC;
1844   ICmpInst::Predicate Pred;
1845   if (match(&I,
1846             m_c_Add(
1847                 m_ZExt(m_ICmp(Pred, m_Intrinsic<Intrinsic::ctpop>(m_Value(A)),
1848                               m_One())),
1849                 m_OneUse(m_ZExtOrSelf(m_OneUse(m_Xor(
1850                     m_OneUse(m_TruncOrSelf(m_OneUse(
1851                         m_Intrinsic<Intrinsic::ctlz>(m_Deferred(A), m_One())))),
1852                     m_APInt(XorC))))))) &&
1853       (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_NE) &&
1854       *XorC == A->getType()->getScalarSizeInBits() - 1) {
1855     Value *Sub = Builder.CreateAdd(A, Constant::getAllOnesValue(A->getType()));
1856     Value *Ctlz = Builder.CreateIntrinsic(Intrinsic::ctlz, {A->getType()},
1857                                           {Sub, Builder.getFalse()});
1858     Value *Ret = Builder.CreateSub(
1859         ConstantInt::get(A->getType(), A->getType()->getScalarSizeInBits()),
1860         Ctlz, "", /*HasNUW*/ true, /*HasNSW*/ true);
1861     return replaceInstUsesWith(I, Builder.CreateZExtOrTrunc(Ret, I.getType()));
1862   }
1863 
1864   if (Instruction *Res = foldSquareSumInt(I))
1865     return Res;
1866 
1867   if (Instruction *Res = foldBinOpOfDisplacedShifts(I))
1868     return Res;
1869 
1870   if (Instruction *Res = foldBinOpOfSelectAndCastOfSelectCondition(I))
1871     return Res;
1872 
1873   // Re-enqueue users of the induction variable of add recurrence if we infer
1874   // new nuw/nsw flags.
1875   if (Changed) {
1876     PHINode *PHI;
1877     Value *Start, *Step;
1878     if (matchSimpleRecurrence(&I, PHI, Start, Step))
1879       Worklist.pushUsersToWorkList(*PHI);
1880   }
1881 
1882   return Changed ? &I : nullptr;
1883 }
1884 
1885 /// Eliminate an op from a linear interpolation (lerp) pattern.
1886 static Instruction *factorizeLerp(BinaryOperator &I,
1887                                   InstCombiner::BuilderTy &Builder) {
1888   Value *X, *Y, *Z;
1889   if (!match(&I, m_c_FAdd(m_OneUse(m_c_FMul(m_Value(Y),
1890                                             m_OneUse(m_FSub(m_FPOne(),
1891                                                             m_Value(Z))))),
1892                           m_OneUse(m_c_FMul(m_Value(X), m_Deferred(Z))))))
1893     return nullptr;
1894 
1895   // (Y * (1.0 - Z)) + (X * Z) --> Y + Z * (X - Y) [8 commuted variants]
1896   Value *XY = Builder.CreateFSubFMF(X, Y, &I);
1897   Value *MulZ = Builder.CreateFMulFMF(Z, XY, &I);
1898   return BinaryOperator::CreateFAddFMF(Y, MulZ, &I);
1899 }
1900 
1901 /// Factor a common operand out of fadd/fsub of fmul/fdiv.
1902 static Instruction *factorizeFAddFSub(BinaryOperator &I,
1903                                       InstCombiner::BuilderTy &Builder) {
1904   assert((I.getOpcode() == Instruction::FAdd ||
1905           I.getOpcode() == Instruction::FSub) && "Expecting fadd/fsub");
1906   assert(I.hasAllowReassoc() && I.hasNoSignedZeros() &&
1907          "FP factorization requires FMF");
1908 
1909   if (Instruction *Lerp = factorizeLerp(I, Builder))
1910     return Lerp;
1911 
1912   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1913   if (!Op0->hasOneUse() || !Op1->hasOneUse())
1914     return nullptr;
1915 
1916   Value *X, *Y, *Z;
1917   bool IsFMul;
1918   if ((match(Op0, m_FMul(m_Value(X), m_Value(Z))) &&
1919        match(Op1, m_c_FMul(m_Value(Y), m_Specific(Z)))) ||
1920       (match(Op0, m_FMul(m_Value(Z), m_Value(X))) &&
1921        match(Op1, m_c_FMul(m_Value(Y), m_Specific(Z)))))
1922     IsFMul = true;
1923   else if (match(Op0, m_FDiv(m_Value(X), m_Value(Z))) &&
1924            match(Op1, m_FDiv(m_Value(Y), m_Specific(Z))))
1925     IsFMul = false;
1926   else
1927     return nullptr;
1928 
1929   // (X * Z) + (Y * Z) --> (X + Y) * Z
1930   // (X * Z) - (Y * Z) --> (X - Y) * Z
1931   // (X / Z) + (Y / Z) --> (X + Y) / Z
1932   // (X / Z) - (Y / Z) --> (X - Y) / Z
1933   bool IsFAdd = I.getOpcode() == Instruction::FAdd;
1934   Value *XY = IsFAdd ? Builder.CreateFAddFMF(X, Y, &I)
1935                      : Builder.CreateFSubFMF(X, Y, &I);
1936 
1937   // Bail out if we just created a denormal constant.
1938   // TODO: This is copied from a previous implementation. Is it necessary?
1939   const APFloat *C;
1940   if (match(XY, m_APFloat(C)) && !C->isNormal())
1941     return nullptr;
1942 
1943   return IsFMul ? BinaryOperator::CreateFMulFMF(XY, Z, &I)
1944                 : BinaryOperator::CreateFDivFMF(XY, Z, &I);
1945 }
1946 
1947 Instruction *InstCombinerImpl::visitFAdd(BinaryOperator &I) {
1948   if (Value *V = simplifyFAddInst(I.getOperand(0), I.getOperand(1),
1949                                   I.getFastMathFlags(),
1950                                   SQ.getWithInstruction(&I)))
1951     return replaceInstUsesWith(I, V);
1952 
1953   if (SimplifyAssociativeOrCommutative(I))
1954     return &I;
1955 
1956   if (Instruction *X = foldVectorBinop(I))
1957     return X;
1958 
1959   if (Instruction *Phi = foldBinopWithPhiOperands(I))
1960     return Phi;
1961 
1962   if (Instruction *FoldedFAdd = foldBinOpIntoSelectOrPhi(I))
1963     return FoldedFAdd;
1964 
1965   // (-X) + Y --> Y - X
1966   Value *X, *Y;
1967   if (match(&I, m_c_FAdd(m_FNeg(m_Value(X)), m_Value(Y))))
1968     return BinaryOperator::CreateFSubFMF(Y, X, &I);
1969 
1970   // Similar to above, but look through fmul/fdiv for the negated term.
1971   // (-X * Y) + Z --> Z - (X * Y) [4 commuted variants]
1972   Value *Z;
1973   if (match(&I, m_c_FAdd(m_OneUse(m_c_FMul(m_FNeg(m_Value(X)), m_Value(Y))),
1974                          m_Value(Z)))) {
1975     Value *XY = Builder.CreateFMulFMF(X, Y, &I);
1976     return BinaryOperator::CreateFSubFMF(Z, XY, &I);
1977   }
1978   // (-X / Y) + Z --> Z - (X / Y) [2 commuted variants]
1979   // (X / -Y) + Z --> Z - (X / Y) [2 commuted variants]
1980   if (match(&I, m_c_FAdd(m_OneUse(m_FDiv(m_FNeg(m_Value(X)), m_Value(Y))),
1981                          m_Value(Z))) ||
1982       match(&I, m_c_FAdd(m_OneUse(m_FDiv(m_Value(X), m_FNeg(m_Value(Y)))),
1983                          m_Value(Z)))) {
1984     Value *XY = Builder.CreateFDivFMF(X, Y, &I);
1985     return BinaryOperator::CreateFSubFMF(Z, XY, &I);
1986   }
1987 
1988   // Check for (fadd double (sitofp x), y), see if we can merge this into an
1989   // integer add followed by a promotion.
1990   if (Instruction *R = foldFBinOpOfIntCasts(I))
1991     return R;
1992 
1993   Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
1994   // Handle specials cases for FAdd with selects feeding the operation
1995   if (Value *V = SimplifySelectsFeedingBinaryOp(I, LHS, RHS))
1996     return replaceInstUsesWith(I, V);
1997 
1998   if (I.hasAllowReassoc() && I.hasNoSignedZeros()) {
1999     if (Instruction *F = factorizeFAddFSub(I, Builder))
2000       return F;
2001 
2002     if (Instruction *F = foldSquareSumFP(I))
2003       return F;
2004 
2005     // Try to fold fadd into start value of reduction intrinsic.
2006     if (match(&I, m_c_FAdd(m_OneUse(m_Intrinsic<Intrinsic::vector_reduce_fadd>(
2007                                m_AnyZeroFP(), m_Value(X))),
2008                            m_Value(Y)))) {
2009       // fadd (rdx 0.0, X), Y --> rdx Y, X
2010       return replaceInstUsesWith(
2011           I, Builder.CreateIntrinsic(Intrinsic::vector_reduce_fadd,
2012                                      {X->getType()}, {Y, X}, &I));
2013     }
2014     const APFloat *StartC, *C;
2015     if (match(LHS, m_OneUse(m_Intrinsic<Intrinsic::vector_reduce_fadd>(
2016                        m_APFloat(StartC), m_Value(X)))) &&
2017         match(RHS, m_APFloat(C))) {
2018       // fadd (rdx StartC, X), C --> rdx (C + StartC), X
2019       Constant *NewStartC = ConstantFP::get(I.getType(), *C + *StartC);
2020       return replaceInstUsesWith(
2021           I, Builder.CreateIntrinsic(Intrinsic::vector_reduce_fadd,
2022                                      {X->getType()}, {NewStartC, X}, &I));
2023     }
2024 
2025     // (X * MulC) + X --> X * (MulC + 1.0)
2026     Constant *MulC;
2027     if (match(&I, m_c_FAdd(m_FMul(m_Value(X), m_ImmConstant(MulC)),
2028                            m_Deferred(X)))) {
2029       if (Constant *NewMulC = ConstantFoldBinaryOpOperands(
2030               Instruction::FAdd, MulC, ConstantFP::get(I.getType(), 1.0), DL))
2031         return BinaryOperator::CreateFMulFMF(X, NewMulC, &I);
2032     }
2033 
2034     // (-X - Y) + (X + Z) --> Z - Y
2035     if (match(&I, m_c_FAdd(m_FSub(m_FNeg(m_Value(X)), m_Value(Y)),
2036                            m_c_FAdd(m_Deferred(X), m_Value(Z)))))
2037       return BinaryOperator::CreateFSubFMF(Z, Y, &I);
2038 
2039     if (Value *V = FAddCombine(Builder).simplify(&I))
2040       return replaceInstUsesWith(I, V);
2041   }
2042 
2043   // minumum(X, Y) + maximum(X, Y) => X + Y.
2044   if (match(&I,
2045             m_c_FAdd(m_Intrinsic<Intrinsic::maximum>(m_Value(X), m_Value(Y)),
2046                      m_c_Intrinsic<Intrinsic::minimum>(m_Deferred(X),
2047                                                        m_Deferred(Y))))) {
2048     BinaryOperator *Result = BinaryOperator::CreateFAddFMF(X, Y, &I);
2049     // We cannot preserve ninf if nnan flag is not set.
2050     // If X is NaN and Y is Inf then in original program we had NaN + NaN,
2051     // while in optimized version NaN + Inf and this is a poison with ninf flag.
2052     if (!Result->hasNoNaNs())
2053       Result->setHasNoInfs(false);
2054     return Result;
2055   }
2056 
2057   return nullptr;
2058 }
2059 
2060 /// Optimize pointer differences into the same array into a size.  Consider:
2061 ///  &A[10] - &A[0]: we should compile this to "10".  LHS/RHS are the pointer
2062 /// operands to the ptrtoint instructions for the LHS/RHS of the subtract.
2063 Value *InstCombinerImpl::OptimizePointerDifference(Value *LHS, Value *RHS,
2064                                                    Type *Ty, bool IsNUW) {
2065   // If LHS is a gep based on RHS or RHS is a gep based on LHS, we can optimize
2066   // this.
2067   bool Swapped = false;
2068   GEPOperator *GEP1 = nullptr, *GEP2 = nullptr;
2069   if (!isa<GEPOperator>(LHS) && isa<GEPOperator>(RHS)) {
2070     std::swap(LHS, RHS);
2071     Swapped = true;
2072   }
2073 
2074   // Require at least one GEP with a common base pointer on both sides.
2075   if (auto *LHSGEP = dyn_cast<GEPOperator>(LHS)) {
2076     // (gep X, ...) - X
2077     if (LHSGEP->getOperand(0)->stripPointerCasts() ==
2078         RHS->stripPointerCasts()) {
2079       GEP1 = LHSGEP;
2080     } else if (auto *RHSGEP = dyn_cast<GEPOperator>(RHS)) {
2081       // (gep X, ...) - (gep X, ...)
2082       if (LHSGEP->getOperand(0)->stripPointerCasts() ==
2083           RHSGEP->getOperand(0)->stripPointerCasts()) {
2084         GEP1 = LHSGEP;
2085         GEP2 = RHSGEP;
2086       }
2087     }
2088   }
2089 
2090   if (!GEP1)
2091     return nullptr;
2092 
2093   // To avoid duplicating the offset arithmetic, rewrite the GEP to use the
2094   // computed offset. This may erase the original GEP, so be sure to cache the
2095   // inbounds flag before emitting the offset.
2096   // TODO: We should probably do this even if there is only one GEP.
2097   bool RewriteGEPs = GEP2 != nullptr;
2098 
2099   // Emit the offset of the GEP and an intptr_t.
2100   bool GEP1IsInBounds = GEP1->isInBounds();
2101   Value *Result = EmitGEPOffset(GEP1, RewriteGEPs);
2102 
2103   // If this is a single inbounds GEP and the original sub was nuw,
2104   // then the final multiplication is also nuw.
2105   if (auto *I = dyn_cast<Instruction>(Result))
2106     if (IsNUW && !GEP2 && !Swapped && GEP1IsInBounds &&
2107         I->getOpcode() == Instruction::Mul)
2108       I->setHasNoUnsignedWrap();
2109 
2110   // If we have a 2nd GEP of the same base pointer, subtract the offsets.
2111   // If both GEPs are inbounds, then the subtract does not have signed overflow.
2112   // If both GEPs are nuw and the original sub is nuw, the new sub is also nuw.
2113   if (GEP2) {
2114     Value *Offset = EmitGEPOffset(GEP2, RewriteGEPs);
2115     Result = Builder.CreateSub(Result, Offset, "gepdiff",
2116                                IsNUW && GEP1->hasNoUnsignedWrap() &&
2117                                    GEP2->hasNoUnsignedWrap(),
2118                                GEP1IsInBounds && GEP2->isInBounds());
2119   }
2120 
2121   // If we have p - gep(p, ...)  then we have to negate the result.
2122   if (Swapped)
2123     Result = Builder.CreateNeg(Result, "diff.neg");
2124 
2125   return Builder.CreateIntCast(Result, Ty, true);
2126 }
2127 
2128 static Instruction *foldSubOfMinMax(BinaryOperator &I,
2129                                     InstCombiner::BuilderTy &Builder) {
2130   Value *Op0 = I.getOperand(0);
2131   Value *Op1 = I.getOperand(1);
2132   Type *Ty = I.getType();
2133   auto *MinMax = dyn_cast<MinMaxIntrinsic>(Op1);
2134   if (!MinMax)
2135     return nullptr;
2136 
2137   // sub(add(X,Y), s/umin(X,Y)) --> s/umax(X,Y)
2138   // sub(add(X,Y), s/umax(X,Y)) --> s/umin(X,Y)
2139   Value *X = MinMax->getLHS();
2140   Value *Y = MinMax->getRHS();
2141   if (match(Op0, m_c_Add(m_Specific(X), m_Specific(Y))) &&
2142       (Op0->hasOneUse() || Op1->hasOneUse())) {
2143     Intrinsic::ID InvID = getInverseMinMaxIntrinsic(MinMax->getIntrinsicID());
2144     Function *F = Intrinsic::getOrInsertDeclaration(I.getModule(), InvID, Ty);
2145     return CallInst::Create(F, {X, Y});
2146   }
2147 
2148   // sub(add(X,Y),umin(Y,Z)) --> add(X,usub.sat(Y,Z))
2149   // sub(add(X,Z),umin(Y,Z)) --> add(X,usub.sat(Z,Y))
2150   Value *Z;
2151   if (match(Op1, m_OneUse(m_UMin(m_Value(Y), m_Value(Z))))) {
2152     if (match(Op0, m_OneUse(m_c_Add(m_Specific(Y), m_Value(X))))) {
2153       Value *USub = Builder.CreateIntrinsic(Intrinsic::usub_sat, Ty, {Y, Z});
2154       return BinaryOperator::CreateAdd(X, USub);
2155     }
2156     if (match(Op0, m_OneUse(m_c_Add(m_Specific(Z), m_Value(X))))) {
2157       Value *USub = Builder.CreateIntrinsic(Intrinsic::usub_sat, Ty, {Z, Y});
2158       return BinaryOperator::CreateAdd(X, USub);
2159     }
2160   }
2161 
2162   // sub Op0, smin((sub nsw Op0, Z), 0) --> smax Op0, Z
2163   // sub Op0, smax((sub nsw Op0, Z), 0) --> smin Op0, Z
2164   if (MinMax->isSigned() && match(Y, m_ZeroInt()) &&
2165       match(X, m_NSWSub(m_Specific(Op0), m_Value(Z)))) {
2166     Intrinsic::ID InvID = getInverseMinMaxIntrinsic(MinMax->getIntrinsicID());
2167     Function *F = Intrinsic::getOrInsertDeclaration(I.getModule(), InvID, Ty);
2168     return CallInst::Create(F, {Op0, Z});
2169   }
2170 
2171   return nullptr;
2172 }
2173 
2174 Instruction *InstCombinerImpl::visitSub(BinaryOperator &I) {
2175   if (Value *V = simplifySubInst(I.getOperand(0), I.getOperand(1),
2176                                  I.hasNoSignedWrap(), I.hasNoUnsignedWrap(),
2177                                  SQ.getWithInstruction(&I)))
2178     return replaceInstUsesWith(I, V);
2179 
2180   if (Instruction *X = foldVectorBinop(I))
2181     return X;
2182 
2183   if (Instruction *Phi = foldBinopWithPhiOperands(I))
2184     return Phi;
2185 
2186   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
2187 
2188   // If this is a 'B = x-(-A)', change to B = x+A.
2189   // We deal with this without involving Negator to preserve NSW flag.
2190   if (Value *V = dyn_castNegVal(Op1)) {
2191     BinaryOperator *Res = BinaryOperator::CreateAdd(Op0, V);
2192 
2193     if (const auto *BO = dyn_cast<BinaryOperator>(Op1)) {
2194       assert(BO->getOpcode() == Instruction::Sub &&
2195              "Expected a subtraction operator!");
2196       if (BO->hasNoSignedWrap() && I.hasNoSignedWrap())
2197         Res->setHasNoSignedWrap(true);
2198     } else {
2199       if (cast<Constant>(Op1)->isNotMinSignedValue() && I.hasNoSignedWrap())
2200         Res->setHasNoSignedWrap(true);
2201     }
2202 
2203     return Res;
2204   }
2205 
2206   // Try this before Negator to preserve NSW flag.
2207   if (Instruction *R = factorizeMathWithShlOps(I, Builder))
2208     return R;
2209 
2210   Constant *C;
2211   if (match(Op0, m_ImmConstant(C))) {
2212     Value *X;
2213     Constant *C2;
2214 
2215     // C-(X+C2) --> (C-C2)-X
2216     if (match(Op1, m_Add(m_Value(X), m_ImmConstant(C2)))) {
2217       // C-C2 never overflow, and C-(X+C2), (X+C2) has NSW/NUW
2218       // => (C-C2)-X can have NSW/NUW
2219       bool WillNotSOV = willNotOverflowSignedSub(C, C2, I);
2220       BinaryOperator *Res =
2221           BinaryOperator::CreateSub(ConstantExpr::getSub(C, C2), X);
2222       auto *OBO1 = cast<OverflowingBinaryOperator>(Op1);
2223       Res->setHasNoSignedWrap(I.hasNoSignedWrap() && OBO1->hasNoSignedWrap() &&
2224                               WillNotSOV);
2225       Res->setHasNoUnsignedWrap(I.hasNoUnsignedWrap() &&
2226                                 OBO1->hasNoUnsignedWrap());
2227       return Res;
2228     }
2229   }
2230 
2231   auto TryToNarrowDeduceFlags = [this, &I, &Op0, &Op1]() -> Instruction * {
2232     if (Instruction *Ext = narrowMathIfNoOverflow(I))
2233       return Ext;
2234 
2235     bool Changed = false;
2236     if (!I.hasNoSignedWrap() && willNotOverflowSignedSub(Op0, Op1, I)) {
2237       Changed = true;
2238       I.setHasNoSignedWrap(true);
2239     }
2240     if (!I.hasNoUnsignedWrap() && willNotOverflowUnsignedSub(Op0, Op1, I)) {
2241       Changed = true;
2242       I.setHasNoUnsignedWrap(true);
2243     }
2244 
2245     return Changed ? &I : nullptr;
2246   };
2247 
2248   // First, let's try to interpret `sub a, b` as `add a, (sub 0, b)`,
2249   // and let's try to sink `(sub 0, b)` into `b` itself. But only if this isn't
2250   // a pure negation used by a select that looks like abs/nabs.
2251   bool IsNegation = match(Op0, m_ZeroInt());
2252   if (!IsNegation || none_of(I.users(), [&I, Op1](const User *U) {
2253         const Instruction *UI = dyn_cast<Instruction>(U);
2254         if (!UI)
2255           return false;
2256         return match(UI, m_c_Select(m_Specific(Op1), m_Specific(&I)));
2257       })) {
2258     if (Value *NegOp1 = Negator::Negate(IsNegation, /* IsNSW */ IsNegation &&
2259                                                         I.hasNoSignedWrap(),
2260                                         Op1, *this))
2261       return BinaryOperator::CreateAdd(NegOp1, Op0);
2262   }
2263   if (IsNegation)
2264     return TryToNarrowDeduceFlags(); // Should have been handled in Negator!
2265 
2266   // (A*B)-(A*C) -> A*(B-C) etc
2267   if (Value *V = foldUsingDistributiveLaws(I))
2268     return replaceInstUsesWith(I, V);
2269 
2270   if (I.getType()->isIntOrIntVectorTy(1))
2271     return BinaryOperator::CreateXor(Op0, Op1);
2272 
2273   // Replace (-1 - A) with (~A).
2274   if (match(Op0, m_AllOnes()))
2275     return BinaryOperator::CreateNot(Op1);
2276 
2277   // (X + -1) - Y --> ~Y + X
2278   Value *X, *Y;
2279   if (match(Op0, m_OneUse(m_Add(m_Value(X), m_AllOnes()))))
2280     return BinaryOperator::CreateAdd(Builder.CreateNot(Op1), X);
2281 
2282   // Reassociate sub/add sequences to create more add instructions and
2283   // reduce dependency chains:
2284   // ((X - Y) + Z) - Op1 --> (X + Z) - (Y + Op1)
2285   Value *Z;
2286   if (match(Op0, m_OneUse(m_c_Add(m_OneUse(m_Sub(m_Value(X), m_Value(Y))),
2287                                   m_Value(Z))))) {
2288     Value *XZ = Builder.CreateAdd(X, Z);
2289     Value *YW = Builder.CreateAdd(Y, Op1);
2290     return BinaryOperator::CreateSub(XZ, YW);
2291   }
2292 
2293   // ((X - Y) - Op1)  -->  X - (Y + Op1)
2294   if (match(Op0, m_OneUse(m_Sub(m_Value(X), m_Value(Y))))) {
2295     OverflowingBinaryOperator *LHSSub = cast<OverflowingBinaryOperator>(Op0);
2296     bool HasNUW = I.hasNoUnsignedWrap() && LHSSub->hasNoUnsignedWrap();
2297     bool HasNSW = HasNUW && I.hasNoSignedWrap() && LHSSub->hasNoSignedWrap();
2298     Value *Add = Builder.CreateAdd(Y, Op1, "", /* HasNUW */ HasNUW,
2299                                    /* HasNSW */ HasNSW);
2300     BinaryOperator *Sub = BinaryOperator::CreateSub(X, Add);
2301     Sub->setHasNoUnsignedWrap(HasNUW);
2302     Sub->setHasNoSignedWrap(HasNSW);
2303     return Sub;
2304   }
2305 
2306   {
2307     // (X + Z) - (Y + Z) --> (X - Y)
2308     // This is done in other passes, but we want to be able to consume this
2309     // pattern in InstCombine so we can generate it without creating infinite
2310     // loops.
2311     if (match(Op0, m_Add(m_Value(X), m_Value(Z))) &&
2312         match(Op1, m_c_Add(m_Value(Y), m_Specific(Z))))
2313       return BinaryOperator::CreateSub(X, Y);
2314 
2315     // (X + C0) - (Y + C1) --> (X - Y) + (C0 - C1)
2316     Constant *CX, *CY;
2317     if (match(Op0, m_OneUse(m_Add(m_Value(X), m_ImmConstant(CX)))) &&
2318         match(Op1, m_OneUse(m_Add(m_Value(Y), m_ImmConstant(CY))))) {
2319       Value *OpsSub = Builder.CreateSub(X, Y);
2320       Constant *ConstsSub = ConstantExpr::getSub(CX, CY);
2321       return BinaryOperator::CreateAdd(OpsSub, ConstsSub);
2322     }
2323   }
2324 
2325   {
2326     Value *W, *Z;
2327     if (match(Op0, m_AddLike(m_Value(W), m_Value(X))) &&
2328         match(Op1, m_AddLike(m_Value(Y), m_Value(Z)))) {
2329       Instruction *R = nullptr;
2330       if (W == Y)
2331         R = BinaryOperator::CreateSub(X, Z);
2332       else if (W == Z)
2333         R = BinaryOperator::CreateSub(X, Y);
2334       else if (X == Y)
2335         R = BinaryOperator::CreateSub(W, Z);
2336       else if (X == Z)
2337         R = BinaryOperator::CreateSub(W, Y);
2338       if (R) {
2339         bool NSW = I.hasNoSignedWrap() &&
2340                    match(Op0, m_NSWAddLike(m_Value(), m_Value())) &&
2341                    match(Op1, m_NSWAddLike(m_Value(), m_Value()));
2342 
2343         bool NUW = I.hasNoUnsignedWrap() &&
2344                    match(Op1, m_NUWAddLike(m_Value(), m_Value()));
2345         R->setHasNoSignedWrap(NSW);
2346         R->setHasNoUnsignedWrap(NUW);
2347         return R;
2348       }
2349     }
2350   }
2351 
2352   // (~X) - (~Y) --> Y - X
2353   {
2354     // Need to ensure we can consume at least one of the `not` instructions,
2355     // otherwise this can inf loop.
2356     bool ConsumesOp0, ConsumesOp1;
2357     if (isFreeToInvert(Op0, Op0->hasOneUse(), ConsumesOp0) &&
2358         isFreeToInvert(Op1, Op1->hasOneUse(), ConsumesOp1) &&
2359         (ConsumesOp0 || ConsumesOp1)) {
2360       Value *NotOp0 = getFreelyInverted(Op0, Op0->hasOneUse(), &Builder);
2361       Value *NotOp1 = getFreelyInverted(Op1, Op1->hasOneUse(), &Builder);
2362       assert(NotOp0 != nullptr && NotOp1 != nullptr &&
2363              "isFreeToInvert desynced with getFreelyInverted");
2364       return BinaryOperator::CreateSub(NotOp1, NotOp0);
2365     }
2366   }
2367 
2368   auto m_AddRdx = [](Value *&Vec) {
2369     return m_OneUse(m_Intrinsic<Intrinsic::vector_reduce_add>(m_Value(Vec)));
2370   };
2371   Value *V0, *V1;
2372   if (match(Op0, m_AddRdx(V0)) && match(Op1, m_AddRdx(V1)) &&
2373       V0->getType() == V1->getType()) {
2374     // Difference of sums is sum of differences:
2375     // add_rdx(V0) - add_rdx(V1) --> add_rdx(V0 - V1)
2376     Value *Sub = Builder.CreateSub(V0, V1);
2377     Value *Rdx = Builder.CreateIntrinsic(Intrinsic::vector_reduce_add,
2378                                          {Sub->getType()}, {Sub});
2379     return replaceInstUsesWith(I, Rdx);
2380   }
2381 
2382   if (Constant *C = dyn_cast<Constant>(Op0)) {
2383     Value *X;
2384     if (match(Op1, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
2385       // C - (zext bool) --> bool ? C - 1 : C
2386       return SelectInst::Create(X, InstCombiner::SubOne(C), C);
2387     if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
2388       // C - (sext bool) --> bool ? C + 1 : C
2389       return SelectInst::Create(X, InstCombiner::AddOne(C), C);
2390 
2391     // C - ~X == X + (1+C)
2392     if (match(Op1, m_Not(m_Value(X))))
2393       return BinaryOperator::CreateAdd(X, InstCombiner::AddOne(C));
2394 
2395     // Try to fold constant sub into select arguments.
2396     if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
2397       if (Instruction *R = FoldOpIntoSelect(I, SI))
2398         return R;
2399 
2400     // Try to fold constant sub into PHI values.
2401     if (PHINode *PN = dyn_cast<PHINode>(Op1))
2402       if (Instruction *R = foldOpIntoPhi(I, PN))
2403         return R;
2404 
2405     Constant *C2;
2406 
2407     // C-(C2-X) --> X+(C-C2)
2408     if (match(Op1, m_Sub(m_ImmConstant(C2), m_Value(X))))
2409       return BinaryOperator::CreateAdd(X, ConstantExpr::getSub(C, C2));
2410   }
2411 
2412   const APInt *Op0C;
2413   if (match(Op0, m_APInt(Op0C))) {
2414     if (Op0C->isMask()) {
2415       // Turn this into a xor if LHS is 2^n-1 and the remaining bits are known
2416       // zero. We don't use information from dominating conditions so this
2417       // transform is easier to reverse if necessary.
2418       KnownBits RHSKnown = llvm::computeKnownBits(
2419           Op1, 0, SQ.getWithInstruction(&I).getWithoutDomCondCache());
2420       if ((*Op0C | RHSKnown.Zero).isAllOnes())
2421         return BinaryOperator::CreateXor(Op1, Op0);
2422     }
2423 
2424     // C - ((C3 -nuw X) & C2) --> (C - (C2 & C3)) + (X & C2) when:
2425     // (C3 - ((C2 & C3) - 1)) is pow2
2426     // ((C2 + C3) & ((C2 & C3) - 1)) == ((C2 & C3) - 1)
2427     // C2 is negative pow2 || sub nuw
2428     const APInt *C2, *C3;
2429     BinaryOperator *InnerSub;
2430     if (match(Op1, m_OneUse(m_And(m_BinOp(InnerSub), m_APInt(C2)))) &&
2431         match(InnerSub, m_Sub(m_APInt(C3), m_Value(X))) &&
2432         (InnerSub->hasNoUnsignedWrap() || C2->isNegatedPowerOf2())) {
2433       APInt C2AndC3 = *C2 & *C3;
2434       APInt C2AndC3Minus1 = C2AndC3 - 1;
2435       APInt C2AddC3 = *C2 + *C3;
2436       if ((*C3 - C2AndC3Minus1).isPowerOf2() &&
2437           C2AndC3Minus1.isSubsetOf(C2AddC3)) {
2438         Value *And = Builder.CreateAnd(X, ConstantInt::get(I.getType(), *C2));
2439         return BinaryOperator::CreateAdd(
2440             And, ConstantInt::get(I.getType(), *Op0C - C2AndC3));
2441       }
2442     }
2443   }
2444 
2445   {
2446     Value *Y;
2447     // X-(X+Y) == -Y    X-(Y+X) == -Y
2448     if (match(Op1, m_c_Add(m_Specific(Op0), m_Value(Y))))
2449       return BinaryOperator::CreateNeg(Y);
2450 
2451     // (X-Y)-X == -Y
2452     if (match(Op0, m_Sub(m_Specific(Op1), m_Value(Y))))
2453       return BinaryOperator::CreateNeg(Y);
2454   }
2455 
2456   // (sub (or A, B) (and A, B)) --> (xor A, B)
2457   {
2458     Value *A, *B;
2459     if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
2460         match(Op0, m_c_Or(m_Specific(A), m_Specific(B))))
2461       return BinaryOperator::CreateXor(A, B);
2462   }
2463 
2464   // (sub (add A, B) (or A, B)) --> (and A, B)
2465   {
2466     Value *A, *B;
2467     if (match(Op0, m_Add(m_Value(A), m_Value(B))) &&
2468         match(Op1, m_c_Or(m_Specific(A), m_Specific(B))))
2469       return BinaryOperator::CreateAnd(A, B);
2470   }
2471 
2472   // (sub (add A, B) (and A, B)) --> (or A, B)
2473   {
2474     Value *A, *B;
2475     if (match(Op0, m_Add(m_Value(A), m_Value(B))) &&
2476         match(Op1, m_c_And(m_Specific(A), m_Specific(B))))
2477       return BinaryOperator::CreateOr(A, B);
2478   }
2479 
2480   // (sub (and A, B) (or A, B)) --> neg (xor A, B)
2481   {
2482     Value *A, *B;
2483     if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
2484         match(Op1, m_c_Or(m_Specific(A), m_Specific(B))) &&
2485         (Op0->hasOneUse() || Op1->hasOneUse()))
2486       return BinaryOperator::CreateNeg(Builder.CreateXor(A, B));
2487   }
2488 
2489   // (sub (or A, B), (xor A, B)) --> (and A, B)
2490   {
2491     Value *A, *B;
2492     if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
2493         match(Op0, m_c_Or(m_Specific(A), m_Specific(B))))
2494       return BinaryOperator::CreateAnd(A, B);
2495   }
2496 
2497   // (sub (xor A, B) (or A, B)) --> neg (and A, B)
2498   {
2499     Value *A, *B;
2500     if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
2501         match(Op1, m_c_Or(m_Specific(A), m_Specific(B))) &&
2502         (Op0->hasOneUse() || Op1->hasOneUse()))
2503       return BinaryOperator::CreateNeg(Builder.CreateAnd(A, B));
2504   }
2505 
2506   {
2507     Value *Y;
2508     // ((X | Y) - X) --> (~X & Y)
2509     if (match(Op0, m_OneUse(m_c_Or(m_Value(Y), m_Specific(Op1)))))
2510       return BinaryOperator::CreateAnd(
2511           Y, Builder.CreateNot(Op1, Op1->getName() + ".not"));
2512   }
2513 
2514   {
2515     // (sub (and Op1, (neg X)), Op1) --> neg (and Op1, (add X, -1))
2516     Value *X;
2517     if (match(Op0, m_OneUse(m_c_And(m_Specific(Op1),
2518                                     m_OneUse(m_Neg(m_Value(X))))))) {
2519       return BinaryOperator::CreateNeg(Builder.CreateAnd(
2520           Op1, Builder.CreateAdd(X, Constant::getAllOnesValue(I.getType()))));
2521     }
2522   }
2523 
2524   {
2525     // (sub (and Op1, C), Op1) --> neg (and Op1, ~C)
2526     Constant *C;
2527     if (match(Op0, m_OneUse(m_And(m_Specific(Op1), m_Constant(C))))) {
2528       return BinaryOperator::CreateNeg(
2529           Builder.CreateAnd(Op1, Builder.CreateNot(C)));
2530     }
2531   }
2532 
2533   {
2534     // (sub (xor X, (sext C)), (sext C)) => (select C, (neg X), X)
2535     // (sub (sext C), (xor X, (sext C))) => (select C, X, (neg X))
2536     Value *C, *X;
2537     auto m_SubXorCmp = [&C, &X](Value *LHS, Value *RHS) {
2538       return match(LHS, m_OneUse(m_c_Xor(m_Value(X), m_Specific(RHS)))) &&
2539              match(RHS, m_SExt(m_Value(C))) &&
2540              (C->getType()->getScalarSizeInBits() == 1);
2541     };
2542     if (m_SubXorCmp(Op0, Op1))
2543       return SelectInst::Create(C, Builder.CreateNeg(X), X);
2544     if (m_SubXorCmp(Op1, Op0))
2545       return SelectInst::Create(C, X, Builder.CreateNeg(X));
2546   }
2547 
2548   if (Instruction *R = tryFoldInstWithCtpopWithNot(&I))
2549     return R;
2550 
2551   if (Instruction *R = foldSubOfMinMax(I, Builder))
2552     return R;
2553 
2554   {
2555     // If we have a subtraction between some value and a select between
2556     // said value and something else, sink subtraction into select hands, i.e.:
2557     //   sub (select %Cond, %TrueVal, %FalseVal), %Op1
2558     //     ->
2559     //   select %Cond, (sub %TrueVal, %Op1), (sub %FalseVal, %Op1)
2560     //  or
2561     //   sub %Op0, (select %Cond, %TrueVal, %FalseVal)
2562     //     ->
2563     //   select %Cond, (sub %Op0, %TrueVal), (sub %Op0, %FalseVal)
2564     // This will result in select between new subtraction and 0.
2565     auto SinkSubIntoSelect =
2566         [Ty = I.getType()](Value *Select, Value *OtherHandOfSub,
2567                            auto SubBuilder) -> Instruction * {
2568       Value *Cond, *TrueVal, *FalseVal;
2569       if (!match(Select, m_OneUse(m_Select(m_Value(Cond), m_Value(TrueVal),
2570                                            m_Value(FalseVal)))))
2571         return nullptr;
2572       if (OtherHandOfSub != TrueVal && OtherHandOfSub != FalseVal)
2573         return nullptr;
2574       // While it is really tempting to just create two subtractions and let
2575       // InstCombine fold one of those to 0, it isn't possible to do so
2576       // because of worklist visitation order. So ugly it is.
2577       bool OtherHandOfSubIsTrueVal = OtherHandOfSub == TrueVal;
2578       Value *NewSub = SubBuilder(OtherHandOfSubIsTrueVal ? FalseVal : TrueVal);
2579       Constant *Zero = Constant::getNullValue(Ty);
2580       SelectInst *NewSel =
2581           SelectInst::Create(Cond, OtherHandOfSubIsTrueVal ? Zero : NewSub,
2582                              OtherHandOfSubIsTrueVal ? NewSub : Zero);
2583       // Preserve prof metadata if any.
2584       NewSel->copyMetadata(cast<Instruction>(*Select));
2585       return NewSel;
2586     };
2587     if (Instruction *NewSel = SinkSubIntoSelect(
2588             /*Select=*/Op0, /*OtherHandOfSub=*/Op1,
2589             [Builder = &Builder, Op1](Value *OtherHandOfSelect) {
2590               return Builder->CreateSub(OtherHandOfSelect,
2591                                         /*OtherHandOfSub=*/Op1);
2592             }))
2593       return NewSel;
2594     if (Instruction *NewSel = SinkSubIntoSelect(
2595             /*Select=*/Op1, /*OtherHandOfSub=*/Op0,
2596             [Builder = &Builder, Op0](Value *OtherHandOfSelect) {
2597               return Builder->CreateSub(/*OtherHandOfSub=*/Op0,
2598                                         OtherHandOfSelect);
2599             }))
2600       return NewSel;
2601   }
2602 
2603   // (X - (X & Y))   -->   (X & ~Y)
2604   if (match(Op1, m_c_And(m_Specific(Op0), m_Value(Y))) &&
2605       (Op1->hasOneUse() || isa<Constant>(Y)))
2606     return BinaryOperator::CreateAnd(
2607         Op0, Builder.CreateNot(Y, Y->getName() + ".not"));
2608 
2609   // ~X - Min/Max(~X, Y) -> ~Min/Max(X, ~Y) - X
2610   // ~X - Min/Max(Y, ~X) -> ~Min/Max(X, ~Y) - X
2611   // Min/Max(~X, Y) - ~X -> X - ~Min/Max(X, ~Y)
2612   // Min/Max(Y, ~X) - ~X -> X - ~Min/Max(X, ~Y)
2613   // As long as Y is freely invertible, this will be neutral or a win.
2614   // Note: We don't generate the inverse max/min, just create the 'not' of
2615   // it and let other folds do the rest.
2616   if (match(Op0, m_Not(m_Value(X))) &&
2617       match(Op1, m_c_MaxOrMin(m_Specific(Op0), m_Value(Y))) &&
2618       !Op0->hasNUsesOrMore(3) && isFreeToInvert(Y, Y->hasOneUse())) {
2619     Value *Not = Builder.CreateNot(Op1);
2620     return BinaryOperator::CreateSub(Not, X);
2621   }
2622   if (match(Op1, m_Not(m_Value(X))) &&
2623       match(Op0, m_c_MaxOrMin(m_Specific(Op1), m_Value(Y))) &&
2624       !Op1->hasNUsesOrMore(3) && isFreeToInvert(Y, Y->hasOneUse())) {
2625     Value *Not = Builder.CreateNot(Op0);
2626     return BinaryOperator::CreateSub(X, Not);
2627   }
2628 
2629   // Optimize pointer differences into the same array into a size.  Consider:
2630   //  &A[10] - &A[0]: we should compile this to "10".
2631   Value *LHSOp, *RHSOp;
2632   if (match(Op0, m_PtrToInt(m_Value(LHSOp))) &&
2633       match(Op1, m_PtrToInt(m_Value(RHSOp))))
2634     if (Value *Res = OptimizePointerDifference(LHSOp, RHSOp, I.getType(),
2635                                                I.hasNoUnsignedWrap()))
2636       return replaceInstUsesWith(I, Res);
2637 
2638   // trunc(p)-trunc(q) -> trunc(p-q)
2639   if (match(Op0, m_Trunc(m_PtrToInt(m_Value(LHSOp)))) &&
2640       match(Op1, m_Trunc(m_PtrToInt(m_Value(RHSOp)))))
2641     if (Value *Res = OptimizePointerDifference(LHSOp, RHSOp, I.getType(),
2642                                                /* IsNUW */ false))
2643       return replaceInstUsesWith(I, Res);
2644 
2645   if (match(Op0, m_ZExt(m_PtrToIntSameSize(DL, m_Value(LHSOp)))) &&
2646       match(Op1, m_ZExtOrSelf(m_PtrToInt(m_Value(RHSOp))))) {
2647     if (auto *GEP = dyn_cast<GEPOperator>(LHSOp)) {
2648       if (GEP->getPointerOperand() == RHSOp) {
2649         if (GEP->hasNoUnsignedWrap() || GEP->hasNoUnsignedSignedWrap()) {
2650           Value *Offset = EmitGEPOffset(GEP);
2651           Value *Res = GEP->hasNoUnsignedWrap()
2652                            ? Builder.CreateZExt(
2653                                  Offset, I.getType(), "",
2654                                  /*IsNonNeg=*/GEP->hasNoUnsignedSignedWrap())
2655                            : Builder.CreateSExt(Offset, I.getType());
2656           return replaceInstUsesWith(I, Res);
2657         }
2658       }
2659     }
2660   }
2661 
2662   // Canonicalize a shifty way to code absolute value to the common pattern.
2663   // There are 2 potential commuted variants.
2664   // We're relying on the fact that we only do this transform when the shift has
2665   // exactly 2 uses and the xor has exactly 1 use (otherwise, we might increase
2666   // instructions).
2667   Value *A;
2668   const APInt *ShAmt;
2669   Type *Ty = I.getType();
2670   unsigned BitWidth = Ty->getScalarSizeInBits();
2671   if (match(Op1, m_AShr(m_Value(A), m_APInt(ShAmt))) &&
2672       Op1->hasNUses(2) && *ShAmt == BitWidth - 1 &&
2673       match(Op0, m_OneUse(m_c_Xor(m_Specific(A), m_Specific(Op1))))) {
2674     // B = ashr i32 A, 31 ; smear the sign bit
2675     // sub (xor A, B), B  ; flip bits if negative and subtract -1 (add 1)
2676     // --> (A < 0) ? -A : A
2677     Value *IsNeg = Builder.CreateIsNeg(A);
2678     // Copy the nsw flags from the sub to the negate.
2679     Value *NegA = I.hasNoUnsignedWrap()
2680                       ? Constant::getNullValue(A->getType())
2681                       : Builder.CreateNeg(A, "", I.hasNoSignedWrap());
2682     return SelectInst::Create(IsNeg, NegA, A);
2683   }
2684 
2685   // If we are subtracting a low-bit masked subset of some value from an add
2686   // of that same value with no low bits changed, that is clearing some low bits
2687   // of the sum:
2688   // sub (X + AddC), (X & AndC) --> and (X + AddC), ~AndC
2689   const APInt *AddC, *AndC;
2690   if (match(Op0, m_Add(m_Value(X), m_APInt(AddC))) &&
2691       match(Op1, m_And(m_Specific(X), m_APInt(AndC)))) {
2692     unsigned Cttz = AddC->countr_zero();
2693     APInt HighMask(APInt::getHighBitsSet(BitWidth, BitWidth - Cttz));
2694     if ((HighMask & *AndC).isZero())
2695       return BinaryOperator::CreateAnd(Op0, ConstantInt::get(Ty, ~(*AndC)));
2696   }
2697 
2698   if (Instruction *V =
2699           canonicalizeCondSignextOfHighBitExtractToSignextHighBitExtract(I))
2700     return V;
2701 
2702   // X - usub.sat(X, Y) => umin(X, Y)
2703   if (match(Op1, m_OneUse(m_Intrinsic<Intrinsic::usub_sat>(m_Specific(Op0),
2704                                                            m_Value(Y)))))
2705     return replaceInstUsesWith(
2706         I, Builder.CreateIntrinsic(Intrinsic::umin, {I.getType()}, {Op0, Y}));
2707 
2708   // umax(X, Op1) - Op1 --> usub.sat(X, Op1)
2709   // TODO: The one-use restriction is not strictly necessary, but it may
2710   //       require improving other pattern matching and/or codegen.
2711   if (match(Op0, m_OneUse(m_c_UMax(m_Value(X), m_Specific(Op1)))))
2712     return replaceInstUsesWith(
2713         I, Builder.CreateIntrinsic(Intrinsic::usub_sat, {Ty}, {X, Op1}));
2714 
2715   // Op0 - umin(X, Op0) --> usub.sat(Op0, X)
2716   if (match(Op1, m_OneUse(m_c_UMin(m_Value(X), m_Specific(Op0)))))
2717     return replaceInstUsesWith(
2718         I, Builder.CreateIntrinsic(Intrinsic::usub_sat, {Ty}, {Op0, X}));
2719 
2720   // Op0 - umax(X, Op0) --> 0 - usub.sat(X, Op0)
2721   if (match(Op1, m_OneUse(m_c_UMax(m_Value(X), m_Specific(Op0))))) {
2722     Value *USub = Builder.CreateIntrinsic(Intrinsic::usub_sat, {Ty}, {X, Op0});
2723     return BinaryOperator::CreateNeg(USub);
2724   }
2725 
2726   // umin(X, Op1) - Op1 --> 0 - usub.sat(Op1, X)
2727   if (match(Op0, m_OneUse(m_c_UMin(m_Value(X), m_Specific(Op1))))) {
2728     Value *USub = Builder.CreateIntrinsic(Intrinsic::usub_sat, {Ty}, {Op1, X});
2729     return BinaryOperator::CreateNeg(USub);
2730   }
2731 
2732   // C - ctpop(X) => ctpop(~X) if C is bitwidth
2733   if (match(Op0, m_SpecificInt(BitWidth)) &&
2734       match(Op1, m_OneUse(m_Intrinsic<Intrinsic::ctpop>(m_Value(X)))))
2735     return replaceInstUsesWith(
2736         I, Builder.CreateIntrinsic(Intrinsic::ctpop, {I.getType()},
2737                                    {Builder.CreateNot(X)}));
2738 
2739   // Reduce multiplies for difference-of-squares by factoring:
2740   // (X * X) - (Y * Y) --> (X + Y) * (X - Y)
2741   if (match(Op0, m_OneUse(m_Mul(m_Value(X), m_Deferred(X)))) &&
2742       match(Op1, m_OneUse(m_Mul(m_Value(Y), m_Deferred(Y))))) {
2743     auto *OBO0 = cast<OverflowingBinaryOperator>(Op0);
2744     auto *OBO1 = cast<OverflowingBinaryOperator>(Op1);
2745     bool PropagateNSW = I.hasNoSignedWrap() && OBO0->hasNoSignedWrap() &&
2746                         OBO1->hasNoSignedWrap() && BitWidth > 2;
2747     bool PropagateNUW = I.hasNoUnsignedWrap() && OBO0->hasNoUnsignedWrap() &&
2748                         OBO1->hasNoUnsignedWrap() && BitWidth > 1;
2749     Value *Add = Builder.CreateAdd(X, Y, "add", PropagateNUW, PropagateNSW);
2750     Value *Sub = Builder.CreateSub(X, Y, "sub", PropagateNUW, PropagateNSW);
2751     Value *Mul = Builder.CreateMul(Add, Sub, "", PropagateNUW, PropagateNSW);
2752     return replaceInstUsesWith(I, Mul);
2753   }
2754 
2755   // max(X,Y) nsw/nuw - min(X,Y) --> abs(X nsw - Y)
2756   if (match(Op0, m_OneUse(m_c_SMax(m_Value(X), m_Value(Y)))) &&
2757       match(Op1, m_OneUse(m_c_SMin(m_Specific(X), m_Specific(Y))))) {
2758     if (I.hasNoUnsignedWrap() || I.hasNoSignedWrap()) {
2759       Value *Sub =
2760           Builder.CreateSub(X, Y, "sub", /*HasNUW=*/false, /*HasNSW=*/true);
2761       Value *Call =
2762           Builder.CreateBinaryIntrinsic(Intrinsic::abs, Sub, Builder.getTrue());
2763       return replaceInstUsesWith(I, Call);
2764     }
2765   }
2766 
2767   if (Instruction *Res = foldBinOpOfSelectAndCastOfSelectCondition(I))
2768     return Res;
2769 
2770   return TryToNarrowDeduceFlags();
2771 }
2772 
2773 /// This eliminates floating-point negation in either 'fneg(X)' or
2774 /// 'fsub(-0.0, X)' form by combining into a constant operand.
2775 static Instruction *foldFNegIntoConstant(Instruction &I, const DataLayout &DL) {
2776   // This is limited with one-use because fneg is assumed better for
2777   // reassociation and cheaper in codegen than fmul/fdiv.
2778   // TODO: Should the m_OneUse restriction be removed?
2779   Instruction *FNegOp;
2780   if (!match(&I, m_FNeg(m_OneUse(m_Instruction(FNegOp)))))
2781     return nullptr;
2782 
2783   Value *X;
2784   Constant *C;
2785 
2786   // Fold negation into constant operand.
2787   // -(X * C) --> X * (-C)
2788   if (match(FNegOp, m_FMul(m_Value(X), m_Constant(C))))
2789     if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL))
2790       return BinaryOperator::CreateFMulFMF(X, NegC, &I);
2791   // -(X / C) --> X / (-C)
2792   if (match(FNegOp, m_FDiv(m_Value(X), m_Constant(C))))
2793     if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL))
2794       return BinaryOperator::CreateFDivFMF(X, NegC, &I);
2795   // -(C / X) --> (-C) / X
2796   if (match(FNegOp, m_FDiv(m_Constant(C), m_Value(X))))
2797     if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL)) {
2798       Instruction *FDiv = BinaryOperator::CreateFDivFMF(NegC, X, &I);
2799 
2800       // Intersect 'nsz' and 'ninf' because those special value exceptions may
2801       // not apply to the fdiv. Everything else propagates from the fneg.
2802       // TODO: We could propagate nsz/ninf from fdiv alone?
2803       FastMathFlags FMF = I.getFastMathFlags();
2804       FastMathFlags OpFMF = FNegOp->getFastMathFlags();
2805       FDiv->setHasNoSignedZeros(FMF.noSignedZeros() && OpFMF.noSignedZeros());
2806       FDiv->setHasNoInfs(FMF.noInfs() && OpFMF.noInfs());
2807       return FDiv;
2808     }
2809   // With NSZ [ counter-example with -0.0: -(-0.0 + 0.0) != 0.0 + -0.0 ]:
2810   // -(X + C) --> -X + -C --> -C - X
2811   if (I.hasNoSignedZeros() && match(FNegOp, m_FAdd(m_Value(X), m_Constant(C))))
2812     if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL))
2813       return BinaryOperator::CreateFSubFMF(NegC, X, &I);
2814 
2815   return nullptr;
2816 }
2817 
2818 Instruction *InstCombinerImpl::hoistFNegAboveFMulFDiv(Value *FNegOp,
2819                                                       Instruction &FMFSource) {
2820   Value *X, *Y;
2821   if (match(FNegOp, m_FMul(m_Value(X), m_Value(Y)))) {
2822     // Push into RHS which is more likely to simplify (const or another fneg).
2823     // FIXME: It would be better to invert the transform.
2824     return cast<Instruction>(Builder.CreateFMulFMF(
2825         X, Builder.CreateFNegFMF(Y, &FMFSource), &FMFSource));
2826   }
2827 
2828   if (match(FNegOp, m_FDiv(m_Value(X), m_Value(Y)))) {
2829     return cast<Instruction>(Builder.CreateFDivFMF(
2830         Builder.CreateFNegFMF(X, &FMFSource), Y, &FMFSource));
2831   }
2832 
2833   if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(FNegOp)) {
2834     // Make sure to preserve flags and metadata on the call.
2835     if (II->getIntrinsicID() == Intrinsic::ldexp) {
2836       FastMathFlags FMF = FMFSource.getFastMathFlags() | II->getFastMathFlags();
2837       IRBuilder<>::FastMathFlagGuard FMFGuard(Builder);
2838       Builder.setFastMathFlags(FMF);
2839 
2840       CallInst *New = Builder.CreateCall(
2841           II->getCalledFunction(),
2842           {Builder.CreateFNeg(II->getArgOperand(0)), II->getArgOperand(1)});
2843       New->copyMetadata(*II);
2844       return New;
2845     }
2846   }
2847 
2848   return nullptr;
2849 }
2850 
2851 Instruction *InstCombinerImpl::visitFNeg(UnaryOperator &I) {
2852   Value *Op = I.getOperand(0);
2853 
2854   if (Value *V = simplifyFNegInst(Op, I.getFastMathFlags(),
2855                                   getSimplifyQuery().getWithInstruction(&I)))
2856     return replaceInstUsesWith(I, V);
2857 
2858   if (Instruction *X = foldFNegIntoConstant(I, DL))
2859     return X;
2860 
2861   Value *X, *Y;
2862 
2863   // If we can ignore the sign of zeros: -(X - Y) --> (Y - X)
2864   if (I.hasNoSignedZeros() &&
2865       match(Op, m_OneUse(m_FSub(m_Value(X), m_Value(Y)))))
2866     return BinaryOperator::CreateFSubFMF(Y, X, &I);
2867 
2868   Value *OneUse;
2869   if (!match(Op, m_OneUse(m_Value(OneUse))))
2870     return nullptr;
2871 
2872   if (Instruction *R = hoistFNegAboveFMulFDiv(OneUse, I))
2873     return replaceInstUsesWith(I, R);
2874 
2875   // Try to eliminate fneg if at least 1 arm of the select is negated.
2876   Value *Cond;
2877   if (match(OneUse, m_Select(m_Value(Cond), m_Value(X), m_Value(Y)))) {
2878     // Unlike most transforms, this one is not safe to propagate nsz unless
2879     // it is present on the original select. We union the flags from the select
2880     // and fneg and then remove nsz if needed.
2881     auto propagateSelectFMF = [&](SelectInst *S, bool CommonOperand) {
2882       S->copyFastMathFlags(&I);
2883       if (auto *OldSel = dyn_cast<SelectInst>(Op)) {
2884         FastMathFlags FMF = I.getFastMathFlags() | OldSel->getFastMathFlags();
2885         S->setFastMathFlags(FMF);
2886         if (!OldSel->hasNoSignedZeros() && !CommonOperand &&
2887             !isGuaranteedNotToBeUndefOrPoison(OldSel->getCondition()))
2888           S->setHasNoSignedZeros(false);
2889       }
2890     };
2891     // -(Cond ? -P : Y) --> Cond ? P : -Y
2892     Value *P;
2893     if (match(X, m_FNeg(m_Value(P)))) {
2894       Value *NegY = Builder.CreateFNegFMF(Y, &I, Y->getName() + ".neg");
2895       SelectInst *NewSel = SelectInst::Create(Cond, P, NegY);
2896       propagateSelectFMF(NewSel, P == Y);
2897       return NewSel;
2898     }
2899     // -(Cond ? X : -P) --> Cond ? -X : P
2900     if (match(Y, m_FNeg(m_Value(P)))) {
2901       Value *NegX = Builder.CreateFNegFMF(X, &I, X->getName() + ".neg");
2902       SelectInst *NewSel = SelectInst::Create(Cond, NegX, P);
2903       propagateSelectFMF(NewSel, P == X);
2904       return NewSel;
2905     }
2906 
2907     // -(Cond ? X : C) --> Cond ? -X : -C
2908     // -(Cond ? C : Y) --> Cond ? -C : -Y
2909     if (match(X, m_ImmConstant()) || match(Y, m_ImmConstant())) {
2910       Value *NegX = Builder.CreateFNegFMF(X, &I, X->getName() + ".neg");
2911       Value *NegY = Builder.CreateFNegFMF(Y, &I, Y->getName() + ".neg");
2912       SelectInst *NewSel = SelectInst::Create(Cond, NegX, NegY);
2913       propagateSelectFMF(NewSel, /*CommonOperand=*/true);
2914       return NewSel;
2915     }
2916   }
2917 
2918   // fneg (copysign x, y) -> copysign x, (fneg y)
2919   if (match(OneUse, m_CopySign(m_Value(X), m_Value(Y)))) {
2920     // The source copysign has an additional value input, so we can't propagate
2921     // flags the copysign doesn't also have.
2922     FastMathFlags FMF = I.getFastMathFlags();
2923     FMF &= cast<FPMathOperator>(OneUse)->getFastMathFlags();
2924 
2925     IRBuilder<>::FastMathFlagGuard FMFGuard(Builder);
2926     Builder.setFastMathFlags(FMF);
2927 
2928     Value *NegY = Builder.CreateFNeg(Y);
2929     Value *NewCopySign = Builder.CreateCopySign(X, NegY);
2930     return replaceInstUsesWith(I, NewCopySign);
2931   }
2932 
2933   return nullptr;
2934 }
2935 
2936 Instruction *InstCombinerImpl::visitFSub(BinaryOperator &I) {
2937   if (Value *V = simplifyFSubInst(I.getOperand(0), I.getOperand(1),
2938                                   I.getFastMathFlags(),
2939                                   getSimplifyQuery().getWithInstruction(&I)))
2940     return replaceInstUsesWith(I, V);
2941 
2942   if (Instruction *X = foldVectorBinop(I))
2943     return X;
2944 
2945   if (Instruction *Phi = foldBinopWithPhiOperands(I))
2946     return Phi;
2947 
2948   // Subtraction from -0.0 is the canonical form of fneg.
2949   // fsub -0.0, X ==> fneg X
2950   // fsub nsz 0.0, X ==> fneg nsz X
2951   //
2952   // FIXME This matcher does not respect FTZ or DAZ yet:
2953   // fsub -0.0, Denorm ==> +-0
2954   // fneg Denorm ==> -Denorm
2955   Value *Op;
2956   if (match(&I, m_FNeg(m_Value(Op))))
2957     return UnaryOperator::CreateFNegFMF(Op, &I);
2958 
2959   if (Instruction *X = foldFNegIntoConstant(I, DL))
2960     return X;
2961 
2962   if (Instruction *R = foldFBinOpOfIntCasts(I))
2963     return R;
2964 
2965   Value *X, *Y;
2966   Constant *C;
2967 
2968   Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
2969   // If Op0 is not -0.0 or we can ignore -0.0: Z - (X - Y) --> Z + (Y - X)
2970   // Canonicalize to fadd to make analysis easier.
2971   // This can also help codegen because fadd is commutative.
2972   // Note that if this fsub was really an fneg, the fadd with -0.0 will get
2973   // killed later. We still limit that particular transform with 'hasOneUse'
2974   // because an fneg is assumed better/cheaper than a generic fsub.
2975   if (I.hasNoSignedZeros() ||
2976       cannotBeNegativeZero(Op0, 0, getSimplifyQuery().getWithInstruction(&I))) {
2977     if (match(Op1, m_OneUse(m_FSub(m_Value(X), m_Value(Y))))) {
2978       Value *NewSub = Builder.CreateFSubFMF(Y, X, &I);
2979       return BinaryOperator::CreateFAddFMF(Op0, NewSub, &I);
2980     }
2981   }
2982 
2983   // (-X) - Op1 --> -(X + Op1)
2984   if (I.hasNoSignedZeros() && !isa<ConstantExpr>(Op0) &&
2985       match(Op0, m_OneUse(m_FNeg(m_Value(X))))) {
2986     Value *FAdd = Builder.CreateFAddFMF(X, Op1, &I);
2987     return UnaryOperator::CreateFNegFMF(FAdd, &I);
2988   }
2989 
2990   if (isa<Constant>(Op0))
2991     if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
2992       if (Instruction *NV = FoldOpIntoSelect(I, SI))
2993         return NV;
2994 
2995   // X - C --> X + (-C)
2996   // But don't transform constant expressions because there's an inverse fold
2997   // for X + (-Y) --> X - Y.
2998   if (match(Op1, m_ImmConstant(C)))
2999     if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL))
3000       return BinaryOperator::CreateFAddFMF(Op0, NegC, &I);
3001 
3002   // X - (-Y) --> X + Y
3003   if (match(Op1, m_FNeg(m_Value(Y))))
3004     return BinaryOperator::CreateFAddFMF(Op0, Y, &I);
3005 
3006   // Similar to above, but look through a cast of the negated value:
3007   // X - (fptrunc(-Y)) --> X + fptrunc(Y)
3008   Type *Ty = I.getType();
3009   if (match(Op1, m_OneUse(m_FPTrunc(m_FNeg(m_Value(Y))))))
3010     return BinaryOperator::CreateFAddFMF(Op0, Builder.CreateFPTrunc(Y, Ty), &I);
3011 
3012   // X - (fpext(-Y)) --> X + fpext(Y)
3013   if (match(Op1, m_OneUse(m_FPExt(m_FNeg(m_Value(Y))))))
3014     return BinaryOperator::CreateFAddFMF(Op0, Builder.CreateFPExt(Y, Ty), &I);
3015 
3016   // Similar to above, but look through fmul/fdiv of the negated value:
3017   // Op0 - (-X * Y) --> Op0 + (X * Y)
3018   // Op0 - (Y * -X) --> Op0 + (X * Y)
3019   if (match(Op1, m_OneUse(m_c_FMul(m_FNeg(m_Value(X)), m_Value(Y))))) {
3020     Value *FMul = Builder.CreateFMulFMF(X, Y, &I);
3021     return BinaryOperator::CreateFAddFMF(Op0, FMul, &I);
3022   }
3023   // Op0 - (-X / Y) --> Op0 + (X / Y)
3024   // Op0 - (X / -Y) --> Op0 + (X / Y)
3025   if (match(Op1, m_OneUse(m_FDiv(m_FNeg(m_Value(X)), m_Value(Y)))) ||
3026       match(Op1, m_OneUse(m_FDiv(m_Value(X), m_FNeg(m_Value(Y)))))) {
3027     Value *FDiv = Builder.CreateFDivFMF(X, Y, &I);
3028     return BinaryOperator::CreateFAddFMF(Op0, FDiv, &I);
3029   }
3030 
3031   // Handle special cases for FSub with selects feeding the operation
3032   if (Value *V = SimplifySelectsFeedingBinaryOp(I, Op0, Op1))
3033     return replaceInstUsesWith(I, V);
3034 
3035   if (I.hasAllowReassoc() && I.hasNoSignedZeros()) {
3036     // (Y - X) - Y --> -X
3037     if (match(Op0, m_FSub(m_Specific(Op1), m_Value(X))))
3038       return UnaryOperator::CreateFNegFMF(X, &I);
3039 
3040     // Y - (X + Y) --> -X
3041     // Y - (Y + X) --> -X
3042     if (match(Op1, m_c_FAdd(m_Specific(Op0), m_Value(X))))
3043       return UnaryOperator::CreateFNegFMF(X, &I);
3044 
3045     // (X * C) - X --> X * (C - 1.0)
3046     if (match(Op0, m_FMul(m_Specific(Op1), m_Constant(C)))) {
3047       if (Constant *CSubOne = ConstantFoldBinaryOpOperands(
3048               Instruction::FSub, C, ConstantFP::get(Ty, 1.0), DL))
3049         return BinaryOperator::CreateFMulFMF(Op1, CSubOne, &I);
3050     }
3051     // X - (X * C) --> X * (1.0 - C)
3052     if (match(Op1, m_FMul(m_Specific(Op0), m_Constant(C)))) {
3053       if (Constant *OneSubC = ConstantFoldBinaryOpOperands(
3054               Instruction::FSub, ConstantFP::get(Ty, 1.0), C, DL))
3055         return BinaryOperator::CreateFMulFMF(Op0, OneSubC, &I);
3056     }
3057 
3058     // Reassociate fsub/fadd sequences to create more fadd instructions and
3059     // reduce dependency chains:
3060     // ((X - Y) + Z) - Op1 --> (X + Z) - (Y + Op1)
3061     Value *Z;
3062     if (match(Op0, m_OneUse(m_c_FAdd(m_OneUse(m_FSub(m_Value(X), m_Value(Y))),
3063                                      m_Value(Z))))) {
3064       Value *XZ = Builder.CreateFAddFMF(X, Z, &I);
3065       Value *YW = Builder.CreateFAddFMF(Y, Op1, &I);
3066       return BinaryOperator::CreateFSubFMF(XZ, YW, &I);
3067     }
3068 
3069     auto m_FaddRdx = [](Value *&Sum, Value *&Vec) {
3070       return m_OneUse(m_Intrinsic<Intrinsic::vector_reduce_fadd>(m_Value(Sum),
3071                                                                  m_Value(Vec)));
3072     };
3073     Value *A0, *A1, *V0, *V1;
3074     if (match(Op0, m_FaddRdx(A0, V0)) && match(Op1, m_FaddRdx(A1, V1)) &&
3075         V0->getType() == V1->getType()) {
3076       // Difference of sums is sum of differences:
3077       // add_rdx(A0, V0) - add_rdx(A1, V1) --> add_rdx(A0, V0 - V1) - A1
3078       Value *Sub = Builder.CreateFSubFMF(V0, V1, &I);
3079       Value *Rdx = Builder.CreateIntrinsic(Intrinsic::vector_reduce_fadd,
3080                                            {Sub->getType()}, {A0, Sub}, &I);
3081       return BinaryOperator::CreateFSubFMF(Rdx, A1, &I);
3082     }
3083 
3084     if (Instruction *F = factorizeFAddFSub(I, Builder))
3085       return F;
3086 
3087     // TODO: This performs reassociative folds for FP ops. Some fraction of the
3088     // functionality has been subsumed by simple pattern matching here and in
3089     // InstSimplify. We should let a dedicated reassociation pass handle more
3090     // complex pattern matching and remove this from InstCombine.
3091     if (Value *V = FAddCombine(Builder).simplify(&I))
3092       return replaceInstUsesWith(I, V);
3093 
3094     // (X - Y) - Op1 --> X - (Y + Op1)
3095     if (match(Op0, m_OneUse(m_FSub(m_Value(X), m_Value(Y))))) {
3096       Value *FAdd = Builder.CreateFAddFMF(Y, Op1, &I);
3097       return BinaryOperator::CreateFSubFMF(X, FAdd, &I);
3098     }
3099   }
3100 
3101   return nullptr;
3102 }
3103