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