LLVM 23.0.0git
InstCombineAddSub.cpp
Go to the documentation of this file.
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"
20#include "llvm/IR/Constant.h"
21#include "llvm/IR/Constants.h"
22#include "llvm/IR/InstrTypes.h"
23#include "llvm/IR/Instruction.h"
25#include "llvm/IR/Operator.h"
27#include "llvm/IR/Type.h"
28#include "llvm/IR/Value.h"
33#include <cassert>
34#include <utility>
35
36using namespace llvm;
37using namespace PatternMatch;
38
39#define DEBUG_TYPE "instcombine"
40
41namespace {
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
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
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
213 Instruction *Instr = nullptr;
214 };
215
216} // end anonymous namespace
217
218//===----------------------------------------------------------------------===//
219//
220// Implementation of
221// {FAddendCoef, FAddend, FAddition, FAddCombine}.
222//
223//===----------------------------------------------------------------------===//
224FAddendCoef::~FAddendCoef() {
225 if (BufHasFpVal)
226 getFpValPtr()->~APFloat();
227}
228
229void 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
242void 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
256APFloat 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
266void FAddendCoef::operator=(const FAddendCoef &That) {
267 if (That.isInt())
268 set(That.IntVal);
269 else
270 set(That.getFpVal());
271}
272
273void 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
294void 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
324void FAddendCoef::negate() {
325 if (isInt())
326 IntVal = 0 - IntVal;
327 else
328 getFpVal().changeSign();
329}
330
331Value *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
347unsigned 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>.
410unsigned 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
427Value *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
514Value *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
592Value *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
650Value *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
657Value *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
664Value *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
671Value *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
678void 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().
691unsigned 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.
723Value *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
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.
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,
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
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
864 return NV;
865
866 if (Instruction *FoldedLogic = foldBinOpSelectBinOp(Add))
867 return FoldedLogic;
868
869 Value *X;
870 Constant *Op00C;
871
872 // add (sub C1, X), C2 --> sub (add C1, C2), X
873 if (match(Op0, m_Sub(m_Constant(Op00C), m_Value(X))))
874 return BinaryOperator::CreateSub(ConstantExpr::getAdd(Op00C, Op1C), X);
875
876 Value *Y;
877
878 // add (sub X, Y), -1 --> add (not Y), X
879 if (match(Op0, m_OneUse(m_Sub(m_Value(X), m_Value(Y)))) &&
880 match(Op1, m_AllOnes()))
881 return BinaryOperator::CreateAdd(Builder.CreateNot(Y), X);
882
883 // zext(bool) + C -> bool ? C + 1 : C
884 if (match(Op0, m_ZExt(m_Value(X))) &&
885 X->getType()->getScalarSizeInBits() == 1)
886 return createSelectInstWithUnknownProfile(X, InstCombiner::AddOne(Op1C),
887 Op1);
888 // sext(bool) + C -> bool ? C - 1 : C
889 if (match(Op0, m_SExt(m_Value(X))) &&
890 X->getType()->getScalarSizeInBits() == 1)
891 return createSelectInstWithUnknownProfile(X, InstCombiner::SubOne(Op1C),
892 Op1);
893
894 // ~X + C --> (C-1) - X
895 if (match(Op0, m_Not(m_Value(X)))) {
896 // ~X + C has NSW and (C-1) won't oveflow => (C-1)-X can have NSW
897 auto *COne = ConstantInt::get(Op1C->getType(), 1);
898 bool WillNotSOV = willNotOverflowSignedSub(Op1C, COne, Add);
899 BinaryOperator *Res =
900 BinaryOperator::CreateSub(ConstantExpr::getSub(Op1C, COne), X);
901 Res->setHasNoSignedWrap(Add.hasNoSignedWrap() && WillNotSOV);
902 return Res;
903 }
904
905 // (iN X s>> (N - 1)) + 1 --> zext (X > -1)
906 const APInt *C;
907 unsigned BitWidth = Ty->getScalarSizeInBits();
908 if (match(Op0, m_OneUse(m_AShr(m_Value(X),
910 match(Op1, m_One()))
911 return new ZExtInst(Builder.CreateIsNotNeg(X, "isnotneg"), Ty);
912
913 if (!match(Op1, m_APInt(C)))
914 return nullptr;
915
916 // (X | Op01C) + Op1C --> X + (Op01C + Op1C) iff the `or` is actually an `add`
917 Constant *Op01C;
918 if (match(Op0, m_DisjointOr(m_Value(X), m_ImmConstant(Op01C)))) {
919 BinaryOperator *NewAdd =
920 BinaryOperator::CreateAdd(X, ConstantExpr::getAdd(Op01C, Op1C));
921 NewAdd->setHasNoSignedWrap(Add.hasNoSignedWrap() &&
922 willNotOverflowSignedAdd(Op01C, Op1C, Add));
923 NewAdd->setHasNoUnsignedWrap(Add.hasNoUnsignedWrap());
924 return NewAdd;
925 }
926
927 // (X | C2) + C --> (X | C2) ^ C2 iff (C2 == -C)
928 const APInt *C2;
929 if (match(Op0, m_Or(m_Value(), m_APInt(C2))) && *C2 == -*C)
930 return BinaryOperator::CreateXor(Op0, ConstantInt::get(Add.getType(), *C2));
931
932 if (C->isSignMask()) {
933 // If wrapping is not allowed, then the addition must set the sign bit:
934 // X + (signmask) --> X | signmask
935 if (Add.hasNoSignedWrap() || Add.hasNoUnsignedWrap())
936 return BinaryOperator::CreateOr(Op0, Op1);
937
938 // If wrapping is allowed, then the addition flips the sign bit of LHS:
939 // X + (signmask) --> X ^ signmask
940 return BinaryOperator::CreateXor(Op0, Op1);
941 }
942
943 // Is this add the last step in a convoluted sext?
944 // add(zext(xor i16 X, -32768), -32768) --> sext X
945 if (match(Op0, m_ZExt(m_Xor(m_Value(X), m_APInt(C2)))) &&
946 C2->isMinSignedValue() && C2->sext(Ty->getScalarSizeInBits()) == *C)
947 return CastInst::Create(Instruction::SExt, X, Ty);
948
949 if (match(Op0, m_Xor(m_Value(X), m_APInt(C2)))) {
950 // (X ^ signmask) + C --> (X + (signmask ^ C))
951 if (C2->isSignMask())
952 return BinaryOperator::CreateAdd(X, ConstantInt::get(Ty, *C2 ^ *C));
953
954 // If X has no high-bits set above an xor mask:
955 // add (xor X, LowMaskC), C --> sub (LowMaskC + C), X
956 if (C2->isMask()) {
957 KnownBits LHSKnown = computeKnownBits(X, &Add);
958 if ((*C2 | LHSKnown.Zero).isAllOnes())
959 return BinaryOperator::CreateSub(ConstantInt::get(Ty, *C2 + *C), X);
960 }
961
962 // Look for a math+logic pattern that corresponds to sext-in-register of a
963 // value with cleared high bits. Convert that into a pair of shifts:
964 // add (xor X, 0x80), 0xF..F80 --> (X << ShAmtC) >>s ShAmtC
965 // add (xor X, 0xF..F80), 0x80 --> (X << ShAmtC) >>s ShAmtC
966 if (Op0->hasOneUse() && *C2 == -(*C)) {
967 unsigned BitWidth = Ty->getScalarSizeInBits();
968 unsigned ShAmt = 0;
969 if (C->isPowerOf2())
970 ShAmt = BitWidth - C->logBase2() - 1;
971 else if (C2->isPowerOf2())
972 ShAmt = BitWidth - C2->logBase2() - 1;
973 if (ShAmt &&
975 Constant *ShAmtC = ConstantInt::get(Ty, ShAmt);
976 Value *NewShl = Builder.CreateShl(X, ShAmtC, "sext");
977 return BinaryOperator::CreateAShr(NewShl, ShAmtC);
978 }
979 }
980 }
981
982 if (C->isOne() && Op0->hasOneUse()) {
983 // add (sext i1 X), 1 --> zext (not X)
984 // TODO: The smallest IR representation is (select X, 0, 1), and that would
985 // not require the one-use check. But we need to remove a transform in
986 // visitSelect and make sure that IR value tracking for select is equal or
987 // better than for these ops.
988 if (match(Op0, m_SExt(m_Value(X))) &&
989 X->getType()->getScalarSizeInBits() == 1)
990 return new ZExtInst(Builder.CreateNot(X), Ty);
991
992 // Shifts and add used to flip and mask off the low bit:
993 // add (ashr (shl i32 X, 31), 31), 1 --> and (not X), 1
994 const APInt *C3;
995 if (match(Op0, m_AShr(m_Shl(m_Value(X), m_APInt(C2)), m_APInt(C3))) &&
996 C2 == C3 && *C2 == Ty->getScalarSizeInBits() - 1) {
997 Value *NotX = Builder.CreateNot(X);
998 return BinaryOperator::CreateAnd(NotX, ConstantInt::get(Ty, 1));
999 }
1000 }
1001
1002 // umax(X, C) + -C --> usub.sat(X, C)
1003 if (match(Op0, m_OneUse(m_UMax(m_Value(X), m_SpecificInt(-*C)))))
1004 return replaceInstUsesWith(
1005 Add, Builder.CreateBinaryIntrinsic(
1006 Intrinsic::usub_sat, X, ConstantInt::get(Add.getType(), -*C)));
1007
1008 // Fold (add (zext (add X, -C)), C) -> (zext X) if X u>= C.
1009 // Truncate C to the narrow type to avoid mismatched width comparisons.
1010 {
1011 const APInt *InnerC;
1012 if (match(Op0, m_ZExt(m_Add(m_Value(X), m_APIntAllowPoison(InnerC))))) {
1013 unsigned NarrowBW = InnerC->getBitWidth();
1014 if (C->isIntN(NarrowBW)) {
1015 APInt NarrowC = C->trunc(NarrowBW);
1016 const SimplifyQuery Q = SQ.getWithInstruction(&Add);
1017 if (*InnerC == -NarrowC &&
1018 (NarrowC.isOne()
1020 : computeKnownBits(X, &Add).getMinValue().uge(NarrowC)))
1021 return new ZExtInst(X, Ty);
1022 }
1023 }
1024 }
1025
1026 return nullptr;
1027}
1028
1029// match variations of a^2 + 2*a*b + b^2
1030//
1031// to reuse the code between the FP and Int versions, the instruction OpCodes
1032// and constant types have been turned into template parameters.
1033//
1034// Mul2Rhs: The constant to perform the multiplicative equivalent of X*2 with;
1035// should be `m_SpecificFP(2.0)` for FP and `m_SpecificInt(1)` for Int
1036// (we're matching `X<<1` instead of `X*2` for Int)
1037template <bool FP, typename Mul2Rhs>
1038static bool matchesSquareSum(BinaryOperator &I, Mul2Rhs M2Rhs, Value *&A,
1039 Value *&B) {
1040 constexpr unsigned MulOp = FP ? Instruction::FMul : Instruction::Mul;
1041 constexpr unsigned AddOp = FP ? Instruction::FAdd : Instruction::Add;
1042 constexpr unsigned Mul2Op = FP ? Instruction::FMul : Instruction::Shl;
1043
1044 // (a * a) + (((a * 2) + b) * b)
1045 if (match(&I, m_c_BinOp(
1046 AddOp, m_OneUse(m_BinOp(MulOp, m_Value(A), m_Deferred(A))),
1048 MulOp,
1049 m_c_BinOp(AddOp, m_BinOp(Mul2Op, m_Deferred(A), M2Rhs),
1050 m_Value(B)),
1051 m_Deferred(B))))))
1052 return true;
1053
1054 // ((a * b) * 2) or ((a * 2) * b)
1055 // +
1056 // (a * a + b * b) or (b * b + a * a)
1057 return match(
1058 &I, m_c_BinOp(
1059 AddOp,
1062 Mul2Op, m_BinOp(MulOp, m_Value(A), m_Value(B)), M2Rhs)),
1063 m_OneUse(m_c_BinOp(MulOp, m_BinOp(Mul2Op, m_Value(A), M2Rhs),
1064 m_Value(B)))),
1065 m_OneUse(
1066 m_c_BinOp(AddOp, m_BinOp(MulOp, m_Deferred(A), m_Deferred(A)),
1067 m_BinOp(MulOp, m_Deferred(B), m_Deferred(B))))));
1068}
1069
1070// Fold integer variations of a^2 + 2*a*b + b^2 -> (a + b)^2
1072 Value *A, *B;
1074 Value *AB = Builder.CreateAdd(A, B);
1075 return BinaryOperator::CreateMul(AB, AB);
1076 }
1077 return nullptr;
1078}
1079
1080// Fold floating point variations of a^2 + 2*a*b + b^2 -> (a + b)^2
1081// Requires `nsz` and `reassoc`.
1083 assert(I.hasAllowReassoc() && I.hasNoSignedZeros() && "Assumption mismatch");
1084 Value *A, *B;
1086 Value *AB = Builder.CreateFAddFMF(A, B, &I);
1087 return BinaryOperator::CreateFMulFMF(AB, AB, &I);
1088 }
1089 return nullptr;
1090}
1091
1092// Matches multiplication expression Op * C where C is a constant. Returns the
1093// constant value in C and the other operand in Op. Returns true if such a
1094// match is found.
1095static bool MatchMul(Value *E, Value *&Op, APInt &C) {
1096 const APInt *AI;
1097 if (match(E, m_Mul(m_Value(Op), m_APInt(AI)))) {
1098 C = *AI;
1099 return true;
1100 }
1101 if (match(E, m_Shl(m_Value(Op), m_APInt(AI)))) {
1102 C = APInt(AI->getBitWidth(), 1);
1103 C <<= *AI;
1104 return true;
1105 }
1106 return false;
1107}
1108
1109// Matches remainder expression Op % C where C is a constant. Returns the
1110// constant value in C and the other operand in Op. Returns the signedness of
1111// the remainder operation in IsSigned. Returns true if such a match is
1112// found.
1113static bool MatchRem(Value *E, Value *&Op, APInt &C, bool &IsSigned) {
1114 const APInt *AI;
1115 IsSigned = false;
1116 if (match(E, m_SRem(m_Value(Op), m_APInt(AI)))) {
1117 IsSigned = true;
1118 C = *AI;
1119 return true;
1120 }
1121 if (match(E, m_URem(m_Value(Op), m_APInt(AI)))) {
1122 C = *AI;
1123 return true;
1124 }
1125 if (match(E, m_And(m_Value(Op), m_APInt(AI))) && (*AI + 1).isPowerOf2()) {
1126 C = *AI + 1;
1127 return true;
1128 }
1129 return false;
1130}
1131
1132// Matches division expression Op / C with the given signedness as indicated
1133// by IsSigned, where C is a constant. Returns the constant value in C and the
1134// other operand in Op. Returns true if such a match is found.
1135static bool MatchDiv(Value *E, Value *&Op, APInt &C, bool IsSigned) {
1136 const APInt *AI;
1137 if (IsSigned && match(E, m_SDiv(m_Value(Op), m_APInt(AI)))) {
1138 C = *AI;
1139 return true;
1140 }
1141 if (!IsSigned) {
1142 if (match(E, m_UDiv(m_Value(Op), m_APInt(AI)))) {
1143 C = *AI;
1144 return true;
1145 }
1146 if (match(E, m_LShr(m_Value(Op), m_APInt(AI)))) {
1147 C = APInt(AI->getBitWidth(), 1);
1148 C <<= *AI;
1149 return true;
1150 }
1151 }
1152 return false;
1153}
1154
1155// Returns whether C0 * C1 with the given signedness overflows.
1156static bool MulWillOverflow(APInt &C0, APInt &C1, bool IsSigned) {
1157 bool overflow;
1158 if (IsSigned)
1159 (void)C0.smul_ov(C1, overflow);
1160 else
1161 (void)C0.umul_ov(C1, overflow);
1162 return overflow;
1163}
1164
1165// Simplifies X % C0 + (( X / C0 ) % C1) * C0 to X % (C0 * C1), where (C0 * C1)
1166// does not overflow.
1167// Simplifies (X / C0) * C1 + (X % C0) * C2 to
1168// (X / C0) * (C1 - C2 * C0) + X * C2
1170 Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
1171 Value *X, *MulOpV;
1172 APInt C0, MulOpC;
1173 bool IsSigned;
1174 // Match I = X % C0 + MulOpV * C0
1175 if (((MatchRem(LHS, X, C0, IsSigned) && MatchMul(RHS, MulOpV, MulOpC)) ||
1176 (MatchRem(RHS, X, C0, IsSigned) && MatchMul(LHS, MulOpV, MulOpC))) &&
1177 C0 == MulOpC) {
1178 Value *RemOpV;
1179 APInt C1;
1180 bool Rem2IsSigned;
1181 // Match MulOpC = RemOpV % C1
1182 if (MatchRem(MulOpV, RemOpV, C1, Rem2IsSigned) &&
1183 IsSigned == Rem2IsSigned) {
1184 Value *DivOpV;
1185 APInt DivOpC;
1186 // Match RemOpV = X / C0
1187 if (MatchDiv(RemOpV, DivOpV, DivOpC, IsSigned) && X == DivOpV &&
1188 C0 == DivOpC && !MulWillOverflow(C0, C1, IsSigned)) {
1189 Value *NewDivisor = ConstantInt::get(X->getType(), C0 * C1);
1190 return IsSigned ? Builder.CreateSRem(X, NewDivisor, "srem")
1191 : Builder.CreateURem(X, NewDivisor, "urem");
1192 }
1193 }
1194 }
1195
1196 // Match I = (X / C0) * C1 + (X % C0) * C2
1197 Value *Div, *Rem;
1198 APInt C1, C2;
1199 if (!LHS->hasOneUse() || !MatchMul(LHS, Div, C1))
1200 Div = LHS, C1 = APInt(I.getType()->getScalarSizeInBits(), 1);
1201 if (!RHS->hasOneUse() || !MatchMul(RHS, Rem, C2))
1202 Rem = RHS, C2 = APInt(I.getType()->getScalarSizeInBits(), 1);
1203 if (match(Div, m_IRem(m_Value(), m_Value()))) {
1204 std::swap(Div, Rem);
1205 std::swap(C1, C2);
1206 }
1207 Value *DivOpV;
1208 APInt DivOpC;
1209 if (MatchRem(Rem, X, C0, IsSigned) &&
1210 MatchDiv(Div, DivOpV, DivOpC, IsSigned) && X == DivOpV && C0 == DivOpC &&
1211 // Avoid unprofitable replacement of and with mul.
1212 !(C1.isOne() && !IsSigned && DivOpC.isPowerOf2() && DivOpC != 2)) {
1213 APInt NewC = C1 - C2 * C0;
1214 if (!NewC.isZero() && !Rem->hasOneUse())
1215 return nullptr;
1216 if (!isGuaranteedNotToBeUndef(X, &AC, &I, &DT))
1217 return nullptr;
1218 Value *MulXC2 = Builder.CreateMul(X, ConstantInt::get(X->getType(), C2));
1219 if (NewC.isZero())
1220 return MulXC2;
1221 return Builder.CreateAdd(
1222 Builder.CreateMul(Div, ConstantInt::get(X->getType(), NewC)), MulXC2);
1223 }
1224
1225 return nullptr;
1226}
1227
1228/// Fold
1229/// (1 << NBits) - 1
1230/// Into:
1231/// ~(-(1 << NBits))
1232/// Because a 'not' is better for bit-tracking analysis and other transforms
1233/// than an 'add'. The new shl is always nsw, and is nuw if old `and` was.
1235 InstCombiner::BuilderTy &Builder) {
1236 Value *NBits;
1237 if (!match(&I, m_Add(m_OneUse(m_Shl(m_One(), m_Value(NBits))), m_AllOnes())))
1238 return nullptr;
1239
1240 Constant *MinusOne = Constant::getAllOnesValue(NBits->getType());
1241 Value *NotMask = Builder.CreateShl(MinusOne, NBits, "notmask");
1242 // Be wary of constant folding.
1243 if (auto *BOp = dyn_cast<BinaryOperator>(NotMask)) {
1244 // Always NSW. But NUW propagates from `add`.
1245 BOp->setHasNoSignedWrap();
1246 BOp->setHasNoUnsignedWrap(I.hasNoUnsignedWrap());
1247 }
1248
1249 return BinaryOperator::CreateNot(NotMask, I.getName());
1250}
1251
1253 assert(I.getOpcode() == Instruction::Add && "Expecting add instruction");
1254 Type *Ty = I.getType();
1255 auto getUAddSat = [&]() {
1256 return Intrinsic::getOrInsertDeclaration(I.getModule(), Intrinsic::uadd_sat,
1257 Ty);
1258 };
1259
1260 // add (umin X, ~Y), Y --> uaddsat X, Y
1261 Value *X, *Y;
1263 m_Deferred(Y))))
1264 return CallInst::Create(getUAddSat(), { X, Y });
1265
1266 // add (umin X, ~C), C --> uaddsat X, C
1267 const APInt *C, *NotC;
1268 if (match(&I, m_Add(m_UMin(m_Value(X), m_APInt(NotC)), m_APInt(C))) &&
1269 *C == ~*NotC)
1270 return CallInst::Create(getUAddSat(), { X, ConstantInt::get(Ty, *C) });
1271
1272 return nullptr;
1273}
1274
1275// Transform:
1276// (add A, (shl (neg B), Y))
1277// -> (sub A, (shl B, Y))
1279 const BinaryOperator &I) {
1280 Value *A, *B, *Cnt;
1281 if (match(&I,
1283 m_Value(A)))) {
1284 Value *NewShl = Builder.CreateShl(B, Cnt);
1285 return BinaryOperator::CreateSub(A, NewShl);
1286 }
1287 return nullptr;
1288}
1289
1290/// Try to reduce signed division by power-of-2 to an arithmetic shift right.
1292 // Division must be by power-of-2, but not the minimum signed value.
1293 Value *X;
1294 const APInt *DivC;
1295 if (!match(Add.getOperand(0), m_SDiv(m_Value(X), m_Power2(DivC))) ||
1296 DivC->isNegative())
1297 return nullptr;
1298
1299 // Rounding is done by adding -1 if the dividend (X) is negative and has any
1300 // low bits set. It recognizes two canonical patterns:
1301 // 1. For an 'ugt' cmp with the signed minimum value (SMIN), the
1302 // pattern is: sext (icmp ugt (X & (DivC - 1)), SMIN).
1303 // 2. For an 'eq' cmp, the pattern's: sext (icmp eq X & (SMIN + 1), SMIN + 1).
1304 // Note that, by the time we end up here, if possible, ugt has been
1305 // canonicalized into eq.
1306 const APInt *MaskC, *MaskCCmp;
1307 CmpPredicate Pred;
1308 if (!match(Add.getOperand(1),
1309 m_SExt(m_ICmp(Pred, m_And(m_Specific(X), m_APInt(MaskC)),
1310 m_APInt(MaskCCmp)))))
1311 return nullptr;
1312
1313 if ((Pred != ICmpInst::ICMP_UGT || !MaskCCmp->isSignMask()) &&
1314 (Pred != ICmpInst::ICMP_EQ || *MaskCCmp != *MaskC))
1315 return nullptr;
1316
1317 APInt SMin = APInt::getSignedMinValue(Add.getType()->getScalarSizeInBits());
1318 bool IsMaskValid = Pred == ICmpInst::ICMP_UGT
1319 ? (*MaskC == (SMin | (*DivC - 1)))
1320 : (*DivC == 2 && *MaskC == SMin + 1);
1321 if (!IsMaskValid)
1322 return nullptr;
1323
1324 // (X / DivC) + sext ((X & (SMin | (DivC - 1)) >u SMin) --> X >>s log2(DivC)
1325 return BinaryOperator::CreateAShr(
1326 X, ConstantInt::get(Add.getType(), DivC->exactLogBase2()));
1327}
1328
1330 bool NSW, bool NUW) {
1331 Value *A, *B, *C;
1332 if (match(LHS, m_Sub(m_Value(A), m_Value(B))) &&
1333 match(RHS, m_Sub(m_Value(C), m_Specific(A)))) {
1334 Instruction *R = BinaryOperator::CreateSub(C, B);
1335 bool NSWOut = NSW && match(LHS, m_NSWSub(m_Value(), m_Value())) &&
1336 match(RHS, m_NSWSub(m_Value(), m_Value()));
1337
1338 bool NUWOut = match(LHS, m_NUWSub(m_Value(), m_Value())) &&
1339 match(RHS, m_NUWSub(m_Value(), m_Value()));
1340 R->setHasNoSignedWrap(NSWOut);
1341 R->setHasNoUnsignedWrap(NUWOut);
1342 return R;
1343 }
1344
1345 // ((X s/ C1) << C2) + X => X s% -C1 where -C1 is 1 << C2
1346 const APInt *C1, *C2;
1347 if (match(LHS, m_Shl(m_SDiv(m_Specific(RHS), m_APInt(C1)), m_APInt(C2)))) {
1348 APInt One(C2->getBitWidth(), 1);
1349 APInt MinusC1 = -(*C1);
1350 if (MinusC1 == (One << *C2)) {
1351 Constant *NewRHS = ConstantInt::get(RHS->getType(), MinusC1);
1352 return BinaryOperator::CreateSRem(RHS, NewRHS);
1353 }
1354 }
1355
1356 // (A + C) + (B & ~C) == A + (B | C)
1357 if (match(LHS, m_c_Add(m_Value(A), m_APInt(C1))) &&
1358 match(RHS, m_c_And(m_Value(B), m_SpecificInt(~*C1)))) {
1359 // Replacing one add with {or, add}. Avoid growth if both sides are shared.
1360 if (!LHS->hasOneUse() && !RHS->hasOneUse())
1361 return nullptr;
1362
1363 bool NSWOut = NSW && match(LHS, m_NSWAdd(m_Value(), m_Value()));
1364 bool NUWOut = NUW && match(LHS, m_NUWAdd(m_Value(), m_Value()));
1365 Value *NewOr =
1366 Builder.CreateOr(B, Constant::getIntegerValue(LHS->getType(), *C1));
1367 Instruction *NewAdd = BinaryOperator::CreateAdd(A, NewOr);
1368 NewAdd->setHasNoSignedWrap(NSWOut);
1369 NewAdd->setHasNoUnsignedWrap(NUWOut);
1370 return NewAdd;
1371 }
1372
1373 return nullptr;
1374}
1375
1378 BinaryOperator &I) {
1379 assert((I.getOpcode() == Instruction::Add ||
1380 I.getOpcode() == Instruction::Or ||
1381 I.getOpcode() == Instruction::Sub) &&
1382 "Expecting add/or/sub instruction");
1383
1384 // We have a subtraction/addition between a (potentially truncated) *logical*
1385 // right-shift of X and a "select".
1386 Value *X, *Select;
1387 Instruction *LowBitsToSkip, *Extract;
1389 Extract, m_LShr(m_Value(X),
1390 m_Instruction(LowBitsToSkip)))),
1391 m_Value(Select))))
1392 return nullptr;
1393
1394 // `add`/`or` is commutative; but for `sub`, "select" *must* be on RHS.
1395 if (I.getOpcode() == Instruction::Sub && I.getOperand(1) != Select)
1396 return nullptr;
1397
1398 Type *XTy = X->getType();
1399 bool HadTrunc = I.getType() != XTy;
1400
1401 // If there was a truncation of extracted value, then we'll need to produce
1402 // one extra instruction, so we need to ensure one instruction will go away.
1403 if (HadTrunc && !match(&I, m_c_BinOp(m_OneUse(m_Value()), m_Value())))
1404 return nullptr;
1405
1406 // Extraction should extract high NBits bits, with shift amount calculated as:
1407 // low bits to skip = shift bitwidth - high bits to extract
1408 // The shift amount itself may be extended, and we need to look past zero-ext
1409 // when matching NBits, that will matter for matching later.
1410 Value *NBits;
1411 if (!match(LowBitsToSkip,
1413 m_ZExtOrSelf(m_Value(NBits))))))
1414 return nullptr;
1415
1416 // Sign-extending value can be zero-extended if we `sub`tract it,
1417 // or sign-extended otherwise.
1418 auto SkipExtInMagic = [&I](Value *&V) {
1419 if (I.getOpcode() == Instruction::Sub)
1420 match(V, m_ZExtOrSelf(m_Value(V)));
1421 else
1422 match(V, m_SExtOrSelf(m_Value(V)));
1423 };
1424
1425 // Now, finally validate the sign-extending magic.
1426 // `select` itself may be appropriately extended, look past that.
1427 SkipExtInMagic(Select);
1428
1429 CmpPredicate Pred;
1430 const APInt *Thr;
1431 Value *SignExtendingValue, *Zero;
1432 bool ShouldSignext;
1433 // It must be a select between two values we will later establish to be a
1434 // sign-extending value and a zero constant. The condition guarding the
1435 // sign-extension must be based on a sign bit of the same X we had in `lshr`.
1436 if (!match(Select, m_Select(m_ICmp(Pred, m_Specific(X), m_APInt(Thr)),
1437 m_Value(SignExtendingValue), m_Value(Zero))) ||
1438 !isSignBitCheck(Pred, *Thr, ShouldSignext))
1439 return nullptr;
1440
1441 // icmp-select pair is commutative.
1442 if (!ShouldSignext)
1443 std::swap(SignExtendingValue, Zero);
1444
1445 // If we should not perform sign-extension then we must add/or/subtract zero.
1446 if (!match(Zero, m_Zero()))
1447 return nullptr;
1448 // Otherwise, it should be some constant, left-shifted by the same NBits we
1449 // had in `lshr`. Said left-shift can also be appropriately extended.
1450 // Again, we must look past zero-ext when looking for NBits.
1451 SkipExtInMagic(SignExtendingValue);
1452 Constant *SignExtendingValueBaseConstant;
1453 if (!match(SignExtendingValue,
1454 m_Shl(m_Constant(SignExtendingValueBaseConstant),
1455 m_ZExtOrSelf(m_Specific(NBits)))))
1456 return nullptr;
1457 // If we `sub`, then the constant should be one, else it should be all-ones.
1458 if (I.getOpcode() == Instruction::Sub
1459 ? !match(SignExtendingValueBaseConstant, m_One())
1460 : !match(SignExtendingValueBaseConstant, m_AllOnes()))
1461 return nullptr;
1462
1463 auto *NewAShr = BinaryOperator::CreateAShr(X, LowBitsToSkip,
1464 Extract->getName() + ".sext");
1465 NewAShr->copyIRFlags(Extract); // Preserve `exact`-ness.
1466 if (!HadTrunc)
1467 return NewAShr;
1468
1469 Builder.Insert(NewAShr);
1470 return TruncInst::CreateTruncOrBitCast(NewAShr, I.getType());
1471}
1472
1473/// This is a specialization of a more general transform from
1474/// foldUsingDistributiveLaws. If that code can be made to work optimally
1475/// for multi-use cases or propagating nsw/nuw, then we would not need this.
1477 InstCombiner::BuilderTy &Builder) {
1478 // TODO: Also handle mul by doubling the shift amount?
1479 assert((I.getOpcode() == Instruction::Add ||
1480 I.getOpcode() == Instruction::Sub) &&
1481 "Expected add/sub");
1482 auto *Op0 = dyn_cast<BinaryOperator>(I.getOperand(0));
1483 auto *Op1 = dyn_cast<BinaryOperator>(I.getOperand(1));
1484 if (!Op0 || !Op1 || !(Op0->hasOneUse() || Op1->hasOneUse()))
1485 return nullptr;
1486
1487 Value *X, *Y, *ShAmt;
1488 if (!match(Op0, m_Shl(m_Value(X), m_Value(ShAmt))) ||
1489 !match(Op1, m_Shl(m_Value(Y), m_Specific(ShAmt))))
1490 return nullptr;
1491
1492 // No-wrap propagates only when all ops have no-wrap.
1493 bool HasNSW = I.hasNoSignedWrap() && Op0->hasNoSignedWrap() &&
1494 Op1->hasNoSignedWrap();
1495 bool HasNUW = I.hasNoUnsignedWrap() && Op0->hasNoUnsignedWrap() &&
1496 Op1->hasNoUnsignedWrap();
1497
1498 // add/sub (X << ShAmt), (Y << ShAmt) --> (add/sub X, Y) << ShAmt
1499 Value *NewMath = Builder.CreateBinOp(I.getOpcode(), X, Y);
1500 if (auto *NewI = dyn_cast<BinaryOperator>(NewMath)) {
1501 NewI->setHasNoSignedWrap(HasNSW);
1502 NewI->setHasNoUnsignedWrap(HasNUW);
1503 }
1504 auto *NewShl = BinaryOperator::CreateShl(NewMath, ShAmt);
1505 NewShl->setHasNoSignedWrap(HasNSW);
1506 NewShl->setHasNoUnsignedWrap(HasNUW);
1507 return NewShl;
1508}
1509
1510/// Reduce a sequence of masked half-width multiplies to a single multiply.
1511/// ((XLow * YHigh) + (YLow * XHigh)) << HalfBits) + (XLow * YLow) --> X * Y
1513 unsigned BitWidth = I.getType()->getScalarSizeInBits();
1514 // Skip the odd bitwidth types.
1515 if ((BitWidth & 0x1))
1516 return nullptr;
1517
1518 unsigned HalfBits = BitWidth >> 1;
1519 APInt HalfMask = APInt::getMaxValue(HalfBits);
1520
1521 // ResLo = (CrossSum << HalfBits) + (YLo * XLo)
1522 Value *XLo, *YLo;
1523 Value *CrossSum;
1524 // Require one-use on the multiply to avoid increasing the number of
1525 // multiplications.
1526 if (!match(&I, m_c_Add(m_Shl(m_Value(CrossSum), m_SpecificInt(HalfBits)),
1527 m_OneUse(m_Mul(m_Value(YLo), m_Value(XLo))))))
1528 return nullptr;
1529
1530 // XLo = X & HalfMask
1531 // YLo = Y & HalfMask
1532 // TODO: Refactor with SimplifyDemandedBits or KnownBits known leading zeros
1533 // to enhance robustness
1534 Value *X, *Y;
1535 if (!match(XLo, m_And(m_Value(X), m_SpecificInt(HalfMask))) ||
1536 !match(YLo, m_And(m_Value(Y), m_SpecificInt(HalfMask))))
1537 return nullptr;
1538
1539 // CrossSum = (X' * (Y >> Halfbits)) + (Y' * (X >> HalfBits))
1540 // X' can be either X or XLo in the pattern (and the same for Y')
1541 if (match(CrossSum,
1546 return BinaryOperator::CreateMul(X, Y);
1547
1548 return nullptr;
1549}
1550
1551/// Return true if X + (Y-1) is provably non-wrapping in X's type
1552static bool checkDivCeilNUW(Value *X, Value *Y, const SimplifyQuery &SQ) {
1553 ConstantRange CRX = computeConstantRange(X, /*ForSigned=*/false, SQ);
1554 ConstantRange CRY = computeConstantRange(Y, /*ForSigned=*/false, SQ);
1555 APInt MinY = CRY.getUnsignedMin();
1556 APInt MaxX = CRX.getUnsignedMax();
1557 APInt MaxY = CRY.getUnsignedMax();
1558
1559 return !MinY.isZero() && !MaxX.ugt(-MaxY);
1560}
1561
1562/// Fold the div_ceil idiom in both forms:
1563/// add(udiv(X, Y), zext(icmp ne(urem(X, Y), 0)))
1564/// -> udiv(add nuw(X, Y - 1), Y)
1565/// add(zext(udiv(X, Y)), zext(icmp ne(urem(X, Y), 0)))
1566/// -> zext(udiv(add nuw(X, Y - 1), Y))
1567/// The zext form applies when udiv/urem operate in a narrower type than the
1568/// add.
1570 Value *X, *Y;
1571
1572 auto UDivPat = m_OneUse(m_UDiv(m_Value(X), m_Value(Y)));
1573 auto URemPat = m_OneUse(m_URem(m_Deferred(X), m_Deferred(Y)));
1574 auto ICmpPat = m_OneUse(m_SpecificICmp(ICmpInst::ICMP_NE, URemPat, m_Zero()));
1575 auto DivPat = m_OneUse(m_ZExtOrSelf(UDivPat));
1576 auto ZExtCmpPat = m_OneUse(m_ZExt(ICmpPat));
1577
1578 if (!match(&I, m_c_Add(DivPat, ZExtCmpPat)) || !checkDivCeilNUW(X, Y, SQ))
1579 return nullptr;
1580
1581 Value *YMinusOne =
1582 Builder.CreateAdd(Y, ConstantInt::getAllOnesValue(Y->getType()));
1583 Value *NUWAdd = Builder.CreateNUWAdd(X, YMinusOne);
1584 if (X->getType() != I.getType()) {
1585 Value *Div = Builder.CreateUDiv(NUWAdd, Y);
1586 return new ZExtInst(Div, I.getType());
1587 }
1588 return BinaryOperator::CreateUDiv(NUWAdd, Y);
1589}
1590
1592 if (Value *V = simplifyAddInst(I.getOperand(0), I.getOperand(1),
1593 I.hasNoSignedWrap(), I.hasNoUnsignedWrap(),
1594 SQ.getWithInstruction(&I)))
1595 return replaceInstUsesWith(I, V);
1596
1598 return &I;
1599
1601 return X;
1602
1604 return Phi;
1605
1606 // (A*B)+(A*C) -> A*(B+C) etc
1608 return replaceInstUsesWith(I, V);
1609
1610 if (Instruction *R = foldBoxMultiply(I))
1611 return R;
1612
1614 return R;
1615
1617 return X;
1618
1620 return X;
1621
1623 return R;
1624
1626 return R;
1627
1628 Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
1629 if (Instruction *R = foldAddLikeCommutative(LHS, RHS, I.hasNoSignedWrap(),
1630 I.hasNoUnsignedWrap()))
1631 return R;
1632 if (Instruction *R = foldAddLikeCommutative(RHS, LHS, I.hasNoSignedWrap(),
1633 I.hasNoUnsignedWrap()))
1634 return R;
1635 Type *Ty = I.getType();
1636 if (Ty->isIntOrIntVectorTy(1))
1637 return BinaryOperator::CreateXor(LHS, RHS);
1638
1639 // X + X --> X << 1
1640 if (LHS == RHS) {
1641 auto *Shl = BinaryOperator::CreateShl(LHS, ConstantInt::get(Ty, 1));
1642 Shl->setHasNoSignedWrap(I.hasNoSignedWrap());
1643 Shl->setHasNoUnsignedWrap(I.hasNoUnsignedWrap());
1644 return Shl;
1645 }
1646
1647 Value *A, *B;
1648 if (match(LHS, m_Neg(m_Value(A)))) {
1649 // -A + -B --> -(A + B)
1650 if (match(RHS, m_Neg(m_Value(B))))
1651 return BinaryOperator::CreateNeg(Builder.CreateAdd(A, B));
1652
1653 // -A + B --> B - A
1654 auto *Sub = BinaryOperator::CreateSub(RHS, A);
1655 auto *OB0 = cast<OverflowingBinaryOperator>(LHS);
1656 Sub->setHasNoSignedWrap(I.hasNoSignedWrap() && OB0->hasNoSignedWrap());
1657
1658 return Sub;
1659 }
1660
1661 // A + -B --> A - B
1662 if (match(RHS, m_Neg(m_Value(B)))) {
1663 auto *Sub = BinaryOperator::CreateSub(LHS, B);
1664 auto *OBO = cast<OverflowingBinaryOperator>(RHS);
1665 Sub->setHasNoSignedWrap(I.hasNoSignedWrap() && OBO->hasNoSignedWrap());
1666 return Sub;
1667 }
1668
1670 return replaceInstUsesWith(I, V);
1671
1672 // (A + 1) + ~B --> A - B
1673 // ~B + (A + 1) --> A - B
1674 // (~B + A) + 1 --> A - B
1675 // (A + ~B) + 1 --> A - B
1676 // This relies on the ~B == -1-B identity.
1677 if (match(&I, m_c_BinOp(m_Add(m_Value(A), m_One()), m_Not(m_Value(B)))) ||
1679 return BinaryOperator::CreateSub(A, B);
1680
1681 {
1682 // (A + C) + ~B --> A - B + (C-1)
1683 // ~B + (A + C) --> A - B + (C-1)
1684 // (~B + A) + C --> A - B + (C-1)
1685 // (A + ~B) + C --> A - B + (C-1)
1686 // With constant C, subtraction of one is free, so we replace three ops
1687 // (two adds and a bitwise-not) with two (sub and add).
1688 const APInt *C;
1690 m_Not(m_Value(B)))) ||
1692 m_APIntAllowPoison(C)))) {
1693 Value *Sub = Builder.CreateSub(A, B);
1694 return BinaryOperator::CreateAdd(Sub, ConstantInt::get(Ty, *C - 1));
1695 }
1696 }
1697
1698 // (A + RHS) + RHS --> A + (RHS << 1)
1699 if (match(LHS, m_OneUse(m_c_Add(m_Value(A), m_Specific(RHS)))))
1700 return BinaryOperator::CreateAdd(A, Builder.CreateShl(RHS, 1, "reass.add"));
1701
1702 // LHS + (A + LHS) --> A + (LHS << 1)
1703 if (match(RHS, m_OneUse(m_c_Add(m_Value(A), m_Specific(LHS)))))
1704 return BinaryOperator::CreateAdd(A, Builder.CreateShl(LHS, 1, "reass.add"));
1705
1706 {
1707 // (A + C1) + (C2 - B) --> (A - B) + (C1 + C2)
1708 Constant *C1, *C2;
1709 if (match(&I, m_c_Add(m_Add(m_Value(A), m_ImmConstant(C1)),
1710 m_Sub(m_ImmConstant(C2), m_Value(B)))) &&
1711 (LHS->hasOneUse() || RHS->hasOneUse())) {
1712 Value *Sub = Builder.CreateSub(A, B);
1713 return BinaryOperator::CreateAdd(Sub, ConstantExpr::getAdd(C1, C2));
1714 }
1715
1716 // Canonicalize a constant sub operand as an add operand for better folding:
1717 // (C1 - A) + B --> (B - A) + C1
1719 m_Value(B)))) {
1720 Value *Sub = Builder.CreateSub(B, A, "reass.sub");
1721 return BinaryOperator::CreateAdd(Sub, C1);
1722 }
1723 }
1724
1725 // X % C0 + (( X / C0 ) % C1) * C0 => X % (C0 * C1)
1727
1728 const APInt *C1;
1729 // (A & 2^C1) + A => A & (2^C1 - 1) iff bit C1 in A is a sign bit
1730 if (match(&I, m_c_Add(m_And(m_Value(A), m_APInt(C1)), m_Deferred(A))) &&
1731 C1->isPowerOf2() && (ComputeNumSignBits(A) > C1->countl_zero())) {
1732 Constant *NewMask = ConstantInt::get(RHS->getType(), *C1 - 1);
1733 return BinaryOperator::CreateAnd(A, NewMask);
1734 }
1735
1736 // ZExt (B - A) + ZExt(A) --> ZExt(B)
1737 if ((match(RHS, m_ZExt(m_Value(A))) &&
1738 match(LHS, m_ZExt(m_NUWSub(m_Value(B), m_Specific(A))))) ||
1739 (match(LHS, m_ZExt(m_Value(A))) &&
1741 return new ZExtInst(B, LHS->getType());
1742
1743 // zext(A) + sext(A) --> 0 if A is i1
1745 A->getType()->isIntOrIntVectorTy(1))
1746 return replaceInstUsesWith(I, Constant::getNullValue(I.getType()));
1747
1748 // sext(A < B) + zext(A > B) => ucmp/scmp(A, B)
1749 CmpPredicate LTPred, GTPred;
1750 if (match(&I,
1751 m_c_Add(m_SExt(m_c_ICmp(LTPred, m_Value(A), m_Value(B))),
1752 m_ZExt(m_c_ICmp(GTPred, m_Deferred(A), m_Deferred(B))))) &&
1753 A->getType()->isIntOrIntVectorTy()) {
1754 if (ICmpInst::isGT(LTPred)) {
1755 std::swap(LTPred, GTPred);
1756 std::swap(A, B);
1757 }
1758
1759 if (ICmpInst::isLT(LTPred) && ICmpInst::isGT(GTPred) &&
1760 ICmpInst::isSigned(LTPred) == ICmpInst::isSigned(GTPred))
1761 return replaceInstUsesWith(
1762 I, Builder.CreateIntrinsic(
1763 Ty,
1764 ICmpInst::isSigned(LTPred) ? Intrinsic::scmp : Intrinsic::ucmp,
1765 {A, B}));
1766 }
1767
1768 // A+B --> A|B iff A and B have no bits set in common.
1769 WithCache<const Value *> LHSCache(LHS), RHSCache(RHS);
1770 if (haveNoCommonBitsSet(LHSCache, RHSCache, SQ.getWithInstruction(&I)))
1771 return BinaryOperator::CreateDisjointOr(LHS, RHS);
1772
1773 if (Instruction *Ext = narrowMathIfNoOverflow(I))
1774 return Ext;
1775
1776 // (add (xor A, B) (and A, B)) --> (or A, B)
1777 // (add (and A, B) (xor A, B)) --> (or A, B)
1778 if (match(&I, m_c_BinOp(m_Xor(m_Value(A), m_Value(B)),
1780 return BinaryOperator::CreateOr(A, B);
1781
1782 // (add (or A, B) (and A, B)) --> (add A, B)
1783 // (add (and A, B) (or A, B)) --> (add A, B)
1784 if (match(&I, m_c_BinOp(m_Or(m_Value(A), m_Value(B)),
1786 // Replacing operands in-place to preserve nuw/nsw flags.
1787 replaceOperand(I, 0, A);
1788 replaceOperand(I, 1, B);
1789 return &I;
1790 }
1791
1792 // (add A (or A, -A)) --> (and (add A, -1) A)
1793 // (add A (or -A, A)) --> (and (add A, -1) A)
1794 // (add (or A, -A) A) --> (and (add A, -1) A)
1795 // (add (or -A, A) A) --> (and (add A, -1) A)
1797 m_Deferred(A)))))) {
1798 Value *Add =
1799 Builder.CreateAdd(A, Constant::getAllOnesValue(A->getType()), "",
1800 I.hasNoUnsignedWrap(), I.hasNoSignedWrap());
1801 return BinaryOperator::CreateAnd(Add, A);
1802 }
1803
1804 // Canonicalize ((A & -A) - 1) --> ((A - 1) & ~A)
1805 // Forms all commutable operations, and simplifies ctpop -> cttz folds.
1806 if (match(&I,
1808 m_AllOnes()))) {
1810 Value *Dec = Builder.CreateAdd(A, AllOnes);
1811 Value *Not = Builder.CreateXor(A, AllOnes);
1812 return BinaryOperator::CreateAnd(Dec, Not);
1813 }
1814
1815 // Disguised reassociation/factorization:
1816 // ~(A * C1) + A
1817 // ((A * -C1) - 1) + A
1818 // ((A * -C1) + A) - 1
1819 // (A * (1 - C1)) - 1
1820 if (match(&I,
1822 m_Deferred(A)))) {
1823 Type *Ty = I.getType();
1824 Constant *NewMulC = ConstantInt::get(Ty, 1 - *C1);
1825 Value *NewMul = Builder.CreateMul(A, NewMulC);
1826 return BinaryOperator::CreateAdd(NewMul, ConstantInt::getAllOnesValue(Ty));
1827 }
1828
1829 // (A * -2**C) + B --> B - (A << C)
1830 const APInt *NegPow2C;
1831 if (match(&I, m_c_Add(m_OneUse(m_Mul(m_Value(A), m_NegatedPower2(NegPow2C))),
1832 m_Value(B)))) {
1833 Constant *ShiftAmtC = ConstantInt::get(Ty, NegPow2C->countr_zero());
1834 Value *Shl = Builder.CreateShl(A, ShiftAmtC);
1835 return BinaryOperator::CreateSub(B, Shl);
1836 }
1837
1838 // Canonicalize signum variant that ends in add:
1839 // (A s>> (BW - 1)) + (zext (A s> 0)) --> (A s>> (BW - 1)) | (zext (A != 0))
1840 uint64_t BitWidth = Ty->getScalarSizeInBits();
1844 Value *NotZero = Builder.CreateIsNotNull(A, "isnotnull");
1845 Value *Zext = Builder.CreateZExt(NotZero, Ty, "isnotnull.zext");
1846 return BinaryOperator::CreateOr(LHS, Zext);
1847 }
1848
1849 {
1850 Value *Cond, *Ext;
1851 Constant *C;
1852 // (add X, (sext/zext (icmp eq X, C)))
1853 // -> (select (icmp eq X, C), (add C, (sext/zext 1)), X)
1854 auto CondMatcher =
1856 m_ImmConstant(C)));
1857
1858 if (match(&I,
1859 m_c_Add(m_Value(A), m_Value(Ext, m_ZExtOrSExt(CondMatcher)))) &&
1860 Ext->hasOneUse()) {
1863 return replaceInstUsesWith(I, Builder.CreateSelect(Cond, Add, A));
1864 }
1865 }
1866
1867 // (add (add A, 1), (sext (icmp ne A, 0))) => call umax(A, 1)
1868 if (match(LHS, m_Add(m_Value(A), m_One())) &&
1871 Value *OneConst = ConstantInt::get(A->getType(), 1);
1872 Value *UMax = Builder.CreateBinaryIntrinsic(Intrinsic::umax, A, OneConst);
1873 return replaceInstUsesWith(I, UMax);
1874 }
1875
1876 if (Instruction *Ashr = foldAddToAshr(I))
1877 return Ashr;
1878
1879 // Ceiling division by power-of-2:
1880 // (X >> log2(N)) + zext(X & (N-1) != 0) --> (X + (N-1)) >> log2(N)
1881 // This is valid when adding (N-1) to X doesn't overflow.
1882 {
1883 Value *X;
1884 const APInt *ShiftAmt, *Mask;
1885 CmpPredicate Pred;
1886
1887 // Match: (X >> C) + zext((X & Mask) != 0)
1888 // or: zext((X & Mask) != 0) + (X >> C)
1889 if (match(&I, m_c_Add(m_OneUse(m_LShr(m_Value(X), m_APInt(ShiftAmt))),
1892 m_And(m_Deferred(X), m_LowBitMask(Mask)),
1893 m_ZeroInt())))) &&
1894 Mask->popcount() == *ShiftAmt) {
1895
1896 // Check if X + Mask doesn't overflow
1897 Constant *MaskC = ConstantInt::get(X->getType(), *Mask);
1898 if (willNotOverflowUnsignedAdd(X, MaskC, I)) {
1899 // (X + Mask) >> ShiftAmt
1900 Value *Add = Builder.CreateNUWAdd(X, MaskC);
1901 return BinaryOperator::CreateLShr(
1902 Add, ConstantInt::get(X->getType(), *ShiftAmt));
1903 }
1904 }
1905 }
1906
1907 // (~X) + (~Y) --> -2 - (X + Y)
1908 {
1909 // To ensure we can save instructions we need to ensure that we consume both
1910 // LHS/RHS (i.e they have a `not`).
1911 bool ConsumesLHS, ConsumesRHS;
1912 if (isFreeToInvert(LHS, LHS->hasOneUse(), ConsumesLHS) && ConsumesLHS &&
1913 isFreeToInvert(RHS, RHS->hasOneUse(), ConsumesRHS) && ConsumesRHS) {
1914 Value *NotLHS = getFreelyInverted(LHS, LHS->hasOneUse(), &Builder);
1915 Value *NotRHS = getFreelyInverted(RHS, RHS->hasOneUse(), &Builder);
1916 assert(NotLHS != nullptr && NotRHS != nullptr &&
1917 "isFreeToInvert desynced with getFreelyInverted");
1918 Value *LHSPlusRHS = Builder.CreateAdd(NotLHS, NotRHS);
1919 return BinaryOperator::CreateSub(
1920 ConstantInt::getSigned(RHS->getType(), -2), LHSPlusRHS);
1921 }
1922 }
1923
1925 return R;
1926
1927 // TODO(jingyue): Consider willNotOverflowSignedAdd and
1928 // willNotOverflowUnsignedAdd to reduce the number of invocations of
1929 // computeKnownBits.
1930 bool Changed = false;
1931 if (!I.hasNoSignedWrap() && willNotOverflowSignedAdd(LHSCache, RHSCache, I)) {
1932 Changed = true;
1933 I.setHasNoSignedWrap(true);
1934 }
1935 if (!I.hasNoUnsignedWrap() &&
1936 willNotOverflowUnsignedAdd(LHSCache, RHSCache, I)) {
1937 Changed = true;
1938 I.setHasNoUnsignedWrap(true);
1939 }
1940
1942 return V;
1943
1944 if (Instruction *V =
1946 return V;
1947
1949 return SatAdd;
1950
1951 // usub.sat(A, B) + B => umax(A, B)
1952 if (match(&I, m_c_BinOp(
1954 m_Deferred(B)))) {
1955 return replaceInstUsesWith(I,
1956 Builder.CreateIntrinsic(Intrinsic::umax, {I.getType()}, {A, B}));
1957 }
1958
1959 // ctpop(A) + ctpop(B) => ctpop(A | B) if A and B have no bits set in common.
1962 haveNoCommonBitsSet(A, B, SQ.getWithInstruction(&I)))
1963 return replaceInstUsesWith(
1964 I, Builder.CreateIntrinsic(Intrinsic::ctpop, {I.getType()},
1965 {Builder.CreateOr(A, B)}));
1966
1967 // Fold the log2_ceil idiom:
1968 // zext(ctpop(A) >u/!= 1) + (ctlz(A, true) ^ (BW - 1))
1969 // -->
1970 // BW - ctlz(A - 1, false)
1971 const APInt *XorC;
1972 CmpPredicate Pred;
1973 if (match(&I,
1974 m_c_Add(
1976 m_One())),
1980 m_APInt(XorC))))))) &&
1981 (Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_NE) &&
1982 *XorC == A->getType()->getScalarSizeInBits() - 1) {
1983 Value *Sub = Builder.CreateAdd(A, Constant::getAllOnesValue(A->getType()));
1984 Value *Ctlz = Builder.CreateIntrinsic(Intrinsic::ctlz, {A->getType()},
1985 {Sub, Builder.getFalse()});
1986 Value *Ret = Builder.CreateSub(
1987 ConstantInt::get(A->getType(), A->getType()->getScalarSizeInBits()),
1988 Ctlz, "", /*HasNUW=*/true, /*HasNSW=*/true);
1989 return replaceInstUsesWith(I, Builder.CreateZExtOrTrunc(Ret, I.getType()));
1990 }
1991
1992 if (Instruction *Res = foldSquareSumInt(I))
1993 return Res;
1994
1995 if (Instruction *Res = foldBinOpOfDisplacedShifts(I))
1996 return Res;
1997
1999 return Res;
2000
2001 if (Instruction *Res = foldDivCeil(I))
2002 return Res;
2003
2004 // Re-enqueue users of the induction variable of add recurrence if we infer
2005 // new nuw/nsw flags.
2006 if (Changed) {
2007 PHINode *PHI;
2008 Value *Start, *Step;
2009 if (matchSimpleRecurrence(&I, PHI, Start, Step))
2010 Worklist.pushUsersToWorkList(*PHI);
2011 }
2012
2013 return Changed ? &I : nullptr;
2014}
2015
2016/// Eliminate an op from a linear interpolation (lerp) pattern.
2018 InstCombiner::BuilderTy &Builder) {
2019 Value *X, *Y, *Z;
2022 m_Value(Z))))),
2024 return nullptr;
2025
2026 // (Y * (1.0 - Z)) + (X * Z) --> Y + Z * (X - Y) [8 commuted variants]
2027 Value *XY = Builder.CreateFSubFMF(X, Y, &I);
2028 Value *MulZ = Builder.CreateFMulFMF(Z, XY, &I);
2029 return BinaryOperator::CreateFAddFMF(Y, MulZ, &I);
2030}
2031
2032/// Factor a common operand out of fadd/fsub of fmul/fdiv.
2034 InstCombiner::BuilderTy &Builder) {
2035 assert((I.getOpcode() == Instruction::FAdd ||
2036 I.getOpcode() == Instruction::FSub) && "Expecting fadd/fsub");
2037 assert(I.hasAllowReassoc() && I.hasNoSignedZeros() &&
2038 "FP factorization requires FMF");
2039
2040 if (Instruction *Lerp = factorizeLerp(I, Builder))
2041 return Lerp;
2042
2043 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
2044 if (!Op0->hasOneUse() || !Op1->hasOneUse())
2045 return nullptr;
2046
2047 Value *X, *Y, *Z;
2048 bool IsFMul;
2049 if ((match(Op0, m_FMul(m_Value(X), m_Value(Z))) &&
2050 match(Op1, m_c_FMul(m_Value(Y), m_Specific(Z)))) ||
2051 (match(Op0, m_FMul(m_Value(Z), m_Value(X))) &&
2052 match(Op1, m_c_FMul(m_Value(Y), m_Specific(Z)))))
2053 IsFMul = true;
2054 else if (match(Op0, m_FDiv(m_Value(X), m_Value(Z))) &&
2055 match(Op1, m_FDiv(m_Value(Y), m_Specific(Z))))
2056 IsFMul = false;
2057 else
2058 return nullptr;
2059
2060 // (X * Z) + (Y * Z) --> (X + Y) * Z
2061 // (X * Z) - (Y * Z) --> (X - Y) * Z
2062 // (X / Z) + (Y / Z) --> (X + Y) / Z
2063 // (X / Z) - (Y / Z) --> (X - Y) / Z
2064 bool IsFAdd = I.getOpcode() == Instruction::FAdd;
2065 Value *XY = IsFAdd ? Builder.CreateFAddFMF(X, Y, &I)
2066 : Builder.CreateFSubFMF(X, Y, &I);
2067
2068 // Bail out if we just created a denormal constant.
2069 // TODO: This is copied from a previous implementation. Is it necessary?
2070 const APFloat *C;
2071 if (match(XY, m_APFloat(C)) && !C->isNormal())
2072 return nullptr;
2073
2074 return IsFMul ? BinaryOperator::CreateFMulFMF(XY, Z, &I)
2076}
2077
2079 if (Value *V = simplifyFAddInst(I.getOperand(0), I.getOperand(1),
2080 I.getFastMathFlags(),
2081 SQ.getWithInstruction(&I)))
2082 return replaceInstUsesWith(I, V);
2083
2085 return &I;
2086
2088 return X;
2089
2091 return Phi;
2092
2093 if (Instruction *FoldedFAdd = foldBinOpIntoSelectOrPhi(I))
2094 return FoldedFAdd;
2095
2096 // B = fadd A, 0.0
2097 // Z = Op B
2098 // can be transformed into
2099 // Z = Op A
2100 // Where Op is such that we can ignore sign of 0 in fadd
2101 Value *A;
2102 if (match(&I, m_OneUse(m_FAdd(m_Value(A), m_AnyZeroFP()))) &&
2103 canIgnoreSignBitOfZero(*I.use_begin()))
2104 return replaceInstUsesWith(I, A);
2105
2106 // (-X) + Y --> Y - X
2107 Value *X, *Y;
2108 if (match(&I, m_c_FAdd(m_FNeg(m_Value(X)), m_Value(Y))))
2110
2111 // Similar to above, but look through fmul/fdiv for the negated term.
2112 // (-X * Y) + Z --> Z - (X * Y) [4 commuted variants]
2113 Value *Z;
2115 m_Value(Z)))) {
2116 Value *XY = Builder.CreateFMulFMF(X, Y, &I);
2117 return BinaryOperator::CreateFSubFMF(Z, XY, &I);
2118 }
2119 // (-X / Y) + Z --> Z - (X / Y) [2 commuted variants]
2120 // (X / -Y) + Z --> Z - (X / Y) [2 commuted variants]
2122 m_Value(Z))) ||
2124 m_Value(Z)))) {
2125 Value *XY = Builder.CreateFDivFMF(X, Y, &I);
2126 return BinaryOperator::CreateFSubFMF(Z, XY, &I);
2127 }
2128
2129 // Check for (fadd double (sitofp x), y), see if we can merge this into an
2130 // integer add followed by a promotion.
2131 if (Instruction *R = foldFBinOpOfIntCasts(I))
2132 return R;
2133
2134 Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
2135 // Handle specials cases for FAdd with selects feeding the operation
2136 if (Value *V = SimplifySelectsFeedingBinaryOp(I, LHS, RHS))
2137 return replaceInstUsesWith(I, V);
2138
2139 if (I.hasAllowReassoc() && I.hasNoSignedZeros()) {
2141 return F;
2142
2144 return F;
2145
2146 // Try to fold fadd into start value of reduction intrinsic.
2148 m_AnyZeroFP(), m_Value(X))),
2149 m_Value(Y)))) {
2150 // fadd (rdx 0.0, X), Y --> rdx Y, X
2151 return replaceInstUsesWith(
2152 I, Builder.CreateIntrinsic(Intrinsic::vector_reduce_fadd,
2153 {X->getType()}, {Y, X}, &I));
2154 }
2155 const APFloat *StartC, *C;
2157 m_APFloat(StartC), m_Value(X)))) &&
2158 match(RHS, m_APFloat(C))) {
2159 // fadd (rdx StartC, X), C --> rdx (C + StartC), X
2160 Constant *NewStartC = ConstantFP::get(I.getType(), *C + *StartC);
2161 return replaceInstUsesWith(
2162 I, Builder.CreateIntrinsic(Intrinsic::vector_reduce_fadd,
2163 {X->getType()}, {NewStartC, X}, &I));
2164 }
2165
2166 // (X * MulC) + X --> X * (MulC + 1.0)
2167 Constant *MulC;
2168 if (match(&I, m_c_FAdd(m_FMul(m_Value(X), m_ImmConstant(MulC)),
2169 m_Deferred(X)))) {
2171 Instruction::FAdd, MulC, ConstantFP::get(I.getType(), 1.0), DL))
2172 return BinaryOperator::CreateFMulFMF(X, NewMulC, &I);
2173 }
2174
2175 // (-X - Y) + (X + Z) --> Z - Y
2177 m_c_FAdd(m_Deferred(X), m_Value(Z)))))
2178 return BinaryOperator::CreateFSubFMF(Z, Y, &I);
2179
2180 if (Value *V = FAddCombine(Builder).simplify(&I))
2181 return replaceInstUsesWith(I, V);
2182 }
2183
2184 // minumum(X, Y) + maximum(X, Y) => X + Y.
2185 if (match(&I,
2188 m_Deferred(Y))))) {
2190 // We cannot preserve ninf if nnan flag is not set.
2191 // If X is NaN and Y is Inf then in original program we had NaN + NaN,
2192 // while in optimized version NaN + Inf and this is a poison with ninf flag.
2193 if (!Result->hasNoNaNs())
2194 Result->setHasNoInfs(false);
2195 return Result;
2196 }
2197
2198 return nullptr;
2199}
2200
2203
2204 if (LHS->getType() != RHS->getType())
2205 return Base;
2206
2207 // Collect all base pointers of LHS.
2209 Value *Ptr = LHS;
2210 while (true) {
2211 Ptrs.insert(Ptr);
2212 if (auto *GEP = dyn_cast<GEPOperator>(Ptr))
2213 Ptr = GEP->getPointerOperand();
2214 else
2215 break;
2216 }
2217
2218 // Find common base and collect RHS GEPs.
2219 bool First = true;
2220 while (true) {
2221 if (Ptrs.contains(RHS)) {
2222 Base.Ptr = RHS;
2223 break;
2224 }
2225
2226 if (auto *GEP = dyn_cast<GEPOperator>(RHS)) {
2227 Base.RHSGEPs.push_back(GEP);
2228 if (First) {
2229 First = false;
2230 Base.RHSNW = GEP->getNoWrapFlags();
2231 } else {
2232 Base.RHSNW = Base.RHSNW.intersectForOffsetAdd(GEP->getNoWrapFlags());
2233 }
2234 RHS = GEP->getPointerOperand();
2235 } else {
2236 // No common base.
2237 return Base;
2238 }
2239 }
2240
2241 // Collect LHS GEPs.
2242 First = true;
2243 while (true) {
2244 if (LHS == Base.Ptr)
2245 break;
2246
2247 auto *GEP = cast<GEPOperator>(LHS);
2248 Base.LHSGEPs.push_back(GEP);
2249 if (First) {
2250 First = false;
2251 Base.LHSNW = GEP->getNoWrapFlags();
2252 } else {
2253 Base.LHSNW = Base.LHSNW.intersectForOffsetAdd(GEP->getNoWrapFlags());
2254 }
2255 LHS = GEP->getPointerOperand();
2256 }
2257
2258 return Base;
2259}
2260
2262 unsigned NumGEPs = 0;
2263 auto ProcessGEPs = [&NumGEPs](ArrayRef<GEPOperator *> GEPs) {
2264 bool SeenMultiUse = false;
2265 for (GEPOperator *GEP : GEPs) {
2266 // Only count multi-use GEPs, excluding the first one. For the first one,
2267 // we will directly reuse the offset. For one-use GEPs, their offset will
2268 // be folded into a multi-use GEP.
2269 if (!GEP->hasOneUse()) {
2270 if (SeenMultiUse)
2271 ++NumGEPs;
2272 SeenMultiUse = true;
2273 }
2274 }
2275 };
2276 ProcessGEPs(LHSGEPs);
2277 ProcessGEPs(RHSGEPs);
2278 return NumGEPs > 2;
2279}
2280
2281/// Optimize pointer differences into the same array into a size. Consider:
2282/// &A[10] - &A[0]: we should compile this to "10". LHS/RHS are the pointer
2283/// operands to the ptrtoint instructions for the LHS/RHS of the subtract.
2285 Type *Ty, bool IsNUW) {
2287 if (!Base.Ptr || Base.isExpensive())
2288 return nullptr;
2289
2290 // To avoid duplicating the offset arithmetic, rewrite the GEP to use the
2291 // computed offset.
2292 // TODO: We should probably do this even if there is only one GEP.
2293 bool RewriteGEPs = !Base.LHSGEPs.empty() && !Base.RHSGEPs.empty();
2294
2295 Type *IdxTy = DL.getIndexType(LHS->getType());
2296 Value *Result = EmitGEPOffsets(Base.LHSGEPs, Base.LHSNW, IdxTy, RewriteGEPs);
2297 Value *Offset2 = EmitGEPOffsets(Base.RHSGEPs, Base.RHSNW, IdxTy, RewriteGEPs);
2298
2299 // If this is a single inbounds GEP and the original sub was nuw,
2300 // then the final multiplication is also nuw.
2301 if (auto *I = dyn_cast<OverflowingBinaryOperator>(Result))
2302 if (IsNUW && match(Offset2, m_Zero()) && Base.LHSNW.isInBounds() &&
2303 (I->use_empty() || I->hasOneUse()) && I->hasNoSignedWrap() &&
2304 !I->hasNoUnsignedWrap() &&
2305 ((I->getOpcode() == Instruction::Mul &&
2306 match(I->getOperand(1), m_NonNegative())) ||
2307 I->getOpcode() == Instruction::Shl))
2308 cast<Instruction>(I)->setHasNoUnsignedWrap();
2309
2310 // If we have a 2nd GEP of the same base pointer, subtract the offsets.
2311 // If both GEPs are inbounds, then the subtract does not have signed overflow.
2312 // If both GEPs are nuw and the original sub is nuw, the new sub is also nuw.
2313 if (!match(Offset2, m_Zero())) {
2314 Result =
2315 Builder.CreateSub(Result, Offset2, "gepdiff",
2316 IsNUW && Base.LHSNW.hasNoUnsignedWrap() &&
2317 Base.RHSNW.hasNoUnsignedWrap(),
2318 Base.LHSNW.isInBounds() && Base.RHSNW.isInBounds());
2319 }
2320
2321 return Builder.CreateIntCast(Result, Ty, true);
2322}
2323
2325 InstCombiner::BuilderTy &Builder) {
2326 Value *Op0 = I.getOperand(0);
2327 Value *Op1 = I.getOperand(1);
2328 Type *Ty = I.getType();
2329 auto *MinMax = dyn_cast<MinMaxIntrinsic>(Op1);
2330 if (!MinMax)
2331 return nullptr;
2332
2333 // sub(add(X,Y), s/umin(X,Y)) --> s/umax(X,Y)
2334 // sub(add(X,Y), s/umax(X,Y)) --> s/umin(X,Y)
2335 Value *X = MinMax->getLHS();
2336 Value *Y = MinMax->getRHS();
2337 if (match(Op0, m_c_Add(m_Specific(X), m_Specific(Y))) &&
2338 (Op0->hasOneUse() || Op1->hasOneUse())) {
2339 Intrinsic::ID InvID = getInverseMinMaxIntrinsic(MinMax->getIntrinsicID());
2340 Function *F = Intrinsic::getOrInsertDeclaration(I.getModule(), InvID, Ty);
2341 return CallInst::Create(F, {X, Y});
2342 }
2343
2344 // sub(add(X,Y),umin(Y,Z)) --> add(X,usub.sat(Y,Z))
2345 // sub(add(X,Z),umin(Y,Z)) --> add(X,usub.sat(Z,Y))
2346 Value *Z;
2347 if (match(Op1, m_OneUse(m_UMin(m_Value(Y), m_Value(Z))))) {
2348 if (match(Op0, m_OneUse(m_c_Add(m_Specific(Y), m_Value(X))))) {
2349 Value *USub = Builder.CreateIntrinsic(Intrinsic::usub_sat, Ty, {Y, Z});
2350 return BinaryOperator::CreateAdd(X, USub);
2351 }
2352 if (match(Op0, m_OneUse(m_c_Add(m_Specific(Z), m_Value(X))))) {
2353 Value *USub = Builder.CreateIntrinsic(Intrinsic::usub_sat, Ty, {Z, Y});
2354 return BinaryOperator::CreateAdd(X, USub);
2355 }
2356 }
2357
2358 // sub Op0, smin((sub nsw Op0, Z), 0) --> smax Op0, Z
2359 // sub Op0, smax((sub nsw Op0, Z), 0) --> smin Op0, Z
2360 if (MinMax->isSigned() && match(Y, m_ZeroInt()) &&
2361 match(X, m_NSWSub(m_Specific(Op0), m_Value(Z)))) {
2362 Intrinsic::ID InvID = getInverseMinMaxIntrinsic(MinMax->getIntrinsicID());
2363 Function *F = Intrinsic::getOrInsertDeclaration(I.getModule(), InvID, Ty);
2364 return CallInst::Create(F, {Op0, Z});
2365 }
2366
2367 return nullptr;
2368}
2369
2371 if (Value *V = simplifySubInst(I.getOperand(0), I.getOperand(1),
2372 I.hasNoSignedWrap(), I.hasNoUnsignedWrap(),
2373 SQ.getWithInstruction(&I)))
2374 return replaceInstUsesWith(I, V);
2375
2377 return X;
2378
2380 return Phi;
2381
2382 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
2383
2384 // If this is a 'B = x-(-A)', change to B = x+A.
2385 // We deal with this without involving Negator to preserve NSW flag.
2386 if (Value *V = dyn_castNegVal(Op1)) {
2387 BinaryOperator *Res = BinaryOperator::CreateAdd(Op0, V);
2388
2389 if (const auto *BO = dyn_cast<BinaryOperator>(Op1)) {
2390 assert(BO->getOpcode() == Instruction::Sub &&
2391 "Expected a subtraction operator!");
2392 if (BO->hasNoSignedWrap() && I.hasNoSignedWrap())
2393 Res->setHasNoSignedWrap(true);
2394 } else {
2395 if (cast<Constant>(Op1)->isNotMinSignedValue() && I.hasNoSignedWrap())
2396 Res->setHasNoSignedWrap(true);
2397 }
2398
2399 return Res;
2400 }
2401
2402 // Try this before Negator to preserve NSW flag.
2404 return R;
2405
2406 Constant *C;
2407 if (match(Op0, m_ImmConstant(C))) {
2408 Value *X;
2409 Constant *C2;
2410
2411 // C-(X+C2) --> (C-C2)-X
2412 if (match(Op1, m_AddLike(m_Value(X), m_ImmConstant(C2)))) {
2413 // C-C2 never overflow, and C-(X+C2), (X+C2) has NSW/NUW
2414 // => (C-C2)-X can have NSW/NUW
2415 bool WillNotSOV = willNotOverflowSignedSub(C, C2, I);
2416 BinaryOperator *Res =
2417 BinaryOperator::CreateSub(ConstantExpr::getSub(C, C2), X);
2418
2419 // or disjoint is equivalent to add nuw nsw.
2420 bool Op1NSW = true;
2421 bool Op1NUW = true;
2422
2423 if (auto *OBO1 = dyn_cast<OverflowingBinaryOperator>(Op1)) {
2424 Op1NSW = OBO1->hasNoSignedWrap();
2425 Op1NUW = OBO1->hasNoUnsignedWrap();
2426 }
2427
2428 Res->setHasNoSignedWrap(I.hasNoSignedWrap() && Op1NSW && WillNotSOV);
2429 Res->setHasNoUnsignedWrap(I.hasNoUnsignedWrap() && Op1NUW);
2430 return Res;
2431 }
2432 }
2433
2434 auto TryToNarrowDeduceFlags = [this, &I, &Op0, &Op1]() -> Instruction * {
2435 if (Instruction *Ext = narrowMathIfNoOverflow(I))
2436 return Ext;
2437
2438 bool Changed = false;
2439 if (!I.hasNoSignedWrap() && willNotOverflowSignedSub(Op0, Op1, I)) {
2440 Changed = true;
2441 I.setHasNoSignedWrap(true);
2442 }
2443 if (!I.hasNoUnsignedWrap() && willNotOverflowUnsignedSub(Op0, Op1, I)) {
2444 Changed = true;
2445 I.setHasNoUnsignedWrap(true);
2446 }
2447
2448 return Changed ? &I : nullptr;
2449 };
2450
2451 // First, let's try to interpret `sub a, b` as `add a, (sub 0, b)`,
2452 // and let's try to sink `(sub 0, b)` into `b` itself. But only if this isn't
2453 // a pure negation used by a select that looks like abs/nabs.
2454 bool IsNegation = match(Op0, m_ZeroInt());
2455 if (!IsNegation || none_of(I.users(), match_fn(m_c_Select(m_Specific(Op1),
2456 m_Specific(&I))))) {
2457 if (Value *NegOp1 = Negator::Negate(IsNegation, /* IsNSW */ IsNegation &&
2458 I.hasNoSignedWrap(),
2459 Op1, *this))
2460 return BinaryOperator::CreateAdd(NegOp1, Op0);
2461 }
2462 if (IsNegation)
2463 return TryToNarrowDeduceFlags(); // Should have been handled in Negator!
2464
2465 // (A*B)-(A*C) -> A*(B-C) etc
2467 return replaceInstUsesWith(I, V);
2468
2469 if (I.getType()->isIntOrIntVectorTy(1))
2470 return BinaryOperator::CreateXor(Op0, Op1);
2471
2472 // Replace (-1 - A) with (~A).
2473 if (match(Op0, m_AllOnes()))
2474 return BinaryOperator::CreateNot(Op1);
2475
2476 // (X + -1) - Y --> ~Y + X
2477 Value *X, *Y;
2478 if (match(Op0, m_OneUse(m_Add(m_Value(X), m_AllOnes()))))
2479 return BinaryOperator::CreateAdd(Builder.CreateNot(Op1), X);
2480
2481 // if (C1 & C2) == C2 then (X & C1) - (X & C2) -> X & (C1 ^ C2)
2482 Constant *C1, *C2;
2483 if (match(Op0, m_And(m_Value(X), m_ImmConstant(C1))) &&
2484 match(Op1, m_And(m_Specific(X), m_ImmConstant(C2)))) {
2485 Value *AndC = ConstantFoldBinaryInstruction(Instruction::And, C1, C2);
2486 if (C2->isElementWiseEqual(AndC))
2487 return BinaryOperator::CreateAnd(
2488 X, ConstantFoldBinaryInstruction(Instruction::Xor, C1, C2));
2489 }
2490
2491 // Reassociate sub/add sequences to create more add instructions and
2492 // reduce dependency chains:
2493 // ((X - Y) + Z) - Op1 --> (X + Z) - (Y + Op1)
2494 Value *Z;
2496 m_Value(Z))))) {
2497 Value *XZ = Builder.CreateAdd(X, Z);
2498 Value *YW = Builder.CreateAdd(Y, Op1);
2499 return BinaryOperator::CreateSub(XZ, YW);
2500 }
2501
2502 // ((X - Y) - Op1) --> X - (Y + Op1)
2503 if (match(Op0, m_OneUse(m_Sub(m_Value(X), m_Value(Y))))) {
2505 bool HasNUW = I.hasNoUnsignedWrap() && LHSSub->hasNoUnsignedWrap();
2506 bool HasNSW = HasNUW && I.hasNoSignedWrap() && LHSSub->hasNoSignedWrap();
2507 Value *Add = Builder.CreateAdd(Y, Op1, "", /*HasNUW=*/HasNUW,
2508 /*HasNSW=*/HasNSW);
2509 BinaryOperator *Sub = BinaryOperator::CreateSub(X, Add);
2510 Sub->setHasNoUnsignedWrap(HasNUW);
2511 Sub->setHasNoSignedWrap(HasNSW);
2512 return Sub;
2513 }
2514
2515 {
2516 // (X + Z) - (Y + Z) --> (X - Y)
2517 // This is done in other passes, but we want to be able to consume this
2518 // pattern in InstCombine so we can generate it without creating infinite
2519 // loops.
2520 if (match(Op0, m_Add(m_Value(X), m_Value(Z))) &&
2521 match(Op1, m_c_Add(m_Value(Y), m_Specific(Z))))
2522 return BinaryOperator::CreateSub(X, Y);
2523
2524 // (X + C0) - (Y + C1) --> (X - Y) + (C0 - C1)
2525 Constant *CX, *CY;
2526 if (match(Op0, m_OneUse(m_Add(m_Value(X), m_ImmConstant(CX)))) &&
2527 match(Op1, m_OneUse(m_Add(m_Value(Y), m_ImmConstant(CY))))) {
2528 Value *OpsSub = Builder.CreateSub(X, Y);
2529 Constant *ConstsSub = ConstantExpr::getSub(CX, CY);
2530 return BinaryOperator::CreateAdd(OpsSub, ConstsSub);
2531 }
2532 }
2533
2534 {
2535 Value *W, *Z;
2536 if (match(Op0, m_AddLike(m_Value(W), m_Value(X))) &&
2537 match(Op1, m_AddLike(m_Value(Y), m_Value(Z)))) {
2538 Instruction *R = nullptr;
2539 if (W == Y)
2540 R = BinaryOperator::CreateSub(X, Z);
2541 else if (W == Z)
2542 R = BinaryOperator::CreateSub(X, Y);
2543 else if (X == Y)
2544 R = BinaryOperator::CreateSub(W, Z);
2545 else if (X == Z)
2546 R = BinaryOperator::CreateSub(W, Y);
2547 if (R) {
2548 bool NSW = I.hasNoSignedWrap() &&
2549 match(Op0, m_NSWAddLike(m_Value(), m_Value())) &&
2550 match(Op1, m_NSWAddLike(m_Value(), m_Value()));
2551
2552 bool NUW = I.hasNoUnsignedWrap() &&
2553 match(Op1, m_NUWAddLike(m_Value(), m_Value()));
2554 R->setHasNoSignedWrap(NSW);
2555 R->setHasNoUnsignedWrap(NUW);
2556 return R;
2557 }
2558 }
2559 }
2560
2561 // (~X) - (~Y) --> Y - X
2562 {
2563 // Need to ensure we can consume at least one of the `not` instructions,
2564 // otherwise this can inf loop.
2565 bool ConsumesOp0, ConsumesOp1;
2566 if (isFreeToInvert(Op0, Op0->hasOneUse(), ConsumesOp0) &&
2567 isFreeToInvert(Op1, Op1->hasOneUse(), ConsumesOp1) &&
2568 (ConsumesOp0 || ConsumesOp1)) {
2569 Value *NotOp0 = getFreelyInverted(Op0, Op0->hasOneUse(), &Builder);
2570 Value *NotOp1 = getFreelyInverted(Op1, Op1->hasOneUse(), &Builder);
2571 assert(NotOp0 != nullptr && NotOp1 != nullptr &&
2572 "isFreeToInvert desynced with getFreelyInverted");
2573 return BinaryOperator::CreateSub(NotOp1, NotOp0);
2574 }
2575 }
2576
2577 auto m_AddRdx = [](Value *&Vec) {
2579 };
2580 Value *V0, *V1;
2581 if (match(Op0, m_AddRdx(V0)) && match(Op1, m_AddRdx(V1)) &&
2582 V0->getType() == V1->getType()) {
2583 // Difference of sums is sum of differences:
2584 // add_rdx(V0) - add_rdx(V1) --> add_rdx(V0 - V1)
2585 Value *Sub = Builder.CreateSub(V0, V1);
2586 Value *Rdx = Builder.CreateIntrinsic(Intrinsic::vector_reduce_add,
2587 {Sub->getType()}, {Sub});
2588 return replaceInstUsesWith(I, Rdx);
2589 }
2590
2591 if (Constant *C = dyn_cast<Constant>(Op0)) {
2592 Value *X;
2593 if (match(Op1, m_ZExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
2594 // C - (zext bool) --> bool ? C - 1 : C
2596 if (match(Op1, m_SExt(m_Value(X))) && X->getType()->isIntOrIntVectorTy(1))
2597 // C - (sext bool) --> bool ? C + 1 : C
2599
2600 // C - ~X == X + (1+C)
2601 if (match(Op1, m_Not(m_Value(X))))
2602 return BinaryOperator::CreateAdd(X, InstCombiner::AddOne(C));
2603
2604 // Try to fold constant sub into select arguments.
2606 if (Instruction *R = FoldOpIntoSelect(I, SI))
2607 return R;
2608
2609 // Try to fold constant sub into PHI values.
2610 if (PHINode *PN = dyn_cast<PHINode>(Op1))
2611 if (Instruction *R = foldOpIntoPhi(I, PN))
2612 return R;
2613
2614 Constant *C2;
2615
2616 // C-(C2-X) --> X+(C-C2)
2617 if (match(Op1, m_Sub(m_ImmConstant(C2), m_Value(X))))
2618 return BinaryOperator::CreateAdd(X, ConstantExpr::getSub(C, C2));
2619 }
2620
2621 const APInt *Op0C;
2622 if (match(Op0, m_APInt(Op0C))) {
2623 if (Op0C->isMask()) {
2624 // Turn this into a xor if LHS is 2^n-1 and the remaining bits are known
2625 // zero. We don't use information from dominating conditions so this
2626 // transform is easier to reverse if necessary.
2628 Op1, SQ.getWithInstruction(&I).getWithoutDomCondCache());
2629 if ((*Op0C | RHSKnown.Zero).isAllOnes())
2630 return BinaryOperator::CreateXor(Op1, Op0);
2631 }
2632
2633 // C - ((C3 -nuw X) & C2) --> (C - (C2 & C3)) + (X & C2) when:
2634 // (C3 - ((C2 & C3) - 1)) is pow2
2635 // ((C2 + C3) & ((C2 & C3) - 1)) == ((C2 & C3) - 1)
2636 // C2 is negative pow2 || sub nuw
2637 const APInt *C2, *C3;
2638 BinaryOperator *InnerSub;
2639 if (match(Op1, m_OneUse(m_And(m_BinOp(InnerSub), m_APInt(C2)))) &&
2640 match(InnerSub, m_Sub(m_APInt(C3), m_Value(X))) &&
2641 (InnerSub->hasNoUnsignedWrap() || C2->isNegatedPowerOf2())) {
2642 APInt C2AndC3 = *C2 & *C3;
2643 APInt C2AndC3Minus1 = C2AndC3 - 1;
2644 APInt C2AddC3 = *C2 + *C3;
2645 if ((*C3 - C2AndC3Minus1).isPowerOf2() &&
2646 C2AndC3Minus1.isSubsetOf(C2AddC3)) {
2647 Value *And = Builder.CreateAnd(X, ConstantInt::get(I.getType(), *C2));
2648 return BinaryOperator::CreateAdd(
2649 And, ConstantInt::get(I.getType(), *Op0C - C2AndC3));
2650 }
2651 }
2652 }
2653
2654 {
2655 Value *Y;
2656 // X-(X+Y) == -Y X-(Y+X) == -Y
2657 if (match(Op1, m_c_Add(m_Specific(Op0), m_Value(Y))))
2659
2660 // (X-Y)-X == -Y
2661 if (match(Op0, m_Sub(m_Specific(Op1), m_Value(Y))))
2663 }
2664
2665 // (sub (or A, B) (and A, B)) --> (xor A, B)
2666 {
2667 Value *A, *B;
2668 if (match(Op1, m_And(m_Value(A), m_Value(B))) &&
2669 match(Op0, m_c_Or(m_Specific(A), m_Specific(B))))
2670 return BinaryOperator::CreateXor(A, B);
2671 }
2672
2673 // (sub (add A, B) (or A, B)) --> (and A, B)
2674 {
2675 Value *A, *B;
2676 if (match(Op0, m_Add(m_Value(A), m_Value(B))) &&
2677 match(Op1, m_c_Or(m_Specific(A), m_Specific(B))))
2678 return BinaryOperator::CreateAnd(A, B);
2679 }
2680
2681 // (sub (add A, B) (and A, B)) --> (or A, B)
2682 {
2683 Value *A, *B;
2684 if (match(Op0, m_Add(m_Value(A), m_Value(B))) &&
2686 return BinaryOperator::CreateOr(A, B);
2687 }
2688
2689 // (sub (and A, B) (or A, B)) --> neg (xor A, B)
2690 {
2691 Value *A, *B;
2692 if (match(Op0, m_And(m_Value(A), m_Value(B))) &&
2693 match(Op1, m_c_Or(m_Specific(A), m_Specific(B))) &&
2694 (Op0->hasOneUse() || Op1->hasOneUse()))
2695 return BinaryOperator::CreateNeg(Builder.CreateXor(A, B));
2696 }
2697
2698 // (sub (or A, B), (xor A, B)) --> (and A, B)
2699 {
2700 Value *A, *B;
2701 if (match(Op1, m_Xor(m_Value(A), m_Value(B))) &&
2702 match(Op0, m_c_Or(m_Specific(A), m_Specific(B))))
2703 return BinaryOperator::CreateAnd(A, B);
2704 }
2705
2706 // (sub (xor A, B) (or A, B)) --> neg (and A, B)
2707 {
2708 Value *A, *B;
2709 if (match(Op0, m_Xor(m_Value(A), m_Value(B))) &&
2710 match(Op1, m_c_Or(m_Specific(A), m_Specific(B))) &&
2711 (Op0->hasOneUse() || Op1->hasOneUse()))
2712 return BinaryOperator::CreateNeg(Builder.CreateAnd(A, B));
2713 }
2714
2715 {
2716 Value *Y;
2717 // ((X | Y) - X) --> (~X & Y)
2718 if (match(Op0, m_OneUse(m_c_Or(m_Value(Y), m_Specific(Op1)))))
2719 return BinaryOperator::CreateAnd(
2720 Y, Builder.CreateNot(Op1, Op1->getName() + ".not"));
2721 }
2722
2723 {
2724 // (sub (and Op1, (neg X)), Op1) --> neg (and Op1, (add X, -1))
2725 Value *X;
2726 if (match(Op0, m_OneUse(m_c_And(m_Specific(Op1),
2727 m_OneUse(m_Neg(m_Value(X))))))) {
2728 return BinaryOperator::CreateNeg(Builder.CreateAnd(
2729 Op1, Builder.CreateAdd(X, Constant::getAllOnesValue(I.getType()))));
2730 }
2731 }
2732
2733 {
2734 // (sub (and Op1, C), Op1) --> neg (and Op1, ~C)
2735 Constant *C;
2736 if (match(Op0, m_OneUse(m_And(m_Specific(Op1), m_Constant(C))))) {
2738 Builder.CreateAnd(Op1, Builder.CreateNot(C)));
2739 }
2740 }
2741
2742 {
2743 // (sub (xor X, (sext C)), (sext C)) => (select C, (neg X), X)
2744 // (sub (sext C), (xor X, (sext C))) => (select C, X, (neg X))
2745 Value *C, *X;
2746 auto m_SubXorCmp = [&C, &X](Value *LHS, Value *RHS) {
2747 return match(LHS, m_OneUse(m_c_Xor(m_Value(X), m_Specific(RHS)))) &&
2748 match(RHS, m_SExt(m_Value(C))) &&
2749 (C->getType()->getScalarSizeInBits() == 1);
2750 };
2751 if (m_SubXorCmp(Op0, Op1))
2752 return createSelectInstWithUnknownProfile(C, Builder.CreateNeg(X), X);
2753 if (m_SubXorCmp(Op1, Op0))
2754 return createSelectInstWithUnknownProfile(C, X, Builder.CreateNeg(X));
2755 }
2756
2758 return R;
2759
2761 return R;
2762
2763 {
2764 // If we have a subtraction between some value and a select between
2765 // said value and something else, sink subtraction into select hands, i.e.:
2766 // sub (select %Cond, %TrueVal, %FalseVal), %Op1
2767 // ->
2768 // select %Cond, (sub %TrueVal, %Op1), (sub %FalseVal, %Op1)
2769 // or
2770 // sub %Op0, (select %Cond, %TrueVal, %FalseVal)
2771 // ->
2772 // select %Cond, (sub %Op0, %TrueVal), (sub %Op0, %FalseVal)
2773 // This will result in select between new subtraction and 0.
2774 auto SinkSubIntoSelect =
2775 [Ty = I.getType()](Value *Select, Value *OtherHandOfSub,
2776 auto SubBuilder) -> Instruction * {
2777 Value *Cond, *TrueVal, *FalseVal;
2778 if (!match(Select, m_OneUse(m_Select(m_Value(Cond), m_Value(TrueVal),
2779 m_Value(FalseVal)))))
2780 return nullptr;
2781 if (OtherHandOfSub != TrueVal && OtherHandOfSub != FalseVal)
2782 return nullptr;
2783 // While it is really tempting to just create two subtractions and let
2784 // InstCombine fold one of those to 0, it isn't possible to do so
2785 // because of worklist visitation order. So ugly it is.
2786 bool OtherHandOfSubIsTrueVal = OtherHandOfSub == TrueVal;
2787 Value *NewSub = SubBuilder(OtherHandOfSubIsTrueVal ? FalseVal : TrueVal);
2788 Constant *Zero = Constant::getNullValue(Ty);
2789 SelectInst *NewSel =
2790 SelectInst::Create(Cond, OtherHandOfSubIsTrueVal ? Zero : NewSub,
2791 OtherHandOfSubIsTrueVal ? NewSub : Zero);
2792 // Preserve prof metadata if any.
2794 return NewSel;
2795 };
2796 if (Instruction *NewSel = SinkSubIntoSelect(
2797 /*Select=*/Op0, /*OtherHandOfSub=*/Op1,
2798 [Builder = &Builder, Op1](Value *OtherHandOfSelect) {
2799 return Builder->CreateSub(OtherHandOfSelect,
2800 /*OtherHandOfSub=*/Op1);
2801 }))
2802 return NewSel;
2803 if (Instruction *NewSel = SinkSubIntoSelect(
2804 /*Select=*/Op1, /*OtherHandOfSub=*/Op0,
2805 [Builder = &Builder, Op0](Value *OtherHandOfSelect) {
2806 return Builder->CreateSub(/*OtherHandOfSub=*/Op0,
2807 OtherHandOfSelect);
2808 }))
2809 return NewSel;
2810 }
2811
2812 // (X - (X & Y)) --> (X & ~Y)
2813 if (match(Op1, m_c_And(m_Specific(Op0), m_Value(Y))) &&
2814 (Op1->hasOneUse() || isa<Constant>(Y)))
2815 return BinaryOperator::CreateAnd(
2816 Op0, Builder.CreateNot(Y, Y->getName() + ".not"));
2817
2818 // ~X - Min/Max(~X, Y) -> ~Min/Max(X, ~Y) - X
2819 // ~X - Min/Max(Y, ~X) -> ~Min/Max(X, ~Y) - X
2820 // Min/Max(~X, Y) - ~X -> X - ~Min/Max(X, ~Y)
2821 // Min/Max(Y, ~X) - ~X -> X - ~Min/Max(X, ~Y)
2822 // As long as Y is freely invertible, this will be neutral or a win.
2823 // Note: We don't generate the inverse max/min, just create the 'not' of
2824 // it and let other folds do the rest.
2825 if (match(Op0, m_Not(m_Value(X))) &&
2826 match(Op1, m_c_MaxOrMin(m_Specific(Op0), m_Value(Y))) &&
2827 !Op0->hasNUsesOrMore(3) && isFreeToInvert(Y, Y->hasOneUse())) {
2828 Value *Not = Builder.CreateNot(Op1);
2829 return BinaryOperator::CreateSub(Not, X);
2830 }
2831 if (match(Op1, m_Not(m_Value(X))) &&
2832 match(Op0, m_c_MaxOrMin(m_Specific(Op1), m_Value(Y))) &&
2833 !Op1->hasNUsesOrMore(3) && isFreeToInvert(Y, Y->hasOneUse())) {
2834 Value *Not = Builder.CreateNot(Op0);
2835 return BinaryOperator::CreateSub(X, Not);
2836 }
2837
2838 // min(X+1, Y) - min(X, Y) --> zext X < Y
2839 // Replacing a sub and at least one min with an icmp
2840 // and a zext is a potential improvement.
2841 if (match(Op0, m_c_SMin(m_NSWAddLike(m_Value(X), m_One()), m_Value(Y))) &&
2842 match(Op1, m_c_SMin(m_Specific(X), m_Specific(Y))) &&
2843 I.getType()->getScalarSizeInBits() != 1 &&
2844 (Op0->hasOneUse() || Op1->hasOneUse())) {
2845 Value *Cond = Builder.CreateICmpSLT(X, Y);
2846 return new ZExtInst(Cond, I.getType());
2847 }
2848 if (match(Op0, m_c_UMin(m_NUWAddLike(m_Value(X), m_One()), m_Value(Y))) &&
2849 match(Op1, m_c_UMin(m_Specific(X), m_Specific(Y))) &&
2850 I.getType()->getScalarSizeInBits() != 1 &&
2851 (Op0->hasOneUse() || Op1->hasOneUse())) {
2852 Value *Cond = Builder.CreateICmpULT(X, Y);
2853 return new ZExtInst(Cond, I.getType());
2854 }
2855
2856 // Optimize pointer differences into the same array into a size. Consider:
2857 // &A[10] - &A[0]: we should compile this to "10".
2858 Value *LHSOp, *RHSOp;
2859 if (match(Op0, m_PtrToIntOrAddr(m_Value(LHSOp))) &&
2860 match(Op1, m_PtrToIntOrAddr(m_Value(RHSOp))))
2861 if (Value *Res = OptimizePointerDifference(LHSOp, RHSOp, I.getType(),
2862 I.hasNoUnsignedWrap()))
2863 return replaceInstUsesWith(I, Res);
2864
2865 // trunc(p)-trunc(q) -> trunc(p-q)
2866 if (match(Op0, m_Trunc(m_PtrToIntOrAddr(m_Value(LHSOp)))) &&
2867 match(Op1, m_Trunc(m_PtrToIntOrAddr(m_Value(RHSOp)))))
2868 if (Value *Res = OptimizePointerDifference(LHSOp, RHSOp, I.getType(),
2869 /* IsNUW */ false))
2870 return replaceInstUsesWith(I, Res);
2871
2872 auto MatchSubOfZExtOfPtrToIntOrAddr = [&]() {
2873 if (match(Op0, m_ZExt(m_PtrToIntSameSize(DL, m_Value(LHSOp)))) &&
2874 match(Op1, m_ZExt(m_PtrToIntSameSize(DL, m_Value(RHSOp)))))
2875 return true;
2876 if (match(Op0, m_ZExt(m_PtrToAddr(m_Value(LHSOp)))) &&
2877 match(Op1, m_ZExt(m_PtrToAddr(m_Value(RHSOp)))))
2878 return true;
2879 // Special case for non-canonical ptrtoint in constant expression,
2880 // where the zext has been folded into the ptrtoint.
2881 if (match(Op0, m_ZExt(m_PtrToIntSameSize(DL, m_Value(LHSOp)))) &&
2882 match(Op1, m_PtrToInt(m_Value(RHSOp))))
2883 return true;
2884 return false;
2885 };
2886 if (MatchSubOfZExtOfPtrToIntOrAddr()) {
2887 if (auto *GEP = dyn_cast<GEPOperator>(LHSOp)) {
2888 if (GEP->getPointerOperand() == RHSOp) {
2889 if (GEP->hasNoUnsignedWrap() || GEP->hasNoUnsignedSignedWrap()) {
2890 Value *Offset = EmitGEPOffset(GEP);
2891 Value *Res = GEP->hasNoUnsignedWrap()
2892 ? Builder.CreateZExt(
2893 Offset, I.getType(), "",
2894 /*IsNonNeg=*/GEP->hasNoUnsignedSignedWrap())
2895 : Builder.CreateSExt(Offset, I.getType());
2896 return replaceInstUsesWith(I, Res);
2897 }
2898 }
2899 }
2900 }
2901
2902 // Canonicalize a shifty way to code absolute value to the common pattern.
2903 // There are 2 potential commuted variants.
2904 // We're relying on the fact that we only do this transform when the shift has
2905 // exactly 2 uses and the xor has exactly 1 use (otherwise, we might increase
2906 // instructions).
2907 Value *A;
2908 const APInt *ShAmt;
2909 Type *Ty = I.getType();
2910 unsigned BitWidth = Ty->getScalarSizeInBits();
2911 if (match(Op1, m_AShr(m_Value(A), m_APInt(ShAmt))) &&
2912 Op1->hasNUses(2) && *ShAmt == BitWidth - 1 &&
2913 match(Op0, m_OneUse(m_c_Xor(m_Specific(A), m_Specific(Op1))))) {
2914 // B = ashr i32 A, 31 ; smear the sign bit
2915 // sub (xor A, B), B ; flip bits if negative and subtract -1 (add 1)
2916 // --> (A < 0) ? -A : A
2917 Value *IsNeg = Builder.CreateIsNeg(A);
2918 // Copy the nsw flags from the sub to the negate.
2919 Value *NegA = I.hasNoUnsignedWrap()
2920 ? Constant::getNullValue(A->getType())
2921 : Builder.CreateNeg(A, "", I.hasNoSignedWrap());
2922 return SelectInst::Create(IsNeg, NegA, A);
2923 }
2924
2925 // If we are subtracting a low-bit masked subset of some value from an add
2926 // of that same value with no low bits changed, that is clearing some low bits
2927 // of the sum:
2928 // sub (X + AddC), (X & AndC) --> and (X + AddC), ~AndC
2929 const APInt *AddC, *AndC;
2930 if (match(Op0, m_Add(m_Value(X), m_APInt(AddC))) &&
2931 match(Op1, m_And(m_Specific(X), m_APInt(AndC)))) {
2932 unsigned Cttz = AddC->countr_zero();
2933 APInt HighMask(APInt::getHighBitsSet(BitWidth, BitWidth - Cttz));
2934 if ((HighMask & *AndC).isZero())
2935 return BinaryOperator::CreateAnd(Op0, ConstantInt::get(Ty, ~(*AndC)));
2936 }
2937
2938 if (Instruction *V =
2940 return V;
2941
2942 // X - usub.sat(X, Y) => umin(X, Y)
2944 m_Value(Y)))))
2945 return replaceInstUsesWith(
2946 I, Builder.CreateIntrinsic(Intrinsic::umin, {I.getType()}, {Op0, Y}));
2947
2948 // umax(X, Op1) - Op1 --> usub.sat(X, Op1)
2949 // TODO: The one-use restriction is not strictly necessary, but it may
2950 // require improving other pattern matching and/or codegen.
2951 if (match(Op0, m_OneUse(m_c_UMax(m_Value(X), m_Specific(Op1)))))
2952 return replaceInstUsesWith(
2953 I, Builder.CreateIntrinsic(Intrinsic::usub_sat, {Ty}, {X, Op1}));
2954
2955 // Op0 - umin(X, Op0) --> usub.sat(Op0, X)
2956 if (match(Op1, m_OneUse(m_c_UMin(m_Value(X), m_Specific(Op0)))))
2957 return replaceInstUsesWith(
2958 I, Builder.CreateIntrinsic(Intrinsic::usub_sat, {Ty}, {Op0, X}));
2959
2960 // Op0 - umax(X, Op0) --> 0 - usub.sat(X, Op0)
2961 if (match(Op1, m_OneUse(m_c_UMax(m_Value(X), m_Specific(Op0))))) {
2962 Value *USub = Builder.CreateIntrinsic(Intrinsic::usub_sat, {Ty}, {X, Op0});
2963 return BinaryOperator::CreateNeg(USub);
2964 }
2965
2966 // umin(X, Op1) - Op1 --> 0 - usub.sat(Op1, X)
2967 if (match(Op0, m_OneUse(m_c_UMin(m_Value(X), m_Specific(Op1))))) {
2968 Value *USub = Builder.CreateIntrinsic(Intrinsic::usub_sat, {Ty}, {Op1, X});
2969 return BinaryOperator::CreateNeg(USub);
2970 }
2971
2972 // C - ctpop(X) => ctpop(~X) if C is bitwidth
2973 if (match(Op0, m_SpecificInt(BitWidth)) &&
2975 return replaceInstUsesWith(
2976 I, Builder.CreateIntrinsic(Intrinsic::ctpop, {I.getType()},
2977 {Builder.CreateNot(X)}));
2978
2979 // Reduce multiplies for difference-of-squares by factoring:
2980 // (X * X) - (Y * Y) --> (X + Y) * (X - Y)
2981 if (match(Op0, m_OneUse(m_Mul(m_Value(X), m_Deferred(X)))) &&
2982 match(Op1, m_OneUse(m_Mul(m_Value(Y), m_Deferred(Y))))) {
2983 auto *OBO0 = cast<OverflowingBinaryOperator>(Op0);
2984 auto *OBO1 = cast<OverflowingBinaryOperator>(Op1);
2985 bool PropagateNSW = I.hasNoSignedWrap() && OBO0->hasNoSignedWrap() &&
2986 OBO1->hasNoSignedWrap() && BitWidth > 2;
2987 bool PropagateNUW = I.hasNoUnsignedWrap() && OBO0->hasNoUnsignedWrap() &&
2988 OBO1->hasNoUnsignedWrap() && BitWidth > 1;
2989 Value *Add = Builder.CreateAdd(X, Y, "add", PropagateNUW, PropagateNSW);
2990 Value *Sub = Builder.CreateSub(X, Y, "sub", PropagateNUW, PropagateNSW);
2991 Value *Mul = Builder.CreateMul(Add, Sub, "", PropagateNUW, PropagateNSW);
2992 return replaceInstUsesWith(I, Mul);
2993 }
2994
2995 // max(X,Y) nsw/nuw - min(X,Y) --> abs(X nsw - Y)
2996 if (match(Op0, m_OneUse(m_c_SMax(m_Value(X), m_Value(Y)))) &&
2998 if (I.hasNoUnsignedWrap() || I.hasNoSignedWrap()) {
2999 Value *Sub =
3000 Builder.CreateSub(X, Y, "sub", /*HasNUW=*/false, /*HasNSW=*/true);
3001 Value *Call =
3002 Builder.CreateBinaryIntrinsic(Intrinsic::abs, Sub, Builder.getTrue());
3003 return replaceInstUsesWith(I, Call);
3004 }
3005 }
3006
3008 return Res;
3009
3010 // (sub (sext (add nsw (X, Y)), sext (X))) --> (sext (Y))
3011 if (match(Op1, m_SExtLike(m_Value(X))) &&
3013 Value *SExtY = Builder.CreateSExt(Y, I.getType());
3014 return replaceInstUsesWith(I, SExtY);
3015 }
3016
3017 // (sub[ nsw] (sext (add nsw (X, Y)), sext (add nsw (X, Z)))) -->
3018 // --> (sub[ nsw] (sext (Y), sext (Z)))
3019 {
3020 Value *Z, *Add0, *Add1;
3021 if (match(Op0, m_SExtLike(m_Value(Add0))) &&
3022 match(Op1, m_SExtLike(m_Value(Add1))) &&
3023 ((match(Add0, m_NSWAdd(m_Value(X), m_Value(Y))) &&
3024 match(Add1, m_c_NSWAdd(m_Specific(X), m_Value(Z)))) ||
3025 (match(Add0, m_NSWAdd(m_Value(Y), m_Value(X))) &&
3026 match(Add1, m_c_NSWAdd(m_Specific(X), m_Value(Z)))))) {
3027 unsigned NumOfNewInstrs = 0;
3028 // Non-constant Y, Z require new SExt.
3029 NumOfNewInstrs += !isa<Constant>(Y) ? 1 : 0;
3030 NumOfNewInstrs += !isa<Constant>(Z) ? 1 : 0;
3031 // Check if we can trade some of the old instructions for the new ones.
3032 unsigned NumOfDeadInstrs = 0;
3033 if (Op0->hasOneUse()) {
3034 // If Op0 (sext) has multiple uses, then we keep it
3035 // and the add that it uses, otherwise, we can remove
3036 // the sext and probably the add (depending on the number of its uses).
3037 ++NumOfDeadInstrs;
3038 NumOfDeadInstrs += Add0->hasOneUse() ? 1 : 0;
3039 }
3040 if (Op1->hasOneUse()) {
3041 ++NumOfDeadInstrs;
3042 NumOfDeadInstrs += Add1->hasOneUse() ? 1 : 0;
3043 }
3044 if (NumOfDeadInstrs >= NumOfNewInstrs) {
3045 Value *SExtY = Builder.CreateSExt(Y, I.getType());
3046 Value *SExtZ = Builder.CreateSExt(Z, I.getType());
3047 Value *Sub = Builder.CreateSub(SExtY, SExtZ, "",
3048 /*HasNUW=*/false,
3049 /*HasNSW=*/I.hasNoSignedWrap());
3050 return replaceInstUsesWith(I, Sub);
3051 }
3052 }
3053 }
3054
3055 return TryToNarrowDeduceFlags();
3056}
3057
3058/// This eliminates floating-point negation in either 'fneg(X)' or
3059/// 'fsub(-0.0, X)' form by combining into a constant operand.
3061 // This is limited with one-use because fneg is assumed better for
3062 // reassociation and cheaper in codegen than fmul/fdiv.
3063 // TODO: Should the m_OneUse restriction be removed?
3064 Instruction *FNegOp;
3065 if (!match(&I, m_FNeg(m_OneUse(m_Instruction(FNegOp)))))
3066 return nullptr;
3067
3068 Value *X;
3069 Constant *C;
3070
3071 // Fold negation into constant operand.
3072 // -(X * C) --> X * (-C)
3073 if (match(FNegOp, m_FMul(m_Value(X), m_Constant(C))))
3074 if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL)) {
3075 FastMathFlags FNegF = I.getFastMathFlags();
3076 FastMathFlags OpF = FNegOp->getFastMathFlags();
3077 FastMathFlags FMF = FastMathFlags::unionValue(FNegF, OpF) |
3079 FMF.setNoInfs(FNegF.noInfs() && OpF.noInfs());
3080 return BinaryOperator::CreateFMulFMF(X, NegC, FMF);
3081 }
3082 // -(X / C) --> X / (-C)
3083 if (match(FNegOp, m_FDiv(m_Value(X), m_Constant(C)))) {
3084 if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL)) {
3086
3087 // Intersect 'nsz' and 'ninf' because those special value exceptions may
3088 // not apply to the fdiv. Everything else propagates from the fneg.
3089 FastMathFlags FMF = I.getFastMathFlags();
3090 FastMathFlags OpFMF = FNegOp->getFastMathFlags();
3091 FDiv->setHasNoSignedZeros(FMF.noSignedZeros() && OpFMF.noSignedZeros());
3092 FDiv->setHasNoInfs(FMF.noInfs() && OpFMF.noInfs());
3093 FDiv->copyMetadata(*FNegOp);
3094 return FDiv;
3095 }
3096 }
3097 // -(C / X) --> (-C) / X
3098 if (match(FNegOp, m_FDiv(m_Constant(C), m_Value(X))))
3099 if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL)) {
3101
3102 // Intersect 'nsz' and 'ninf' because those special value exceptions may
3103 // not apply to the fdiv. Everything else propagates from the fneg.
3104 // TODO: We could propagate nsz/ninf from fdiv alone?
3105 FastMathFlags FMF = I.getFastMathFlags();
3106 FastMathFlags OpFMF = FNegOp->getFastMathFlags();
3107 FDiv->setHasNoSignedZeros(FMF.noSignedZeros() && OpFMF.noSignedZeros());
3108 FDiv->setHasNoInfs(FMF.noInfs() && OpFMF.noInfs());
3109 FDiv->copyMetadata(*FNegOp);
3110 return FDiv;
3111 }
3112 // With NSZ [ counter-example with -0.0: -(-0.0 + 0.0) != 0.0 + -0.0 ]:
3113 // -(X + C) --> -X + -C --> -C - X
3114 if (I.hasNoSignedZeros() && match(FNegOp, m_FAdd(m_Value(X), m_Constant(C))))
3115 if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL))
3116 return BinaryOperator::CreateFSubFMF(NegC, X, &I);
3117
3118 return nullptr;
3119}
3120
3121Instruction *InstCombinerImpl::hoistFNegAboveFMulFDiv(Value *FNegOp,
3122 Instruction &FMFSource) {
3123 Value *X, *Y;
3124 if (match(FNegOp, m_FMul(m_Value(X), m_Value(Y)))) {
3125 // Push into RHS which is more likely to simplify (const or another fneg).
3126 // FIXME: It would be better to invert the transform.
3127 return cast<Instruction>(Builder.CreateFMulFMF(
3128 X, Builder.CreateFNegFMF(Y, &FMFSource), &FMFSource));
3129 }
3130
3131 if (match(FNegOp, m_FDiv(m_Value(X), m_Value(Y)))) {
3132 auto *FDiv = cast<Instruction>(Builder.CreateFDivFMF(
3133 Builder.CreateFNegFMF(X, &FMFSource), Y, &FMFSource));
3134 FDiv->copyMetadata(*cast<Instruction>(FNegOp));
3135 return FDiv;
3136 }
3137
3138 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(FNegOp)) {
3139 // Make sure to preserve flags and metadata on the call.
3140 if (II->getIntrinsicID() == Intrinsic::ldexp) {
3141 FastMathFlags FMF = FMFSource.getFastMathFlags() | II->getFastMathFlags();
3142 CallInst *New =
3143 Builder.CreateCall(II->getCalledFunction(),
3144 {Builder.CreateFNegFMF(II->getArgOperand(0), FMF),
3145 II->getArgOperand(1)});
3146 New->setFastMathFlags(FMF);
3147 New->copyMetadata(*II);
3148 return New;
3149 }
3150 }
3151
3152 return nullptr;
3153}
3154
3156 Value *Op = I.getOperand(0);
3157
3158 if (Value *V = simplifyFNegInst(Op, I.getFastMathFlags(),
3159 getSimplifyQuery().getWithInstruction(&I)))
3160 return replaceInstUsesWith(I, V);
3161
3163 return X;
3164
3165 Value *X, *Y;
3166
3167 // If we can ignore the sign of zeros: -(X - Y) --> (Y - X)
3168 if (I.hasNoSignedZeros() &&
3171
3172 Value *OneUse;
3173 if (!match(Op, m_OneUse(m_Value(OneUse))))
3174 return nullptr;
3175
3176 if (Instruction *R = hoistFNegAboveFMulFDiv(OneUse, I))
3177 return replaceInstUsesWith(I, R);
3178
3179 // Try to eliminate fneg if at least 1 arm of the select is negated.
3180 Value *Cond;
3181 if (match(OneUse, m_Select(m_Value(Cond), m_Value(X), m_Value(Y)))) {
3182 // Unlike most transforms, this one is not safe to propagate nsz unless
3183 // it is present on the original select. We union the flags from the select
3184 // and fneg and then remove nsz if needed.
3185 auto propagateSelectFMF = [&](SelectInst *S, bool CommonOperand) {
3186 S->copyFastMathFlags(&I);
3187 if (auto *OldSel = dyn_cast<SelectInst>(Op)) {
3188 FastMathFlags FMF = I.getFastMathFlags() | OldSel->getFastMathFlags();
3189 S->setFastMathFlags(FMF);
3190 if (!OldSel->hasNoSignedZeros() && !CommonOperand &&
3191 !isGuaranteedNotToBeUndefOrPoison(OldSel->getCondition()))
3192 S->setHasNoSignedZeros(false);
3193 }
3194 };
3195 // -(Cond ? -P : Y) --> Cond ? P : -Y
3196 Value *P;
3197 if (match(X, m_FNeg(m_Value(P)))) {
3198 Value *NegY = Builder.CreateFNegFMF(Y, &I, Y->getName() + ".neg");
3199 SelectInst *NewSel = SelectInst::Create(Cond, P, NegY);
3200 propagateSelectFMF(NewSel, P == Y);
3201 return NewSel;
3202 }
3203 // -(Cond ? X : -P) --> Cond ? -X : P
3204 if (match(Y, m_FNeg(m_Value(P)))) {
3205 Value *NegX = Builder.CreateFNegFMF(X, &I, X->getName() + ".neg");
3206 SelectInst *NewSel = SelectInst::Create(Cond, NegX, P);
3207 propagateSelectFMF(NewSel, P == X);
3208 return NewSel;
3209 }
3210
3211 // -(Cond ? X : C) --> Cond ? -X : -C
3212 // -(Cond ? C : Y) --> Cond ? -C : -Y
3213 if (match(X, m_ImmConstant()) || match(Y, m_ImmConstant())) {
3214 Value *NegX = Builder.CreateFNegFMF(X, &I, X->getName() + ".neg");
3215 Value *NegY = Builder.CreateFNegFMF(Y, &I, Y->getName() + ".neg");
3216 SelectInst *NewSel = SelectInst::Create(Cond, NegX, NegY);
3217 propagateSelectFMF(NewSel, /*CommonOperand=*/true);
3218 return NewSel;
3219 }
3220 }
3221
3222 // fneg (copysign x, y) -> copysign x, (fneg y)
3223 if (match(OneUse, m_CopySign(m_Value(X), m_Value(Y)))) {
3224 // The source copysign has an additional value input, so we can't propagate
3225 // flags the copysign doesn't also have.
3226 FastMathFlags FMF = I.getFastMathFlags();
3227 FMF &= cast<FPMathOperator>(OneUse)->getFastMathFlags();
3228 Value *NegY = Builder.CreateFNegFMF(Y, FMF);
3229 Value *NewCopySign = Builder.CreateCopySign(X, NegY, FMF);
3230 return replaceInstUsesWith(I, NewCopySign);
3231 }
3232
3233 // fneg (shuffle x, Mask) --> shuffle (fneg x), Mask
3234 ArrayRef<int> Mask;
3235 if (match(OneUse, m_Shuffle(m_Value(X), m_Poison(), m_Mask(Mask))))
3236 return new ShuffleVectorInst(Builder.CreateFNegFMF(X, &I), Mask);
3237
3238 // fneg (reverse x) --> reverse (fneg x)
3239 if (match(OneUse, m_VecReverse(m_Value(X)))) {
3240 Value *Reverse = Builder.CreateVectorReverse(Builder.CreateFNegFMF(X, &I));
3241 return replaceInstUsesWith(I, Reverse);
3242 }
3243
3244 return nullptr;
3245}
3246
3248 if (Value *V = simplifyFSubInst(I.getOperand(0), I.getOperand(1),
3249 I.getFastMathFlags(),
3250 getSimplifyQuery().getWithInstruction(&I)))
3251 return replaceInstUsesWith(I, V);
3252
3254 return X;
3255
3257 return Phi;
3258
3259 // Subtraction from -0.0 is the canonical form of fneg.
3260 // fsub -0.0, X ==> fneg X
3261 // fsub nsz 0.0, X ==> fneg nsz X
3262 //
3263 // FIXME This matcher does not respect FTZ or DAZ yet:
3264 // fsub -0.0, Denorm ==> +-0
3265 // fneg Denorm ==> -Denorm
3266 Value *Op;
3267 if (match(&I, m_FNeg(m_Value(Op))))
3269
3271 return X;
3272
3273 if (Instruction *R = foldFBinOpOfIntCasts(I))
3274 return R;
3275
3276 Value *X, *Y;
3277 Constant *C;
3278
3279 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
3280 // If Op0 is not -0.0 or we can ignore -0.0: Z - (X - Y) --> Z + (Y - X)
3281 // Canonicalize to fadd to make analysis easier.
3282 // This can also help codegen because fadd is commutative.
3283 // Note that if this fsub was really an fneg, the fadd with -0.0 will get
3284 // killed later. We still limit that particular transform with 'hasOneUse'
3285 // because an fneg is assumed better/cheaper than a generic fsub.
3286 if (I.hasNoSignedZeros() ||
3287 cannotBeNegativeZero(Op0, getSimplifyQuery().getWithInstruction(&I))) {
3288 if (match(Op1, m_OneUse(m_FSub(m_Value(X), m_Value(Y))))) {
3289 Value *NewSub = Builder.CreateFSubFMF(Y, X, &I);
3290 return BinaryOperator::CreateFAddFMF(Op0, NewSub, &I);
3291 }
3292 }
3293
3294 // (-X) - Op1 --> -(X + Op1)
3295 if (I.hasNoSignedZeros() && !isa<ConstantExpr>(Op0) &&
3296 match(Op0, m_OneUse(m_FNeg(m_Value(X))))) {
3297 Value *FAdd = Builder.CreateFAddFMF(X, Op1, &I);
3299 }
3300
3301 if (isa<Constant>(Op0))
3303 if (Instruction *NV = FoldOpIntoSelect(I, SI))
3304 return NV;
3305
3306 // X - C --> X + (-C)
3307 // But don't transform constant expressions because there's an inverse fold
3308 // for X + (-Y) --> X - Y.
3309 if (match(Op1, m_ImmConstant(C)))
3310 if (Constant *NegC = ConstantFoldUnaryOpOperand(Instruction::FNeg, C, DL))
3311 return BinaryOperator::CreateFAddFMF(Op0, NegC, &I);
3312
3313 // X - (-Y) --> X + Y
3314 if (match(Op1, m_FNeg(m_Value(Y))))
3315 return BinaryOperator::CreateFAddFMF(Op0, Y, &I);
3316
3317 // Similar to above, but look through a cast of the negated value:
3318 // X - (fptrunc(-Y)) --> X + fptrunc(Y)
3319 Type *Ty = I.getType();
3320 if (match(Op1, m_OneUse(m_FPTrunc(m_FNeg(m_Value(Y))))))
3321 return BinaryOperator::CreateFAddFMF(Op0, Builder.CreateFPTrunc(Y, Ty), &I);
3322
3323 // X - (fpext(-Y)) --> X + fpext(Y)
3324 if (match(Op1, m_OneUse(m_FPExt(m_FNeg(m_Value(Y))))))
3325 return BinaryOperator::CreateFAddFMF(Op0, Builder.CreateFPExt(Y, Ty), &I);
3326
3327 // Similar to above, but look through fmul/fdiv of the negated value:
3328 // Op0 - (-X * Y) --> Op0 + (X * Y)
3329 // Op0 - (Y * -X) --> Op0 + (X * Y)
3330 if (match(Op1, m_OneUse(m_c_FMul(m_FNeg(m_Value(X)), m_Value(Y))))) {
3331 Value *FMul = Builder.CreateFMulFMF(X, Y, &I);
3332 return BinaryOperator::CreateFAddFMF(Op0, FMul, &I);
3333 }
3334 // Op0 - (-X / Y) --> Op0 + (X / Y)
3335 // Op0 - (X / -Y) --> Op0 + (X / Y)
3336 if (match(Op1, m_OneUse(m_FDiv(m_FNeg(m_Value(X)), m_Value(Y)))) ||
3337 match(Op1, m_OneUse(m_FDiv(m_Value(X), m_FNeg(m_Value(Y)))))) {
3338 Value *FDiv = Builder.CreateFDivFMF(X, Y, &I);
3339 return BinaryOperator::CreateFAddFMF(Op0, FDiv, &I);
3340 }
3341
3342 // Handle special cases for FSub with selects feeding the operation
3343 if (Value *V = SimplifySelectsFeedingBinaryOp(I, Op0, Op1))
3344 return replaceInstUsesWith(I, V);
3345
3346 if (I.hasAllowReassoc() && I.hasNoSignedZeros()) {
3347 // (Y - X) - Y --> -X
3348 if (match(Op0, m_FSub(m_Specific(Op1), m_Value(X))))
3350
3351 // Y - (X + Y) --> -X
3352 // Y - (Y + X) --> -X
3353 if (match(Op1, m_c_FAdd(m_Specific(Op0), m_Value(X))))
3355
3356 // (X * C) - X --> X * (C - 1.0)
3357 if (match(Op0, m_FMul(m_Specific(Op1), m_Constant(C)))) {
3359 Instruction::FSub, C, ConstantFP::get(Ty, 1.0), DL))
3360 return BinaryOperator::CreateFMulFMF(Op1, CSubOne, &I);
3361 }
3362 // X - (X * C) --> X * (1.0 - C)
3363 if (match(Op1, m_FMul(m_Specific(Op0), m_Constant(C)))) {
3365 Instruction::FSub, ConstantFP::get(Ty, 1.0), C, DL))
3366 return BinaryOperator::CreateFMulFMF(Op0, OneSubC, &I);
3367 }
3368
3369 // Reassociate fsub/fadd sequences to create more fadd instructions and
3370 // reduce dependency chains:
3371 // ((X - Y) + Z) - Op1 --> (X + Z) - (Y + Op1)
3372 Value *Z;
3374 m_Value(Z))))) {
3375 Value *XZ = Builder.CreateFAddFMF(X, Z, &I);
3376 Value *YW = Builder.CreateFAddFMF(Y, Op1, &I);
3377 return BinaryOperator::CreateFSubFMF(XZ, YW, &I);
3378 }
3379
3380 auto m_FaddRdx = [](Value *&Sum, Value *&Vec) {
3382 m_Value(Vec)));
3383 };
3384 Value *A0, *A1, *V0, *V1;
3385 if (match(Op0, m_FaddRdx(A0, V0)) && match(Op1, m_FaddRdx(A1, V1)) &&
3386 V0->getType() == V1->getType()) {
3387 // Difference of sums is sum of differences:
3388 // add_rdx(A0, V0) - add_rdx(A1, V1) --> add_rdx(A0, V0 - V1) - A1
3389 Value *Sub = Builder.CreateFSubFMF(V0, V1, &I);
3390 Value *Rdx = Builder.CreateIntrinsic(Intrinsic::vector_reduce_fadd,
3391 {Sub->getType()}, {A0, Sub}, &I);
3392 return BinaryOperator::CreateFSubFMF(Rdx, A1, &I);
3393 }
3394
3396 return F;
3397
3398 // TODO: This performs reassociative folds for FP ops. Some fraction of the
3399 // functionality has been subsumed by simple pattern matching here and in
3400 // InstSimplify. We should let a dedicated reassociation pass handle more
3401 // complex pattern matching and remove this from InstCombine.
3402 if (Value *V = FAddCombine(Builder).simplify(&I))
3403 return replaceInstUsesWith(I, V);
3404
3405 // (X - Y) - Op1 --> X - (Y + Op1)
3406 if (match(Op0, m_OneUse(m_FSub(m_Value(X), m_Value(Y))))) {
3407 Value *FAdd = Builder.CreateFAddFMF(Y, Op1, &I);
3409 }
3410 }
3411
3412 return nullptr;
3413}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
static bool isConstant(const MachineInstr &MI)
AMDGPU Register Bank Select
Rewrite undef for PHI
This file declares a class to represent arbitrary precision floating point values and provide a varie...
This file implements a class to represent arbitrary precision integral constant values and operations...
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
#define X(NUM, ENUM, NAME)
Definition ELF.h:851
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
This file contains the declarations for the subclasses of Constant, which represent the different fla...
hexagon bit simplify
Hexagon Common GEP
static Instruction * factorizeFAddFSub(BinaryOperator &I, InstCombiner::BuilderTy &Builder)
Factor a common operand out of fadd/fsub of fmul/fdiv.
static Instruction * foldAddToAshr(BinaryOperator &Add)
Try to reduce signed division by power-of-2 to an arithmetic shift right.
static bool MatchMul(Value *E, Value *&Op, APInt &C)
static bool MatchDiv(Value *E, Value *&Op, APInt &C, bool IsSigned)
static Instruction * foldFNegIntoConstant(Instruction &I, const DataLayout &DL)
This eliminates floating-point negation in either 'fneg(X)' or 'fsub(-0.0, X)' form by combining into...
static Instruction * combineAddSubWithShlAddSub(InstCombiner::BuilderTy &Builder, const BinaryOperator &I)
static Instruction * factorizeLerp(BinaryOperator &I, InstCombiner::BuilderTy &Builder)
Eliminate an op from a linear interpolation (lerp) pattern.
static Instruction * foldSubOfMinMax(BinaryOperator &I, InstCombiner::BuilderTy &Builder)
static Instruction * foldBoxMultiply(BinaryOperator &I)
Reduce a sequence of masked half-width multiplies to a single multiply.
static Value * checkForNegativeOperand(BinaryOperator &I, InstCombiner::BuilderTy &Builder)
static bool MulWillOverflow(APInt &C0, APInt &C1, bool IsSigned)
static Instruction * foldNoWrapAdd(BinaryOperator &Add, InstCombiner::BuilderTy &Builder)
Wrapping flags may allow combining constants separated by an extend.
static bool matchesSquareSum(BinaryOperator &I, Mul2Rhs M2Rhs, Value *&A, Value *&B)
static Instruction * factorizeMathWithShlOps(BinaryOperator &I, InstCombiner::BuilderTy &Builder)
This is a specialization of a more general transform from foldUsingDistributiveLaws.
static Instruction * canonicalizeLowbitMask(BinaryOperator &I, InstCombiner::BuilderTy &Builder)
Fold (1 << NBits) - 1 Into: ~(-(1 << NBits)) Because a 'not' is better for bit-tracking analysis and ...
static bool checkDivCeilNUW(Value *X, Value *Y, const SimplifyQuery &SQ)
Return true if X + (Y-1) is provably non-wrapping in X's type.
static Instruction * foldToUnsignedSaturatedAdd(BinaryOperator &I)
static bool MatchRem(Value *E, Value *&Op, APInt &C, bool &IsSigned)
This file provides internal interfaces used to implement the InstCombine.
This file provides the interface for the instcombine pass implementation.
static bool isZero(Value *V, const DataLayout &DL, DominatorTree *DT, AssumptionCache *AC)
Definition Lint.cpp:539
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
#define T
uint64_t IntrinsicInst * II
#define P(N)
const SmallVectorImpl< MachineOperand > & Cond
This file contains some templates that are useful if you are working with the STL at all.
This file defines the SmallVector class.
static unsigned getScalarSizeInBits(Type *Ty)
static TableGen::Emitter::Opt Y("gen-skeleton-entry", EmitSkeleton, "Generate example skeleton entry")
Value * RHS
Value * LHS
const fltSemantics & getSemantics() const
Definition APFloat.h:1524
opStatus multiply(const APFloat &RHS, roundingMode RM)
Definition APFloat.h:1254
Class for arbitrary precision integers.
Definition APInt.h:78
LLVM_ABI APInt umul_ov(const APInt &RHS, bool &Overflow) const
Definition APInt.cpp:2022
bool isNegatedPowerOf2() const
Check if this APInt's negated value is a power of two greater than zero.
Definition APInt.h:450
bool isMinSignedValue() const
Determine if this is the smallest signed value.
Definition APInt.h:424
LLVM_ABI APInt trunc(unsigned width) const
Truncate to new width.
Definition APInt.cpp:967
static APInt getMaxValue(unsigned numBits)
Gets maximum unsigned value of APInt for specific bit width.
Definition APInt.h:207
bool ugt(const APInt &RHS) const
Unsigned greater than comparison.
Definition APInt.h:1189
bool isZero() const
Determine if this value is zero, i.e. all bits are clear.
Definition APInt.h:381
bool isSignMask() const
Check if the APInt's value is returned by getSignMask.
Definition APInt.h:467
unsigned getBitWidth() const
Return the number of bits in the APInt.
Definition APInt.h:1511
bool isNegative() const
Determine sign of this APInt.
Definition APInt.h:330
int32_t exactLogBase2() const
Definition APInt.h:1806
unsigned countr_zero() const
Count the number of trailing zero bits.
Definition APInt.h:1662
unsigned countl_zero() const
The APInt version of std::countl_zero.
Definition APInt.h:1621
static APInt getSignedMinValue(unsigned numBits)
Gets minimum signed value of APInt for a specific bit width.
Definition APInt.h:220
unsigned logBase2() const
Definition APInt.h:1784
LLVM_ABI APInt smul_ov(const APInt &RHS, bool &Overflow) const
Definition APInt.cpp:2011
bool isMask(unsigned numBits) const
Definition APInt.h:489
LLVM_ABI APInt sext(unsigned width) const
Sign extend to a new width.
Definition APInt.cpp:1027
bool isSubsetOf(const APInt &RHS) const
This operation checks that all bits set in this APInt are also set in RHS.
Definition APInt.h:1264
bool isPowerOf2() const
Check if this APInt's value is a power of two greater than zero.
Definition APInt.h:441
static APInt getHighBitsSet(unsigned numBits, unsigned hiBitsSet)
Constructs an APInt value that has the top hiBitsSet bits set.
Definition APInt.h:297
bool sge(const APInt &RHS) const
Signed greater or equal comparison.
Definition APInt.h:1244
bool isOne() const
Determine if this is a value of 1.
Definition APInt.h:390
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
static BinaryOperator * CreateFAddFMF(Value *V1, Value *V2, FastMathFlags FMF, const Twine &Name="")
Definition InstrTypes.h:236
static LLVM_ABI BinaryOperator * CreateNeg(Value *Op, const Twine &Name="", InsertPosition InsertBefore=nullptr)
Helper functions to construct and inspect unary operations (NEG and NOT) via binary operators SUB and...
static LLVM_ABI BinaryOperator * CreateNot(Value *Op, const Twine &Name="", InsertPosition InsertBefore=nullptr)
static BinaryOperator * CreateFMulFMF(Value *V1, Value *V2, FastMathFlags FMF, const Twine &Name="")
Definition InstrTypes.h:244
static BinaryOperator * CreateFDivFMF(Value *V1, Value *V2, FastMathFlags FMF, const Twine &Name="")
Definition InstrTypes.h:248
static BinaryOperator * CreateFSubFMF(Value *V1, Value *V2, FastMathFlags FMF, const Twine &Name="")
Definition InstrTypes.h:240
static CallInst * Create(FunctionType *Ty, Value *F, const Twine &NameStr="", InsertPosition InsertBefore=nullptr)
static LLVM_ABI CastInst * CreateTruncOrBitCast(Value *S, Type *Ty, const Twine &Name="", InsertPosition InsertBefore=nullptr)
Create a Trunc or BitCast cast instruction.
static LLVM_ABI CastInst * Create(Instruction::CastOps, Value *S, Type *Ty, const Twine &Name="", InsertPosition InsertBefore=nullptr)
Provides a way to construct any of the CastInst subclasses using an opcode instead of the subclass's ...
@ ICMP_UGT
unsigned greater than
Definition InstrTypes.h:699
@ ICMP_SGT
signed greater than
Definition InstrTypes.h:703
@ ICMP_NE
not equal
Definition InstrTypes.h:698
bool isSigned() const
Definition InstrTypes.h:930
An abstraction over a floating-point predicate, and a pack of an integer predicate with samesign info...
static LLVM_ABI Constant * getSub(Constant *C1, Constant *C2, bool HasNUW=false, bool HasNSW=false)
static LLVM_ABI Constant * getAdd(Constant *C1, Constant *C2, bool HasNUW=false, bool HasNSW=false)
ConstantFP - Floating Point Values [float, double].
Definition Constants.h:420
const APFloat & getValueAPF() const
Definition Constants.h:463
bool isZero() const
Return true if the value is positive or negative zero.
Definition Constants.h:467
static ConstantInt * getSigned(IntegerType *Ty, int64_t V, bool ImplicitTrunc=false)
Return a ConstantInt with the specified value for the specified type.
Definition Constants.h:135
This class represents a range of values.
LLVM_ABI APInt getUnsignedMin() const
Return the smallest unsigned value contained in the ConstantRange.
LLVM_ABI APInt getUnsignedMax() const
Return the largest unsigned value contained in the ConstantRange.
This is an important base class in LLVM.
Definition Constant.h:43
static LLVM_ABI Constant * getIntegerValue(Type *Ty, const APInt &V)
Return the value for an integer or pointer constant, or a vector thereof, with the given scalar value...
static LLVM_ABI Constant * getAllOnesValue(Type *Ty)
static LLVM_ABI Constant * getNullValue(Type *Ty)
Constructor to create a '0' constant of arbitrary type.
LLVM_ABI bool isElementWiseEqual(Value *Y) const
Return true if this constant and a constant 'Y' are element-wise equal.
A parsed version of the target data layout string in and methods for querying it.
Definition DataLayout.h:64
Convenience struct for specifying and reasoning about fast-math flags.
Definition FMF.h:23
static FastMathFlags intersectRewrite(FastMathFlags LHS, FastMathFlags RHS)
Intersect rewrite-based flags.
Definition FMF.h:119
bool noSignedZeros() const
Definition FMF.h:70
bool noInfs() const
Definition FMF.h:69
static FastMathFlags unionValue(FastMathFlags LHS, FastMathFlags RHS)
Union value flags.
Definition FMF.h:127
void setNoInfs(bool B=true)
Definition FMF.h:84
static bool isLT(Predicate P)
Return true if the predicate is SLT or ULT.
static bool isGT(Predicate P)
Return true if the predicate is SGT or UGT.
Instruction * foldBinOpOfSelectAndCastOfSelectCondition(BinaryOperator &I)
Tries to simplify binops of select and cast of the select condition.
Instruction * visitAdd(BinaryOperator &I)
Instruction * canonicalizeCondSignextOfHighBitExtractToSignextHighBitExtract(BinaryOperator &I)
Instruction * foldBinOpIntoSelectOrPhi(BinaryOperator &I)
This is a convenience wrapper function for the above two functions.
bool SimplifyAssociativeOrCommutative(BinaryOperator &I)
Performs a few simplifications for operators which are associative or commutative.
Value * foldUsingDistributiveLaws(BinaryOperator &I)
Tries to simplify binary operations which some other binary operation distributes over.
Instruction * foldBinOpShiftWithShift(BinaryOperator &I)
Instruction * foldSquareSumInt(BinaryOperator &I)
Instruction * foldOpIntoPhi(Instruction &I, PHINode *PN, bool AllowMultipleUses=false)
Given a binary operator, cast instruction, or select which has a PHI node as operand #0,...
Instruction * foldBinOpSelectBinOp(BinaryOperator &Op)
In some cases it is beneficial to fold a select into a binary operator.
Instruction * foldSquareSumFP(BinaryOperator &I)
Instruction * FoldOpIntoSelect(Instruction &Op, SelectInst *SI, bool FoldWithMultiUse=false, bool SimplifyBothArms=false)
Given an instruction with a select as one operand and a constant as the other operand,...
Instruction * visitSub(BinaryOperator &I)
Instruction * foldDivCeil(BinaryOperator &I)
Fold both forms of the div_ceil idiom: (add (udiv X, Y), (zext (icmp ne (urem X, Y),...
Value * OptimizePointerDifference(Value *LHS, Value *RHS, Type *Ty, bool isNUW)
Optimize pointer differences into the same array into a size.
Instruction * visitFAdd(BinaryOperator &I)
Instruction * foldBinopWithPhiOperands(BinaryOperator &BO)
For a binary operator with 2 phi operands, try to hoist the binary operation before the phi.
Instruction * foldAddLikeCommutative(Value *LHS, Value *RHS, bool NSW, bool NUW)
Common transforms for add / disjoint or.
Instruction * tryFoldInstWithCtpopWithNot(Instruction *I)
Value * SimplifyAddWithRemainder(BinaryOperator &I)
Tries to simplify add operations using the definition of remainder.
Instruction * foldAddWithConstant(BinaryOperator &Add)
Instruction * foldVectorBinop(BinaryOperator &Inst)
Canonicalize the position of binops relative to shufflevector.
Value * SimplifySelectsFeedingBinaryOp(BinaryOperator &I, Value *LHS, Value *RHS)
Instruction * visitFNeg(UnaryOperator &I)
Instruction * visitFSub(BinaryOperator &I)
SimplifyQuery SQ
IRBuilder< TargetFolder, IRBuilderCallbackInserter > BuilderTy
An IRBuilder that automatically inserts new instructions into the worklist.
bool isFreeToInvert(Value *V, bool WillInvertAllUses, bool &DoesConsume)
Return true if the specified value is free to invert (apply ~ to).
unsigned ComputeNumSignBits(const Value *Op, const Instruction *CxtI=nullptr, unsigned Depth=0) const
Instruction * replaceInstUsesWith(Instruction &I, Value *V)
A combiner-aware RAUW-like routine.
static Constant * SubOne(Constant *C)
Subtract one from a Constant.
InstructionWorklist & Worklist
A worklist of the instructions that need to be simplified.
const DataLayout & DL
void computeKnownBits(const Value *V, KnownBits &Known, const Instruction *CxtI, unsigned Depth=0) const
AssumptionCache & AC
Instruction * replaceOperand(Instruction &I, unsigned OpNum, Value *V)
Replace operand of instruction and add old operand to the worklist.
DominatorTree & DT
BuilderTy & Builder
Value * getFreelyInverted(Value *V, bool WillInvertAllUses, BuilderTy *Builder, bool &DoesConsume)
const SimplifyQuery & getSimplifyQuery() const
static Constant * AddOne(Constant *C)
Add one to a Constant.
LLVM_ABI void setHasNoUnsignedWrap(bool b=true)
Set or clear the nuw flag on this instruction, which must be an operator which supports this flag.
LLVM_ABI bool hasNoUnsignedWrap() const LLVM_READONLY
Determine whether the no unsigned wrap flag is set.
LLVM_ABI void copyFastMathFlags(FastMathFlags FMF)
Convenience function for transferring all fast-math flag values to this instruction,...
LLVM_ABI void setHasNoSignedZeros(bool B)
Set or clear the no-signed-zeros flag on this instruction, which must be an operator which supports t...
LLVM_ABI void setHasNoSignedWrap(bool b=true)
Set or clear the nsw flag on this instruction, which must be an operator which supports this flag.
const DebugLoc & getDebugLoc() const
Return the debug location for this node as a DebugLoc.
LLVM_ABI void setFastMathFlags(FastMathFlags FMF)
Convenience function for setting multiple fast-math flags on this instruction, which must be an opera...
LLVM_ABI void setHasNoInfs(bool B)
Set or clear the no-infs flag on this instruction, which must be an operator which supports this flag...
LLVM_ABI FastMathFlags getFastMathFlags() const LLVM_READONLY
Convenience function for getting all the fast-math flags, which must be an operator which supports th...
void setDebugLoc(DebugLoc Loc)
Set the debug location information for this instruction.
LLVM_ABI void copyMetadata(const Instruction &SrcInst, ArrayRef< unsigned > WL=ArrayRef< unsigned >())
Copy metadata from SrcInst to this instruction.
static Value * Negate(bool LHSIsZero, bool IsNSW, Value *Root, InstCombinerImpl &IC)
Attempt to negate Root.
Utility class for integer operators which may exhibit overflow - Add, Sub, Mul, and Shl.
Definition Operator.h:78
bool hasNoSignedWrap() const
Test whether this operation is known to never undergo signed overflow, aka the nsw property.
Definition Operator.h:111
bool hasNoUnsignedWrap() const
Test whether this operation is known to never undergo unsigned overflow, aka the nuw property.
Definition Operator.h:105
This class represents the LLVM 'select' instruction.
static SelectInst * Create(Value *C, Value *S1, Value *S2, const Twine &NameStr="", InsertPosition InsertBefore=nullptr, const Instruction *MDFrom=nullptr)
This instruction constructs a fixed permutation of two input vectors.
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
bool contains(ConstPtrType Ptr) const
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
LLVM_ABI unsigned getScalarSizeInBits() const LLVM_READONLY
If this is a vector type, return the getPrimitiveSizeInBits value for the element type.
Definition Type.cpp:236
static UnaryOperator * CreateFNegFMF(Value *Op, Instruction *FMFSource, const Twine &Name="", InsertPosition InsertBefore=nullptr)
Definition InstrTypes.h:147
LLVM Value Representation.
Definition Value.h:75
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:255
bool hasOneUse() const
Return true if there is exactly one use of this value.
Definition Value.h:439
LLVM_ABI bool hasNUsesOrMore(unsigned N) const
Return true if this value has N uses or more.
Definition Value.cpp:154
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:318
This class represents zero extension of integer types.
CallInst * Call
Changed
@ C
The default llvm calling convention, compatible with C.
Definition CallingConv.h:34
LLVM_ABI Function * getOrInsertDeclaration(Module *M, ID id, ArrayRef< Type * > OverloadTys={})
Look up the Function declaration of the intrinsic id in the Module M.
SpecificConstantMatch m_ZeroInt()
Convenience matchers for specific integer values.
BinaryOp_match< SpecificConstantMatch, SrcTy, TargetOpcode::G_SUB > m_Neg(const SrcTy &&Src)
Matches a register negated by a G_SUB.
BinaryOp_match< SrcTy, SpecificConstantMatch, TargetOpcode::G_XOR, true > m_Not(const SrcTy &&Src)
Matches a register not-ed by a G_XOR.
OneUse_match< SubPat > m_OneUse(const SubPat &SP)
match_combine_or< Ty... > m_CombineOr(const Ty &...Ps)
Combine pattern matchers matching any of Ps patterns.
cst_pred_ty< is_all_ones > m_AllOnes()
Match an integer or vector with all bits set.
cst_pred_ty< is_lowbit_mask > m_LowBitMask()
Match an integer or vector with only the low bit(s) set.
BinaryOp_match< LHS, RHS, Instruction::And > m_And(const LHS &L, const RHS &R)
PtrToIntSameSize_match< OpTy > m_PtrToIntSameSize(const DataLayout &DL, const OpTy &Op)
BinaryOp_match< LHS, RHS, Instruction::Add > m_Add(const LHS &L, const RHS &R)
BinaryOp_match< LHS, RHS, Instruction::FMul, true > m_c_FMul(const LHS &L, const RHS &R)
Matches FMul with LHS and RHS in either order.
OverflowingBinaryOp_match< LHS, RHS, Instruction::Add, OverflowingBinaryOperator::NoUnsignedWrap > m_NUWAdd(const LHS &L, const RHS &R)
BinaryOp_match< LHS, RHS, Instruction::AShr > m_AShr(const LHS &L, const RHS &R)
auto m_PtrToIntOrAddr(const OpTy &Op)
Matches PtrToInt or PtrToAddr.
BinaryOp_match< LHS, RHS, Instruction::FSub > m_FSub(const LHS &L, const RHS &R)
cst_pred_ty< is_power2 > m_Power2()
Match an integer or vector power-of-2.
OverflowingBinaryOp_match< LHS, RHS, Instruction::Add, OverflowingBinaryOperator::NoSignedWrap, true > m_c_NSWAdd(const LHS &L, const RHS &R)
BinaryOp_match< LHS, RHS, Instruction::URem > m_URem(const LHS &L, const RHS &R)
match_combine_or< CastInst_match< OpTy, TruncInst >, OpTy > m_TruncOrSelf(const OpTy &Op)
CommutativeBinaryIntrinsic_match< IntrID, T0, T1 > m_c_Intrinsic(const T0 &Op0, const T1 &Op1)
auto m_Poison()
Match an arbitrary poison constant.
ap_match< APInt > m_APInt(const APInt *&Res)
Match a ConstantInt or splatted ConstantVector, binding the specified pointer to the contained APInt.
BinaryOp_match< LHS, RHS, Instruction::And, true > m_c_And(const LHS &L, const RHS &R)
Matches an And with LHS and RHS in either order.
CastInst_match< OpTy, TruncInst > m_Trunc(const OpTy &Op)
Matches Trunc.
BinaryOp_match< LHS, RHS, Instruction::Xor > m_Xor(const LHS &L, const RHS &R)
CastOperator_match< OpTy, Instruction::PtrToAddr > m_PtrToAddr(const OpTy &Op)
Matches PtrToAddr.
ap_match< APInt > m_APIntAllowPoison(const APInt *&Res)
Match APInt while allowing poison in splat vector constants.
OverflowingBinaryOp_match< LHS, RHS, Instruction::Sub, OverflowingBinaryOperator::NoSignedWrap > m_NSWSub(const LHS &L, const RHS &R)
specific_intval< false > m_SpecificInt(const APInt &V)
Match a specific integer value or vector with all elements equal to the value.
BinaryOp_match< LHS, RHS, Instruction::FMul > m_FMul(const LHS &L, const RHS &R)
match_combine_or< CastInst_match< OpTy, ZExtInst >, OpTy > m_ZExtOrSelf(const OpTy &Op)
bool match(Val *V, const Pattern &P)
match_bind< Instruction > m_Instruction(Instruction *&I)
Match an instruction, capturing it if we match.
match_deferred< Value > m_Deferred(Value *const &V)
Like m_Specific(), but works if the specific value to match is determined as part of the same match()...
cstfp_pred_ty< is_any_zero_fp > m_AnyZeroFP()
Match a floating-point negative zero or positive zero.
specificval_ty m_Specific(const Value *V)
Match if we have a specific specified value.
DisjointOr_match< LHS, RHS > m_DisjointOr(const LHS &L, const RHS &R)
specific_intval< true > m_SpecificIntAllowPoison(const APInt &V)
ap_match< APFloat > m_APFloat(const APFloat *&Res)
Match a ConstantFP or splatted ConstantVector, binding the specified pointer to the contained APFloat...
CmpClass_match< LHS, RHS, ICmpInst, true > m_c_ICmp(CmpPredicate &Pred, const LHS &L, const RHS &R)
Matches an ICmp with a predicate over LHS and RHS in either order.
auto match_fn(const Pattern &P)
A match functor that can be used as a UnaryPredicate in functional algorithms like all_of.
cst_pred_ty< is_nonnegative > m_NonNegative()
Match an integer or vector of non-negative values.
cst_pred_ty< is_one > m_One()
Match an integer 1 or a vector with all elements equal to 1.
IntrinsicID_match m_Intrinsic()
Match intrinsic calls like this: m_Intrinsic<Intrinsic::fabs>(m_Value(X))
ThreeOps_match< Cond, LHS, RHS, Instruction::Select > m_Select(const Cond &C, const LHS &L, const RHS &R)
Matches SelectInst.
auto m_BinOp()
Match an arbitrary binary operation and ignore it.
match_combine_or< CastInst_match< OpTy, SExtInst >, OpTy > m_SExtOrSelf(const OpTy &Op)
specific_fpval m_SpecificFP(double V)
Match a specific floating point value or vector with all elements equal to the value.
auto m_Value()
Match an arbitrary value and ignore it.
BinaryOp_match< LHS, RHS, Instruction::Xor, true > m_c_Xor(const LHS &L, const RHS &R)
Matches an Xor with LHS and RHS in either order.
BinaryOp_match< LHS, RHS, Instruction::FAdd > m_FAdd(const LHS &L, const RHS &R)
BinaryOp_match< LHS, RHS, Instruction::Mul > m_Mul(const LHS &L, const RHS &R)
auto m_Constant()
Match an arbitrary Constant and ignore it.
MaxMin_match< ICmpInst, LHS, RHS, smin_pred_ty, true > m_c_SMin(const LHS &L, const RHS &R)
Matches an SMin with LHS and RHS in either order.
TwoOps_match< V1_t, V2_t, Instruction::ShuffleVector > m_Shuffle(const V1_t &v1, const V2_t &v2)
Matches ShuffleVectorInst independently of mask value.
MaxMin_match< ICmpInst, LHS, RHS, umax_pred_ty, true > m_c_UMax(const LHS &L, const RHS &R)
Matches a UMax with LHS and RHS in either order.
ThreeOps_match< decltype(m_Value()), LHS, RHS, Instruction::Select, true > m_c_Select(const LHS &L, const RHS &R)
Match Select(C, LHS, RHS) or Select(C, RHS, LHS)
CastInst_match< OpTy, FPExtInst > m_FPExt(const OpTy &Op)
SpecificCmpClass_match< LHS, RHS, ICmpInst > m_SpecificICmp(CmpPredicate MatchPred, const LHS &L, const RHS &R)
CastInst_match< OpTy, ZExtInst > m_ZExt(const OpTy &Op)
Matches ZExt.
BinaryOp_match< LHS, RHS, Instruction::UDiv > m_UDiv(const LHS &L, const RHS &R)
MaxMin_match< ICmpInst, LHS, RHS, umax_pred_ty > m_UMax(const LHS &L, const RHS &R)
cst_pred_ty< is_negated_power2 > m_NegatedPower2()
Match a integer or vector negated power-of-2.
match_immconstant_ty m_ImmConstant()
Match an arbitrary immediate Constant and ignore it.
specific_fpval m_FPOne()
Match a float 1.0 or vector with all elements equal to 1.0.
MaxMin_match< ICmpInst, LHS, RHS, umin_pred_ty, true > m_c_UMin(const LHS &L, const RHS &R)
Matches a UMin with LHS and RHS in either order.
BinaryOp_match< LHS, RHS, Instruction::Add, true > m_c_Add(const LHS &L, const RHS &R)
Matches a Add with LHS and RHS in either order.
match_combine_or< BinaryOp_match< LHS, RHS, Instruction::Add >, DisjointOr_match< LHS, RHS > > m_AddLike(const LHS &L, const RHS &R)
Match either "add" or "or disjoint".
MaxMin_match< ICmpInst, LHS, RHS, smax_pred_ty, true > m_c_SMax(const LHS &L, const RHS &R)
Matches an SMax with LHS and RHS in either order.
match_combine_or< CastInst_match< OpTy, SExtInst >, NNegZExt_match< OpTy > > m_SExtLike(const OpTy &Op)
Match either "sext" or "zext nneg".
BinaryOp_match< LHS, RHS, Instruction::SDiv > m_SDiv(const LHS &L, const RHS &R)
auto m_c_MaxOrMin(const LHS &L, const RHS &R)
OverflowingBinaryOp_match< LHS, RHS, Instruction::Sub, OverflowingBinaryOperator::NoUnsignedWrap > m_NUWSub(const LHS &L, const RHS &R)
match_combine_or< OverflowingBinaryOp_match< LHS, RHS, Instruction::Add, OverflowingBinaryOperator::NoSignedWrap >, DisjointOr_match< LHS, RHS > > m_NSWAddLike(const LHS &L, const RHS &R)
Match either "add nsw" or "or disjoint".
AnyBinaryOp_match< LHS, RHS, true > m_c_BinOp(const LHS &L, const RHS &R)
Matches a BinaryOperator with LHS and RHS in either order.
OverflowingBinaryOp_match< LHS, RHS, Instruction::Add, OverflowingBinaryOperator::NoSignedWrap > m_NSWAdd(const LHS &L, const RHS &R)
BinaryOp_match< LHS, RHS, Instruction::LShr > m_LShr(const LHS &L, const RHS &R)
CmpClass_match< LHS, RHS, ICmpInst > m_ICmp(CmpPredicate &Pred, const LHS &L, const RHS &R)
match_combine_or< CastInst_match< OpTy, ZExtInst >, CastInst_match< OpTy, SExtInst > > m_ZExtOrSExt(const OpTy &Op)
FNeg_match< OpTy > m_FNeg(const OpTy &X)
Match 'fneg X' as 'fsub -0.0, X'.
BinaryOp_match< LHS, RHS, Instruction::FAdd, true > m_c_FAdd(const LHS &L, const RHS &R)
Matches FAdd with LHS and RHS in either order.
BinaryOp_match< LHS, RHS, Instruction::Shl > m_Shl(const LHS &L, const RHS &R)
BinaryOp_match< LHS, RHS, Instruction::FDiv > m_FDiv(const LHS &L, const RHS &R)
m_Intrinsic_Ty< Opnd0 >::Ty m_VecReverse(const Opnd0 &Op0)
BinOpPred_match< LHS, RHS, is_irem_op > m_IRem(const LHS &L, const RHS &R)
Matches integer remainder operations.
CastInst_match< OpTy, FPTruncInst > m_FPTrunc(const OpTy &Op)
BinaryOp_match< LHS, RHS, Instruction::SRem > m_SRem(const LHS &L, const RHS &R)
BinaryOp_match< LHS, RHS, Instruction::Or > m_Or(const LHS &L, const RHS &R)
CastInst_match< OpTy, SExtInst > m_SExt(const OpTy &Op)
Matches SExt.
is_zero m_Zero()
Match any null constant or a vector with all elements equal to 0.
BinaryOp_match< LHS, RHS, Instruction::Or, true > m_c_Or(const LHS &L, const RHS &R)
Matches an Or with LHS and RHS in either order.
match_combine_or< OverflowingBinaryOp_match< LHS, RHS, Instruction::Add, OverflowingBinaryOperator::NoUnsignedWrap >, DisjointOr_match< LHS, RHS > > m_NUWAddLike(const LHS &L, const RHS &R)
Match either "add nuw" or "or disjoint".
BinaryOp_match< LHS, RHS, Instruction::Mul, true > m_c_Mul(const LHS &L, const RHS &R)
Matches a Mul with LHS and RHS in either order.
m_Intrinsic_Ty< Opnd0, Opnd1 >::Ty m_CopySign(const Opnd0 &Op0, const Opnd1 &Op1)
CastOperator_match< OpTy, Instruction::PtrToInt > m_PtrToInt(const OpTy &Op)
Matches PtrToInt.
BinaryOp_match< LHS, RHS, Instruction::Sub > m_Sub(const LHS &L, const RHS &R)
MaxMin_match< ICmpInst, LHS, RHS, umin_pred_ty > m_UMin(const LHS &L, const RHS &R)
@ CE
Windows NT (Windows on ARM)
Definition MCAsmInfo.h:48
Context & getContext() const
Definition BasicBlock.h:99
friend class Instruction
Iterator for Instructions in a `BasicBlock.
Definition BasicBlock.h:73
This is an optimization pass for GlobalISel generic memory operations.
LLVM_ABI bool haveNoCommonBitsSet(const WithCache< const Value * > &LHSCache, const WithCache< const Value * > &RHSCache, const SimplifyQuery &SQ)
Return true if LHS and RHS have no common bits set.
LLVM_ABI Intrinsic::ID getInverseMinMaxIntrinsic(Intrinsic::ID MinMaxID)
@ Offset
Definition DWP.cpp:532
FunctionAddr VTableAddr Value
Definition InstrProf.h:137
constexpr bool isInt(int64_t x)
Checks if an integer fits into the given bit width.
Definition MathExtras.h:165
LLVM_ABI bool isSignBitCheck(ICmpInst::Predicate Pred, const APInt &RHS, bool &TrueIfSigned)
Given an exploded icmp instruction, return true if the comparison only checks the sign bit.
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
LLVM_ATTRIBUTE_ALWAYS_INLINE DynamicAPInt & operator+=(DynamicAPInt &A, int64_t B)
LLVM_ABI bool canIgnoreSignBitOfZero(const Use &U)
Return true if the sign bit of the FP value can be ignored by the user when the value is zero.
LLVM_ABI bool isGuaranteedNotToBeUndef(const Value *V, AssumptionCache *AC=nullptr, const Instruction *CtxI=nullptr, const DominatorTree *DT=nullptr, unsigned Depth=0)
Returns true if V cannot be undef, but may be poison.
LLVM_ABI bool MaskedValueIsZero(const Value *V, const APInt &Mask, const SimplifyQuery &SQ, unsigned Depth=0)
Return true if 'V & Mask' is known to be zero.
LLVM_ABI Value * simplifySubInst(Value *LHS, Value *RHS, bool IsNSW, bool IsNUW, const SimplifyQuery &Q)
Given operands for a Sub, fold the result or return null.
LLVM_ABI bool matchSimpleRecurrence(const PHINode *P, BinaryOperator *&BO, Value *&Start, Value *&Step)
Attempt to match a simple first order recurrence cycle of the form: iv = phi Ty [Start,...
LLVM_ABI Value * simplifyAddInst(Value *LHS, Value *RHS, bool IsNSW, bool IsNUW, const SimplifyQuery &Q)
Given operands for an Add, fold the result or return null.
LLVM_ATTRIBUTE_ALWAYS_INLINE DynamicAPInt & operator*=(DynamicAPInt &A, int64_t B)
LLVM_ABI Constant * ConstantFoldUnaryOpOperand(unsigned Opcode, Constant *Op, const DataLayout &DL)
Attempt to constant fold a unary operation with the specified operand.
LLVM_ABI Value * simplifyFNegInst(Value *Op, FastMathFlags FMF, const SimplifyQuery &Q)
Given operand for an FNeg, fold the result or return null.
LLVM_ABI Value * simplifyFSubInst(Value *LHS, Value *RHS, FastMathFlags FMF, const SimplifyQuery &Q, fp::ExceptionBehavior ExBehavior=fp::ebIgnore, RoundingMode Rounding=RoundingMode::NearestTiesToEven)
Given operands for an FSub, fold the result or return null.
decltype(auto) get(const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > &Pair)
LLVM_ABI Value * simplifyFAddInst(Value *LHS, Value *RHS, FastMathFlags FMF, const SimplifyQuery &Q, fp::ExceptionBehavior ExBehavior=fp::ebIgnore, RoundingMode Rounding=RoundingMode::NearestTiesToEven)
Given operands for an FAdd, fold the result or return null.
LLVM_ABI void computeKnownBits(const Value *V, KnownBits &Known, const DataLayout &DL, AssumptionCache *AC=nullptr, const Instruction *CxtI=nullptr, const DominatorTree *DT=nullptr, bool UseInstrInfo=true, unsigned Depth=0)
Determine which bits of V are known to be either zero or one and return them in the KnownZero/KnownOn...
LLVM_ABI bool cannotBeNegativeZero(const Value *V, const SimplifyQuery &SQ, unsigned Depth=0)
Return true if we can prove that the specified FP value is never equal to -0.0.
bool none_of(R &&Range, UnaryPredicate P)
Provide wrappers to std::none_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1752
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
LLVM_ABI Constant * ConstantFoldBinaryOpOperands(unsigned Opcode, Constant *LHS, Constant *RHS, const DataLayout &DL)
Attempt to constant fold a binary operation with the specified operands.
LLVM_ABI bool isKnownNonZero(const Value *V, const SimplifyQuery &Q, unsigned Depth=0)
Return true if the given value is known to be non-zero when defined.
@ First
Helpers to iterate all locations in the MemoryEffectsBase class.
Definition ModRef.h:74
@ Mul
Product of integers.
@ FMul
Product of floats.
@ SMin
Signed integer min implemented in terms of select(cmp()).
@ Sub
Subtraction of integers.
@ Add
Sum of integers.
@ FAdd
Sum of floats.
@ UMax
Unsigned integer max implemented in terms of select(cmp()).
DWARFExpression::Operation Op
RoundingMode
Rounding mode.
LLVM_ABI bool isGuaranteedNotToBeUndefOrPoison(const Value *V, AssumptionCache *AC=nullptr, const Instruction *CtxI=nullptr, const DominatorTree *DT=nullptr, unsigned Depth=0)
Return true if this function can prove that V does not have undef bits and is never poison.
constexpr unsigned BitWidth
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
LLVM_ABI Constant * ConstantFoldBinaryInstruction(unsigned Opcode, Constant *V1, Constant *V2)
LLVM_ABI ConstantRange computeConstantRange(const Value *V, bool ForSigned, const SimplifyQuery &SQ, unsigned Depth=0)
Determine the possible constant range of an integer or vector of integer value.
void swap(llvm::BitVector &LHS, llvm::BitVector &RHS)
Implement std::swap in terms of BitVector swap.
Definition BitVector.h:872
A suitably aligned and sized character array member which can hold elements of any type.
Definition AlignOf.h:22
Value * Ptr
Common base pointer.
SmallVector< GEPOperator * > RHSGEPs
RHS GEPs until common base.
SmallVector< GEPOperator * > LHSGEPs
LHS GEPs until common base.
bool isExpensive() const
Whether expanding the GEP chains is expensive.
static CommonPointerBase compute(Value *LHS, Value *RHS)
Matching combinators.