1 //===- InstructionCombining.cpp - Combine multiple instructions -----------===//
3 // InstructionCombining - Combine instructions to form fewer, simple
4 // instructions. This pass does not modify the CFG This pass is where algebraic
5 // simplification happens.
7 // This pass combines things like:
13 // This is a simple worklist driven algorithm.
15 //===----------------------------------------------------------------------===//
17 #include "llvm/Transforms/Scalar.h"
18 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
19 #include "llvm/Transforms/Utils/Local.h"
20 #include "llvm/Instructions.h"
21 #include "llvm/Pass.h"
22 #include "llvm/Constants.h"
23 #include "llvm/ConstantHandling.h"
24 #include "llvm/DerivedTypes.h"
25 #include "llvm/GlobalVariable.h"
26 #include "llvm/Support/InstIterator.h"
27 #include "llvm/Support/InstVisitor.h"
28 #include "llvm/Support/CallSite.h"
29 #include "Support/Statistic.h"
33 Statistic<> NumCombined ("instcombine", "Number of insts combined");
34 Statistic<> NumConstProp("instcombine", "Number of constant folds");
35 Statistic<> NumDeadInst ("instcombine", "Number of dead inst eliminated");
37 class InstCombiner : public FunctionPass,
38 public InstVisitor<InstCombiner, Instruction*> {
39 // Worklist of all of the instructions that need to be simplified.
40 std::vector<Instruction*> WorkList;
42 void AddUsesToWorkList(Instruction &I) {
43 // The instruction was simplified, add all users of the instruction to
44 // the work lists because they might get more simplified now...
46 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
48 WorkList.push_back(cast<Instruction>(*UI));
51 // removeFromWorkList - remove all instances of I from the worklist.
52 void removeFromWorkList(Instruction *I);
54 virtual bool runOnFunction(Function &F);
56 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
60 // Visitation implementation - Implement instruction combining for different
61 // instruction types. The semantics are as follows:
63 // null - No change was made
64 // I - Change was made, I is still valid, I may be dead though
65 // otherwise - Change was made, replace I with returned instruction
67 Instruction *visitAdd(BinaryOperator &I);
68 Instruction *visitSub(BinaryOperator &I);
69 Instruction *visitMul(BinaryOperator &I);
70 Instruction *visitDiv(BinaryOperator &I);
71 Instruction *visitRem(BinaryOperator &I);
72 Instruction *visitAnd(BinaryOperator &I);
73 Instruction *visitOr (BinaryOperator &I);
74 Instruction *visitXor(BinaryOperator &I);
75 Instruction *visitSetCondInst(BinaryOperator &I);
76 Instruction *visitShiftInst(ShiftInst &I);
77 Instruction *visitCastInst(CastInst &CI);
78 Instruction *visitCallInst(CallInst &CI);
79 Instruction *visitInvokeInst(InvokeInst &II);
80 Instruction *visitPHINode(PHINode &PN);
81 Instruction *visitGetElementPtrInst(GetElementPtrInst &GEP);
82 Instruction *visitAllocationInst(AllocationInst &AI);
83 Instruction *visitLoadInst(LoadInst &LI);
84 Instruction *visitBranchInst(BranchInst &BI);
86 // visitInstruction - Specify what to return for unhandled instructions...
87 Instruction *visitInstruction(Instruction &I) { return 0; }
90 bool transformConstExprCastCall(CallSite CS);
92 // InsertNewInstBefore - insert an instruction New before instruction Old
93 // in the program. Add the new instruction to the worklist.
95 void InsertNewInstBefore(Instruction *New, Instruction &Old) {
96 assert(New && New->getParent() == 0 &&
97 "New instruction already inserted into a basic block!");
98 BasicBlock *BB = Old.getParent();
99 BB->getInstList().insert(&Old, New); // Insert inst
100 WorkList.push_back(New); // Add to worklist
103 // ReplaceInstUsesWith - This method is to be used when an instruction is
104 // found to be dead, replacable with another preexisting expression. Here
105 // we add all uses of I to the worklist, replace all uses of I with the new
106 // value, then return I, so that the inst combiner will know that I was
109 Instruction *ReplaceInstUsesWith(Instruction &I, Value *V) {
110 AddUsesToWorkList(I); // Add all modified instrs to worklist
111 I.replaceAllUsesWith(V);
115 // SimplifyCommutative - This performs a few simplifications for commutative
117 bool SimplifyCommutative(BinaryOperator &I);
120 RegisterOpt<InstCombiner> X("instcombine", "Combine redundant instructions");
123 // getComplexity: Assign a complexity or rank value to LLVM Values...
124 // 0 -> Constant, 1 -> Other, 2 -> Argument, 2 -> Unary, 3 -> OtherInst
125 static unsigned getComplexity(Value *V) {
126 if (isa<Instruction>(V)) {
127 if (BinaryOperator::isNeg(V) || BinaryOperator::isNot(V))
131 if (isa<Argument>(V)) return 2;
132 return isa<Constant>(V) ? 0 : 1;
135 // isOnlyUse - Return true if this instruction will be deleted if we stop using
137 static bool isOnlyUse(Value *V) {
138 return V->use_size() == 1 || isa<Constant>(V);
141 // SimplifyCommutative - This performs a few simplifications for commutative
144 // 1. Order operands such that they are listed from right (least complex) to
145 // left (most complex). This puts constants before unary operators before
148 // 2. Transform: (op (op V, C1), C2) ==> (op V, (op C1, C2))
149 // 3. Transform: (op (op V1, C1), (op V2, C2)) ==> (op (op V1, V2), (op C1,C2))
151 bool InstCombiner::SimplifyCommutative(BinaryOperator &I) {
152 bool Changed = false;
153 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1)))
154 Changed = !I.swapOperands();
156 if (!I.isAssociative()) return Changed;
157 Instruction::BinaryOps Opcode = I.getOpcode();
158 if (BinaryOperator *Op = dyn_cast<BinaryOperator>(I.getOperand(0)))
159 if (Op->getOpcode() == Opcode && isa<Constant>(Op->getOperand(1))) {
160 if (isa<Constant>(I.getOperand(1))) {
161 Constant *Folded = ConstantExpr::get(I.getOpcode(),
162 cast<Constant>(I.getOperand(1)),
163 cast<Constant>(Op->getOperand(1)));
164 I.setOperand(0, Op->getOperand(0));
165 I.setOperand(1, Folded);
167 } else if (BinaryOperator *Op1=dyn_cast<BinaryOperator>(I.getOperand(1)))
168 if (Op1->getOpcode() == Opcode && isa<Constant>(Op1->getOperand(1)) &&
169 isOnlyUse(Op) && isOnlyUse(Op1)) {
170 Constant *C1 = cast<Constant>(Op->getOperand(1));
171 Constant *C2 = cast<Constant>(Op1->getOperand(1));
173 // Fold (op (op V1, C1), (op V2, C2)) ==> (op (op V1, V2), (op C1,C2))
174 Constant *Folded = ConstantExpr::get(I.getOpcode(), C1, C2);
175 Instruction *New = BinaryOperator::create(Opcode, Op->getOperand(0),
178 WorkList.push_back(New);
179 I.setOperand(0, New);
180 I.setOperand(1, Folded);
187 // dyn_castNegVal - Given a 'sub' instruction, return the RHS of the instruction
188 // if the LHS is a constant zero (which is the 'negate' form).
190 static inline Value *dyn_castNegVal(Value *V) {
191 if (BinaryOperator::isNeg(V))
192 return BinaryOperator::getNegArgument(cast<BinaryOperator>(V));
194 // Constants can be considered to be negated values if they can be folded...
195 if (Constant *C = dyn_cast<Constant>(V))
196 return ConstantExpr::get(Instruction::Sub,
197 Constant::getNullValue(V->getType()), C);
201 static inline Value *dyn_castNotVal(Value *V) {
202 if (BinaryOperator::isNot(V))
203 return BinaryOperator::getNotArgument(cast<BinaryOperator>(V));
205 // Constants can be considered to be not'ed values...
206 if (ConstantIntegral *C = dyn_cast<ConstantIntegral>(V))
207 return ConstantExpr::get(Instruction::Xor,
208 ConstantIntegral::getAllOnesValue(C->getType()),C);
212 // dyn_castFoldableMul - If this value is a multiply that can be folded into
213 // other computations (because it has a constant operand), return the
214 // non-constant operand of the multiply.
216 static inline Value *dyn_castFoldableMul(Value *V) {
217 if (V->use_size() == 1 && V->getType()->isInteger())
218 if (Instruction *I = dyn_cast<Instruction>(V))
219 if (I->getOpcode() == Instruction::Mul)
220 if (isa<Constant>(I->getOperand(1)))
221 return I->getOperand(0);
225 // dyn_castMaskingAnd - If this value is an And instruction masking a value with
226 // a constant, return the constant being anded with.
228 static inline Constant *dyn_castMaskingAnd(Value *V) {
229 if (Instruction *I = dyn_cast<Instruction>(V))
230 if (I->getOpcode() == Instruction::And)
231 return dyn_cast<Constant>(I->getOperand(1));
233 // If this is a constant, it acts just like we were masking with it.
234 return dyn_cast<Constant>(V);
237 // Log2 - Calculate the log base 2 for the specified value if it is exactly a
239 static unsigned Log2(uint64_t Val) {
240 assert(Val > 1 && "Values 0 and 1 should be handled elsewhere!");
243 if (Val & 1) return 0; // Multiple bits set?
250 Instruction *InstCombiner::visitAdd(BinaryOperator &I) {
251 bool Changed = SimplifyCommutative(I);
252 Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
254 // Eliminate 'add int %X, 0'
255 if (RHS == Constant::getNullValue(I.getType()))
256 return ReplaceInstUsesWith(I, LHS);
259 if (Value *V = dyn_castNegVal(LHS))
260 return BinaryOperator::create(Instruction::Sub, RHS, V);
263 if (!isa<Constant>(RHS))
264 if (Value *V = dyn_castNegVal(RHS))
265 return BinaryOperator::create(Instruction::Sub, LHS, V);
267 // X*C + X --> X * (C+1)
268 if (dyn_castFoldableMul(LHS) == RHS) {
270 ConstantExpr::get(Instruction::Add,
271 cast<Constant>(cast<Instruction>(LHS)->getOperand(1)),
272 ConstantInt::get(I.getType(), 1));
273 return BinaryOperator::create(Instruction::Mul, RHS, CP1);
276 // X + X*C --> X * (C+1)
277 if (dyn_castFoldableMul(RHS) == LHS) {
279 ConstantExpr::get(Instruction::Add,
280 cast<Constant>(cast<Instruction>(RHS)->getOperand(1)),
281 ConstantInt::get(I.getType(), 1));
282 return BinaryOperator::create(Instruction::Mul, LHS, CP1);
285 // (A & C1)+(B & C2) -> (A & C1)|(B & C2) iff C1&C2 == 0
286 if (Constant *C1 = dyn_castMaskingAnd(LHS))
287 if (Constant *C2 = dyn_castMaskingAnd(RHS))
288 if (ConstantExpr::get(Instruction::And, C1, C2)->isNullValue())
289 return BinaryOperator::create(Instruction::Or, LHS, RHS);
291 return Changed ? &I : 0;
294 // isSignBit - Return true if the value represented by the constant only has the
295 // highest order bit set.
296 static bool isSignBit(ConstantInt *CI) {
297 unsigned NumBits = CI->getType()->getPrimitiveSize()*8;
298 return (CI->getRawValue() & ~(-1LL << NumBits)) == (1ULL << (NumBits-1));
301 Instruction *InstCombiner::visitSub(BinaryOperator &I) {
302 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
304 if (Op0 == Op1) // sub X, X -> 0
305 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
307 // If this is a 'B = x-(-A)', change to B = x+A...
308 if (Value *V = dyn_castNegVal(Op1))
309 return BinaryOperator::create(Instruction::Add, Op0, V);
311 // Replace (-1 - A) with (~A)...
312 if (ConstantInt *C = dyn_cast<ConstantInt>(Op0))
313 if (C->isAllOnesValue())
314 return BinaryOperator::createNot(Op1);
316 if (BinaryOperator *Op1I = dyn_cast<BinaryOperator>(Op1))
317 if (Op1I->use_size() == 1) {
318 // Replace (x - (y - z)) with (x + (z - y)) if the (y - z) subexpression
319 // is not used by anyone else...
321 if (Op1I->getOpcode() == Instruction::Sub) {
322 // Swap the two operands of the subexpr...
323 Value *IIOp0 = Op1I->getOperand(0), *IIOp1 = Op1I->getOperand(1);
324 Op1I->setOperand(0, IIOp1);
325 Op1I->setOperand(1, IIOp0);
327 // Create the new top level add instruction...
328 return BinaryOperator::create(Instruction::Add, Op0, Op1);
331 // Replace (A - (A & B)) with (A & ~B) if this is the only use of (A&B)...
333 if (Op1I->getOpcode() == Instruction::And &&
334 (Op1I->getOperand(0) == Op0 || Op1I->getOperand(1) == Op0)) {
335 Value *OtherOp = Op1I->getOperand(Op1I->getOperand(0) == Op0);
337 Instruction *NewNot = BinaryOperator::createNot(OtherOp, "B.not", &I);
338 return BinaryOperator::create(Instruction::And, Op0, NewNot);
341 // X - X*C --> X * (1-C)
342 if (dyn_castFoldableMul(Op1I) == Op0) {
344 ConstantExpr::get(Instruction::Sub,
345 ConstantInt::get(I.getType(), 1),
346 cast<Constant>(cast<Instruction>(Op1)->getOperand(1)));
347 assert(CP1 && "Couldn't constant fold 1-C?");
348 return BinaryOperator::create(Instruction::Mul, Op0, CP1);
352 // X*C - X --> X * (C-1)
353 if (dyn_castFoldableMul(Op0) == Op1) {
355 ConstantExpr::get(Instruction::Sub,
356 cast<Constant>(cast<Instruction>(Op0)->getOperand(1)),
357 ConstantInt::get(I.getType(), 1));
358 assert(CP1 && "Couldn't constant fold C - 1?");
359 return BinaryOperator::create(Instruction::Mul, Op1, CP1);
365 Instruction *InstCombiner::visitMul(BinaryOperator &I) {
366 bool Changed = SimplifyCommutative(I);
367 Value *Op0 = I.getOperand(0);
369 // Simplify mul instructions with a constant RHS...
370 if (Constant *Op1 = dyn_cast<Constant>(I.getOperand(1))) {
371 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
372 const Type *Ty = CI->getType();
373 int64_t Val = (int64_t)cast<ConstantInt>(CI)->getRawValue();
375 case -1: // X * -1 -> -X
376 return BinaryOperator::createNeg(Op0, I.getName());
378 return ReplaceInstUsesWith(I, Op1); // Eliminate 'mul double %X, 0'
380 return ReplaceInstUsesWith(I, Op0); // Eliminate 'mul int %X, 1'
381 case 2: // Convert 'mul int %X, 2' to 'add int %X, %X'
382 return BinaryOperator::create(Instruction::Add, Op0, Op0, I.getName());
385 if (uint64_t C = Log2(Val)) // Replace X*(2^C) with X << C
386 return new ShiftInst(Instruction::Shl, Op0,
387 ConstantUInt::get(Type::UByteTy, C));
389 ConstantFP *Op1F = cast<ConstantFP>(Op1);
390 if (Op1F->isNullValue())
391 return ReplaceInstUsesWith(I, Op1);
393 // "In IEEE floating point, x*1 is not equivalent to x for nans. However,
394 // ANSI says we can drop signals, so we can do this anyway." (from GCC)
395 if (Op1F->getValue() == 1.0)
396 return ReplaceInstUsesWith(I, Op0); // Eliminate 'mul double %X, 1.0'
400 if (Value *Op0v = dyn_castNegVal(Op0)) // -X * -Y = X*Y
401 if (Value *Op1v = dyn_castNegVal(I.getOperand(1)))
402 return BinaryOperator::create(Instruction::Mul, Op0v, Op1v);
404 return Changed ? &I : 0;
407 Instruction *InstCombiner::visitDiv(BinaryOperator &I) {
409 if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1))) {
410 if (RHS->equalsInt(1))
411 return ReplaceInstUsesWith(I, I.getOperand(0));
413 // Check to see if this is an unsigned division with an exact power of 2,
414 // if so, convert to a right shift.
415 if (ConstantUInt *C = dyn_cast<ConstantUInt>(RHS))
416 if (uint64_t Val = C->getValue()) // Don't break X / 0
417 if (uint64_t C = Log2(Val))
418 return new ShiftInst(Instruction::Shr, I.getOperand(0),
419 ConstantUInt::get(Type::UByteTy, C));
422 // 0 / X == 0, we don't need to preserve faults!
423 if (ConstantInt *LHS = dyn_cast<ConstantInt>(I.getOperand(0)))
424 if (LHS->equalsInt(0))
425 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
431 Instruction *InstCombiner::visitRem(BinaryOperator &I) {
432 if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1))) {
433 if (RHS->equalsInt(1)) // X % 1 == 0
434 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
436 // Check to see if this is an unsigned remainder with an exact power of 2,
437 // if so, convert to a bitwise and.
438 if (ConstantUInt *C = dyn_cast<ConstantUInt>(RHS))
439 if (uint64_t Val = C->getValue()) // Don't break X % 0 (divide by zero)
441 return BinaryOperator::create(Instruction::And, I.getOperand(0),
442 ConstantUInt::get(I.getType(), Val-1));
445 // 0 % X == 0, we don't need to preserve faults!
446 if (ConstantInt *LHS = dyn_cast<ConstantInt>(I.getOperand(0)))
447 if (LHS->equalsInt(0))
448 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
453 // isMaxValueMinusOne - return true if this is Max-1
454 static bool isMaxValueMinusOne(const ConstantInt *C) {
455 if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(C)) {
456 // Calculate -1 casted to the right type...
457 unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
458 uint64_t Val = ~0ULL; // All ones
459 Val >>= 64-TypeBits; // Shift out unwanted 1 bits...
460 return CU->getValue() == Val-1;
463 const ConstantSInt *CS = cast<ConstantSInt>(C);
465 // Calculate 0111111111..11111
466 unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
467 int64_t Val = INT64_MAX; // All ones
468 Val >>= 64-TypeBits; // Shift out unwanted 1 bits...
469 return CS->getValue() == Val-1;
472 // isMinValuePlusOne - return true if this is Min+1
473 static bool isMinValuePlusOne(const ConstantInt *C) {
474 if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(C))
475 return CU->getValue() == 1;
477 const ConstantSInt *CS = cast<ConstantSInt>(C);
479 // Calculate 1111111111000000000000
480 unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
481 int64_t Val = -1; // All ones
482 Val <<= TypeBits-1; // Shift over to the right spot
483 return CS->getValue() == Val+1;
487 Instruction *InstCombiner::visitAnd(BinaryOperator &I) {
488 bool Changed = SimplifyCommutative(I);
489 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
491 // and X, X = X and X, 0 == 0
492 if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType()))
493 return ReplaceInstUsesWith(I, Op1);
496 if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1))
497 if (RHS->isAllOnesValue())
498 return ReplaceInstUsesWith(I, Op0);
500 Value *Op0NotVal = dyn_castNotVal(Op0);
501 Value *Op1NotVal = dyn_castNotVal(Op1);
503 // (~A & ~B) == (~(A | B)) - Demorgan's Law
504 if (Op0NotVal && Op1NotVal && isOnlyUse(Op0) && isOnlyUse(Op1)) {
505 Instruction *Or = BinaryOperator::create(Instruction::Or, Op0NotVal,
506 Op1NotVal,I.getName()+".demorgan",
508 WorkList.push_back(Or);
509 return BinaryOperator::createNot(Or);
512 if (Op0NotVal == Op1 || Op1NotVal == Op0) // A & ~A == ~A & A == 0
513 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
515 return Changed ? &I : 0;
520 Instruction *InstCombiner::visitOr(BinaryOperator &I) {
521 bool Changed = SimplifyCommutative(I);
522 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
524 // or X, X = X or X, 0 == X
525 if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType()))
526 return ReplaceInstUsesWith(I, Op0);
529 if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1))
530 if (RHS->isAllOnesValue())
531 return ReplaceInstUsesWith(I, Op1);
533 Value *Op0NotVal = dyn_castNotVal(Op0);
534 Value *Op1NotVal = dyn_castNotVal(Op1);
536 if (Op1 == Op0NotVal) // ~A | A == -1
537 return ReplaceInstUsesWith(I,
538 ConstantIntegral::getAllOnesValue(I.getType()));
540 if (Op0 == Op1NotVal) // A | ~A == -1
541 return ReplaceInstUsesWith(I,
542 ConstantIntegral::getAllOnesValue(I.getType()));
544 // (~A | ~B) == (~(A & B)) - Demorgan's Law
545 if (Op0NotVal && Op1NotVal && isOnlyUse(Op0) && isOnlyUse(Op1)) {
546 Instruction *And = BinaryOperator::create(Instruction::And, Op0NotVal,
547 Op1NotVal,I.getName()+".demorgan",
549 WorkList.push_back(And);
550 return BinaryOperator::createNot(And);
553 return Changed ? &I : 0;
558 Instruction *InstCombiner::visitXor(BinaryOperator &I) {
559 bool Changed = SimplifyCommutative(I);
560 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
564 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
566 if (ConstantIntegral *Op1C = dyn_cast<ConstantIntegral>(Op1)) {
568 if (Op1C->isNullValue())
569 return ReplaceInstUsesWith(I, Op0);
571 // Is this a "NOT" instruction?
572 if (Op1C->isAllOnesValue()) {
573 // xor (xor X, -1), -1 = not (not X) = X
574 if (Value *X = dyn_castNotVal(Op0))
575 return ReplaceInstUsesWith(I, X);
577 // xor (setcc A, B), true = not (setcc A, B) = setncc A, B
578 if (SetCondInst *SCI = dyn_cast<SetCondInst>(Op0))
579 if (SCI->use_size() == 1)
580 return new SetCondInst(SCI->getInverseCondition(),
581 SCI->getOperand(0), SCI->getOperand(1));
585 if (Value *X = dyn_castNotVal(Op0)) // ~A ^ A == -1
587 return ReplaceInstUsesWith(I,
588 ConstantIntegral::getAllOnesValue(I.getType()));
590 if (Value *X = dyn_castNotVal(Op1)) // A ^ ~A == -1
592 return ReplaceInstUsesWith(I,
593 ConstantIntegral::getAllOnesValue(I.getType()));
595 if (Instruction *Op1I = dyn_cast<Instruction>(Op1))
596 if (Op1I->getOpcode() == Instruction::Or)
597 if (Op1I->getOperand(0) == Op0) { // B^(B|A) == (A|B)^B
598 cast<BinaryOperator>(Op1I)->swapOperands();
601 } else if (Op1I->getOperand(1) == Op0) { // B^(A|B) == (A|B)^B
606 if (Instruction *Op0I = dyn_cast<Instruction>(Op0))
607 if (Op0I->getOpcode() == Instruction::Or && Op0I->use_size() == 1) {
608 if (Op0I->getOperand(0) == Op1) // (B|A)^B == (A|B)^B
609 cast<BinaryOperator>(Op0I)->swapOperands();
610 if (Op0I->getOperand(1) == Op1) { // (A|B)^B == A & ~B
611 Value *NotB = BinaryOperator::createNot(Op1, Op1->getName()+".not", &I);
612 WorkList.push_back(cast<Instruction>(NotB));
613 return BinaryOperator::create(Instruction::And, Op0I->getOperand(0),
618 // (A & C1)^(B & C2) -> (A & C1)|(B & C2) iff C1^C2 == 0
619 if (Constant *C1 = dyn_castMaskingAnd(Op0))
620 if (Constant *C2 = dyn_castMaskingAnd(Op1))
621 if (ConstantExpr::get(Instruction::And, C1, C2)->isNullValue())
622 return BinaryOperator::create(Instruction::Or, Op0, Op1);
624 return Changed ? &I : 0;
627 // AddOne, SubOne - Add or subtract a constant one from an integer constant...
628 static Constant *AddOne(ConstantInt *C) {
629 Constant *Result = ConstantExpr::get(Instruction::Add, C,
630 ConstantInt::get(C->getType(), 1));
631 assert(Result && "Constant folding integer addition failed!");
634 static Constant *SubOne(ConstantInt *C) {
635 Constant *Result = ConstantExpr::get(Instruction::Sub, C,
636 ConstantInt::get(C->getType(), 1));
637 assert(Result && "Constant folding integer addition failed!");
641 // isTrueWhenEqual - Return true if the specified setcondinst instruction is
642 // true when both operands are equal...
644 static bool isTrueWhenEqual(Instruction &I) {
645 return I.getOpcode() == Instruction::SetEQ ||
646 I.getOpcode() == Instruction::SetGE ||
647 I.getOpcode() == Instruction::SetLE;
650 Instruction *InstCombiner::visitSetCondInst(BinaryOperator &I) {
651 bool Changed = SimplifyCommutative(I);
652 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
653 const Type *Ty = Op0->getType();
657 return ReplaceInstUsesWith(I, ConstantBool::get(isTrueWhenEqual(I)));
659 // setcc <global*>, 0 - Global value addresses are never null!
660 if (isa<GlobalValue>(Op0) && isa<ConstantPointerNull>(Op1))
661 return ReplaceInstUsesWith(I, ConstantBool::get(!isTrueWhenEqual(I)));
663 // setcc's with boolean values can always be turned into bitwise operations
664 if (Ty == Type::BoolTy) {
665 // If this is <, >, or !=, we can change this into a simple xor instruction
666 if (!isTrueWhenEqual(I))
667 return BinaryOperator::create(Instruction::Xor, Op0, Op1, I.getName());
669 // Otherwise we need to make a temporary intermediate instruction and insert
670 // it into the instruction stream. This is what we are after:
672 // seteq bool %A, %B -> ~(A^B)
673 // setle bool %A, %B -> ~A | B
674 // setge bool %A, %B -> A | ~B
676 if (I.getOpcode() == Instruction::SetEQ) { // seteq case
677 Instruction *Xor = BinaryOperator::create(Instruction::Xor, Op0, Op1,
679 InsertNewInstBefore(Xor, I);
680 return BinaryOperator::createNot(Xor, I.getName());
683 // Handle the setXe cases...
684 assert(I.getOpcode() == Instruction::SetGE ||
685 I.getOpcode() == Instruction::SetLE);
687 if (I.getOpcode() == Instruction::SetGE)
688 std::swap(Op0, Op1); // Change setge -> setle
690 // Now we just have the SetLE case.
691 Instruction *Not = BinaryOperator::createNot(Op0, I.getName()+"tmp");
692 InsertNewInstBefore(Not, I);
693 return BinaryOperator::create(Instruction::Or, Not, Op1, I.getName());
696 // Check to see if we are doing one of many comparisons against constant
697 // integers at the end of their ranges...
699 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
700 if (CI->isNullValue()) {
701 if (I.getOpcode() == Instruction::SetNE)
702 return new CastInst(Op0, Type::BoolTy, I.getName());
703 else if (I.getOpcode() == Instruction::SetEQ) {
704 // seteq X, 0 -> not (cast X to bool)
705 Instruction *Val = new CastInst(Op0, Type::BoolTy, I.getName()+".not");
706 InsertNewInstBefore(Val, I);
707 return BinaryOperator::createNot(Val, I.getName());
711 // Check to see if we are comparing against the minimum or maximum value...
712 if (CI->isMinValue()) {
713 if (I.getOpcode() == Instruction::SetLT) // A < MIN -> FALSE
714 return ReplaceInstUsesWith(I, ConstantBool::False);
715 if (I.getOpcode() == Instruction::SetGE) // A >= MIN -> TRUE
716 return ReplaceInstUsesWith(I, ConstantBool::True);
717 if (I.getOpcode() == Instruction::SetLE) // A <= MIN -> A == MIN
718 return BinaryOperator::create(Instruction::SetEQ, Op0,Op1, I.getName());
719 if (I.getOpcode() == Instruction::SetGT) // A > MIN -> A != MIN
720 return BinaryOperator::create(Instruction::SetNE, Op0,Op1, I.getName());
722 } else if (CI->isMaxValue()) {
723 if (I.getOpcode() == Instruction::SetGT) // A > MAX -> FALSE
724 return ReplaceInstUsesWith(I, ConstantBool::False);
725 if (I.getOpcode() == Instruction::SetLE) // A <= MAX -> TRUE
726 return ReplaceInstUsesWith(I, ConstantBool::True);
727 if (I.getOpcode() == Instruction::SetGE) // A >= MAX -> A == MAX
728 return BinaryOperator::create(Instruction::SetEQ, Op0,Op1, I.getName());
729 if (I.getOpcode() == Instruction::SetLT) // A < MAX -> A != MAX
730 return BinaryOperator::create(Instruction::SetNE, Op0,Op1, I.getName());
732 // Comparing against a value really close to min or max?
733 } else if (isMinValuePlusOne(CI)) {
734 if (I.getOpcode() == Instruction::SetLT) // A < MIN+1 -> A == MIN
735 return BinaryOperator::create(Instruction::SetEQ, Op0,
736 SubOne(CI), I.getName());
737 if (I.getOpcode() == Instruction::SetGE) // A >= MIN-1 -> A != MIN
738 return BinaryOperator::create(Instruction::SetNE, Op0,
739 SubOne(CI), I.getName());
741 } else if (isMaxValueMinusOne(CI)) {
742 if (I.getOpcode() == Instruction::SetGT) // A > MAX-1 -> A == MAX
743 return BinaryOperator::create(Instruction::SetEQ, Op0,
744 AddOne(CI), I.getName());
745 if (I.getOpcode() == Instruction::SetLE) // A <= MAX-1 -> A != MAX
746 return BinaryOperator::create(Instruction::SetNE, Op0,
747 AddOne(CI), I.getName());
751 return Changed ? &I : 0;
756 Instruction *InstCombiner::visitShiftInst(ShiftInst &I) {
757 assert(I.getOperand(1)->getType() == Type::UByteTy);
758 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
760 // shl X, 0 == X and shr X, 0 == X
761 // shl 0, X == 0 and shr 0, X == 0
762 if (Op1 == Constant::getNullValue(Type::UByteTy) ||
763 Op0 == Constant::getNullValue(Op0->getType()))
764 return ReplaceInstUsesWith(I, Op0);
766 // If this is a shift of a shift, see if we can fold the two together...
767 if (ShiftInst *Op0SI = dyn_cast<ShiftInst>(Op0)) {
768 if (isa<Constant>(Op1) && isa<Constant>(Op0SI->getOperand(1))) {
769 ConstantUInt *ShiftAmt1C = cast<ConstantUInt>(Op0SI->getOperand(1));
770 unsigned ShiftAmt1 = ShiftAmt1C->getValue();
771 unsigned ShiftAmt2 = cast<ConstantUInt>(Op1)->getValue();
773 // Check for (A << c1) << c2 and (A >> c1) >> c2
774 if (I.getOpcode() == Op0SI->getOpcode()) {
775 unsigned Amt = ShiftAmt1+ShiftAmt2; // Fold into one big shift...
776 return new ShiftInst(I.getOpcode(), Op0SI->getOperand(0),
777 ConstantUInt::get(Type::UByteTy, Amt));
780 if (I.getType()->isUnsigned()) { // Check for (A << c1) >> c2 or visaversa
781 // Calculate bitmask for what gets shifted off the edge...
782 Constant *C = ConstantIntegral::getAllOnesValue(I.getType());
783 if (I.getOpcode() == Instruction::Shr)
784 C = ConstantExpr::getShift(Instruction::Shr, C, ShiftAmt1C);
786 C = ConstantExpr::getShift(Instruction::Shl, C, ShiftAmt1C);
789 BinaryOperator::create(Instruction::And, Op0SI->getOperand(0),
790 C, Op0SI->getOperand(0)->getName()+".mask",&I);
791 WorkList.push_back(Mask);
793 // Figure out what flavor of shift we should use...
794 if (ShiftAmt1 == ShiftAmt2)
795 return ReplaceInstUsesWith(I, Mask); // (A << c) >> c === A & c2
796 else if (ShiftAmt1 < ShiftAmt2) {
797 return new ShiftInst(I.getOpcode(), Mask,
798 ConstantUInt::get(Type::UByteTy, ShiftAmt2-ShiftAmt1));
800 return new ShiftInst(Op0SI->getOpcode(), Mask,
801 ConstantUInt::get(Type::UByteTy, ShiftAmt1-ShiftAmt2));
807 // shl uint X, 32 = 0 and shr ubyte Y, 9 = 0, ... just don't eliminate shr of
810 if (ConstantUInt *CUI = dyn_cast<ConstantUInt>(Op1)) {
811 unsigned TypeBits = Op0->getType()->getPrimitiveSize()*8;
812 if (CUI->getValue() >= TypeBits &&
813 (!Op0->getType()->isSigned() || I.getOpcode() == Instruction::Shl))
814 return ReplaceInstUsesWith(I, Constant::getNullValue(Op0->getType()));
816 // Check to see if we are shifting left by 1. If so, turn it into an add
818 if (I.getOpcode() == Instruction::Shl && CUI->equalsInt(1))
819 // Convert 'shl int %X, 1' to 'add int %X, %X'
820 return BinaryOperator::create(Instruction::Add, Op0, Op0, I.getName());
824 // shr int -1, X = -1 (for any arithmetic shift rights of ~0)
825 if (ConstantSInt *CSI = dyn_cast<ConstantSInt>(Op0))
826 if (I.getOpcode() == Instruction::Shr && CSI->isAllOnesValue())
827 return ReplaceInstUsesWith(I, CSI);
833 // isEliminableCastOfCast - Return true if it is valid to eliminate the CI
836 static inline bool isEliminableCastOfCast(const CastInst &CI,
837 const CastInst *CSrc) {
838 assert(CI.getOperand(0) == CSrc);
839 const Type *SrcTy = CSrc->getOperand(0)->getType();
840 const Type *MidTy = CSrc->getType();
841 const Type *DstTy = CI.getType();
843 // It is legal to eliminate the instruction if casting A->B->A if the sizes
844 // are identical and the bits don't get reinterpreted (for example
845 // int->float->int would not be allowed)
846 if (SrcTy == DstTy && SrcTy->isLosslesslyConvertibleTo(MidTy))
849 // Allow free casting and conversion of sizes as long as the sign doesn't
851 if (SrcTy->isIntegral() && MidTy->isIntegral() && DstTy->isIntegral()) {
852 unsigned SrcSize = SrcTy->getPrimitiveSize();
853 unsigned MidSize = MidTy->getPrimitiveSize();
854 unsigned DstSize = DstTy->getPrimitiveSize();
856 // Cases where we are monotonically decreasing the size of the type are
857 // always ok, regardless of what sign changes are going on.
859 if (SrcSize >= MidSize && MidSize >= DstSize)
862 // Cases where the source and destination type are the same, but the middle
863 // type is bigger are noops.
865 if (SrcSize == DstSize && MidSize > SrcSize)
868 // If we are monotonically growing, things are more complex.
870 if (SrcSize <= MidSize && MidSize <= DstSize) {
871 // We have eight combinations of signedness to worry about. Here's the
873 static const int SignTable[8] = {
874 // CODE, SrcSigned, MidSigned, DstSigned, Comment
875 1, // U U U Always ok
876 1, // U U S Always ok
877 3, // U S U Ok iff SrcSize != MidSize
878 3, // U S S Ok iff SrcSize != MidSize
880 2, // S U S Ok iff MidSize == DstSize
881 1, // S S U Always ok
882 1, // S S S Always ok
885 // Choose an action based on the current entry of the signtable that this
886 // cast of cast refers to...
887 unsigned Row = SrcTy->isSigned()*4+MidTy->isSigned()*2+DstTy->isSigned();
888 switch (SignTable[Row]) {
889 case 0: return false; // Never ok
890 case 1: return true; // Always ok
891 case 2: return MidSize == DstSize; // Ok iff MidSize == DstSize
892 case 3: // Ok iff SrcSize != MidSize
893 return SrcSize != MidSize || SrcTy == Type::BoolTy;
894 default: assert(0 && "Bad entry in sign table!");
899 // Otherwise, we cannot succeed. Specifically we do not want to allow things
900 // like: short -> ushort -> uint, because this can create wrong results if
901 // the input short is negative!
907 // CastInst simplification
909 Instruction *InstCombiner::visitCastInst(CastInst &CI) {
910 Value *Src = CI.getOperand(0);
912 // If the user is casting a value to the same type, eliminate this cast
914 if (CI.getType() == Src->getType())
915 return ReplaceInstUsesWith(CI, Src);
917 // If casting the result of another cast instruction, try to eliminate this
920 if (CastInst *CSrc = dyn_cast<CastInst>(Src)) {
921 if (isEliminableCastOfCast(CI, CSrc)) {
922 // This instruction now refers directly to the cast's src operand. This
923 // has a good chance of making CSrc dead.
924 CI.setOperand(0, CSrc->getOperand(0));
928 // If this is an A->B->A cast, and we are dealing with integral types, try
929 // to convert this into a logical 'and' instruction.
931 if (CSrc->getOperand(0)->getType() == CI.getType() &&
932 CI.getType()->isInteger() && CSrc->getType()->isInteger() &&
933 CI.getType()->isUnsigned() && CSrc->getType()->isUnsigned() &&
934 CSrc->getType()->getPrimitiveSize() < CI.getType()->getPrimitiveSize()){
935 assert(CSrc->getType() != Type::ULongTy &&
936 "Cannot have type bigger than ulong!");
937 uint64_t AndValue = (1ULL << CSrc->getType()->getPrimitiveSize()*8)-1;
938 Constant *AndOp = ConstantUInt::get(CI.getType(), AndValue);
939 return BinaryOperator::create(Instruction::And, CSrc->getOperand(0),
944 // If casting the result of a getelementptr instruction with no offset, turn
945 // this into a cast of the original pointer!
947 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Src)) {
948 bool AllZeroOperands = true;
949 for (unsigned i = 1, e = GEP->getNumOperands(); i != e; ++i)
950 if (!isa<Constant>(GEP->getOperand(i)) ||
951 !cast<Constant>(GEP->getOperand(i))->isNullValue()) {
952 AllZeroOperands = false;
955 if (AllZeroOperands) {
956 CI.setOperand(0, GEP->getOperand(0));
961 // If this is a cast to bool (which is effectively a "!=0" test), then we can
962 // perform a few optimizations...
964 if (CI.getType() == Type::BoolTy) {
965 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Src)) {
966 Value *Op0 = BO->getOperand(0), *Op1 = BO->getOperand(1);
968 switch (BO->getOpcode()) {
969 case Instruction::Sub:
970 case Instruction::Xor:
971 // Replace (cast ([sub|xor] A, B) to bool) with (setne A, B)
972 return new SetCondInst(Instruction::SetNE, Op0, Op1);
974 // Replace (cast (add A, B) to bool) with (setne A, -B) if B is
975 // efficiently invertible, or if the add has just this one use.
976 case Instruction::Add:
977 if (Value *NegVal = dyn_castNegVal(Op1))
978 return new SetCondInst(Instruction::SetNE, Op0, NegVal);
979 else if (Value *NegVal = dyn_castNegVal(Op0))
980 return new SetCondInst(Instruction::SetNE, NegVal, Op1);
981 else if (BO->use_size() == 1) {
982 Instruction *Neg = BinaryOperator::createNeg(Op1, BO->getName());
984 InsertNewInstBefore(Neg, CI);
985 return new SetCondInst(Instruction::SetNE, Op0, Neg);
989 case Instruction::And:
990 // Replace (cast (and X, (1 << size(X)-1)) to bool) with x < 0,
991 // converting X to be a signed value as appropriate. Don't worry about
992 // bool values, as they will be optimized other ways if they occur in
993 // this configuration.
994 if (ConstantInt *CInt = dyn_cast<ConstantInt>(Op1))
995 if (isSignBit(CInt)) {
996 // If 'X' is not signed, insert a cast now...
997 if (!CInt->getType()->isSigned()) {
999 switch (CInt->getType()->getPrimitiveID()) {
1000 case Type::UByteTyID: DestTy = Type::SByteTy; break;
1001 case Type::UShortTyID: DestTy = Type::ShortTy; break;
1002 case Type::UIntTyID: DestTy = Type::IntTy; break;
1003 case Type::ULongTyID: DestTy = Type::LongTy; break;
1004 default: assert(0 && "Invalid unsigned integer type!"); abort();
1006 CastInst *NewCI = new CastInst(Op0, DestTy,
1007 Op0->getName()+".signed");
1008 InsertNewInstBefore(NewCI, CI);
1011 return new SetCondInst(Instruction::SetLT, Op0,
1012 Constant::getNullValue(Op0->getType()));
1023 // CallInst simplification
1025 Instruction *InstCombiner::visitCallInst(CallInst &CI) {
1026 if (transformConstExprCastCall(&CI)) return 0;
1030 // InvokeInst simplification
1032 Instruction *InstCombiner::visitInvokeInst(InvokeInst &II) {
1033 if (transformConstExprCastCall(&II)) return 0;
1037 // getPromotedType - Return the specified type promoted as it would be to pass
1038 // though a va_arg area...
1039 static const Type *getPromotedType(const Type *Ty) {
1040 switch (Ty->getPrimitiveID()) {
1041 case Type::SByteTyID:
1042 case Type::ShortTyID: return Type::IntTy;
1043 case Type::UByteTyID:
1044 case Type::UShortTyID: return Type::UIntTy;
1045 case Type::FloatTyID: return Type::DoubleTy;
1050 // transformConstExprCastCall - If the callee is a constexpr cast of a function,
1051 // attempt to move the cast to the arguments of the call/invoke.
1053 bool InstCombiner::transformConstExprCastCall(CallSite CS) {
1054 if (!isa<ConstantExpr>(CS.getCalledValue())) return false;
1055 ConstantExpr *CE = cast<ConstantExpr>(CS.getCalledValue());
1056 if (CE->getOpcode() != Instruction::Cast ||
1057 !isa<ConstantPointerRef>(CE->getOperand(0)))
1059 ConstantPointerRef *CPR = cast<ConstantPointerRef>(CE->getOperand(0));
1060 if (!isa<Function>(CPR->getValue())) return false;
1061 Function *Callee = cast<Function>(CPR->getValue());
1062 Instruction *Caller = CS.getInstruction();
1064 // Okay, this is a cast from a function to a different type. Unless doing so
1065 // would cause a type conversion of one of our arguments, change this call to
1066 // be a direct call with arguments casted to the appropriate types.
1068 const FunctionType *FT = Callee->getFunctionType();
1069 const Type *OldRetTy = Caller->getType();
1071 if (Callee->isExternal() &&
1072 !OldRetTy->isLosslesslyConvertibleTo(FT->getReturnType()))
1073 return false; // Cannot transform this return value...
1075 unsigned NumActualArgs = unsigned(CS.arg_end()-CS.arg_begin());
1076 unsigned NumCommonArgs = std::min(FT->getNumParams(), NumActualArgs);
1078 CallSite::arg_iterator AI = CS.arg_begin();
1079 for (unsigned i = 0, e = NumCommonArgs; i != e; ++i, ++AI) {
1080 const Type *ParamTy = FT->getParamType(i);
1081 bool isConvertible = (*AI)->getType()->isLosslesslyConvertibleTo(ParamTy);
1082 if (Callee->isExternal() && !isConvertible) return false;
1085 if (FT->getNumParams() < NumActualArgs && !FT->isVarArg() &&
1086 Callee->isExternal())
1087 return false; // Do not delete arguments unless we have a function body...
1089 // Okay, we decided that this is a safe thing to do: go ahead and start
1090 // inserting cast instructions as necessary...
1091 std::vector<Value*> Args;
1092 Args.reserve(NumActualArgs);
1094 AI = CS.arg_begin();
1095 for (unsigned i = 0; i != NumCommonArgs; ++i, ++AI) {
1096 const Type *ParamTy = FT->getParamType(i);
1097 if ((*AI)->getType() == ParamTy) {
1098 Args.push_back(*AI);
1100 Instruction *Cast = new CastInst(*AI, ParamTy, "tmp");
1101 InsertNewInstBefore(Cast, *Caller);
1102 Args.push_back(Cast);
1106 // If the function takes more arguments than the call was taking, add them
1108 for (unsigned i = NumCommonArgs; i != FT->getNumParams(); ++i)
1109 Args.push_back(Constant::getNullValue(FT->getParamType(i)));
1111 // If we are removing arguments to the function, emit an obnoxious warning...
1112 if (FT->getNumParams() < NumActualArgs)
1113 if (!FT->isVarArg()) {
1114 std::cerr << "WARNING: While resolving call to function '"
1115 << Callee->getName() << "' arguments were dropped!\n";
1117 // Add all of the arguments in their promoted form to the arg list...
1118 for (unsigned i = FT->getNumParams(); i != NumActualArgs; ++i, ++AI) {
1119 const Type *PTy = getPromotedType((*AI)->getType());
1120 if (PTy != (*AI)->getType()) {
1121 // Must promote to pass through va_arg area!
1122 Instruction *Cast = new CastInst(*AI, PTy, "tmp");
1123 InsertNewInstBefore(Cast, *Caller);
1124 Args.push_back(Cast);
1126 Args.push_back(*AI);
1131 if (FT->getReturnType() == Type::VoidTy)
1132 Caller->setName(""); // Void type should not have a name...
1135 if (InvokeInst *II = dyn_cast<InvokeInst>(Caller)) {
1136 NC = new InvokeInst(Callee, II->getNormalDest(), II->getExceptionalDest(),
1137 Args, Caller->getName(), Caller);
1139 NC = new CallInst(Callee, Args, Caller->getName(), Caller);
1142 // Insert a cast of the return type as necessary...
1144 if (Caller->getType() != NV->getType() && !Caller->use_empty()) {
1145 if (NV->getType() != Type::VoidTy) {
1146 NV = NC = new CastInst(NC, Caller->getType(), "tmp");
1147 InsertNewInstBefore(NC, *Caller);
1148 AddUsesToWorkList(*Caller);
1150 NV = Constant::getNullValue(Caller->getType());
1154 if (Caller->getType() != Type::VoidTy && !Caller->use_empty())
1155 Caller->replaceAllUsesWith(NV);
1156 Caller->getParent()->getInstList().erase(Caller);
1157 removeFromWorkList(Caller);
1163 // PHINode simplification
1165 Instruction *InstCombiner::visitPHINode(PHINode &PN) {
1166 // If the PHI node only has one incoming value, eliminate the PHI node...
1167 if (PN.getNumIncomingValues() == 1)
1168 return ReplaceInstUsesWith(PN, PN.getIncomingValue(0));
1170 // Otherwise if all of the incoming values are the same for the PHI, replace
1171 // the PHI node with the incoming value.
1174 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
1175 if (PN.getIncomingValue(i) != &PN) // Not the PHI node itself...
1176 if (InVal && PN.getIncomingValue(i) != InVal)
1177 return 0; // Not the same, bail out.
1179 InVal = PN.getIncomingValue(i);
1181 // The only case that could cause InVal to be null is if we have a PHI node
1182 // that only has entries for itself. In this case, there is no entry into the
1183 // loop, so kill the PHI.
1185 if (InVal == 0) InVal = Constant::getNullValue(PN.getType());
1187 // All of the incoming values are the same, replace the PHI node now.
1188 return ReplaceInstUsesWith(PN, InVal);
1192 Instruction *InstCombiner::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1193 // Is it 'getelementptr %P, long 0' or 'getelementptr %P'
1194 // If so, eliminate the noop.
1195 if ((GEP.getNumOperands() == 2 &&
1196 GEP.getOperand(1) == Constant::getNullValue(Type::LongTy)) ||
1197 GEP.getNumOperands() == 1)
1198 return ReplaceInstUsesWith(GEP, GEP.getOperand(0));
1200 // Combine Indices - If the source pointer to this getelementptr instruction
1201 // is a getelementptr instruction, combine the indices of the two
1202 // getelementptr instructions into a single instruction.
1204 if (GetElementPtrInst *Src = dyn_cast<GetElementPtrInst>(GEP.getOperand(0))) {
1205 std::vector<Value *> Indices;
1207 // Can we combine the two pointer arithmetics offsets?
1208 if (Src->getNumOperands() == 2 && isa<Constant>(Src->getOperand(1)) &&
1209 isa<Constant>(GEP.getOperand(1))) {
1210 // Replace: gep (gep %P, long C1), long C2, ...
1211 // With: gep %P, long (C1+C2), ...
1212 Value *Sum = ConstantExpr::get(Instruction::Add,
1213 cast<Constant>(Src->getOperand(1)),
1214 cast<Constant>(GEP.getOperand(1)));
1215 assert(Sum && "Constant folding of longs failed!?");
1216 GEP.setOperand(0, Src->getOperand(0));
1217 GEP.setOperand(1, Sum);
1218 AddUsesToWorkList(*Src); // Reduce use count of Src
1220 } else if (Src->getNumOperands() == 2) {
1221 // Replace: gep (gep %P, long B), long A, ...
1222 // With: T = long A+B; gep %P, T, ...
1224 Value *Sum = BinaryOperator::create(Instruction::Add, Src->getOperand(1),
1226 Src->getName()+".sum", &GEP);
1227 GEP.setOperand(0, Src->getOperand(0));
1228 GEP.setOperand(1, Sum);
1229 WorkList.push_back(cast<Instruction>(Sum));
1231 } else if (*GEP.idx_begin() == Constant::getNullValue(Type::LongTy) &&
1232 Src->getNumOperands() != 1) {
1233 // Otherwise we can do the fold if the first index of the GEP is a zero
1234 Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end());
1235 Indices.insert(Indices.end(), GEP.idx_begin()+1, GEP.idx_end());
1236 } else if (Src->getOperand(Src->getNumOperands()-1) ==
1237 Constant::getNullValue(Type::LongTy)) {
1238 // If the src gep ends with a constant array index, merge this get into
1239 // it, even if we have a non-zero array index.
1240 Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end()-1);
1241 Indices.insert(Indices.end(), GEP.idx_begin(), GEP.idx_end());
1244 if (!Indices.empty())
1245 return new GetElementPtrInst(Src->getOperand(0), Indices, GEP.getName());
1247 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(GEP.getOperand(0))) {
1248 // GEP of global variable. If all of the indices for this GEP are
1249 // constants, we can promote this to a constexpr instead of an instruction.
1251 // Scan for nonconstants...
1252 std::vector<Constant*> Indices;
1253 User::op_iterator I = GEP.idx_begin(), E = GEP.idx_end();
1254 for (; I != E && isa<Constant>(*I); ++I)
1255 Indices.push_back(cast<Constant>(*I));
1257 if (I == E) { // If they are all constants...
1259 ConstantExpr::getGetElementPtr(ConstantPointerRef::get(GV), Indices);
1261 // Replace all uses of the GEP with the new constexpr...
1262 return ReplaceInstUsesWith(GEP, CE);
1269 Instruction *InstCombiner::visitAllocationInst(AllocationInst &AI) {
1270 // Convert: malloc Ty, C - where C is a constant != 1 into: malloc [C x Ty], 1
1271 if (AI.isArrayAllocation()) // Check C != 1
1272 if (const ConstantUInt *C = dyn_cast<ConstantUInt>(AI.getArraySize())) {
1273 const Type *NewTy = ArrayType::get(AI.getAllocatedType(), C->getValue());
1274 AllocationInst *New = 0;
1276 // Create and insert the replacement instruction...
1277 if (isa<MallocInst>(AI))
1278 New = new MallocInst(NewTy, 0, AI.getName(), &AI);
1280 assert(isa<AllocaInst>(AI) && "Unknown type of allocation inst!");
1281 New = new AllocaInst(NewTy, 0, AI.getName(), &AI);
1284 // Scan to the end of the allocation instructions, to skip over a block of
1285 // allocas if possible...
1287 BasicBlock::iterator It = New;
1288 while (isa<AllocationInst>(*It)) ++It;
1290 // Now that I is pointing to the first non-allocation-inst in the block,
1291 // insert our getelementptr instruction...
1293 std::vector<Value*> Idx(2, Constant::getNullValue(Type::LongTy));
1294 Value *V = new GetElementPtrInst(New, Idx, New->getName()+".sub", It);
1296 // Now make everything use the getelementptr instead of the original
1298 ReplaceInstUsesWith(AI, V);
1304 /// GetGEPGlobalInitializer - Given a constant, and a getelementptr
1305 /// constantexpr, return the constant value being addressed by the constant
1306 /// expression, or null if something is funny.
1308 static Constant *GetGEPGlobalInitializer(Constant *C, ConstantExpr *CE) {
1309 if (CE->getOperand(1) != Constant::getNullValue(Type::LongTy))
1310 return 0; // Do not allow stepping over the value!
1312 // Loop over all of the operands, tracking down which value we are
1314 for (unsigned i = 2, e = CE->getNumOperands(); i != e; ++i)
1315 if (ConstantUInt *CU = dyn_cast<ConstantUInt>(CE->getOperand(i))) {
1316 ConstantStruct *CS = cast<ConstantStruct>(C);
1317 if (CU->getValue() >= CS->getValues().size()) return 0;
1318 C = cast<Constant>(CS->getValues()[CU->getValue()]);
1319 } else if (ConstantSInt *CS = dyn_cast<ConstantSInt>(CE->getOperand(i))) {
1320 ConstantArray *CA = cast<ConstantArray>(C);
1321 if ((uint64_t)CS->getValue() >= CA->getValues().size()) return 0;
1322 C = cast<Constant>(CA->getValues()[CS->getValue()]);
1328 Instruction *InstCombiner::visitLoadInst(LoadInst &LI) {
1329 Value *Op = LI.getOperand(0);
1330 if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(Op))
1331 Op = CPR->getValue();
1333 // Instcombine load (constant global) into the value loaded...
1334 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Op))
1335 if (GV->isConstant() && !GV->isExternal())
1336 return ReplaceInstUsesWith(LI, GV->getInitializer());
1338 // Instcombine load (constantexpr_GEP global, 0, ...) into the value loaded...
1339 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Op))
1340 if (CE->getOpcode() == Instruction::GetElementPtr)
1341 if (ConstantPointerRef *G=dyn_cast<ConstantPointerRef>(CE->getOperand(0)))
1342 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(G->getValue()))
1343 if (GV->isConstant() && !GV->isExternal())
1344 if (Constant *V = GetGEPGlobalInitializer(GV->getInitializer(), CE))
1345 return ReplaceInstUsesWith(LI, V);
1350 Instruction *InstCombiner::visitBranchInst(BranchInst &BI) {
1351 // Change br (not X), label True, label False to: br X, label False, True
1352 if (BI.isConditional() && !isa<Constant>(BI.getCondition()))
1353 if (Value *V = dyn_castNotVal(BI.getCondition())) {
1354 BasicBlock *TrueDest = BI.getSuccessor(0);
1355 BasicBlock *FalseDest = BI.getSuccessor(1);
1356 // Swap Destinations and condition...
1358 BI.setSuccessor(0, FalseDest);
1359 BI.setSuccessor(1, TrueDest);
1366 void InstCombiner::removeFromWorkList(Instruction *I) {
1367 WorkList.erase(std::remove(WorkList.begin(), WorkList.end(), I),
1371 bool InstCombiner::runOnFunction(Function &F) {
1372 bool Changed = false;
1374 WorkList.insert(WorkList.end(), inst_begin(F), inst_end(F));
1376 while (!WorkList.empty()) {
1377 Instruction *I = WorkList.back(); // Get an instruction from the worklist
1378 WorkList.pop_back();
1380 // Check to see if we can DCE or ConstantPropagate the instruction...
1381 // Check to see if we can DIE the instruction...
1382 if (isInstructionTriviallyDead(I)) {
1383 // Add operands to the worklist...
1384 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1385 if (Instruction *Op = dyn_cast<Instruction>(I->getOperand(i)))
1386 WorkList.push_back(Op);
1389 BasicBlock::iterator BBI = I;
1390 if (dceInstruction(BBI)) {
1391 removeFromWorkList(I);
1396 // Instruction isn't dead, see if we can constant propagate it...
1397 if (Constant *C = ConstantFoldInstruction(I)) {
1398 // Add operands to the worklist...
1399 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1400 if (Instruction *Op = dyn_cast<Instruction>(I->getOperand(i)))
1401 WorkList.push_back(Op);
1402 ReplaceInstUsesWith(*I, C);
1405 BasicBlock::iterator BBI = I;
1406 if (dceInstruction(BBI)) {
1407 removeFromWorkList(I);
1412 // Now that we have an instruction, try combining it to simplify it...
1413 if (Instruction *Result = visit(*I)) {
1415 // Should we replace the old instruction with a new one?
1417 // Instructions can end up on the worklist more than once. Make sure
1418 // we do not process an instruction that has been deleted.
1419 removeFromWorkList(I);
1420 ReplaceInstWithInst(I, Result);
1422 BasicBlock::iterator II = I;
1424 // If the instruction was modified, it's possible that it is now dead.
1425 // if so, remove it.
1426 if (dceInstruction(II)) {
1427 // Instructions may end up in the worklist more than once. Erase them
1429 removeFromWorkList(I);
1435 WorkList.push_back(Result);
1436 AddUsesToWorkList(*Result);
1445 Pass *createInstructionCombiningPass() {
1446 return new InstCombiner();