lib/Transforms/Scalar/InstructionCombining.cpp

   1 //===- InstructionCombining.cpp - Combine multiple instructions -------------=//
   2 //
   3 // InstructionCombining - Combine instructions to form fewer, simple
   4 //   instructions.  This pass does not modify the CFG, and has a tendancy to
   5 //   make instructions dead, so a subsequent DIE pass is useful.  This pass is
   6 //   where algebraic simplification happens.
   7 //
   8 // This pass combines things like:
   9 //    %Y = add int 1, %X
  10 //    %Z = add int 1, %Y
  11 // into:
  12 //    %Z = add int 2, %X
  13 //
  14 // This is a simple worklist driven algorithm.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "llvm/Transforms/Scalar/InstructionCombining.h"
  19 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  20 #include "llvm/ConstantHandling.h"
  21 #include "llvm/iMemory.h"
  22 #include "llvm/iOther.h"
  23 #include "llvm/iPHINode.h"
  24 #include "llvm/iOperators.h"
  25 #include "llvm/Pass.h"
  26 #include "llvm/Support/InstIterator.h"
  27 #include "llvm/Support/InstVisitor.h"
  28
  29
  30 namespace {
  31   class InstCombiner : public FunctionPass,
  32                        public InstVisitor<InstCombiner, Instruction*> {
  33     // Worklist of all of the instructions that need to be simplified.
  34     std::vector<Instruction*> WorkList;
  35
  36     void AddUsesToWorkList(Instruction *I) {
  37       // The instruction was simplified, add all users of the instruction to
  38       // the work lists because they might get more simplified now...
  39       //
  40       for (Value::use_iterator UI = I->use_begin(), UE = I->use_end();
  41            UI != UE; ++UI)
  42         WorkList.push_back(cast<Instruction>(*UI));
  43     }
  44
  45   public:
  46     const char *getPassName() const { return "Instruction Combining"; }
  47
  48     virtual bool runOnFunction(Function *F);
  49
  50     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  51       AU.preservesCFG();
  52     }
  53
  54     // Visitation implementation - Implement instruction combining for different
  55     // instruction types.  The semantics are as follows:
  56     // Return Value:
  57     //    null        - No change was made
  58     //     I          - Change was made, I is still valid
  59     //   otherwise    - Change was made, replace I with returned instruction
  60     //
  61     Instruction *visitNot(UnaryOperator *I);
  62     Instruction *visitAdd(BinaryOperator *I);
  63     Instruction *visitSub(BinaryOperator *I);
  64     Instruction *visitMul(BinaryOperator *I);
  65     Instruction *visitDiv(BinaryOperator *I);
  66     Instruction *visitRem(BinaryOperator *I);
  67     Instruction *visitAnd(BinaryOperator *I);
  68     Instruction *visitOr (BinaryOperator *I);
  69     Instruction *visitXor(BinaryOperator *I);
  70     Instruction *visitSetCondInst(BinaryOperator *I);
  71     Instruction *visitShiftInst(Instruction *I);
  72     Instruction *visitCastInst(CastInst *CI);
  73     Instruction *visitPHINode(PHINode *PN);
  74     Instruction *visitGetElementPtrInst(GetElementPtrInst *GEP);
  75     Instruction *visitMemAccessInst(MemAccessInst *MAI);
  76
  77     // visitInstruction - Specify what to return for unhandled instructions...
  78     Instruction *visitInstruction(Instruction *I) { return 0; }
  79   };
  80 }
  81
  82
  83 Instruction *InstCombiner::visitNot(UnaryOperator *I) {
  84   if (I->use_empty()) return 0;       // Don't fix dead instructions...
  85
  86   // not (not X) = X
  87   if (Instruction *Op = dyn_cast<Instruction>(I->getOperand(0)))
  88     if (Op->getOpcode() == Instruction::Not) {
  89       AddUsesToWorkList(I);         // Add all modified instrs to worklist
  90       I->replaceAllUsesWith(Op->getOperand(0));
  91       return I;
  92     }
  93   return 0;
  94 }
  95
  96
  97 // Make sure that this instruction has a constant on the right hand side if it
  98 // has any constant arguments.  If not, fix it an return true.
  99 //
 100 static bool SimplifyBinOp(BinaryOperator *I) {
 101   if (isa<Constant>(I->getOperand(0)) && !isa<Constant>(I->getOperand(1)))
 102     return !I->swapOperands();
 103   return false;
 104 }
 105
 106 // dyn_castNegInst - Given a 'sub' instruction, return the RHS of the
 107 // instruction if the LHS is a constant zero (which is the 'negate' form).
 108 //
 109 static inline Value *dyn_castNegInst(Value *V) {
 110   Instruction *I = dyn_cast<Instruction>(V);
 111   if (!I || I->getOpcode() != Instruction::Sub) return 0;
 112
 113   if (I->getOperand(0) == Constant::getNullValue(I->getType()))
 114     return I->getOperand(1);
 115   return 0;
 116 }
 117
 118 Instruction *InstCombiner::visitAdd(BinaryOperator *I) {
 119   if (I->use_empty()) return 0;       // Don't fix dead add instructions...
 120   bool Changed = SimplifyBinOp(I);
 121   Value *LHS = I->getOperand(0), *RHS = I->getOperand(1);
 122
 123   // Eliminate 'add int %X, 0'
 124   if (I->getType()->isIntegral() &&
 125       RHS == Constant::getNullValue(I->getType())) {
 126     AddUsesToWorkList(I);         // Add all modified instrs to worklist
 127     I->replaceAllUsesWith(LHS);
 128     return I;
 129   }
 130
 131   // -B + A  -->  A - B
 132   if (Value *V = dyn_castNegInst(LHS))
 133     return BinaryOperator::create(Instruction::Sub, RHS, LHS);
 134
 135   // A + -B  -->  A - B
 136   if (Value *V = dyn_castNegInst(RHS))
 137     return BinaryOperator::create(Instruction::Sub, LHS, RHS);
 138
 139   // Simplify add instructions with a constant RHS...
 140   if (Constant *Op2 = dyn_cast<Constant>(RHS)) {
 141     if (BinaryOperator *ILHS = dyn_cast<BinaryOperator>(LHS)) {
 142       if (ILHS->getOpcode() == Instruction::Add &&
 143           isa<Constant>(ILHS->getOperand(1))) {
 144         // Fold:
 145         //    %Y = add int %X, 1
 146         //    %Z = add int %Y, 1
 147         // into:
 148         //    %Z = add int %X, 2
 149         //
 150         if (Constant *Val = *Op2 + *cast<Constant>(ILHS->getOperand(1))) {
 151           I->setOperand(0, ILHS->getOperand(0));
 152           I->setOperand(1, Val);
 153           return I;
 154         }
 155       }
 156     }
 157   }
 158
 159   return Changed ? I : 0;
 160 }
 161
 162 Instruction *InstCombiner::visitSub(BinaryOperator *I) {
 163   if (I->use_empty()) return 0;       // Don't fix dead add instructions...
 164   Value *Op0 = I->getOperand(0), *Op1 = I->getOperand(1);
 165
 166   if (Op0 == Op1) {         // sub X, X  -> 0
 167     AddUsesToWorkList(I);         // Add all modified instrs to worklist
 168     I->replaceAllUsesWith(Constant::getNullValue(I->getType()));
 169     return I;
 170   }
 171
 172   // If this is a subtract instruction with a constant RHS, convert it to an add
 173   // instruction of a negative constant
 174   //
 175   if (Constant *Op2 = dyn_cast<Constant>(Op1))
 176     if (Constant *RHS = *Constant::getNullValue(I->getType()) - *Op2) // 0 - RHS
 177       return BinaryOperator::create(Instruction::Add, Op0, RHS, I->getName());
 178
 179   // If this is a 'C = -B', check to see if 'B = -A', so that C = A...
 180   if (Op0 == Constant::getNullValue(I->getType()))
 181     if (Value *V = dyn_castNegInst(Op1)) {
 182       AddUsesToWorkList(I);         // Add all modified instrs to worklist
 183       I->replaceAllUsesWith(V);
 184       return I;
 185     }
 186
 187   return 0;
 188 }
 189
 190 Instruction *InstCombiner::visitMul(BinaryOperator *I) {
 191   if (I->use_empty()) return 0;       // Don't fix dead instructions...
 192   bool Changed = SimplifyBinOp(I);
 193   Value *Op1 = I->getOperand(0);
 194
 195   // Simplify add instructions with a constant RHS...
 196   if (Constant *Op2 = dyn_cast<Constant>(I->getOperand(1))) {
 197     if (I->getType()->isIntegral() && cast<ConstantInt>(Op2)->equalsInt(1)){
 198       // Eliminate 'mul int %X, 1'
 199       AddUsesToWorkList(I);         // Add all modified instrs to worklist
 200       I->replaceAllUsesWith(Op1);
 201       return I;
 202
 203     } else if (I->getType()->isIntegral() &&
 204                cast<ConstantInt>(Op2)->equalsInt(2)) {
 205       // Convert 'mul int %X, 2' to 'add int %X, %X'
 206       return BinaryOperator::create(Instruction::Add, Op1, Op1, I->getName());
 207
 208     } else if (Op2->isNullValue()) {
 209       // Eliminate 'mul int %X, 0'
 210       AddUsesToWorkList(I);         // Add all modified instrs to worklist
 211       I->replaceAllUsesWith(Op2);   // Set this value to zero directly
 212       return I;
 213     }
 214   }
 215
 216   return Changed ? I : 0;
 217 }
 218
 219
 220 Instruction *InstCombiner::visitDiv(BinaryOperator *I) {
 221   if (I->use_empty()) return 0;       // Don't fix dead instructions...
 222
 223   // div X, 1 == X
 224   if (ConstantInt *RHS = dyn_cast<ConstantInt>(I->getOperand(1)))
 225     if (RHS->equalsInt(1)) {
 226       AddUsesToWorkList(I);         // Add all modified instrs to worklist
 227       I->replaceAllUsesWith(I->getOperand(0));
 228       return I;
 229     }
 230   return 0;
 231 }
 232
 233
 234 Instruction *InstCombiner::visitRem(BinaryOperator *I) {
 235   if (I->use_empty()) return 0;       // Don't fix dead instructions...
 236
 237   // rem X, 1 == 0
 238   if (ConstantInt *RHS = dyn_cast<ConstantInt>(I->getOperand(1)))
 239     if (RHS->equalsInt(1)) {
 240       AddUsesToWorkList(I);         // Add all modified instrs to worklist
 241       I->replaceAllUsesWith(Constant::getNullValue(I->getType()));
 242       return I;
 243     }
 244   return 0;
 245 }
 246
 247 static Constant *getMaxValue(const Type *Ty) {
 248   assert(Ty == Type::BoolTy || Ty->isIntegral());
 249   if (Ty == Type::BoolTy)
 250     return ConstantBool::True;
 251
 252   if (Ty->isSigned())
 253     return ConstantSInt::get(Ty, -1);
 254   else if (Ty->isUnsigned()) {
 255     // Calculate -1 casted to the right type...
 256     unsigned TypeBits = Ty->getPrimitiveSize()*8;
 257     uint64_t Val = (uint64_t)-1LL;       // All ones
 258     Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
 259     return ConstantUInt::get(Ty, Val);
 260   }
 261   return 0;
 262 }
 263
 264
 265 Instruction *InstCombiner::visitAnd(BinaryOperator *I) {
 266   if (I->use_empty()) return 0;       // Don't fix dead instructions...
 267   bool Changed = SimplifyBinOp(I);
 268   Value *Op0 = I->getOperand(0), *Op1 = I->getOperand(1);
 269
 270   // and X, X = X   and X, 0 == 0
 271   if (Op0 == Op1 || Op1 == Constant::getNullValue(I->getType())) {
 272     AddUsesToWorkList(I);         // Add all modified instrs to worklist
 273     I->replaceAllUsesWith(Op1);
 274     return I;
 275   }
 276
 277   // and X, -1 == X
 278   if (Constant *RHS = dyn_cast<Constant>(Op1))
 279     if (RHS == getMaxValue(I->getType())) {
 280       AddUsesToWorkList(I);         // Add all modified instrs to worklist
 281       I->replaceAllUsesWith(Op0);
 282       return I;
 283     }
 284
 285   return Changed ? I : 0;
 286 }
 287
 288
 289
 290 Instruction *InstCombiner::visitOr(BinaryOperator *I) {
 291   if (I->use_empty()) return 0;       // Don't fix dead instructions...
 292   bool Changed = SimplifyBinOp(I);
 293   Value *Op0 = I->getOperand(0), *Op1 = I->getOperand(1);
 294
 295   // or X, X = X   or X, 0 == X
 296   if (Op0 == Op1 || Op1 == Constant::getNullValue(I->getType())) {
 297     AddUsesToWorkList(I);         // Add all modified instrs to worklist
 298     I->replaceAllUsesWith(Op0);
 299     return I;
 300   }
 301
 302   // or X, -1 == -1
 303   if (Constant *RHS = dyn_cast<Constant>(Op1))
 304     if (RHS == getMaxValue(I->getType())) {
 305       AddUsesToWorkList(I);         // Add all modified instrs to worklist
 306       I->replaceAllUsesWith(Op1);
 307       return I;
 308     }
 309
 310   return Changed ? I : 0;
 311 }
 312
 313
 314
 315 Instruction *InstCombiner::visitXor(BinaryOperator *I) {
 316   if (I->use_empty()) return 0;       // Don't fix dead instructions...
 317   bool Changed = SimplifyBinOp(I);
 318   Value *Op0 = I->getOperand(0), *Op1 = I->getOperand(1);
 319
 320   // xor X, X = 0
 321   if (Op0 == Op1) {
 322     AddUsesToWorkList(I);         // Add all modified instrs to worklist
 323     I->replaceAllUsesWith(Constant::getNullValue(I->getType()));
 324     return I;
 325   }
 326
 327   // xor X, 0 == X
 328   if (Op1 == Constant::getNullValue(I->getType())) {
 329     AddUsesToWorkList(I);         // Add all modified instrs to worklist
 330     I->replaceAllUsesWith(Op0);
 331     return I;
 332   }
 333
 334   return Changed ? I : 0;
 335 }
 336
 337 Instruction *InstCombiner::visitSetCondInst(BinaryOperator *I) {
 338   if (I->use_empty()) return 0;       // Don't fix dead instructions...
 339   bool Changed = SimplifyBinOp(I);
 340
 341   // setcc X, X
 342   if (I->getOperand(0) == I->getOperand(1)) {
 343     bool NewVal = I->getOpcode() == Instruction::SetEQ ||
 344                   I->getOpcode() == Instruction::SetGE ||
 345                   I->getOpcode() == Instruction::SetLE;
 346     AddUsesToWorkList(I);         // Add all modified instrs to worklist
 347     I->replaceAllUsesWith(ConstantBool::get(NewVal));
 348     return I;
 349   }
 350
 351   return Changed ? I : 0;
 352 }
 353
 354
 355
 356 Instruction *InstCombiner::visitShiftInst(Instruction *I) {
 357   if (I->use_empty()) return 0;       // Don't fix dead instructions...
 358   assert(I->getOperand(1)->getType() == Type::UByteTy);
 359   Value *Op0 = I->getOperand(0), *Op1 = I->getOperand(1);
 360
 361   // shl X, 0 == X and shr X, 0 == X
 362   // shl 0, X == 0 and shr 0, X == 0
 363   if (Op1 == Constant::getNullValue(Type::UByteTy) ||
 364       Op0 == Constant::getNullValue(Op0->getType())) {
 365     AddUsesToWorkList(I);         // Add all modified instrs to worklist
 366     I->replaceAllUsesWith(Op0);
 367     return I;
 368   }
 369
 370   // shl int X, 32 = 0 and shr sbyte Y, 9 = 0, ... just don't eliminate shr of
 371   // a signed value.
 372   //
 373   if (ConstantUInt *CUI = dyn_cast<ConstantUInt>(Op1)) {
 374     unsigned TypeBits = Op0->getType()->getPrimitiveSize()*8;
 375     if (CUI->getValue() >= TypeBits &&
 376         !(Op0->getType()->isSigned() && I->getOpcode() == Instruction::Shr)) {
 377       AddUsesToWorkList(I);         // Add all modified instrs to worklist
 378       I->replaceAllUsesWith(Constant::getNullValue(Op0->getType()));
 379       return I;
 380     }
 381   }
 382   return 0;
 383 }
 384
 385
 386 // isEliminableCastOfCast - Return true if it is valid to eliminate the CI
 387 // instruction.
 388 //
 389 static inline bool isEliminableCastOfCast(const CastInst *CI,
 390                                           const CastInst *CSrc) {
 391   assert(CI->getOperand(0) == CSrc);
 392   const Type *SrcTy = CSrc->getOperand(0)->getType();
 393   const Type *MidTy = CSrc->getType();
 394   const Type *DstTy = CI->getType();
 395
 396   // It is legal to eliminate the instruction if casting A->B->A
 397   if (SrcTy == DstTy) return true;
 398
 399   // Allow free casting and conversion of sizes as long as the sign doesn't
 400   // change...
 401   if (SrcTy->isSigned() == MidTy->isSigned() &&
 402       MidTy->isSigned() == DstTy->isSigned())
 403     return true;
 404
 405   // Otherwise, we cannot succeed.  Specifically we do not want to allow things
 406   // like:  short -> ushort -> uint, because this can create wrong results if
 407   // the input short is negative!
 408   //
 409   return false;
 410 }
 411
 412
 413 // CastInst simplification
 414 //
 415 Instruction *InstCombiner::visitCastInst(CastInst *CI) {
 416   if (CI->use_empty()) return 0;       // Don't fix dead instructions...
 417
 418   // If the user is casting a value to the same type, eliminate this cast
 419   // instruction...
 420   if (CI->getType() == CI->getOperand(0)->getType() && !CI->use_empty()) {
 421     AddUsesToWorkList(CI);         // Add all modified instrs to worklist
 422     CI->replaceAllUsesWith(CI->getOperand(0));
 423     return CI;
 424   }
 425
 426
 427   // If casting the result of another cast instruction, try to eliminate this
 428   // one!
 429   //
 430   if (CastInst *CSrc = dyn_cast<CastInst>(CI->getOperand(0)))
 431     if (isEliminableCastOfCast(CI, CSrc)) {
 432       // This instruction now refers directly to the cast's src operand.  This
 433       // has a good chance of making CSrc dead.
 434       CI->setOperand(0, CSrc->getOperand(0));
 435       return CI;
 436     }
 437
 438   return 0;
 439 }
 440
 441
 442 // PHINode simplification
 443 //
 444 Instruction *InstCombiner::visitPHINode(PHINode *PN) {
 445   if (PN->use_empty()) return 0;       // Don't fix dead instructions...
 446
 447   // If the PHI node only has one incoming value, eliminate the PHI node...
 448   if (PN->getNumIncomingValues() == 1) {
 449     AddUsesToWorkList(PN);         // Add all modified instrs to worklist
 450     PN->replaceAllUsesWith(PN->getIncomingValue(0));
 451     return PN;
 452   }
 453
 454   return 0;
 455 }
 456
 457
 458 Instruction *InstCombiner::visitGetElementPtrInst(GetElementPtrInst *GEP) {
 459   // Is it getelementptr %P, uint 0
 460   // If so, elminate the noop.
 461   if (GEP->getNumOperands() == 2 && !GEP->use_empty() &&
 462       GEP->getOperand(1) == Constant::getNullValue(Type::UIntTy)) {
 463     AddUsesToWorkList(GEP);         // Add all modified instrs to worklist
 464     GEP->replaceAllUsesWith(GEP->getOperand(0));
 465     return GEP;
 466   }
 467
 468   return visitMemAccessInst(GEP);
 469 }
 470
 471
 472 // Combine Indices - If the source pointer to this mem access instruction is a
 473 // getelementptr instruction, combine the indices of the GEP into this
 474 // instruction
 475 //
 476 Instruction *InstCombiner::visitMemAccessInst(MemAccessInst *MAI) {
 477   GetElementPtrInst *Src =
 478     dyn_cast<GetElementPtrInst>(MAI->getPointerOperand());
 479   if (!Src) return 0;
 480
 481   std::vector<Value *> Indices;
 482
 483   // Only special case we have to watch out for is pointer arithmetic on the
 484   // 0th index of MAI.
 485   unsigned FirstIdx = MAI->getFirstIndexOperandNumber();
 486   if (FirstIdx == MAI->getNumOperands() ||
 487       (FirstIdx == MAI->getNumOperands()-1 &&
 488        MAI->getOperand(FirstIdx) == ConstantUInt::get(Type::UIntTy, 0))) {
 489     // Replace the index list on this MAI with the index on the getelementptr
 490     Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end());
 491   } else if (*MAI->idx_begin() == ConstantUInt::get(Type::UIntTy, 0)) {
 492     // Otherwise we can do the fold if the first index of the GEP is a zero
 493     Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end());
 494     Indices.insert(Indices.end(), MAI->idx_begin()+1, MAI->idx_end());
 495   }
 496
 497   if (Indices.empty()) return 0;  // Can't do the fold?
 498
 499   switch (MAI->getOpcode()) {
 500   case Instruction::GetElementPtr:
 501     return new GetElementPtrInst(Src->getOperand(0), Indices, MAI->getName());
 502   case Instruction::Load:
 503     return new LoadInst(Src->getOperand(0), Indices, MAI->getName());
 504   case Instruction::Store:
 505     return new StoreInst(MAI->getOperand(0), Src->getOperand(0), Indices);
 506   default:
 507     assert(0 && "Unknown memaccessinst!");
 508     break;
 509   }
 510   abort();
 511   return 0;
 512 }
 513
 514
 515 bool InstCombiner::runOnFunction(Function *F) {
 516   bool Changed = false;
 517
 518   WorkList.insert(WorkList.end(), inst_begin(F), inst_end(F));
 519
 520   while (!WorkList.empty()) {
 521     Instruction *I = WorkList.back();  // Get an instruction from the worklist
 522     WorkList.pop_back();
 523
 524     // Now that we have an instruction, try combining it to simplify it...
 525     Instruction *Result = visit(I);
 526     if (Result) {
 527       // Should we replace the old instruction with a new one?
 528       if (Result != I)
 529         ReplaceInstWithInst(I, Result);
 530
 531       WorkList.push_back(Result);
 532       AddUsesToWorkList(Result);
 533       Changed = true;
 534     }
 535   }
 536
 537   return Changed;
 538 }
 539
 540 Pass *createInstructionCombiningPass() {
 541   return new InstCombiner();
 542 }