1 //===- InstCombineAddSub.cpp ----------------------------------------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This file implements the visit functions for add, fadd, sub, and fsub. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "InstCombine.h" 15 #include "llvm/ADT/STLExtras.h" 16 #include "llvm/Analysis/InstructionSimplify.h" 17 #include "llvm/IR/DataLayout.h" 18 #include "llvm/IR/GetElementPtrTypeIterator.h" 19 #include "llvm/IR/PatternMatch.h" 20 using namespace llvm; 21 using namespace PatternMatch; 22 23 #define DEBUG_TYPE "instcombine" 24 25 namespace { 26 27 /// Class representing coefficient of floating-point addend. 28 /// This class needs to be highly efficient, which is especially true for 29 /// the constructor. As of I write this comment, the cost of the default 30 /// constructor is merely 4-byte-store-zero (Assuming compiler is able to 31 /// perform write-merging). 32 /// 33 class FAddendCoef { 34 public: 35 // The constructor has to initialize a APFloat, which is uncessary for 36 // most addends which have coefficient either 1 or -1. So, the constructor 37 // is expensive. In order to avoid the cost of the constructor, we should 38 // reuse some instances whenever possible. The pre-created instances 39 // FAddCombine::Add[0-5] embodies this idea. 40 // 41 FAddendCoef() : IsFp(false), BufHasFpVal(false), IntVal(0) {} 42 ~FAddendCoef(); 43 44 void set(short C) { 45 assert(!insaneIntVal(C) && "Insane coefficient"); 46 IsFp = false; IntVal = C; 47 } 48 49 void set(const APFloat& C); 50 51 void negate(); 52 53 bool isZero() const { return isInt() ? !IntVal : getFpVal().isZero(); } 54 Value *getValue(Type *) const; 55 56 // If possible, don't define operator+/operator- etc because these 57 // operators inevitably call FAddendCoef's constructor which is not cheap. 58 void operator=(const FAddendCoef &A); 59 void operator+=(const FAddendCoef &A); 60 void operator-=(const FAddendCoef &A); 61 void operator*=(const FAddendCoef &S); 62 63 bool isOne() const { return isInt() && IntVal == 1; } 64 bool isTwo() const { return isInt() && IntVal == 2; } 65 bool isMinusOne() const { return isInt() && IntVal == -1; } 66 bool isMinusTwo() const { return isInt() && IntVal == -2; } 67 68 private: 69 bool insaneIntVal(int V) { return V > 4 || V < -4; } 70 APFloat *getFpValPtr(void) 71 { return reinterpret_cast<APFloat*>(&FpValBuf.buffer[0]); } 72 const APFloat *getFpValPtr(void) const 73 { return reinterpret_cast<const APFloat*>(&FpValBuf.buffer[0]); } 74 75 const APFloat &getFpVal(void) const { 76 assert(IsFp && BufHasFpVal && "Incorret state"); 77 return *getFpValPtr(); 78 } 79 80 APFloat &getFpVal(void) { 81 assert(IsFp && BufHasFpVal && "Incorret state"); 82 return *getFpValPtr(); 83 } 84 85 bool isInt() const { return !IsFp; } 86 87 // If the coefficient is represented by an integer, promote it to a 88 // floating point. 89 void convertToFpType(const fltSemantics &Sem); 90 91 // Construct an APFloat from a signed integer. 92 // TODO: We should get rid of this function when APFloat can be constructed 93 // from an *SIGNED* integer. 94 APFloat createAPFloatFromInt(const fltSemantics &Sem, int Val); 95 private: 96 97 bool IsFp; 98 99 // True iff FpValBuf contains an instance of APFloat. 100 bool BufHasFpVal; 101 102 // The integer coefficient of an individual addend is either 1 or -1, 103 // and we try to simplify at most 4 addends from neighboring at most 104 // two instructions. So the range of <IntVal> falls in [-4, 4]. APInt 105 // is overkill of this end. 106 short IntVal; 107 108 AlignedCharArrayUnion<APFloat> FpValBuf; 109 }; 110 111 /// FAddend is used to represent floating-point addend. An addend is 112 /// represented as <C, V>, where the V is a symbolic value, and C is a 113 /// constant coefficient. A constant addend is represented as <C, 0>. 114 /// 115 class FAddend { 116 public: 117 FAddend() { Val = nullptr; } 118 119 Value *getSymVal (void) const { return Val; } 120 const FAddendCoef &getCoef(void) const { return Coeff; } 121 122 bool isConstant() const { return Val == nullptr; } 123 bool isZero() const { return Coeff.isZero(); } 124 125 void set(short Coefficient, Value *V) { Coeff.set(Coefficient), Val = V; } 126 void set(const APFloat& Coefficient, Value *V) 127 { Coeff.set(Coefficient); Val = V; } 128 void set(const ConstantFP* Coefficient, Value *V) 129 { Coeff.set(Coefficient->getValueAPF()); Val = V; } 130 131 void negate() { Coeff.negate(); } 132 133 /// Drill down the U-D chain one step to find the definition of V, and 134 /// try to break the definition into one or two addends. 135 static unsigned drillValueDownOneStep(Value* V, FAddend &A0, FAddend &A1); 136 137 /// Similar to FAddend::drillDownOneStep() except that the value being 138 /// splitted is the addend itself. 139 unsigned drillAddendDownOneStep(FAddend &Addend0, FAddend &Addend1) const; 140 141 void operator+=(const FAddend &T) { 142 assert((Val == T.Val) && "Symbolic-values disagree"); 143 Coeff += T.Coeff; 144 } 145 146 private: 147 void Scale(const FAddendCoef& ScaleAmt) { Coeff *= ScaleAmt; } 148 149 // This addend has the value of "Coeff * Val". 150 Value *Val; 151 FAddendCoef Coeff; 152 }; 153 154 /// FAddCombine is the class for optimizing an unsafe fadd/fsub along 155 /// with its neighboring at most two instructions. 156 /// 157 class FAddCombine { 158 public: 159 FAddCombine(InstCombiner::BuilderTy *B) : Builder(B), Instr(nullptr) {} 160 Value *simplify(Instruction *FAdd); 161 162 private: 163 typedef SmallVector<const FAddend*, 4> AddendVect; 164 165 Value *simplifyFAdd(AddendVect& V, unsigned InstrQuota); 166 167 Value *performFactorization(Instruction *I); 168 169 /// Convert given addend to a Value 170 Value *createAddendVal(const FAddend &A, bool& NeedNeg); 171 172 /// Return the number of instructions needed to emit the N-ary addition. 173 unsigned calcInstrNumber(const AddendVect& Vect); 174 Value *createFSub(Value *Opnd0, Value *Opnd1); 175 Value *createFAdd(Value *Opnd0, Value *Opnd1); 176 Value *createFMul(Value *Opnd0, Value *Opnd1); 177 Value *createFDiv(Value *Opnd0, Value *Opnd1); 178 Value *createFNeg(Value *V); 179 Value *createNaryFAdd(const AddendVect& Opnds, unsigned InstrQuota); 180 void createInstPostProc(Instruction *NewInst, bool NoNumber = false); 181 182 InstCombiner::BuilderTy *Builder; 183 Instruction *Instr; 184 185 private: 186 // Debugging stuff are clustered here. 187 #ifndef NDEBUG 188 unsigned CreateInstrNum; 189 void initCreateInstNum() { CreateInstrNum = 0; } 190 void incCreateInstNum() { CreateInstrNum++; } 191 #else 192 void initCreateInstNum() {} 193 void incCreateInstNum() {} 194 #endif 195 }; 196 } 197 198 //===----------------------------------------------------------------------===// 199 // 200 // Implementation of 201 // {FAddendCoef, FAddend, FAddition, FAddCombine}. 202 // 203 //===----------------------------------------------------------------------===// 204 FAddendCoef::~FAddendCoef() { 205 if (BufHasFpVal) 206 getFpValPtr()->~APFloat(); 207 } 208 209 void FAddendCoef::set(const APFloat& C) { 210 APFloat *P = getFpValPtr(); 211 212 if (isInt()) { 213 // As the buffer is meanless byte stream, we cannot call 214 // APFloat::operator=(). 215 new(P) APFloat(C); 216 } else 217 *P = C; 218 219 IsFp = BufHasFpVal = true; 220 } 221 222 void FAddendCoef::convertToFpType(const fltSemantics &Sem) { 223 if (!isInt()) 224 return; 225 226 APFloat *P = getFpValPtr(); 227 if (IntVal > 0) 228 new(P) APFloat(Sem, IntVal); 229 else { 230 new(P) APFloat(Sem, 0 - IntVal); 231 P->changeSign(); 232 } 233 IsFp = BufHasFpVal = true; 234 } 235 236 APFloat FAddendCoef::createAPFloatFromInt(const fltSemantics &Sem, int Val) { 237 if (Val >= 0) 238 return APFloat(Sem, Val); 239 240 APFloat T(Sem, 0 - Val); 241 T.changeSign(); 242 243 return T; 244 } 245 246 void FAddendCoef::operator=(const FAddendCoef &That) { 247 if (That.isInt()) 248 set(That.IntVal); 249 else 250 set(That.getFpVal()); 251 } 252 253 void FAddendCoef::operator+=(const FAddendCoef &That) { 254 enum APFloat::roundingMode RndMode = APFloat::rmNearestTiesToEven; 255 if (isInt() == That.isInt()) { 256 if (isInt()) 257 IntVal += That.IntVal; 258 else 259 getFpVal().add(That.getFpVal(), RndMode); 260 return; 261 } 262 263 if (isInt()) { 264 const APFloat &T = That.getFpVal(); 265 convertToFpType(T.getSemantics()); 266 getFpVal().add(T, RndMode); 267 return; 268 } 269 270 APFloat &T = getFpVal(); 271 T.add(createAPFloatFromInt(T.getSemantics(), That.IntVal), RndMode); 272 } 273 274 void FAddendCoef::operator-=(const FAddendCoef &That) { 275 enum APFloat::roundingMode RndMode = APFloat::rmNearestTiesToEven; 276 if (isInt() == That.isInt()) { 277 if (isInt()) 278 IntVal -= That.IntVal; 279 else 280 getFpVal().subtract(That.getFpVal(), RndMode); 281 return; 282 } 283 284 if (isInt()) { 285 const APFloat &T = That.getFpVal(); 286 convertToFpType(T.getSemantics()); 287 getFpVal().subtract(T, RndMode); 288 return; 289 } 290 291 APFloat &T = getFpVal(); 292 T.subtract(createAPFloatFromInt(T.getSemantics(), IntVal), RndMode); 293 } 294 295 void 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 return; 325 } 326 327 void FAddendCoef::negate() { 328 if (isInt()) 329 IntVal = 0 - IntVal; 330 else 331 getFpVal().changeSign(); 332 } 333 334 Value *FAddendCoef::getValue(Type *Ty) const { 335 return isInt() ? 336 ConstantFP::get(Ty, float(IntVal)) : 337 ConstantFP::get(Ty->getContext(), getFpVal()); 338 } 339 340 // The definition of <Val> Addends 341 // ========================================= 342 // A + B <1, A>, <1,B> 343 // A - B <1, A>, <1,B> 344 // 0 - B <-1, B> 345 // C * A, <C, A> 346 // A + C <1, A> <C, NULL> 347 // 0 +/- 0 <0, NULL> (corner case) 348 // 349 // Legend: A and B are not constant, C is constant 350 // 351 unsigned FAddend::drillValueDownOneStep 352 (Value *Val, FAddend &Addend0, FAddend &Addend1) { 353 Instruction *I = nullptr; 354 if (!Val || !(I = dyn_cast<Instruction>(Val))) 355 return 0; 356 357 unsigned Opcode = I->getOpcode(); 358 359 if (Opcode == Instruction::FAdd || Opcode == Instruction::FSub) { 360 ConstantFP *C0, *C1; 361 Value *Opnd0 = I->getOperand(0); 362 Value *Opnd1 = I->getOperand(1); 363 if ((C0 = dyn_cast<ConstantFP>(Opnd0)) && C0->isZero()) 364 Opnd0 = nullptr; 365 366 if ((C1 = dyn_cast<ConstantFP>(Opnd1)) && C1->isZero()) 367 Opnd1 = nullptr; 368 369 if (Opnd0) { 370 if (!C0) 371 Addend0.set(1, Opnd0); 372 else 373 Addend0.set(C0, nullptr); 374 } 375 376 if (Opnd1) { 377 FAddend &Addend = Opnd0 ? Addend1 : Addend0; 378 if (!C1) 379 Addend.set(1, Opnd1); 380 else 381 Addend.set(C1, nullptr); 382 if (Opcode == Instruction::FSub) 383 Addend.negate(); 384 } 385 386 if (Opnd0 || Opnd1) 387 return Opnd0 && Opnd1 ? 2 : 1; 388 389 // Both operands are zero. Weird! 390 Addend0.set(APFloat(C0->getValueAPF().getSemantics()), nullptr); 391 return 1; 392 } 393 394 if (I->getOpcode() == Instruction::FMul) { 395 Value *V0 = I->getOperand(0); 396 Value *V1 = I->getOperand(1); 397 if (ConstantFP *C = dyn_cast<ConstantFP>(V0)) { 398 Addend0.set(C, V1); 399 return 1; 400 } 401 402 if (ConstantFP *C = dyn_cast<ConstantFP>(V1)) { 403 Addend0.set(C, V0); 404 return 1; 405 } 406 } 407 408 return 0; 409 } 410 411 // Try to break *this* addend into two addends. e.g. Suppose this addend is 412 // <2.3, V>, and V = X + Y, by calling this function, we obtain two addends, 413 // i.e. <2.3, X> and <2.3, Y>. 414 // 415 unsigned FAddend::drillAddendDownOneStep 416 (FAddend &Addend0, FAddend &Addend1) const { 417 if (isConstant()) 418 return 0; 419 420 unsigned BreakNum = FAddend::drillValueDownOneStep(Val, Addend0, Addend1); 421 if (!BreakNum || Coeff.isOne()) 422 return BreakNum; 423 424 Addend0.Scale(Coeff); 425 426 if (BreakNum == 2) 427 Addend1.Scale(Coeff); 428 429 return BreakNum; 430 } 431 432 // Try to perform following optimization on the input instruction I. Return the 433 // simplified expression if was successful; otherwise, return 0. 434 // 435 // Instruction "I" is Simplified into 436 // ------------------------------------------------------- 437 // (x * y) +/- (x * z) x * (y +/- z) 438 // (y / x) +/- (z / x) (y +/- z) / x 439 // 440 Value *FAddCombine::performFactorization(Instruction *I) { 441 assert((I->getOpcode() == Instruction::FAdd || 442 I->getOpcode() == Instruction::FSub) && "Expect add/sub"); 443 444 Instruction *I0 = dyn_cast<Instruction>(I->getOperand(0)); 445 Instruction *I1 = dyn_cast<Instruction>(I->getOperand(1)); 446 447 if (!I0 || !I1 || I0->getOpcode() != I1->getOpcode()) 448 return nullptr; 449 450 bool isMpy = false; 451 if (I0->getOpcode() == Instruction::FMul) 452 isMpy = true; 453 else if (I0->getOpcode() != Instruction::FDiv) 454 return nullptr; 455 456 Value *Opnd0_0 = I0->getOperand(0); 457 Value *Opnd0_1 = I0->getOperand(1); 458 Value *Opnd1_0 = I1->getOperand(0); 459 Value *Opnd1_1 = I1->getOperand(1); 460 461 // Input Instr I Factor AddSub0 AddSub1 462 // ---------------------------------------------- 463 // (x*y) +/- (x*z) x y z 464 // (y/x) +/- (z/x) x y z 465 // 466 Value *Factor = nullptr; 467 Value *AddSub0 = nullptr, *AddSub1 = nullptr; 468 469 if (isMpy) { 470 if (Opnd0_0 == Opnd1_0 || Opnd0_0 == Opnd1_1) 471 Factor = Opnd0_0; 472 else if (Opnd0_1 == Opnd1_0 || Opnd0_1 == Opnd1_1) 473 Factor = Opnd0_1; 474 475 if (Factor) { 476 AddSub0 = (Factor == Opnd0_0) ? Opnd0_1 : Opnd0_0; 477 AddSub1 = (Factor == Opnd1_0) ? Opnd1_1 : Opnd1_0; 478 } 479 } else if (Opnd0_1 == Opnd1_1) { 480 Factor = Opnd0_1; 481 AddSub0 = Opnd0_0; 482 AddSub1 = Opnd1_0; 483 } 484 485 if (!Factor) 486 return nullptr; 487 488 FastMathFlags Flags; 489 Flags.setUnsafeAlgebra(); 490 if (I0) Flags &= I->getFastMathFlags(); 491 if (I1) Flags &= I->getFastMathFlags(); 492 493 // Create expression "NewAddSub = AddSub0 +/- AddsSub1" 494 Value *NewAddSub = (I->getOpcode() == Instruction::FAdd) ? 495 createFAdd(AddSub0, AddSub1) : 496 createFSub(AddSub0, AddSub1); 497 if (ConstantFP *CFP = dyn_cast<ConstantFP>(NewAddSub)) { 498 const APFloat &F = CFP->getValueAPF(); 499 if (!F.isNormal()) 500 return nullptr; 501 } else if (Instruction *II = dyn_cast<Instruction>(NewAddSub)) 502 II->setFastMathFlags(Flags); 503 504 if (isMpy) { 505 Value *RI = createFMul(Factor, NewAddSub); 506 if (Instruction *II = dyn_cast<Instruction>(RI)) 507 II->setFastMathFlags(Flags); 508 return RI; 509 } 510 511 Value *RI = createFDiv(NewAddSub, Factor); 512 if (Instruction *II = dyn_cast<Instruction>(RI)) 513 II->setFastMathFlags(Flags); 514 return RI; 515 } 516 517 Value *FAddCombine::simplify(Instruction *I) { 518 assert(I->hasUnsafeAlgebra() && "Should be in unsafe mode"); 519 520 // Currently we are not able to handle vector type. 521 if (I->getType()->isVectorTy()) 522 return nullptr; 523 524 assert((I->getOpcode() == Instruction::FAdd || 525 I->getOpcode() == Instruction::FSub) && "Expect add/sub"); 526 527 // Save the instruction before calling other member-functions. 528 Instr = I; 529 530 FAddend Opnd0, Opnd1, Opnd0_0, Opnd0_1, Opnd1_0, Opnd1_1; 531 532 unsigned OpndNum = FAddend::drillValueDownOneStep(I, Opnd0, Opnd1); 533 534 // Step 1: Expand the 1st addend into Opnd0_0 and Opnd0_1. 535 unsigned Opnd0_ExpNum = 0; 536 unsigned Opnd1_ExpNum = 0; 537 538 if (!Opnd0.isConstant()) 539 Opnd0_ExpNum = Opnd0.drillAddendDownOneStep(Opnd0_0, Opnd0_1); 540 541 // Step 2: Expand the 2nd addend into Opnd1_0 and Opnd1_1. 542 if (OpndNum == 2 && !Opnd1.isConstant()) 543 Opnd1_ExpNum = Opnd1.drillAddendDownOneStep(Opnd1_0, Opnd1_1); 544 545 // Step 3: Try to optimize Opnd0_0 + Opnd0_1 + Opnd1_0 + Opnd1_1 546 if (Opnd0_ExpNum && Opnd1_ExpNum) { 547 AddendVect AllOpnds; 548 AllOpnds.push_back(&Opnd0_0); 549 AllOpnds.push_back(&Opnd1_0); 550 if (Opnd0_ExpNum == 2) 551 AllOpnds.push_back(&Opnd0_1); 552 if (Opnd1_ExpNum == 2) 553 AllOpnds.push_back(&Opnd1_1); 554 555 // Compute instruction quota. We should save at least one instruction. 556 unsigned InstQuota = 0; 557 558 Value *V0 = I->getOperand(0); 559 Value *V1 = I->getOperand(1); 560 InstQuota = ((!isa<Constant>(V0) && V0->hasOneUse()) && 561 (!isa<Constant>(V1) && V1->hasOneUse())) ? 2 : 1; 562 563 if (Value *R = simplifyFAdd(AllOpnds, InstQuota)) 564 return R; 565 } 566 567 if (OpndNum != 2) { 568 // The input instruction is : "I=0.0 +/- V". If the "V" were able to be 569 // splitted into two addends, say "V = X - Y", the instruction would have 570 // been optimized into "I = Y - X" in the previous steps. 571 // 572 const FAddendCoef &CE = Opnd0.getCoef(); 573 return CE.isOne() ? Opnd0.getSymVal() : nullptr; 574 } 575 576 // step 4: Try to optimize Opnd0 + Opnd1_0 [+ Opnd1_1] 577 if (Opnd1_ExpNum) { 578 AddendVect AllOpnds; 579 AllOpnds.push_back(&Opnd0); 580 AllOpnds.push_back(&Opnd1_0); 581 if (Opnd1_ExpNum == 2) 582 AllOpnds.push_back(&Opnd1_1); 583 584 if (Value *R = simplifyFAdd(AllOpnds, 1)) 585 return R; 586 } 587 588 // step 5: Try to optimize Opnd1 + Opnd0_0 [+ Opnd0_1] 589 if (Opnd0_ExpNum) { 590 AddendVect AllOpnds; 591 AllOpnds.push_back(&Opnd1); 592 AllOpnds.push_back(&Opnd0_0); 593 if (Opnd0_ExpNum == 2) 594 AllOpnds.push_back(&Opnd0_1); 595 596 if (Value *R = simplifyFAdd(AllOpnds, 1)) 597 return R; 598 } 599 600 // step 6: Try factorization as the last resort, 601 return performFactorization(I); 602 } 603 604 Value *FAddCombine::simplifyFAdd(AddendVect& Addends, unsigned InstrQuota) { 605 606 unsigned AddendNum = Addends.size(); 607 assert(AddendNum <= 4 && "Too many addends"); 608 609 // For saving intermediate results; 610 unsigned NextTmpIdx = 0; 611 FAddend TmpResult[3]; 612 613 // Points to the constant addend of the resulting simplified expression. 614 // If the resulting expr has constant-addend, this constant-addend is 615 // desirable to reside at the top of the resulting expression tree. Placing 616 // constant close to supper-expr(s) will potentially reveal some optimization 617 // opportunities in super-expr(s). 618 // 619 const FAddend *ConstAdd = nullptr; 620 621 // Simplified addends are placed <SimpVect>. 622 AddendVect SimpVect; 623 624 // The outer loop works on one symbolic-value at a time. Suppose the input 625 // addends are : <a1, x>, <b1, y>, <a2, x>, <c1, z>, <b2, y>, ... 626 // The symbolic-values will be processed in this order: x, y, z. 627 // 628 for (unsigned SymIdx = 0; SymIdx < AddendNum; SymIdx++) { 629 630 const FAddend *ThisAddend = Addends[SymIdx]; 631 if (!ThisAddend) { 632 // This addend was processed before. 633 continue; 634 } 635 636 Value *Val = ThisAddend->getSymVal(); 637 unsigned StartIdx = SimpVect.size(); 638 SimpVect.push_back(ThisAddend); 639 640 // The inner loop collects addends sharing same symbolic-value, and these 641 // addends will be later on folded into a single addend. Following above 642 // example, if the symbolic value "y" is being processed, the inner loop 643 // will collect two addends "<b1,y>" and "<b2,Y>". These two addends will 644 // be later on folded into "<b1+b2, y>". 645 // 646 for (unsigned SameSymIdx = SymIdx + 1; 647 SameSymIdx < AddendNum; SameSymIdx++) { 648 const FAddend *T = Addends[SameSymIdx]; 649 if (T && T->getSymVal() == Val) { 650 // Set null such that next iteration of the outer loop will not process 651 // this addend again. 652 Addends[SameSymIdx] = nullptr; 653 SimpVect.push_back(T); 654 } 655 } 656 657 // If multiple addends share same symbolic value, fold them together. 658 if (StartIdx + 1 != SimpVect.size()) { 659 FAddend &R = TmpResult[NextTmpIdx ++]; 660 R = *SimpVect[StartIdx]; 661 for (unsigned Idx = StartIdx + 1; Idx < SimpVect.size(); Idx++) 662 R += *SimpVect[Idx]; 663 664 // Pop all addends being folded and push the resulting folded addend. 665 SimpVect.resize(StartIdx); 666 if (Val) { 667 if (!R.isZero()) { 668 SimpVect.push_back(&R); 669 } 670 } else { 671 // Don't push constant addend at this time. It will be the last element 672 // of <SimpVect>. 673 ConstAdd = &R; 674 } 675 } 676 } 677 678 assert((NextTmpIdx <= array_lengthof(TmpResult) + 1) && 679 "out-of-bound access"); 680 681 if (ConstAdd) 682 SimpVect.push_back(ConstAdd); 683 684 Value *Result; 685 if (!SimpVect.empty()) 686 Result = createNaryFAdd(SimpVect, InstrQuota); 687 else { 688 // The addition is folded to 0.0. 689 Result = ConstantFP::get(Instr->getType(), 0.0); 690 } 691 692 return Result; 693 } 694 695 Value *FAddCombine::createNaryFAdd 696 (const AddendVect &Opnds, unsigned InstrQuota) { 697 assert(!Opnds.empty() && "Expect at least one addend"); 698 699 // Step 1: Check if the # of instructions needed exceeds the quota. 700 // 701 unsigned InstrNeeded = calcInstrNumber(Opnds); 702 if (InstrNeeded > InstrQuota) 703 return nullptr; 704 705 initCreateInstNum(); 706 707 // step 2: Emit the N-ary addition. 708 // Note that at most three instructions are involved in Fadd-InstCombine: the 709 // addition in question, and at most two neighboring instructions. 710 // The resulting optimized addition should have at least one less instruction 711 // than the original addition expression tree. This implies that the resulting 712 // N-ary addition has at most two instructions, and we don't need to worry 713 // about tree-height when constructing the N-ary addition. 714 715 Value *LastVal = nullptr; 716 bool LastValNeedNeg = false; 717 718 // Iterate the addends, creating fadd/fsub using adjacent two addends. 719 for (AddendVect::const_iterator I = Opnds.begin(), E = Opnds.end(); 720 I != E; I++) { 721 bool NeedNeg; 722 Value *V = createAddendVal(**I, NeedNeg); 723 if (!LastVal) { 724 LastVal = V; 725 LastValNeedNeg = NeedNeg; 726 continue; 727 } 728 729 if (LastValNeedNeg == NeedNeg) { 730 LastVal = createFAdd(LastVal, V); 731 continue; 732 } 733 734 if (LastValNeedNeg) 735 LastVal = createFSub(V, LastVal); 736 else 737 LastVal = createFSub(LastVal, V); 738 739 LastValNeedNeg = false; 740 } 741 742 if (LastValNeedNeg) { 743 LastVal = createFNeg(LastVal); 744 } 745 746 #ifndef NDEBUG 747 assert(CreateInstrNum == InstrNeeded && 748 "Inconsistent in instruction numbers"); 749 #endif 750 751 return LastVal; 752 } 753 754 Value *FAddCombine::createFSub 755 (Value *Opnd0, Value *Opnd1) { 756 Value *V = Builder->CreateFSub(Opnd0, Opnd1); 757 if (Instruction *I = dyn_cast<Instruction>(V)) 758 createInstPostProc(I); 759 return V; 760 } 761 762 Value *FAddCombine::createFNeg(Value *V) { 763 Value *Zero = cast<Value>(ConstantFP::get(V->getType(), 0.0)); 764 Value *NewV = createFSub(Zero, V); 765 if (Instruction *I = dyn_cast<Instruction>(NewV)) 766 createInstPostProc(I, true); // fneg's don't receive instruction numbers. 767 return NewV; 768 } 769 770 Value *FAddCombine::createFAdd 771 (Value *Opnd0, Value *Opnd1) { 772 Value *V = Builder->CreateFAdd(Opnd0, Opnd1); 773 if (Instruction *I = dyn_cast<Instruction>(V)) 774 createInstPostProc(I); 775 return V; 776 } 777 778 Value *FAddCombine::createFMul(Value *Opnd0, Value *Opnd1) { 779 Value *V = Builder->CreateFMul(Opnd0, Opnd1); 780 if (Instruction *I = dyn_cast<Instruction>(V)) 781 createInstPostProc(I); 782 return V; 783 } 784 785 Value *FAddCombine::createFDiv(Value *Opnd0, Value *Opnd1) { 786 Value *V = Builder->CreateFDiv(Opnd0, Opnd1); 787 if (Instruction *I = dyn_cast<Instruction>(V)) 788 createInstPostProc(I); 789 return V; 790 } 791 792 void FAddCombine::createInstPostProc(Instruction *NewInstr, 793 bool NoNumber) { 794 NewInstr->setDebugLoc(Instr->getDebugLoc()); 795 796 // Keep track of the number of instruction created. 797 if (!NoNumber) 798 incCreateInstNum(); 799 800 // Propagate fast-math flags 801 NewInstr->setFastMathFlags(Instr->getFastMathFlags()); 802 } 803 804 // Return the number of instruction needed to emit the N-ary addition. 805 // NOTE: Keep this function in sync with createAddendVal(). 806 unsigned FAddCombine::calcInstrNumber(const AddendVect &Opnds) { 807 unsigned OpndNum = Opnds.size(); 808 unsigned InstrNeeded = OpndNum - 1; 809 810 // The number of addends in the form of "(-1)*x". 811 unsigned NegOpndNum = 0; 812 813 // Adjust the number of instructions needed to emit the N-ary add. 814 for (AddendVect::const_iterator I = Opnds.begin(), E = Opnds.end(); 815 I != E; I++) { 816 const FAddend *Opnd = *I; 817 if (Opnd->isConstant()) 818 continue; 819 820 const FAddendCoef &CE = Opnd->getCoef(); 821 if (CE.isMinusOne() || CE.isMinusTwo()) 822 NegOpndNum++; 823 824 // Let the addend be "c * x". If "c == +/-1", the value of the addend 825 // is immediately available; otherwise, it needs exactly one instruction 826 // to evaluate the value. 827 if (!CE.isMinusOne() && !CE.isOne()) 828 InstrNeeded++; 829 } 830 if (NegOpndNum == OpndNum) 831 InstrNeeded++; 832 return InstrNeeded; 833 } 834 835 // Input Addend Value NeedNeg(output) 836 // ================================================================ 837 // Constant C C false 838 // <+/-1, V> V coefficient is -1 839 // <2/-2, V> "fadd V, V" coefficient is -2 840 // <C, V> "fmul V, C" false 841 // 842 // NOTE: Keep this function in sync with FAddCombine::calcInstrNumber. 843 Value *FAddCombine::createAddendVal 844 (const FAddend &Opnd, bool &NeedNeg) { 845 const FAddendCoef &Coeff = Opnd.getCoef(); 846 847 if (Opnd.isConstant()) { 848 NeedNeg = false; 849 return Coeff.getValue(Instr->getType()); 850 } 851 852 Value *OpndVal = Opnd.getSymVal(); 853 854 if (Coeff.isMinusOne() || Coeff.isOne()) { 855 NeedNeg = Coeff.isMinusOne(); 856 return OpndVal; 857 } 858 859 if (Coeff.isTwo() || Coeff.isMinusTwo()) { 860 NeedNeg = Coeff.isMinusTwo(); 861 return createFAdd(OpndVal, OpndVal); 862 } 863 864 NeedNeg = false; 865 return createFMul(OpndVal, Coeff.getValue(Instr->getType())); 866 } 867 868 // dyn_castFoldableMul - If this value is a multiply that can be folded into 869 // other computations (because it has a constant operand), return the 870 // non-constant operand of the multiply, and set CST to point to the multiplier. 871 // Otherwise, return null. 872 // 873 static inline Value *dyn_castFoldableMul(Value *V, Constant *&CST) { 874 if (!V->hasOneUse() || !V->getType()->isIntOrIntVectorTy()) 875 return nullptr; 876 877 Instruction *I = dyn_cast<Instruction>(V); 878 if (!I) return nullptr; 879 880 if (I->getOpcode() == Instruction::Mul) 881 if ((CST = dyn_cast<Constant>(I->getOperand(1)))) 882 return I->getOperand(0); 883 if (I->getOpcode() == Instruction::Shl) 884 if ((CST = dyn_cast<Constant>(I->getOperand(1)))) { 885 // The multiplier is really 1 << CST. 886 CST = ConstantExpr::getShl(ConstantInt::get(V->getType(), 1), CST); 887 return I->getOperand(0); 888 } 889 return nullptr; 890 } 891 892 // If one of the operands only has one non-zero bit, and if the other 893 // operand has a known-zero bit in a more significant place than it (not 894 // including the sign bit) the ripple may go up to and fill the zero, but 895 // won't change the sign. For example, (X & ~4) + 1. 896 static bool checkRippleForAdd(const APInt &Op0KnownZero, 897 const APInt &Op1KnownZero) { 898 APInt Op1MaybeOne = ~Op1KnownZero; 899 // Make sure that one of the operand has at most one bit set to 1. 900 if (Op1MaybeOne.countPopulation() != 1) 901 return false; 902 903 // Find the most significant known 0 other than the sign bit. 904 int BitWidth = Op0KnownZero.getBitWidth(); 905 APInt Op0KnownZeroTemp(Op0KnownZero); 906 Op0KnownZeroTemp.clearBit(BitWidth - 1); 907 int Op0ZeroPosition = BitWidth - Op0KnownZeroTemp.countLeadingZeros() - 1; 908 909 int Op1OnePosition = BitWidth - Op1MaybeOne.countLeadingZeros() - 1; 910 assert(Op1OnePosition >= 0); 911 912 // This also covers the case of no known zero, since in that case 913 // Op0ZeroPosition is -1. 914 return Op0ZeroPosition >= Op1OnePosition; 915 } 916 917 /// WillNotOverflowSignedAdd - Return true if we can prove that: 918 /// (sext (add LHS, RHS)) === (add (sext LHS), (sext RHS)) 919 /// This basically requires proving that the add in the original type would not 920 /// overflow to change the sign bit or have a carry out. 921 /// TODO: Handle this for Vectors. 922 bool InstCombiner::WillNotOverflowSignedAdd(Value *LHS, Value *RHS) { 923 // There are different heuristics we can use for this. Here are some simple 924 // ones. 925 926 // If LHS and RHS each have at least two sign bits, the addition will look 927 // like 928 // 929 // XX..... + 930 // YY..... 931 // 932 // If the carry into the most significant position is 0, X and Y can't both 933 // be 1 and therefore the carry out of the addition is also 0. 934 // 935 // If the carry into the most significant position is 1, X and Y can't both 936 // be 0 and therefore the carry out of the addition is also 1. 937 // 938 // Since the carry into the most significant position is always equal to 939 // the carry out of the addition, there is no signed overflow. 940 if (ComputeNumSignBits(LHS) > 1 && ComputeNumSignBits(RHS) > 1) 941 return true; 942 943 if (IntegerType *IT = dyn_cast<IntegerType>(LHS->getType())) { 944 int BitWidth = IT->getBitWidth(); 945 APInt LHSKnownZero(BitWidth, 0); 946 APInt LHSKnownOne(BitWidth, 0); 947 computeKnownBits(LHS, LHSKnownZero, LHSKnownOne); 948 949 APInt RHSKnownZero(BitWidth, 0); 950 APInt RHSKnownOne(BitWidth, 0); 951 computeKnownBits(RHS, RHSKnownZero, RHSKnownOne); 952 953 // Addition of two 2's compliment numbers having opposite signs will never 954 // overflow. 955 if ((LHSKnownOne[BitWidth - 1] && RHSKnownZero[BitWidth - 1]) || 956 (LHSKnownZero[BitWidth - 1] && RHSKnownOne[BitWidth - 1])) 957 return true; 958 959 // Check if carry bit of addition will not cause overflow. 960 if (checkRippleForAdd(LHSKnownZero, RHSKnownZero)) 961 return true; 962 if (checkRippleForAdd(RHSKnownZero, LHSKnownZero)) 963 return true; 964 } 965 return false; 966 } 967 968 Instruction *InstCombiner::visitAdd(BinaryOperator &I) { 969 bool Changed = SimplifyAssociativeOrCommutative(I); 970 Value *LHS = I.getOperand(0), *RHS = I.getOperand(1); 971 972 if (Value *V = SimplifyVectorOp(I)) 973 return ReplaceInstUsesWith(I, V); 974 975 if (Value *V = SimplifyAddInst(LHS, RHS, I.hasNoSignedWrap(), 976 I.hasNoUnsignedWrap(), DL)) 977 return ReplaceInstUsesWith(I, V); 978 979 // (A*B)+(A*C) -> A*(B+C) etc 980 if (Value *V = SimplifyUsingDistributiveLaws(I)) 981 return ReplaceInstUsesWith(I, V); 982 983 if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS)) { 984 // X + (signbit) --> X ^ signbit 985 const APInt &Val = CI->getValue(); 986 if (Val.isSignBit()) 987 return BinaryOperator::CreateXor(LHS, RHS); 988 989 // See if SimplifyDemandedBits can simplify this. This handles stuff like 990 // (X & 254)+1 -> (X&254)|1 991 if (SimplifyDemandedInstructionBits(I)) 992 return &I; 993 994 // zext(bool) + C -> bool ? C + 1 : C 995 if (ZExtInst *ZI = dyn_cast<ZExtInst>(LHS)) 996 if (ZI->getSrcTy()->isIntegerTy(1)) 997 return SelectInst::Create(ZI->getOperand(0), AddOne(CI), CI); 998 999 Value *XorLHS = nullptr; ConstantInt *XorRHS = nullptr; 1000 if (match(LHS, m_Xor(m_Value(XorLHS), m_ConstantInt(XorRHS)))) { 1001 uint32_t TySizeBits = I.getType()->getScalarSizeInBits(); 1002 const APInt &RHSVal = CI->getValue(); 1003 unsigned ExtendAmt = 0; 1004 // If we have ADD(XOR(AND(X, 0xFF), 0x80), 0xF..F80), it's a sext. 1005 // If we have ADD(XOR(AND(X, 0xFF), 0xF..F80), 0x80), it's a sext. 1006 if (XorRHS->getValue() == -RHSVal) { 1007 if (RHSVal.isPowerOf2()) 1008 ExtendAmt = TySizeBits - RHSVal.logBase2() - 1; 1009 else if (XorRHS->getValue().isPowerOf2()) 1010 ExtendAmt = TySizeBits - XorRHS->getValue().logBase2() - 1; 1011 } 1012 1013 if (ExtendAmt) { 1014 APInt Mask = APInt::getHighBitsSet(TySizeBits, ExtendAmt); 1015 if (!MaskedValueIsZero(XorLHS, Mask)) 1016 ExtendAmt = 0; 1017 } 1018 1019 if (ExtendAmt) { 1020 Constant *ShAmt = ConstantInt::get(I.getType(), ExtendAmt); 1021 Value *NewShl = Builder->CreateShl(XorLHS, ShAmt, "sext"); 1022 return BinaryOperator::CreateAShr(NewShl, ShAmt); 1023 } 1024 1025 // If this is a xor that was canonicalized from a sub, turn it back into 1026 // a sub and fuse this add with it. 1027 if (LHS->hasOneUse() && (XorRHS->getValue()+1).isPowerOf2()) { 1028 IntegerType *IT = cast<IntegerType>(I.getType()); 1029 APInt LHSKnownOne(IT->getBitWidth(), 0); 1030 APInt LHSKnownZero(IT->getBitWidth(), 0); 1031 computeKnownBits(XorLHS, LHSKnownZero, LHSKnownOne); 1032 if ((XorRHS->getValue() | LHSKnownZero).isAllOnesValue()) 1033 return BinaryOperator::CreateSub(ConstantExpr::getAdd(XorRHS, CI), 1034 XorLHS); 1035 } 1036 // (X + signbit) + C could have gotten canonicalized to (X ^ signbit) + C, 1037 // transform them into (X + (signbit ^ C)) 1038 if (XorRHS->getValue().isSignBit()) 1039 return BinaryOperator::CreateAdd(XorLHS, 1040 ConstantExpr::getXor(XorRHS, CI)); 1041 } 1042 } 1043 1044 if (isa<Constant>(RHS) && isa<PHINode>(LHS)) 1045 if (Instruction *NV = FoldOpIntoPhi(I)) 1046 return NV; 1047 1048 if (I.getType()->getScalarType()->isIntegerTy(1)) 1049 return BinaryOperator::CreateXor(LHS, RHS); 1050 1051 // X + X --> X << 1 1052 if (LHS == RHS) { 1053 BinaryOperator *New = 1054 BinaryOperator::CreateShl(LHS, ConstantInt::get(I.getType(), 1)); 1055 New->setHasNoSignedWrap(I.hasNoSignedWrap()); 1056 New->setHasNoUnsignedWrap(I.hasNoUnsignedWrap()); 1057 return New; 1058 } 1059 1060 // -A + B --> B - A 1061 // -A + -B --> -(A + B) 1062 if (Value *LHSV = dyn_castNegVal(LHS)) { 1063 if (!isa<Constant>(RHS)) 1064 if (Value *RHSV = dyn_castNegVal(RHS)) { 1065 Value *NewAdd = Builder->CreateAdd(LHSV, RHSV, "sum"); 1066 return BinaryOperator::CreateNeg(NewAdd); 1067 } 1068 1069 return BinaryOperator::CreateSub(RHS, LHSV); 1070 } 1071 1072 // A + -B --> A - B 1073 if (!isa<Constant>(RHS)) 1074 if (Value *V = dyn_castNegVal(RHS)) 1075 return BinaryOperator::CreateSub(LHS, V); 1076 1077 1078 { 1079 Constant *C2; 1080 if (Value *X = dyn_castFoldableMul(LHS, C2)) { 1081 if (X == RHS) // X*C + X --> X * (C+1) 1082 return BinaryOperator::CreateMul(RHS, AddOne(C2)); 1083 1084 // X*C1 + X*C2 --> X * (C1+C2) 1085 Constant *C1; 1086 if (X == dyn_castFoldableMul(RHS, C1)) 1087 return BinaryOperator::CreateMul(X, ConstantExpr::getAdd(C1, C2)); 1088 } 1089 1090 // X + X*C --> X * (C+1) 1091 if (dyn_castFoldableMul(RHS, C2) == LHS) 1092 return BinaryOperator::CreateMul(LHS, AddOne(C2)); 1093 } 1094 1095 // A+B --> A|B iff A and B have no bits set in common. 1096 if (IntegerType *IT = dyn_cast<IntegerType>(I.getType())) { 1097 APInt LHSKnownOne(IT->getBitWidth(), 0); 1098 APInt LHSKnownZero(IT->getBitWidth(), 0); 1099 computeKnownBits(LHS, LHSKnownZero, LHSKnownOne); 1100 if (LHSKnownZero != 0) { 1101 APInt RHSKnownOne(IT->getBitWidth(), 0); 1102 APInt RHSKnownZero(IT->getBitWidth(), 0); 1103 computeKnownBits(RHS, RHSKnownZero, RHSKnownOne); 1104 1105 // No bits in common -> bitwise or. 1106 if ((LHSKnownZero|RHSKnownZero).isAllOnesValue()) 1107 return BinaryOperator::CreateOr(LHS, RHS); 1108 } 1109 } 1110 1111 // W*X + Y*Z --> W * (X+Z) iff W == Y 1112 { 1113 Value *W, *X, *Y, *Z; 1114 if (match(LHS, m_Mul(m_Value(W), m_Value(X))) && 1115 match(RHS, m_Mul(m_Value(Y), m_Value(Z)))) { 1116 if (W != Y) { 1117 if (W == Z) { 1118 std::swap(Y, Z); 1119 } else if (Y == X) { 1120 std::swap(W, X); 1121 } else if (X == Z) { 1122 std::swap(Y, Z); 1123 std::swap(W, X); 1124 } 1125 } 1126 1127 if (W == Y) { 1128 Value *NewAdd = Builder->CreateAdd(X, Z, LHS->getName()); 1129 return BinaryOperator::CreateMul(W, NewAdd); 1130 } 1131 } 1132 } 1133 1134 if (Constant *CRHS = dyn_cast<Constant>(RHS)) { 1135 Value *X; 1136 if (match(LHS, m_Not(m_Value(X)))) // ~X + C --> (C-1) - X 1137 return BinaryOperator::CreateSub(SubOne(CRHS), X); 1138 } 1139 1140 if (ConstantInt *CRHS = dyn_cast<ConstantInt>(RHS)) { 1141 // (X & FF00) + xx00 -> (X+xx00) & FF00 1142 Value *X; 1143 ConstantInt *C2; 1144 if (LHS->hasOneUse() && 1145 match(LHS, m_And(m_Value(X), m_ConstantInt(C2))) && 1146 CRHS->getValue() == (CRHS->getValue() & C2->getValue())) { 1147 // See if all bits from the first bit set in the Add RHS up are included 1148 // in the mask. First, get the rightmost bit. 1149 const APInt &AddRHSV = CRHS->getValue(); 1150 1151 // Form a mask of all bits from the lowest bit added through the top. 1152 APInt AddRHSHighBits(~((AddRHSV & -AddRHSV)-1)); 1153 1154 // See if the and mask includes all of these bits. 1155 APInt AddRHSHighBitsAnd(AddRHSHighBits & C2->getValue()); 1156 1157 if (AddRHSHighBits == AddRHSHighBitsAnd) { 1158 // Okay, the xform is safe. Insert the new add pronto. 1159 Value *NewAdd = Builder->CreateAdd(X, CRHS, LHS->getName()); 1160 return BinaryOperator::CreateAnd(NewAdd, C2); 1161 } 1162 } 1163 1164 // Try to fold constant add into select arguments. 1165 if (SelectInst *SI = dyn_cast<SelectInst>(LHS)) 1166 if (Instruction *R = FoldOpIntoSelect(I, SI)) 1167 return R; 1168 } 1169 1170 // add (select X 0 (sub n A)) A --> select X A n 1171 { 1172 SelectInst *SI = dyn_cast<SelectInst>(LHS); 1173 Value *A = RHS; 1174 if (!SI) { 1175 SI = dyn_cast<SelectInst>(RHS); 1176 A = LHS; 1177 } 1178 if (SI && SI->hasOneUse()) { 1179 Value *TV = SI->getTrueValue(); 1180 Value *FV = SI->getFalseValue(); 1181 Value *N; 1182 1183 // Can we fold the add into the argument of the select? 1184 // We check both true and false select arguments for a matching subtract. 1185 if (match(FV, m_Zero()) && match(TV, m_Sub(m_Value(N), m_Specific(A)))) 1186 // Fold the add into the true select value. 1187 return SelectInst::Create(SI->getCondition(), N, A); 1188 1189 if (match(TV, m_Zero()) && match(FV, m_Sub(m_Value(N), m_Specific(A)))) 1190 // Fold the add into the false select value. 1191 return SelectInst::Create(SI->getCondition(), A, N); 1192 } 1193 } 1194 1195 // Check for (add (sext x), y), see if we can merge this into an 1196 // integer add followed by a sext. 1197 if (SExtInst *LHSConv = dyn_cast<SExtInst>(LHS)) { 1198 // (add (sext x), cst) --> (sext (add x, cst')) 1199 if (ConstantInt *RHSC = dyn_cast<ConstantInt>(RHS)) { 1200 Constant *CI = 1201 ConstantExpr::getTrunc(RHSC, LHSConv->getOperand(0)->getType()); 1202 if (LHSConv->hasOneUse() && 1203 ConstantExpr::getSExt(CI, I.getType()) == RHSC && 1204 WillNotOverflowSignedAdd(LHSConv->getOperand(0), CI)) { 1205 // Insert the new, smaller add. 1206 Value *NewAdd = Builder->CreateNSWAdd(LHSConv->getOperand(0), 1207 CI, "addconv"); 1208 return new SExtInst(NewAdd, I.getType()); 1209 } 1210 } 1211 1212 // (add (sext x), (sext y)) --> (sext (add int x, y)) 1213 if (SExtInst *RHSConv = dyn_cast<SExtInst>(RHS)) { 1214 // Only do this if x/y have the same type, if at last one of them has a 1215 // single use (so we don't increase the number of sexts), and if the 1216 // integer add will not overflow. 1217 if (LHSConv->getOperand(0)->getType()==RHSConv->getOperand(0)->getType()&& 1218 (LHSConv->hasOneUse() || RHSConv->hasOneUse()) && 1219 WillNotOverflowSignedAdd(LHSConv->getOperand(0), 1220 RHSConv->getOperand(0))) { 1221 // Insert the new integer add. 1222 Value *NewAdd = Builder->CreateNSWAdd(LHSConv->getOperand(0), 1223 RHSConv->getOperand(0), "addconv"); 1224 return new SExtInst(NewAdd, I.getType()); 1225 } 1226 } 1227 } 1228 1229 // Check for (x & y) + (x ^ y) 1230 { 1231 Value *A = nullptr, *B = nullptr; 1232 if (match(RHS, m_Xor(m_Value(A), m_Value(B))) && 1233 (match(LHS, m_And(m_Specific(A), m_Specific(B))) || 1234 match(LHS, m_And(m_Specific(B), m_Specific(A))))) 1235 return BinaryOperator::CreateOr(A, B); 1236 1237 if (match(LHS, m_Xor(m_Value(A), m_Value(B))) && 1238 (match(RHS, m_And(m_Specific(A), m_Specific(B))) || 1239 match(RHS, m_And(m_Specific(B), m_Specific(A))))) 1240 return BinaryOperator::CreateOr(A, B); 1241 } 1242 1243 if (!I.hasNoSignedWrap() && WillNotOverflowSignedAdd(LHS, RHS)) { 1244 Changed = true; 1245 I.setHasNoSignedWrap(true); 1246 } 1247 1248 return Changed ? &I : nullptr; 1249 } 1250 1251 Instruction *InstCombiner::visitFAdd(BinaryOperator &I) { 1252 bool Changed = SimplifyAssociativeOrCommutative(I); 1253 Value *LHS = I.getOperand(0), *RHS = I.getOperand(1); 1254 1255 if (Value *V = SimplifyVectorOp(I)) 1256 return ReplaceInstUsesWith(I, V); 1257 1258 if (Value *V = SimplifyFAddInst(LHS, RHS, I.getFastMathFlags(), DL)) 1259 return ReplaceInstUsesWith(I, V); 1260 1261 if (isa<Constant>(RHS)) { 1262 if (isa<PHINode>(LHS)) 1263 if (Instruction *NV = FoldOpIntoPhi(I)) 1264 return NV; 1265 1266 if (SelectInst *SI = dyn_cast<SelectInst>(LHS)) 1267 if (Instruction *NV = FoldOpIntoSelect(I, SI)) 1268 return NV; 1269 } 1270 1271 // -A + B --> B - A 1272 // -A + -B --> -(A + B) 1273 if (Value *LHSV = dyn_castFNegVal(LHS)) { 1274 Instruction *RI = BinaryOperator::CreateFSub(RHS, LHSV); 1275 RI->copyFastMathFlags(&I); 1276 return RI; 1277 } 1278 1279 // A + -B --> A - B 1280 if (!isa<Constant>(RHS)) 1281 if (Value *V = dyn_castFNegVal(RHS)) { 1282 Instruction *RI = BinaryOperator::CreateFSub(LHS, V); 1283 RI->copyFastMathFlags(&I); 1284 return RI; 1285 } 1286 1287 // Check for (fadd double (sitofp x), y), see if we can merge this into an 1288 // integer add followed by a promotion. 1289 if (SIToFPInst *LHSConv = dyn_cast<SIToFPInst>(LHS)) { 1290 // (fadd double (sitofp x), fpcst) --> (sitofp (add int x, intcst)) 1291 // ... if the constant fits in the integer value. This is useful for things 1292 // like (double)(x & 1234) + 4.0 -> (double)((X & 1234)+4) which no longer 1293 // requires a constant pool load, and generally allows the add to be better 1294 // instcombined. 1295 if (ConstantFP *CFP = dyn_cast<ConstantFP>(RHS)) { 1296 Constant *CI = 1297 ConstantExpr::getFPToSI(CFP, LHSConv->getOperand(0)->getType()); 1298 if (LHSConv->hasOneUse() && 1299 ConstantExpr::getSIToFP(CI, I.getType()) == CFP && 1300 WillNotOverflowSignedAdd(LHSConv->getOperand(0), CI)) { 1301 // Insert the new integer add. 1302 Value *NewAdd = Builder->CreateNSWAdd(LHSConv->getOperand(0), 1303 CI, "addconv"); 1304 return new SIToFPInst(NewAdd, I.getType()); 1305 } 1306 } 1307 1308 // (fadd double (sitofp x), (sitofp y)) --> (sitofp (add int x, y)) 1309 if (SIToFPInst *RHSConv = dyn_cast<SIToFPInst>(RHS)) { 1310 // Only do this if x/y have the same type, if at last one of them has a 1311 // single use (so we don't increase the number of int->fp conversions), 1312 // and if the integer add will not overflow. 1313 if (LHSConv->getOperand(0)->getType()==RHSConv->getOperand(0)->getType()&& 1314 (LHSConv->hasOneUse() || RHSConv->hasOneUse()) && 1315 WillNotOverflowSignedAdd(LHSConv->getOperand(0), 1316 RHSConv->getOperand(0))) { 1317 // Insert the new integer add. 1318 Value *NewAdd = Builder->CreateNSWAdd(LHSConv->getOperand(0), 1319 RHSConv->getOperand(0),"addconv"); 1320 return new SIToFPInst(NewAdd, I.getType()); 1321 } 1322 } 1323 } 1324 1325 // select C, 0, B + select C, A, 0 -> select C, A, B 1326 { 1327 Value *A1, *B1, *C1, *A2, *B2, *C2; 1328 if (match(LHS, m_Select(m_Value(C1), m_Value(A1), m_Value(B1))) && 1329 match(RHS, m_Select(m_Value(C2), m_Value(A2), m_Value(B2)))) { 1330 if (C1 == C2) { 1331 Constant *Z1=nullptr, *Z2=nullptr; 1332 Value *A, *B, *C=C1; 1333 if (match(A1, m_AnyZero()) && match(B2, m_AnyZero())) { 1334 Z1 = dyn_cast<Constant>(A1); A = A2; 1335 Z2 = dyn_cast<Constant>(B2); B = B1; 1336 } else if (match(B1, m_AnyZero()) && match(A2, m_AnyZero())) { 1337 Z1 = dyn_cast<Constant>(B1); B = B2; 1338 Z2 = dyn_cast<Constant>(A2); A = A1; 1339 } 1340 1341 if (Z1 && Z2 && 1342 (I.hasNoSignedZeros() || 1343 (Z1->isNegativeZeroValue() && Z2->isNegativeZeroValue()))) { 1344 return SelectInst::Create(C, A, B); 1345 } 1346 } 1347 } 1348 } 1349 1350 if (I.hasUnsafeAlgebra()) { 1351 if (Value *V = FAddCombine(Builder).simplify(&I)) 1352 return ReplaceInstUsesWith(I, V); 1353 } 1354 1355 return Changed ? &I : nullptr; 1356 } 1357 1358 1359 /// Optimize pointer differences into the same array into a size. Consider: 1360 /// &A[10] - &A[0]: we should compile this to "10". LHS/RHS are the pointer 1361 /// operands to the ptrtoint instructions for the LHS/RHS of the subtract. 1362 /// 1363 Value *InstCombiner::OptimizePointerDifference(Value *LHS, Value *RHS, 1364 Type *Ty) { 1365 assert(DL && "Must have target data info for this"); 1366 1367 // If LHS is a gep based on RHS or RHS is a gep based on LHS, we can optimize 1368 // this. 1369 bool Swapped = false; 1370 GEPOperator *GEP1 = nullptr, *GEP2 = nullptr; 1371 1372 // For now we require one side to be the base pointer "A" or a constant 1373 // GEP derived from it. 1374 if (GEPOperator *LHSGEP = dyn_cast<GEPOperator>(LHS)) { 1375 // (gep X, ...) - X 1376 if (LHSGEP->getOperand(0) == RHS) { 1377 GEP1 = LHSGEP; 1378 Swapped = false; 1379 } else if (GEPOperator *RHSGEP = dyn_cast<GEPOperator>(RHS)) { 1380 // (gep X, ...) - (gep X, ...) 1381 if (LHSGEP->getOperand(0)->stripPointerCasts() == 1382 RHSGEP->getOperand(0)->stripPointerCasts()) { 1383 GEP2 = RHSGEP; 1384 GEP1 = LHSGEP; 1385 Swapped = false; 1386 } 1387 } 1388 } 1389 1390 if (GEPOperator *RHSGEP = dyn_cast<GEPOperator>(RHS)) { 1391 // X - (gep X, ...) 1392 if (RHSGEP->getOperand(0) == LHS) { 1393 GEP1 = RHSGEP; 1394 Swapped = true; 1395 } else if (GEPOperator *LHSGEP = dyn_cast<GEPOperator>(LHS)) { 1396 // (gep X, ...) - (gep X, ...) 1397 if (RHSGEP->getOperand(0)->stripPointerCasts() == 1398 LHSGEP->getOperand(0)->stripPointerCasts()) { 1399 GEP2 = LHSGEP; 1400 GEP1 = RHSGEP; 1401 Swapped = true; 1402 } 1403 } 1404 } 1405 1406 // Avoid duplicating the arithmetic if GEP2 has non-constant indices and 1407 // multiple users. 1408 if (!GEP1 || 1409 (GEP2 && !GEP2->hasAllConstantIndices() && !GEP2->hasOneUse())) 1410 return nullptr; 1411 1412 // Emit the offset of the GEP and an intptr_t. 1413 Value *Result = EmitGEPOffset(GEP1); 1414 1415 // If we had a constant expression GEP on the other side offsetting the 1416 // pointer, subtract it from the offset we have. 1417 if (GEP2) { 1418 Value *Offset = EmitGEPOffset(GEP2); 1419 Result = Builder->CreateSub(Result, Offset); 1420 } 1421 1422 // If we have p - gep(p, ...) then we have to negate the result. 1423 if (Swapped) 1424 Result = Builder->CreateNeg(Result, "diff.neg"); 1425 1426 return Builder->CreateIntCast(Result, Ty, true); 1427 } 1428 1429 1430 Instruction *InstCombiner::visitSub(BinaryOperator &I) { 1431 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 1432 1433 if (Value *V = SimplifyVectorOp(I)) 1434 return ReplaceInstUsesWith(I, V); 1435 1436 if (Value *V = SimplifySubInst(Op0, Op1, I.hasNoSignedWrap(), 1437 I.hasNoUnsignedWrap(), DL)) 1438 return ReplaceInstUsesWith(I, V); 1439 1440 // (A*B)-(A*C) -> A*(B-C) etc 1441 if (Value *V = SimplifyUsingDistributiveLaws(I)) 1442 return ReplaceInstUsesWith(I, V); 1443 1444 // If this is a 'B = x-(-A)', change to B = x+A. This preserves NSW/NUW. 1445 if (Value *V = dyn_castNegVal(Op1)) { 1446 BinaryOperator *Res = BinaryOperator::CreateAdd(Op0, V); 1447 Res->setHasNoSignedWrap(I.hasNoSignedWrap()); 1448 Res->setHasNoUnsignedWrap(I.hasNoUnsignedWrap()); 1449 return Res; 1450 } 1451 1452 if (I.getType()->isIntegerTy(1)) 1453 return BinaryOperator::CreateXor(Op0, Op1); 1454 1455 // Replace (-1 - A) with (~A). 1456 if (match(Op0, m_AllOnes())) 1457 return BinaryOperator::CreateNot(Op1); 1458 1459 if (Constant *C = dyn_cast<Constant>(Op0)) { 1460 // C - ~X == X + (1+C) 1461 Value *X = nullptr; 1462 if (match(Op1, m_Not(m_Value(X)))) 1463 return BinaryOperator::CreateAdd(X, AddOne(C)); 1464 1465 // Try to fold constant sub into select arguments. 1466 if (SelectInst *SI = dyn_cast<SelectInst>(Op1)) 1467 if (Instruction *R = FoldOpIntoSelect(I, SI)) 1468 return R; 1469 1470 // C-(X+C2) --> (C-C2)-X 1471 Constant *C2; 1472 if (match(Op1, m_Add(m_Value(X), m_Constant(C2)))) 1473 return BinaryOperator::CreateSub(ConstantExpr::getSub(C, C2), X); 1474 1475 if (SimplifyDemandedInstructionBits(I)) 1476 return &I; 1477 1478 // Fold (sub 0, (zext bool to B)) --> (sext bool to B) 1479 if (C->isNullValue() && match(Op1, m_ZExt(m_Value(X)))) 1480 if (X->getType()->getScalarType()->isIntegerTy(1)) 1481 return CastInst::CreateSExtOrBitCast(X, Op1->getType()); 1482 1483 // Fold (sub 0, (sext bool to B)) --> (zext bool to B) 1484 if (C->isNullValue() && match(Op1, m_SExt(m_Value(X)))) 1485 if (X->getType()->getScalarType()->isIntegerTy(1)) 1486 return CastInst::CreateZExtOrBitCast(X, Op1->getType()); 1487 } 1488 1489 if (ConstantInt *C = dyn_cast<ConstantInt>(Op0)) { 1490 // -(X >>u 31) -> (X >>s 31) 1491 // -(X >>s 31) -> (X >>u 31) 1492 if (C->isZero()) { 1493 Value *X; ConstantInt *CI; 1494 if (match(Op1, m_LShr(m_Value(X), m_ConstantInt(CI))) && 1495 // Verify we are shifting out everything but the sign bit. 1496 CI->getValue() == I.getType()->getPrimitiveSizeInBits()-1) 1497 return BinaryOperator::CreateAShr(X, CI); 1498 1499 if (match(Op1, m_AShr(m_Value(X), m_ConstantInt(CI))) && 1500 // Verify we are shifting out everything but the sign bit. 1501 CI->getValue() == I.getType()->getPrimitiveSizeInBits()-1) 1502 return BinaryOperator::CreateLShr(X, CI); 1503 } 1504 } 1505 1506 1507 { Value *Y; 1508 // X-(X+Y) == -Y X-(Y+X) == -Y 1509 if (match(Op1, m_Add(m_Specific(Op0), m_Value(Y))) || 1510 match(Op1, m_Add(m_Value(Y), m_Specific(Op0)))) 1511 return BinaryOperator::CreateNeg(Y); 1512 1513 // (X-Y)-X == -Y 1514 if (match(Op0, m_Sub(m_Specific(Op1), m_Value(Y)))) 1515 return BinaryOperator::CreateNeg(Y); 1516 } 1517 1518 if (Op1->hasOneUse()) { 1519 Value *X = nullptr, *Y = nullptr, *Z = nullptr; 1520 Constant *C = nullptr; 1521 Constant *CI = nullptr; 1522 1523 // (X - (Y - Z)) --> (X + (Z - Y)). 1524 if (match(Op1, m_Sub(m_Value(Y), m_Value(Z)))) 1525 return BinaryOperator::CreateAdd(Op0, 1526 Builder->CreateSub(Z, Y, Op1->getName())); 1527 1528 // (X - (X & Y)) --> (X & ~Y) 1529 // 1530 if (match(Op1, m_And(m_Value(Y), m_Specific(Op0))) || 1531 match(Op1, m_And(m_Specific(Op0), m_Value(Y)))) 1532 return BinaryOperator::CreateAnd(Op0, 1533 Builder->CreateNot(Y, Y->getName() + ".not")); 1534 1535 // 0 - (X sdiv C) -> (X sdiv -C) 1536 if (match(Op1, m_SDiv(m_Value(X), m_Constant(C))) && 1537 match(Op0, m_Zero())) 1538 return BinaryOperator::CreateSDiv(X, ConstantExpr::getNeg(C)); 1539 1540 // 0 - (X << Y) -> (-X << Y) when X is freely negatable. 1541 if (match(Op1, m_Shl(m_Value(X), m_Value(Y))) && match(Op0, m_Zero())) 1542 if (Value *XNeg = dyn_castNegVal(X)) 1543 return BinaryOperator::CreateShl(XNeg, Y); 1544 1545 // X - X*C --> X * (1-C) 1546 if (match(Op1, m_Mul(m_Specific(Op0), m_Constant(CI)))) { 1547 Constant *CP1 = ConstantExpr::getSub(ConstantInt::get(I.getType(),1), CI); 1548 return BinaryOperator::CreateMul(Op0, CP1); 1549 } 1550 1551 // X - X<<C --> X * (1-(1<<C)) 1552 if (match(Op1, m_Shl(m_Specific(Op0), m_Constant(CI)))) { 1553 Constant *One = ConstantInt::get(I.getType(), 1); 1554 C = ConstantExpr::getSub(One, ConstantExpr::getShl(One, CI)); 1555 return BinaryOperator::CreateMul(Op0, C); 1556 } 1557 1558 // X - A*-B -> X + A*B 1559 // X - -A*B -> X + A*B 1560 Value *A, *B; 1561 if (match(Op1, m_Mul(m_Value(A), m_Neg(m_Value(B)))) || 1562 match(Op1, m_Mul(m_Neg(m_Value(A)), m_Value(B)))) 1563 return BinaryOperator::CreateAdd(Op0, Builder->CreateMul(A, B)); 1564 1565 // X - A*CI -> X + A*-CI 1566 // X - CI*A -> X + A*-CI 1567 if (match(Op1, m_Mul(m_Value(A), m_Constant(CI))) || 1568 match(Op1, m_Mul(m_Constant(CI), m_Value(A)))) { 1569 Value *NewMul = Builder->CreateMul(A, ConstantExpr::getNeg(CI)); 1570 return BinaryOperator::CreateAdd(Op0, NewMul); 1571 } 1572 } 1573 1574 Constant *C1; 1575 if (Value *X = dyn_castFoldableMul(Op0, C1)) { 1576 if (X == Op1) // X*C - X --> X * (C-1) 1577 return BinaryOperator::CreateMul(Op1, SubOne(C1)); 1578 1579 Constant *C2; // X*C1 - X*C2 -> X * (C1-C2) 1580 if (X == dyn_castFoldableMul(Op1, C2)) 1581 return BinaryOperator::CreateMul(X, ConstantExpr::getSub(C1, C2)); 1582 } 1583 1584 // Optimize pointer differences into the same array into a size. Consider: 1585 // &A[10] - &A[0]: we should compile this to "10". 1586 if (DL) { 1587 Value *LHSOp, *RHSOp; 1588 if (match(Op0, m_PtrToInt(m_Value(LHSOp))) && 1589 match(Op1, m_PtrToInt(m_Value(RHSOp)))) 1590 if (Value *Res = OptimizePointerDifference(LHSOp, RHSOp, I.getType())) 1591 return ReplaceInstUsesWith(I, Res); 1592 1593 // trunc(p)-trunc(q) -> trunc(p-q) 1594 if (match(Op0, m_Trunc(m_PtrToInt(m_Value(LHSOp)))) && 1595 match(Op1, m_Trunc(m_PtrToInt(m_Value(RHSOp))))) 1596 if (Value *Res = OptimizePointerDifference(LHSOp, RHSOp, I.getType())) 1597 return ReplaceInstUsesWith(I, Res); 1598 } 1599 1600 return nullptr; 1601 } 1602 1603 Instruction *InstCombiner::visitFSub(BinaryOperator &I) { 1604 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1); 1605 1606 if (Value *V = SimplifyVectorOp(I)) 1607 return ReplaceInstUsesWith(I, V); 1608 1609 if (Value *V = SimplifyFSubInst(Op0, Op1, I.getFastMathFlags(), DL)) 1610 return ReplaceInstUsesWith(I, V); 1611 1612 if (isa<Constant>(Op0)) 1613 if (SelectInst *SI = dyn_cast<SelectInst>(Op1)) 1614 if (Instruction *NV = FoldOpIntoSelect(I, SI)) 1615 return NV; 1616 1617 // If this is a 'B = x-(-A)', change to B = x+A, potentially looking 1618 // through FP extensions/truncations along the way. 1619 if (Value *V = dyn_castFNegVal(Op1)) { 1620 Instruction *NewI = BinaryOperator::CreateFAdd(Op0, V); 1621 NewI->copyFastMathFlags(&I); 1622 return NewI; 1623 } 1624 if (FPTruncInst *FPTI = dyn_cast<FPTruncInst>(Op1)) { 1625 if (Value *V = dyn_castFNegVal(FPTI->getOperand(0))) { 1626 Value *NewTrunc = Builder->CreateFPTrunc(V, I.getType()); 1627 Instruction *NewI = BinaryOperator::CreateFAdd(Op0, NewTrunc); 1628 NewI->copyFastMathFlags(&I); 1629 return NewI; 1630 } 1631 } else if (FPExtInst *FPEI = dyn_cast<FPExtInst>(Op1)) { 1632 if (Value *V = dyn_castFNegVal(FPEI->getOperand(0))) { 1633 Value *NewExt = Builder->CreateFPExt(V, I.getType()); 1634 Instruction *NewI = BinaryOperator::CreateFAdd(Op0, NewExt); 1635 NewI->copyFastMathFlags(&I); 1636 return NewI; 1637 } 1638 } 1639 1640 if (I.hasUnsafeAlgebra()) { 1641 if (Value *V = FAddCombine(Builder).simplify(&I)) 1642 return ReplaceInstUsesWith(I, V); 1643 } 1644 1645 return nullptr; 1646 } 1647