blob: 07736b57c2de959fa46c7983078ecdd1cc76f1f5 [file] [log] [blame]
Chris Lattnere6794492002-08-12 21:17:25 +00001//===- InstructionCombining.cpp - Combine multiple instructions -----------===//
John Criswell482202a2003-10-20 19:43:21 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
Chris Lattnerca081252001-12-14 16:52:21 +00009//
10// InstructionCombining - Combine instructions to form fewer, simple
Chris Lattner99f48c62002-09-02 04:59:56 +000011// instructions. This pass does not modify the CFG This pass is where algebraic
12// simplification happens.
Chris Lattnerca081252001-12-14 16:52:21 +000013//
14// This pass combines things like:
15// %Y = add int 1, %X
16// %Z = add int 1, %Y
17// into:
18// %Z = add int 2, %X
19//
20// This is a simple worklist driven algorithm.
21//
Chris Lattner216c7b82003-09-10 05:29:43 +000022// This pass guarantees that the following canonicalizations are performed on
Chris Lattnerbfb1d032003-07-23 21:41:57 +000023// the program:
24// 1. If a binary operator has a constant operand, it is moved to the RHS
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +000025// 2. Bitwise operators with constant operands are always grouped so that
26// shifts are performed first, then or's, then and's, then xor's.
Chris Lattnerbfb1d032003-07-23 21:41:57 +000027// 3. SetCC instructions are converted from <,>,<=,>= to ==,!= if possible
28// 4. All SetCC instructions on boolean values are replaced with logical ops
Chris Lattnerede3fe02003-08-13 04:18:28 +000029// 5. add X, X is represented as (X*2) => (X << 1)
30// 6. Multiplies with a power-of-two constant argument are transformed into
31// shifts.
Chris Lattnerbfb1d032003-07-23 21:41:57 +000032// N. This list is incomplete
33//
Chris Lattnerca081252001-12-14 16:52:21 +000034//===----------------------------------------------------------------------===//
35
Chris Lattnerb4cfa7f2002-05-07 20:03:00 +000036#include "llvm/Transforms/Scalar.h"
Chris Lattner471bd762003-05-22 19:07:21 +000037#include "llvm/Instructions.h"
Chris Lattner04805fa2002-02-26 21:46:54 +000038#include "llvm/Pass.h"
Chris Lattner34428442003-05-27 16:40:51 +000039#include "llvm/Constants.h"
40#include "llvm/ConstantHandling.h"
Chris Lattner1085bdf2002-11-04 16:18:53 +000041#include "llvm/DerivedTypes.h"
Chris Lattner0f1d8a32003-06-26 05:06:25 +000042#include "llvm/GlobalVariable.h"
Chris Lattnerf4ad1652003-11-02 05:57:39 +000043#include "llvm/Target/TargetData.h"
44#include "llvm/Transforms/Utils/BasicBlockUtils.h"
45#include "llvm/Transforms/Utils/Local.h"
Chris Lattner60a65912002-02-12 21:07:25 +000046#include "llvm/Support/InstIterator.h"
Chris Lattner260ab202002-04-18 17:39:14 +000047#include "llvm/Support/InstVisitor.h"
Chris Lattner970c33a2003-06-19 17:00:31 +000048#include "llvm/Support/CallSite.h"
Chris Lattnerbf3a0992002-10-01 22:38:41 +000049#include "Support/Statistic.h"
Chris Lattner053c0932002-05-14 15:24:07 +000050#include <algorithm>
Chris Lattnerca081252001-12-14 16:52:21 +000051
Chris Lattner260ab202002-04-18 17:39:14 +000052namespace {
Chris Lattnerbf3a0992002-10-01 22:38:41 +000053 Statistic<> NumCombined ("instcombine", "Number of insts combined");
54 Statistic<> NumConstProp("instcombine", "Number of constant folds");
55 Statistic<> NumDeadInst ("instcombine", "Number of dead inst eliminated");
56
Chris Lattnerc8e66542002-04-27 06:56:12 +000057 class InstCombiner : public FunctionPass,
Chris Lattner260ab202002-04-18 17:39:14 +000058 public InstVisitor<InstCombiner, Instruction*> {
59 // Worklist of all of the instructions that need to be simplified.
60 std::vector<Instruction*> WorkList;
Chris Lattnerf4ad1652003-11-02 05:57:39 +000061 TargetData *TD;
Chris Lattner260ab202002-04-18 17:39:14 +000062
Chris Lattner113f4f42002-06-25 16:13:24 +000063 void AddUsesToWorkList(Instruction &I) {
Chris Lattner260ab202002-04-18 17:39:14 +000064 // The instruction was simplified, add all users of the instruction to
65 // the work lists because they might get more simplified now...
66 //
Chris Lattner113f4f42002-06-25 16:13:24 +000067 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
Chris Lattner260ab202002-04-18 17:39:14 +000068 UI != UE; ++UI)
69 WorkList.push_back(cast<Instruction>(*UI));
70 }
71
Chris Lattner99f48c62002-09-02 04:59:56 +000072 // removeFromWorkList - remove all instances of I from the worklist.
73 void removeFromWorkList(Instruction *I);
Chris Lattner260ab202002-04-18 17:39:14 +000074 public:
Chris Lattner113f4f42002-06-25 16:13:24 +000075 virtual bool runOnFunction(Function &F);
Chris Lattner260ab202002-04-18 17:39:14 +000076
Chris Lattnerf12cc842002-04-28 21:27:06 +000077 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Chris Lattnerf4ad1652003-11-02 05:57:39 +000078 AU.addRequired<TargetData>();
Chris Lattner820d9712002-10-21 20:00:28 +000079 AU.setPreservesCFG();
Chris Lattnerf12cc842002-04-28 21:27:06 +000080 }
81
Chris Lattner260ab202002-04-18 17:39:14 +000082 // Visitation implementation - Implement instruction combining for different
83 // instruction types. The semantics are as follows:
84 // Return Value:
85 // null - No change was made
Chris Lattnere6794492002-08-12 21:17:25 +000086 // I - Change was made, I is still valid, I may be dead though
Chris Lattner260ab202002-04-18 17:39:14 +000087 // otherwise - Change was made, replace I with returned instruction
88 //
Chris Lattner113f4f42002-06-25 16:13:24 +000089 Instruction *visitAdd(BinaryOperator &I);
90 Instruction *visitSub(BinaryOperator &I);
91 Instruction *visitMul(BinaryOperator &I);
92 Instruction *visitDiv(BinaryOperator &I);
93 Instruction *visitRem(BinaryOperator &I);
94 Instruction *visitAnd(BinaryOperator &I);
95 Instruction *visitOr (BinaryOperator &I);
96 Instruction *visitXor(BinaryOperator &I);
97 Instruction *visitSetCondInst(BinaryOperator &I);
Chris Lattnere8d6c602003-03-10 19:16:08 +000098 Instruction *visitShiftInst(ShiftInst &I);
Chris Lattner113f4f42002-06-25 16:13:24 +000099 Instruction *visitCastInst(CastInst &CI);
Chris Lattner970c33a2003-06-19 17:00:31 +0000100 Instruction *visitCallInst(CallInst &CI);
101 Instruction *visitInvokeInst(InvokeInst &II);
Chris Lattner113f4f42002-06-25 16:13:24 +0000102 Instruction *visitPHINode(PHINode &PN);
103 Instruction *visitGetElementPtrInst(GetElementPtrInst &GEP);
Chris Lattner1085bdf2002-11-04 16:18:53 +0000104 Instruction *visitAllocationInst(AllocationInst &AI);
Chris Lattner0f1d8a32003-06-26 05:06:25 +0000105 Instruction *visitLoadInst(LoadInst &LI);
Chris Lattner9eef8a72003-06-04 04:46:00 +0000106 Instruction *visitBranchInst(BranchInst &BI);
Chris Lattner260ab202002-04-18 17:39:14 +0000107
108 // visitInstruction - Specify what to return for unhandled instructions...
Chris Lattner113f4f42002-06-25 16:13:24 +0000109 Instruction *visitInstruction(Instruction &I) { return 0; }
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000110
Chris Lattner970c33a2003-06-19 17:00:31 +0000111 private:
Chris Lattneraec3d942003-10-07 22:32:43 +0000112 Instruction *visitCallSite(CallSite CS);
Chris Lattner970c33a2003-06-19 17:00:31 +0000113 bool transformConstExprCastCall(CallSite CS);
114
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000115 // InsertNewInstBefore - insert an instruction New before instruction Old
116 // in the program. Add the new instruction to the worklist.
117 //
118 void InsertNewInstBefore(Instruction *New, Instruction &Old) {
Chris Lattner65217ff2002-08-23 18:32:43 +0000119 assert(New && New->getParent() == 0 &&
120 "New instruction already inserted into a basic block!");
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000121 BasicBlock *BB = Old.getParent();
122 BB->getInstList().insert(&Old, New); // Insert inst
123 WorkList.push_back(New); // Add to worklist
124 }
125
Chris Lattner3ac7c262003-08-13 20:16:26 +0000126 public:
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000127 // ReplaceInstUsesWith - This method is to be used when an instruction is
128 // found to be dead, replacable with another preexisting expression. Here
129 // we add all uses of I to the worklist, replace all uses of I with the new
130 // value, then return I, so that the inst combiner will know that I was
131 // modified.
132 //
133 Instruction *ReplaceInstUsesWith(Instruction &I, Value *V) {
134 AddUsesToWorkList(I); // Add all modified instrs to worklist
135 I.replaceAllUsesWith(V);
136 return &I;
137 }
Chris Lattner3ac7c262003-08-13 20:16:26 +0000138 private:
Chris Lattnerdfae8be2003-07-24 17:35:25 +0000139 /// InsertOperandCastBefore - This inserts a cast of V to DestTy before the
140 /// InsertBefore instruction. This is specialized a bit to avoid inserting
141 /// casts that are known to not do anything...
142 ///
143 Value *InsertOperandCastBefore(Value *V, const Type *DestTy,
144 Instruction *InsertBefore);
145
Chris Lattner7fb29e12003-03-11 00:12:48 +0000146 // SimplifyCommutative - This performs a few simplifications for commutative
147 // operators...
148 bool SimplifyCommutative(BinaryOperator &I);
Chris Lattnerba1cb382003-09-19 17:17:26 +0000149
150 Instruction *OptAndOp(Instruction *Op, ConstantIntegral *OpRHS,
151 ConstantIntegral *AndRHS, BinaryOperator &TheAnd);
Chris Lattner260ab202002-04-18 17:39:14 +0000152 };
Chris Lattnerb28b6802002-07-23 18:06:35 +0000153
Chris Lattnerc8b70922002-07-26 21:12:46 +0000154 RegisterOpt<InstCombiner> X("instcombine", "Combine redundant instructions");
Chris Lattner260ab202002-04-18 17:39:14 +0000155}
156
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000157// getComplexity: Assign a complexity or rank value to LLVM Values...
158// 0 -> Constant, 1 -> Other, 2 -> Argument, 2 -> Unary, 3 -> OtherInst
159static unsigned getComplexity(Value *V) {
160 if (isa<Instruction>(V)) {
161 if (BinaryOperator::isNeg(V) || BinaryOperator::isNot(V))
162 return 2;
163 return 3;
164 }
165 if (isa<Argument>(V)) return 2;
166 return isa<Constant>(V) ? 0 : 1;
167}
Chris Lattner260ab202002-04-18 17:39:14 +0000168
Chris Lattner7fb29e12003-03-11 00:12:48 +0000169// isOnlyUse - Return true if this instruction will be deleted if we stop using
170// it.
171static bool isOnlyUse(Value *V) {
Chris Lattnerf95d9b92003-10-15 16:48:29 +0000172 return V->hasOneUse() || isa<Constant>(V);
Chris Lattner7fb29e12003-03-11 00:12:48 +0000173}
174
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000175// SimplifyCommutative - This performs a few simplifications for commutative
176// operators:
Chris Lattner260ab202002-04-18 17:39:14 +0000177//
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000178// 1. Order operands such that they are listed from right (least complex) to
179// left (most complex). This puts constants before unary operators before
180// binary operators.
181//
Chris Lattner7fb29e12003-03-11 00:12:48 +0000182// 2. Transform: (op (op V, C1), C2) ==> (op V, (op C1, C2))
183// 3. Transform: (op (op V1, C1), (op V2, C2)) ==> (op (op V1, V2), (op C1,C2))
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000184//
Chris Lattner7fb29e12003-03-11 00:12:48 +0000185bool InstCombiner::SimplifyCommutative(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000186 bool Changed = false;
187 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1)))
188 Changed = !I.swapOperands();
189
190 if (!I.isAssociative()) return Changed;
191 Instruction::BinaryOps Opcode = I.getOpcode();
Chris Lattner7fb29e12003-03-11 00:12:48 +0000192 if (BinaryOperator *Op = dyn_cast<BinaryOperator>(I.getOperand(0)))
193 if (Op->getOpcode() == Opcode && isa<Constant>(Op->getOperand(1))) {
194 if (isa<Constant>(I.getOperand(1))) {
Chris Lattner34428442003-05-27 16:40:51 +0000195 Constant *Folded = ConstantExpr::get(I.getOpcode(),
196 cast<Constant>(I.getOperand(1)),
197 cast<Constant>(Op->getOperand(1)));
Chris Lattner7fb29e12003-03-11 00:12:48 +0000198 I.setOperand(0, Op->getOperand(0));
199 I.setOperand(1, Folded);
200 return true;
201 } else if (BinaryOperator *Op1=dyn_cast<BinaryOperator>(I.getOperand(1)))
202 if (Op1->getOpcode() == Opcode && isa<Constant>(Op1->getOperand(1)) &&
203 isOnlyUse(Op) && isOnlyUse(Op1)) {
204 Constant *C1 = cast<Constant>(Op->getOperand(1));
205 Constant *C2 = cast<Constant>(Op1->getOperand(1));
206
207 // Fold (op (op V1, C1), (op V2, C2)) ==> (op (op V1, V2), (op C1,C2))
Chris Lattner34428442003-05-27 16:40:51 +0000208 Constant *Folded = ConstantExpr::get(I.getOpcode(), C1, C2);
Chris Lattner7fb29e12003-03-11 00:12:48 +0000209 Instruction *New = BinaryOperator::create(Opcode, Op->getOperand(0),
210 Op1->getOperand(0),
211 Op1->getName(), &I);
212 WorkList.push_back(New);
213 I.setOperand(0, New);
214 I.setOperand(1, Folded);
215 return true;
216 }
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000217 }
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000218 return Changed;
Chris Lattner260ab202002-04-18 17:39:14 +0000219}
Chris Lattnerca081252001-12-14 16:52:21 +0000220
Chris Lattnerbb74e222003-03-10 23:06:50 +0000221// dyn_castNegVal - Given a 'sub' instruction, return the RHS of the instruction
222// if the LHS is a constant zero (which is the 'negate' form).
Chris Lattner9fa53de2002-05-06 16:49:18 +0000223//
Chris Lattnerbb74e222003-03-10 23:06:50 +0000224static inline Value *dyn_castNegVal(Value *V) {
225 if (BinaryOperator::isNeg(V))
226 return BinaryOperator::getNegArgument(cast<BinaryOperator>(V));
227
Chris Lattner9244df62003-04-30 22:19:10 +0000228 // Constants can be considered to be negated values if they can be folded...
229 if (Constant *C = dyn_cast<Constant>(V))
Chris Lattner34428442003-05-27 16:40:51 +0000230 return ConstantExpr::get(Instruction::Sub,
231 Constant::getNullValue(V->getType()), C);
Chris Lattnerbb74e222003-03-10 23:06:50 +0000232 return 0;
Chris Lattner9fa53de2002-05-06 16:49:18 +0000233}
234
Chris Lattnerbb74e222003-03-10 23:06:50 +0000235static inline Value *dyn_castNotVal(Value *V) {
236 if (BinaryOperator::isNot(V))
237 return BinaryOperator::getNotArgument(cast<BinaryOperator>(V));
238
239 // Constants can be considered to be not'ed values...
Chris Lattnerdd65d862003-04-30 22:34:06 +0000240 if (ConstantIntegral *C = dyn_cast<ConstantIntegral>(V))
Chris Lattner34428442003-05-27 16:40:51 +0000241 return ConstantExpr::get(Instruction::Xor,
242 ConstantIntegral::getAllOnesValue(C->getType()),C);
Chris Lattnerbb74e222003-03-10 23:06:50 +0000243 return 0;
244}
245
Chris Lattner7fb29e12003-03-11 00:12:48 +0000246// dyn_castFoldableMul - If this value is a multiply that can be folded into
247// other computations (because it has a constant operand), return the
248// non-constant operand of the multiply.
249//
250static inline Value *dyn_castFoldableMul(Value *V) {
Chris Lattnerf95d9b92003-10-15 16:48:29 +0000251 if (V->hasOneUse() && V->getType()->isInteger())
Chris Lattner7fb29e12003-03-11 00:12:48 +0000252 if (Instruction *I = dyn_cast<Instruction>(V))
253 if (I->getOpcode() == Instruction::Mul)
254 if (isa<Constant>(I->getOperand(1)))
255 return I->getOperand(0);
256 return 0;
Chris Lattner3082c5a2003-02-18 19:28:33 +0000257}
Chris Lattner31ae8632002-08-14 17:51:49 +0000258
Chris Lattner7fb29e12003-03-11 00:12:48 +0000259// dyn_castMaskingAnd - If this value is an And instruction masking a value with
260// a constant, return the constant being anded with.
261//
Chris Lattner01d56392003-08-12 19:17:27 +0000262template<class ValueType>
263static inline Constant *dyn_castMaskingAnd(ValueType *V) {
Chris Lattner7fb29e12003-03-11 00:12:48 +0000264 if (Instruction *I = dyn_cast<Instruction>(V))
265 if (I->getOpcode() == Instruction::And)
266 return dyn_cast<Constant>(I->getOperand(1));
267
268 // If this is a constant, it acts just like we were masking with it.
269 return dyn_cast<Constant>(V);
270}
Chris Lattner3082c5a2003-02-18 19:28:33 +0000271
272// Log2 - Calculate the log base 2 for the specified value if it is exactly a
273// power of 2.
274static unsigned Log2(uint64_t Val) {
275 assert(Val > 1 && "Values 0 and 1 should be handled elsewhere!");
276 unsigned Count = 0;
277 while (Val != 1) {
278 if (Val & 1) return 0; // Multiple bits set?
279 Val >>= 1;
280 ++Count;
281 }
282 return Count;
Chris Lattner31ae8632002-08-14 17:51:49 +0000283}
284
Chris Lattnerb8b97502003-08-13 19:01:45 +0000285
286/// AssociativeOpt - Perform an optimization on an associative operator. This
287/// function is designed to check a chain of associative operators for a
288/// potential to apply a certain optimization. Since the optimization may be
289/// applicable if the expression was reassociated, this checks the chain, then
290/// reassociates the expression as necessary to expose the optimization
291/// opportunity. This makes use of a special Functor, which must define
292/// 'shouldApply' and 'apply' methods.
293///
294template<typename Functor>
295Instruction *AssociativeOpt(BinaryOperator &Root, const Functor &F) {
296 unsigned Opcode = Root.getOpcode();
297 Value *LHS = Root.getOperand(0);
298
299 // Quick check, see if the immediate LHS matches...
300 if (F.shouldApply(LHS))
301 return F.apply(Root);
302
303 // Otherwise, if the LHS is not of the same opcode as the root, return.
304 Instruction *LHSI = dyn_cast<Instruction>(LHS);
Chris Lattnerf95d9b92003-10-15 16:48:29 +0000305 while (LHSI && LHSI->getOpcode() == Opcode && LHSI->hasOneUse()) {
Chris Lattnerb8b97502003-08-13 19:01:45 +0000306 // Should we apply this transform to the RHS?
307 bool ShouldApply = F.shouldApply(LHSI->getOperand(1));
308
309 // If not to the RHS, check to see if we should apply to the LHS...
310 if (!ShouldApply && F.shouldApply(LHSI->getOperand(0))) {
311 cast<BinaryOperator>(LHSI)->swapOperands(); // Make the LHS the RHS
312 ShouldApply = true;
313 }
314
315 // If the functor wants to apply the optimization to the RHS of LHSI,
316 // reassociate the expression from ((? op A) op B) to (? op (A op B))
317 if (ShouldApply) {
318 BasicBlock *BB = Root.getParent();
319 // All of the instructions have a single use and have no side-effects,
320 // because of this, we can pull them all into the current basic block.
321 if (LHSI->getParent() != BB) {
322 // Move all of the instructions from root to LHSI into the current
323 // block.
324 Instruction *TmpLHSI = cast<Instruction>(Root.getOperand(0));
325 Instruction *LastUse = &Root;
326 while (TmpLHSI->getParent() == BB) {
327 LastUse = TmpLHSI;
328 TmpLHSI = cast<Instruction>(TmpLHSI->getOperand(0));
329 }
330
331 // Loop over all of the instructions in other blocks, moving them into
332 // the current one.
333 Value *TmpLHS = TmpLHSI;
334 do {
335 TmpLHSI = cast<Instruction>(TmpLHS);
336 // Remove from current block...
337 TmpLHSI->getParent()->getInstList().remove(TmpLHSI);
338 // Insert before the last instruction...
339 BB->getInstList().insert(LastUse, TmpLHSI);
340 TmpLHS = TmpLHSI->getOperand(0);
341 } while (TmpLHSI != LHSI);
342 }
343
344 // Now all of the instructions are in the current basic block, go ahead
345 // and perform the reassociation.
346 Instruction *TmpLHSI = cast<Instruction>(Root.getOperand(0));
347
348 // First move the selected RHS to the LHS of the root...
349 Root.setOperand(0, LHSI->getOperand(1));
350
351 // Make what used to be the LHS of the root be the user of the root...
352 Value *ExtraOperand = TmpLHSI->getOperand(1);
353 Root.replaceAllUsesWith(TmpLHSI); // Users now use TmpLHSI
354 TmpLHSI->setOperand(1, &Root); // TmpLHSI now uses the root
355 BB->getInstList().remove(&Root); // Remove root from the BB
356 BB->getInstList().insert(TmpLHSI, &Root); // Insert root before TmpLHSI
357
358 // Now propagate the ExtraOperand down the chain of instructions until we
359 // get to LHSI.
360 while (TmpLHSI != LHSI) {
361 Instruction *NextLHSI = cast<Instruction>(TmpLHSI->getOperand(0));
362 Value *NextOp = NextLHSI->getOperand(1);
363 NextLHSI->setOperand(1, ExtraOperand);
364 TmpLHSI = NextLHSI;
365 ExtraOperand = NextOp;
366 }
367
368 // Now that the instructions are reassociated, have the functor perform
369 // the transformation...
370 return F.apply(Root);
371 }
372
373 LHSI = dyn_cast<Instruction>(LHSI->getOperand(0));
374 }
375 return 0;
376}
377
378
379// AddRHS - Implements: X + X --> X << 1
380struct AddRHS {
381 Value *RHS;
382 AddRHS(Value *rhs) : RHS(rhs) {}
383 bool shouldApply(Value *LHS) const { return LHS == RHS; }
384 Instruction *apply(BinaryOperator &Add) const {
385 return new ShiftInst(Instruction::Shl, Add.getOperand(0),
386 ConstantInt::get(Type::UByteTy, 1));
387 }
388};
389
390// AddMaskingAnd - Implements (A & C1)+(B & C2) --> (A & C1)|(B & C2)
391// iff C1&C2 == 0
392struct AddMaskingAnd {
393 Constant *C2;
394 AddMaskingAnd(Constant *c) : C2(c) {}
395 bool shouldApply(Value *LHS) const {
396 if (Constant *C1 = dyn_castMaskingAnd(LHS))
397 return ConstantExpr::get(Instruction::And, C1, C2)->isNullValue();
398 return false;
399 }
400 Instruction *apply(BinaryOperator &Add) const {
401 return BinaryOperator::create(Instruction::Or, Add.getOperand(0),
402 Add.getOperand(1));
403 }
404};
405
406
407
Chris Lattner113f4f42002-06-25 16:13:24 +0000408Instruction *InstCombiner::visitAdd(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000409 bool Changed = SimplifyCommutative(I);
Chris Lattner113f4f42002-06-25 16:13:24 +0000410 Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
Chris Lattner9fa53de2002-05-06 16:49:18 +0000411
Chris Lattnerb8b97502003-08-13 19:01:45 +0000412 // X + 0 --> X
Chris Lattnere6794492002-08-12 21:17:25 +0000413 if (RHS == Constant::getNullValue(I.getType()))
414 return ReplaceInstUsesWith(I, LHS);
Chris Lattner9fa53de2002-05-06 16:49:18 +0000415
Chris Lattnerb8b97502003-08-13 19:01:45 +0000416 // X + X --> X << 1
417 if (I.getType()->isInteger())
418 if (Instruction *Result = AssociativeOpt(I, AddRHS(RHS))) return Result;
Chris Lattnerede3fe02003-08-13 04:18:28 +0000419
Chris Lattner147e9752002-05-08 22:46:53 +0000420 // -A + B --> B - A
Chris Lattnerbb74e222003-03-10 23:06:50 +0000421 if (Value *V = dyn_castNegVal(LHS))
Chris Lattner147e9752002-05-08 22:46:53 +0000422 return BinaryOperator::create(Instruction::Sub, RHS, V);
Chris Lattner9fa53de2002-05-06 16:49:18 +0000423
424 // A + -B --> A - B
Chris Lattnerbb74e222003-03-10 23:06:50 +0000425 if (!isa<Constant>(RHS))
426 if (Value *V = dyn_castNegVal(RHS))
427 return BinaryOperator::create(Instruction::Sub, LHS, V);
Chris Lattner260ab202002-04-18 17:39:14 +0000428
Chris Lattner57c8d992003-02-18 19:57:07 +0000429 // X*C + X --> X * (C+1)
430 if (dyn_castFoldableMul(LHS) == RHS) {
Chris Lattner34428442003-05-27 16:40:51 +0000431 Constant *CP1 =
432 ConstantExpr::get(Instruction::Add,
433 cast<Constant>(cast<Instruction>(LHS)->getOperand(1)),
434 ConstantInt::get(I.getType(), 1));
Chris Lattner57c8d992003-02-18 19:57:07 +0000435 return BinaryOperator::create(Instruction::Mul, RHS, CP1);
436 }
437
438 // X + X*C --> X * (C+1)
439 if (dyn_castFoldableMul(RHS) == LHS) {
Chris Lattner34428442003-05-27 16:40:51 +0000440 Constant *CP1 =
441 ConstantExpr::get(Instruction::Add,
442 cast<Constant>(cast<Instruction>(RHS)->getOperand(1)),
443 ConstantInt::get(I.getType(), 1));
Chris Lattner57c8d992003-02-18 19:57:07 +0000444 return BinaryOperator::create(Instruction::Mul, LHS, CP1);
445 }
446
Chris Lattnerb8b97502003-08-13 19:01:45 +0000447 // (A & C1)+(B & C2) --> (A & C1)|(B & C2) iff C1&C2 == 0
448 if (Constant *C2 = dyn_castMaskingAnd(RHS))
449 if (Instruction *R = AssociativeOpt(I, AddMaskingAnd(C2))) return R;
Chris Lattner7fb29e12003-03-11 00:12:48 +0000450
Chris Lattnerb9cde762003-10-02 15:11:26 +0000451 if (ConstantInt *CRHS = dyn_cast<ConstantInt>(RHS)) {
452 if (Instruction *ILHS = dyn_cast<Instruction>(LHS)) {
453 switch (ILHS->getOpcode()) {
454 case Instruction::Xor:
455 // ~X + C --> (C-1) - X
456 if (ConstantInt *XorRHS = dyn_cast<ConstantInt>(ILHS->getOperand(1)))
457 if (XorRHS->isAllOnesValue())
458 return BinaryOperator::create(Instruction::Sub,
459 *CRHS - *ConstantInt::get(I.getType(), 1),
460 ILHS->getOperand(0));
461 break;
462 default: break;
463 }
464 }
465 }
466
Chris Lattner113f4f42002-06-25 16:13:24 +0000467 return Changed ? &I : 0;
Chris Lattner260ab202002-04-18 17:39:14 +0000468}
469
Chris Lattnerbdb0ce02003-07-22 21:46:59 +0000470// isSignBit - Return true if the value represented by the constant only has the
471// highest order bit set.
472static bool isSignBit(ConstantInt *CI) {
473 unsigned NumBits = CI->getType()->getPrimitiveSize()*8;
474 return (CI->getRawValue() & ~(-1LL << NumBits)) == (1ULL << (NumBits-1));
475}
476
Chris Lattnerdfae8be2003-07-24 17:35:25 +0000477static unsigned getTypeSizeInBits(const Type *Ty) {
478 return Ty == Type::BoolTy ? 1 : Ty->getPrimitiveSize()*8;
479}
480
Chris Lattner113f4f42002-06-25 16:13:24 +0000481Instruction *InstCombiner::visitSub(BinaryOperator &I) {
Chris Lattner113f4f42002-06-25 16:13:24 +0000482 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000483
Chris Lattnere6794492002-08-12 21:17:25 +0000484 if (Op0 == Op1) // sub X, X -> 0
485 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
Chris Lattner260ab202002-04-18 17:39:14 +0000486
Chris Lattnere6794492002-08-12 21:17:25 +0000487 // If this is a 'B = x-(-A)', change to B = x+A...
Chris Lattnerbb74e222003-03-10 23:06:50 +0000488 if (Value *V = dyn_castNegVal(Op1))
Chris Lattner147e9752002-05-08 22:46:53 +0000489 return BinaryOperator::create(Instruction::Add, Op0, V);
Chris Lattner9fa53de2002-05-06 16:49:18 +0000490
Chris Lattner8f2f5982003-11-05 01:06:05 +0000491 if (ConstantInt *C = dyn_cast<ConstantInt>(Op0)) {
492 // Replace (-1 - A) with (~A)...
Chris Lattner3082c5a2003-02-18 19:28:33 +0000493 if (C->isAllOnesValue())
494 return BinaryOperator::createNot(Op1);
Chris Lattnerad3c4952002-05-09 01:29:19 +0000495
Chris Lattner8f2f5982003-11-05 01:06:05 +0000496 // C - ~X == X + (1+C)
497 if (BinaryOperator::isNot(Op1))
498 return BinaryOperator::create(Instruction::Add,
499 BinaryOperator::getNotArgument(cast<BinaryOperator>(Op1)),
500 *C + *ConstantInt::get(I.getType(), 1));
501 }
502
Chris Lattner3082c5a2003-02-18 19:28:33 +0000503 if (BinaryOperator *Op1I = dyn_cast<BinaryOperator>(Op1))
Chris Lattnerf95d9b92003-10-15 16:48:29 +0000504 if (Op1I->hasOneUse()) {
Chris Lattner3082c5a2003-02-18 19:28:33 +0000505 // Replace (x - (y - z)) with (x + (z - y)) if the (y - z) subexpression
506 // is not used by anyone else...
507 //
508 if (Op1I->getOpcode() == Instruction::Sub) {
509 // Swap the two operands of the subexpr...
510 Value *IIOp0 = Op1I->getOperand(0), *IIOp1 = Op1I->getOperand(1);
511 Op1I->setOperand(0, IIOp1);
512 Op1I->setOperand(1, IIOp0);
513
514 // Create the new top level add instruction...
515 return BinaryOperator::create(Instruction::Add, Op0, Op1);
516 }
517
518 // Replace (A - (A & B)) with (A & ~B) if this is the only use of (A&B)...
519 //
520 if (Op1I->getOpcode() == Instruction::And &&
521 (Op1I->getOperand(0) == Op0 || Op1I->getOperand(1) == Op0)) {
522 Value *OtherOp = Op1I->getOperand(Op1I->getOperand(0) == Op0);
523
524 Instruction *NewNot = BinaryOperator::createNot(OtherOp, "B.not", &I);
525 return BinaryOperator::create(Instruction::And, Op0, NewNot);
526 }
Chris Lattner57c8d992003-02-18 19:57:07 +0000527
528 // X - X*C --> X * (1-C)
529 if (dyn_castFoldableMul(Op1I) == Op0) {
Chris Lattner34428442003-05-27 16:40:51 +0000530 Constant *CP1 =
531 ConstantExpr::get(Instruction::Sub,
532 ConstantInt::get(I.getType(), 1),
533 cast<Constant>(cast<Instruction>(Op1)->getOperand(1)));
Chris Lattner57c8d992003-02-18 19:57:07 +0000534 assert(CP1 && "Couldn't constant fold 1-C?");
535 return BinaryOperator::create(Instruction::Mul, Op0, CP1);
536 }
Chris Lattnerad3c4952002-05-09 01:29:19 +0000537 }
Chris Lattner3082c5a2003-02-18 19:28:33 +0000538
Chris Lattner57c8d992003-02-18 19:57:07 +0000539 // X*C - X --> X * (C-1)
540 if (dyn_castFoldableMul(Op0) == Op1) {
Chris Lattner34428442003-05-27 16:40:51 +0000541 Constant *CP1 =
542 ConstantExpr::get(Instruction::Sub,
543 cast<Constant>(cast<Instruction>(Op0)->getOperand(1)),
544 ConstantInt::get(I.getType(), 1));
Chris Lattner57c8d992003-02-18 19:57:07 +0000545 assert(CP1 && "Couldn't constant fold C - 1?");
546 return BinaryOperator::create(Instruction::Mul, Op1, CP1);
547 }
548
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000549 return 0;
Chris Lattner260ab202002-04-18 17:39:14 +0000550}
551
Chris Lattner113f4f42002-06-25 16:13:24 +0000552Instruction *InstCombiner::visitMul(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000553 bool Changed = SimplifyCommutative(I);
Chris Lattner3082c5a2003-02-18 19:28:33 +0000554 Value *Op0 = I.getOperand(0);
Chris Lattner260ab202002-04-18 17:39:14 +0000555
Chris Lattnere6794492002-08-12 21:17:25 +0000556 // Simplify mul instructions with a constant RHS...
Chris Lattner3082c5a2003-02-18 19:28:33 +0000557 if (Constant *Op1 = dyn_cast<Constant>(I.getOperand(1))) {
558 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Chris Lattnerede3fe02003-08-13 04:18:28 +0000559
560 // ((X << C1)*C2) == (X * (C2 << C1))
561 if (ShiftInst *SI = dyn_cast<ShiftInst>(Op0))
562 if (SI->getOpcode() == Instruction::Shl)
563 if (Constant *ShOp = dyn_cast<Constant>(SI->getOperand(1)))
564 return BinaryOperator::create(Instruction::Mul, SI->getOperand(0),
565 *CI << *ShOp);
566
Chris Lattnercce81be2003-09-11 22:24:54 +0000567 if (CI->isNullValue())
568 return ReplaceInstUsesWith(I, Op1); // X * 0 == 0
569 if (CI->equalsInt(1)) // X * 1 == X
570 return ReplaceInstUsesWith(I, Op0);
571 if (CI->isAllOnesValue()) // X * -1 == 0 - X
Chris Lattner35236d82003-06-25 17:09:20 +0000572 return BinaryOperator::createNeg(Op0, I.getName());
Chris Lattner31ba1292002-04-29 22:24:47 +0000573
Chris Lattnercce81be2003-09-11 22:24:54 +0000574 int64_t Val = (int64_t)cast<ConstantInt>(CI)->getRawValue();
Chris Lattner3082c5a2003-02-18 19:28:33 +0000575 if (uint64_t C = Log2(Val)) // Replace X*(2^C) with X << C
576 return new ShiftInst(Instruction::Shl, Op0,
577 ConstantUInt::get(Type::UByteTy, C));
578 } else {
579 ConstantFP *Op1F = cast<ConstantFP>(Op1);
580 if (Op1F->isNullValue())
581 return ReplaceInstUsesWith(I, Op1);
Chris Lattner31ba1292002-04-29 22:24:47 +0000582
Chris Lattner3082c5a2003-02-18 19:28:33 +0000583 // "In IEEE floating point, x*1 is not equivalent to x for nans. However,
584 // ANSI says we can drop signals, so we can do this anyway." (from GCC)
585 if (Op1F->getValue() == 1.0)
586 return ReplaceInstUsesWith(I, Op0); // Eliminate 'mul double %X, 1.0'
587 }
Chris Lattner260ab202002-04-18 17:39:14 +0000588 }
589
Chris Lattner934a64cf2003-03-10 23:23:04 +0000590 if (Value *Op0v = dyn_castNegVal(Op0)) // -X * -Y = X*Y
591 if (Value *Op1v = dyn_castNegVal(I.getOperand(1)))
592 return BinaryOperator::create(Instruction::Mul, Op0v, Op1v);
593
Chris Lattner113f4f42002-06-25 16:13:24 +0000594 return Changed ? &I : 0;
Chris Lattner260ab202002-04-18 17:39:14 +0000595}
596
Chris Lattner113f4f42002-06-25 16:13:24 +0000597Instruction *InstCombiner::visitDiv(BinaryOperator &I) {
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000598 // div X, 1 == X
Chris Lattner3082c5a2003-02-18 19:28:33 +0000599 if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1))) {
Chris Lattnere6794492002-08-12 21:17:25 +0000600 if (RHS->equalsInt(1))
601 return ReplaceInstUsesWith(I, I.getOperand(0));
Chris Lattner3082c5a2003-02-18 19:28:33 +0000602
603 // Check to see if this is an unsigned division with an exact power of 2,
604 // if so, convert to a right shift.
605 if (ConstantUInt *C = dyn_cast<ConstantUInt>(RHS))
606 if (uint64_t Val = C->getValue()) // Don't break X / 0
607 if (uint64_t C = Log2(Val))
608 return new ShiftInst(Instruction::Shr, I.getOperand(0),
609 ConstantUInt::get(Type::UByteTy, C));
610 }
611
612 // 0 / X == 0, we don't need to preserve faults!
613 if (ConstantInt *LHS = dyn_cast<ConstantInt>(I.getOperand(0)))
614 if (LHS->equalsInt(0))
615 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
616
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000617 return 0;
618}
619
620
Chris Lattner113f4f42002-06-25 16:13:24 +0000621Instruction *InstCombiner::visitRem(BinaryOperator &I) {
Chris Lattner3082c5a2003-02-18 19:28:33 +0000622 if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1))) {
623 if (RHS->equalsInt(1)) // X % 1 == 0
624 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
625
626 // Check to see if this is an unsigned remainder with an exact power of 2,
627 // if so, convert to a bitwise and.
628 if (ConstantUInt *C = dyn_cast<ConstantUInt>(RHS))
629 if (uint64_t Val = C->getValue()) // Don't break X % 0 (divide by zero)
630 if (Log2(Val))
631 return BinaryOperator::create(Instruction::And, I.getOperand(0),
632 ConstantUInt::get(I.getType(), Val-1));
633 }
634
635 // 0 % X == 0, we don't need to preserve faults!
636 if (ConstantInt *LHS = dyn_cast<ConstantInt>(I.getOperand(0)))
637 if (LHS->equalsInt(0))
Chris Lattnere6794492002-08-12 21:17:25 +0000638 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
639
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000640 return 0;
641}
642
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000643// isMaxValueMinusOne - return true if this is Max-1
Chris Lattnere6794492002-08-12 21:17:25 +0000644static bool isMaxValueMinusOne(const ConstantInt *C) {
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000645 if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(C)) {
646 // Calculate -1 casted to the right type...
647 unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
648 uint64_t Val = ~0ULL; // All ones
649 Val >>= 64-TypeBits; // Shift out unwanted 1 bits...
650 return CU->getValue() == Val-1;
651 }
652
653 const ConstantSInt *CS = cast<ConstantSInt>(C);
654
655 // Calculate 0111111111..11111
656 unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
657 int64_t Val = INT64_MAX; // All ones
658 Val >>= 64-TypeBits; // Shift out unwanted 1 bits...
659 return CS->getValue() == Val-1;
660}
661
662// isMinValuePlusOne - return true if this is Min+1
Chris Lattnere6794492002-08-12 21:17:25 +0000663static bool isMinValuePlusOne(const ConstantInt *C) {
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000664 if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(C))
665 return CU->getValue() == 1;
666
667 const ConstantSInt *CS = cast<ConstantSInt>(C);
668
669 // Calculate 1111111111000000000000
670 unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
671 int64_t Val = -1; // All ones
672 Val <<= TypeBits-1; // Shift over to the right spot
673 return CS->getValue() == Val+1;
674}
675
Chris Lattner3ac7c262003-08-13 20:16:26 +0000676/// getSetCondCode - Encode a setcc opcode into a three bit mask. These bits
677/// are carefully arranged to allow folding of expressions such as:
678///
679/// (A < B) | (A > B) --> (A != B)
680///
681/// Bit value '4' represents that the comparison is true if A > B, bit value '2'
682/// represents that the comparison is true if A == B, and bit value '1' is true
683/// if A < B.
684///
685static unsigned getSetCondCode(const SetCondInst *SCI) {
686 switch (SCI->getOpcode()) {
687 // False -> 0
688 case Instruction::SetGT: return 1;
689 case Instruction::SetEQ: return 2;
690 case Instruction::SetGE: return 3;
691 case Instruction::SetLT: return 4;
692 case Instruction::SetNE: return 5;
693 case Instruction::SetLE: return 6;
694 // True -> 7
695 default:
696 assert(0 && "Invalid SetCC opcode!");
697 return 0;
698 }
699}
700
701/// getSetCCValue - This is the complement of getSetCondCode, which turns an
702/// opcode and two operands into either a constant true or false, or a brand new
703/// SetCC instruction.
704static Value *getSetCCValue(unsigned Opcode, Value *LHS, Value *RHS) {
705 switch (Opcode) {
706 case 0: return ConstantBool::False;
707 case 1: return new SetCondInst(Instruction::SetGT, LHS, RHS);
708 case 2: return new SetCondInst(Instruction::SetEQ, LHS, RHS);
709 case 3: return new SetCondInst(Instruction::SetGE, LHS, RHS);
710 case 4: return new SetCondInst(Instruction::SetLT, LHS, RHS);
711 case 5: return new SetCondInst(Instruction::SetNE, LHS, RHS);
712 case 6: return new SetCondInst(Instruction::SetLE, LHS, RHS);
713 case 7: return ConstantBool::True;
714 default: assert(0 && "Illegal SetCCCode!"); return 0;
715 }
716}
717
718// FoldSetCCLogical - Implements (setcc1 A, B) & (setcc2 A, B) --> (setcc3 A, B)
719struct FoldSetCCLogical {
720 InstCombiner &IC;
721 Value *LHS, *RHS;
722 FoldSetCCLogical(InstCombiner &ic, SetCondInst *SCI)
723 : IC(ic), LHS(SCI->getOperand(0)), RHS(SCI->getOperand(1)) {}
724 bool shouldApply(Value *V) const {
725 if (SetCondInst *SCI = dyn_cast<SetCondInst>(V))
726 return (SCI->getOperand(0) == LHS && SCI->getOperand(1) == RHS ||
727 SCI->getOperand(0) == RHS && SCI->getOperand(1) == LHS);
728 return false;
729 }
730 Instruction *apply(BinaryOperator &Log) const {
731 SetCondInst *SCI = cast<SetCondInst>(Log.getOperand(0));
732 if (SCI->getOperand(0) != LHS) {
733 assert(SCI->getOperand(1) == LHS);
734 SCI->swapOperands(); // Swap the LHS and RHS of the SetCC
735 }
736
737 unsigned LHSCode = getSetCondCode(SCI);
738 unsigned RHSCode = getSetCondCode(cast<SetCondInst>(Log.getOperand(1)));
739 unsigned Code;
740 switch (Log.getOpcode()) {
741 case Instruction::And: Code = LHSCode & RHSCode; break;
742 case Instruction::Or: Code = LHSCode | RHSCode; break;
743 case Instruction::Xor: Code = LHSCode ^ RHSCode; break;
Chris Lattner2caaaba2003-09-22 20:33:34 +0000744 default: assert(0 && "Illegal logical opcode!"); return 0;
Chris Lattner3ac7c262003-08-13 20:16:26 +0000745 }
746
747 Value *RV = getSetCCValue(Code, LHS, RHS);
748 if (Instruction *I = dyn_cast<Instruction>(RV))
749 return I;
750 // Otherwise, it's a constant boolean value...
751 return IC.ReplaceInstUsesWith(Log, RV);
752 }
753};
754
755
Chris Lattnerba1cb382003-09-19 17:17:26 +0000756// OptAndOp - This handles expressions of the form ((val OP C1) & C2). Where
757// the Op parameter is 'OP', OpRHS is 'C1', and AndRHS is 'C2'. Op is
758// guaranteed to be either a shift instruction or a binary operator.
759Instruction *InstCombiner::OptAndOp(Instruction *Op,
760 ConstantIntegral *OpRHS,
761 ConstantIntegral *AndRHS,
762 BinaryOperator &TheAnd) {
763 Value *X = Op->getOperand(0);
764 switch (Op->getOpcode()) {
765 case Instruction::Xor:
766 if ((*AndRHS & *OpRHS)->isNullValue()) {
767 // (X ^ C1) & C2 --> (X & C2) iff (C1&C2) == 0
768 return BinaryOperator::create(Instruction::And, X, AndRHS);
Chris Lattnerf95d9b92003-10-15 16:48:29 +0000769 } else if (Op->hasOneUse()) {
Chris Lattnerba1cb382003-09-19 17:17:26 +0000770 // (X ^ C1) & C2 --> (X & C2) ^ (C1&C2)
771 std::string OpName = Op->getName(); Op->setName("");
772 Instruction *And = BinaryOperator::create(Instruction::And,
773 X, AndRHS, OpName);
774 InsertNewInstBefore(And, TheAnd);
775 return BinaryOperator::create(Instruction::Xor, And, *AndRHS & *OpRHS);
776 }
777 break;
778 case Instruction::Or:
779 // (X | C1) & C2 --> X & C2 iff C1 & C1 == 0
780 if ((*AndRHS & *OpRHS)->isNullValue())
781 return BinaryOperator::create(Instruction::And, X, AndRHS);
782 else {
783 Constant *Together = *AndRHS & *OpRHS;
784 if (Together == AndRHS) // (X | C) & C --> C
785 return ReplaceInstUsesWith(TheAnd, AndRHS);
786
Chris Lattnerf95d9b92003-10-15 16:48:29 +0000787 if (Op->hasOneUse() && Together != OpRHS) {
Chris Lattnerba1cb382003-09-19 17:17:26 +0000788 // (X | C1) & C2 --> (X | (C1&C2)) & C2
789 std::string Op0Name = Op->getName(); Op->setName("");
790 Instruction *Or = BinaryOperator::create(Instruction::Or, X,
791 Together, Op0Name);
792 InsertNewInstBefore(Or, TheAnd);
793 return BinaryOperator::create(Instruction::And, Or, AndRHS);
794 }
795 }
796 break;
797 case Instruction::Add:
Chris Lattnerf95d9b92003-10-15 16:48:29 +0000798 if (Op->hasOneUse()) {
Chris Lattnerba1cb382003-09-19 17:17:26 +0000799 // Adding a one to a single bit bit-field should be turned into an XOR
800 // of the bit. First thing to check is to see if this AND is with a
801 // single bit constant.
802 unsigned long long AndRHSV = cast<ConstantInt>(AndRHS)->getRawValue();
803
804 // Clear bits that are not part of the constant.
805 AndRHSV &= (1ULL << AndRHS->getType()->getPrimitiveSize()*8)-1;
806
807 // If there is only one bit set...
808 if ((AndRHSV & (AndRHSV-1)) == 0) {
809 // Ok, at this point, we know that we are masking the result of the
810 // ADD down to exactly one bit. If the constant we are adding has
811 // no bits set below this bit, then we can eliminate the ADD.
812 unsigned long long AddRHS = cast<ConstantInt>(OpRHS)->getRawValue();
813
814 // Check to see if any bits below the one bit set in AndRHSV are set.
815 if ((AddRHS & (AndRHSV-1)) == 0) {
816 // If not, the only thing that can effect the output of the AND is
817 // the bit specified by AndRHSV. If that bit is set, the effect of
818 // the XOR is to toggle the bit. If it is clear, then the ADD has
819 // no effect.
820 if ((AddRHS & AndRHSV) == 0) { // Bit is not set, noop
821 TheAnd.setOperand(0, X);
822 return &TheAnd;
823 } else {
824 std::string Name = Op->getName(); Op->setName("");
825 // Pull the XOR out of the AND.
826 Instruction *NewAnd =
827 BinaryOperator::create(Instruction::And, X, AndRHS, Name);
828 InsertNewInstBefore(NewAnd, TheAnd);
829 return BinaryOperator::create(Instruction::Xor, NewAnd, AndRHS);
830 }
831 }
832 }
833 }
834 break;
Chris Lattner2da29172003-09-19 19:05:02 +0000835
836 case Instruction::Shl: {
837 // We know that the AND will not produce any of the bits shifted in, so if
838 // the anded constant includes them, clear them now!
839 //
840 Constant *AllOne = ConstantIntegral::getAllOnesValue(AndRHS->getType());
841 Constant *CI = *AndRHS & *(*AllOne << *OpRHS);
842 if (CI != AndRHS) {
843 TheAnd.setOperand(1, CI);
844 return &TheAnd;
845 }
846 break;
847 }
848 case Instruction::Shr:
849 // We know that the AND will not produce any of the bits shifted in, so if
850 // the anded constant includes them, clear them now! This only applies to
851 // unsigned shifts, because a signed shr may bring in set bits!
852 //
853 if (AndRHS->getType()->isUnsigned()) {
854 Constant *AllOne = ConstantIntegral::getAllOnesValue(AndRHS->getType());
855 Constant *CI = *AndRHS & *(*AllOne >> *OpRHS);
856 if (CI != AndRHS) {
857 TheAnd.setOperand(1, CI);
858 return &TheAnd;
859 }
860 }
861 break;
Chris Lattnerba1cb382003-09-19 17:17:26 +0000862 }
863 return 0;
864}
865
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000866
Chris Lattner113f4f42002-06-25 16:13:24 +0000867Instruction *InstCombiner::visitAnd(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000868 bool Changed = SimplifyCommutative(I);
Chris Lattner113f4f42002-06-25 16:13:24 +0000869 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000870
871 // and X, X = X and X, 0 == 0
Chris Lattnere6794492002-08-12 21:17:25 +0000872 if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType()))
873 return ReplaceInstUsesWith(I, Op1);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000874
875 // and X, -1 == X
Chris Lattner49b47ae2003-07-23 17:57:01 +0000876 if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1)) {
Chris Lattnere6794492002-08-12 21:17:25 +0000877 if (RHS->isAllOnesValue())
878 return ReplaceInstUsesWith(I, Op0);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000879
Chris Lattnerba1cb382003-09-19 17:17:26 +0000880 // Optimize a variety of ((val OP C1) & C2) combinations...
881 if (isa<BinaryOperator>(Op0) || isa<ShiftInst>(Op0)) {
882 Instruction *Op0I = cast<Instruction>(Op0);
Chris Lattner33217db2003-07-23 19:36:21 +0000883 Value *X = Op0I->getOperand(0);
Chris Lattner16464b32003-07-23 19:25:52 +0000884 if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1)))
Chris Lattnerba1cb382003-09-19 17:17:26 +0000885 if (Instruction *Res = OptAndOp(Op0I, Op0CI, RHS, I))
886 return Res;
Chris Lattner33217db2003-07-23 19:36:21 +0000887 }
Chris Lattner49b47ae2003-07-23 17:57:01 +0000888 }
889
Chris Lattnerbb74e222003-03-10 23:06:50 +0000890 Value *Op0NotVal = dyn_castNotVal(Op0);
891 Value *Op1NotVal = dyn_castNotVal(Op1);
Chris Lattner3082c5a2003-02-18 19:28:33 +0000892
893 // (~A & ~B) == (~(A | B)) - Demorgan's Law
Chris Lattnerbb74e222003-03-10 23:06:50 +0000894 if (Op0NotVal && Op1NotVal && isOnlyUse(Op0) && isOnlyUse(Op1)) {
Chris Lattner3082c5a2003-02-18 19:28:33 +0000895 Instruction *Or = BinaryOperator::create(Instruction::Or, Op0NotVal,
Chris Lattner49b47ae2003-07-23 17:57:01 +0000896 Op1NotVal,I.getName()+".demorgan");
897 InsertNewInstBefore(Or, I);
Chris Lattner3082c5a2003-02-18 19:28:33 +0000898 return BinaryOperator::createNot(Or);
899 }
900
901 if (Op0NotVal == Op1 || Op1NotVal == Op0) // A & ~A == ~A & A == 0
902 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
Chris Lattner65217ff2002-08-23 18:32:43 +0000903
Chris Lattner3ac7c262003-08-13 20:16:26 +0000904 // (setcc1 A, B) & (setcc2 A, B) --> (setcc3 A, B)
905 if (SetCondInst *RHS = dyn_cast<SetCondInst>(I.getOperand(1)))
906 if (Instruction *R = AssociativeOpt(I, FoldSetCCLogical(*this, RHS)))
907 return R;
908
Chris Lattner113f4f42002-06-25 16:13:24 +0000909 return Changed ? &I : 0;
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000910}
911
912
913
Chris Lattner113f4f42002-06-25 16:13:24 +0000914Instruction *InstCombiner::visitOr(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000915 bool Changed = SimplifyCommutative(I);
Chris Lattner113f4f42002-06-25 16:13:24 +0000916 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000917
918 // or X, X = X or X, 0 == X
Chris Lattnere6794492002-08-12 21:17:25 +0000919 if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType()))
920 return ReplaceInstUsesWith(I, Op0);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000921
922 // or X, -1 == -1
Chris Lattner8f0d1562003-07-23 18:29:44 +0000923 if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1)) {
Chris Lattnere6794492002-08-12 21:17:25 +0000924 if (RHS->isAllOnesValue())
925 return ReplaceInstUsesWith(I, Op1);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000926
Chris Lattner8f0d1562003-07-23 18:29:44 +0000927 if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) {
928 // (X & C1) | C2 --> (X | C2) & (C1|C2)
929 if (Op0I->getOpcode() == Instruction::And && isOnlyUse(Op0))
930 if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1))) {
931 std::string Op0Name = Op0I->getName(); Op0I->setName("");
932 Instruction *Or = BinaryOperator::create(Instruction::Or,
933 Op0I->getOperand(0), RHS,
934 Op0Name);
935 InsertNewInstBefore(Or, I);
936 return BinaryOperator::create(Instruction::And, Or, *RHS | *Op0CI);
937 }
938
939 // (X ^ C1) | C2 --> (X | C2) ^ (C1&~C2)
940 if (Op0I->getOpcode() == Instruction::Xor && isOnlyUse(Op0))
941 if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1))) {
942 std::string Op0Name = Op0I->getName(); Op0I->setName("");
943 Instruction *Or = BinaryOperator::create(Instruction::Or,
944 Op0I->getOperand(0), RHS,
945 Op0Name);
946 InsertNewInstBefore(Or, I);
947 return BinaryOperator::create(Instruction::Xor, Or, *Op0CI & *~*RHS);
948 }
949 }
950 }
951
Chris Lattner812aab72003-08-12 19:11:07 +0000952 // (A & C1)|(A & C2) == A & (C1|C2)
Chris Lattner01d56392003-08-12 19:17:27 +0000953 if (Instruction *LHS = dyn_cast<BinaryOperator>(Op0))
954 if (Instruction *RHS = dyn_cast<BinaryOperator>(Op1))
955 if (LHS->getOperand(0) == RHS->getOperand(0))
956 if (Constant *C0 = dyn_castMaskingAnd(LHS))
957 if (Constant *C1 = dyn_castMaskingAnd(RHS))
958 return BinaryOperator::create(Instruction::And, LHS->getOperand(0),
Chris Lattner812aab72003-08-12 19:11:07 +0000959 *C0 | *C1);
960
Chris Lattner3e327a42003-03-10 23:13:59 +0000961 Value *Op0NotVal = dyn_castNotVal(Op0);
962 Value *Op1NotVal = dyn_castNotVal(Op1);
Chris Lattner3082c5a2003-02-18 19:28:33 +0000963
Chris Lattner3e327a42003-03-10 23:13:59 +0000964 if (Op1 == Op0NotVal) // ~A | A == -1
965 return ReplaceInstUsesWith(I,
966 ConstantIntegral::getAllOnesValue(I.getType()));
967
968 if (Op0 == Op1NotVal) // A | ~A == -1
969 return ReplaceInstUsesWith(I,
970 ConstantIntegral::getAllOnesValue(I.getType()));
971
972 // (~A | ~B) == (~(A & B)) - Demorgan's Law
973 if (Op0NotVal && Op1NotVal && isOnlyUse(Op0) && isOnlyUse(Op1)) {
974 Instruction *And = BinaryOperator::create(Instruction::And, Op0NotVal,
975 Op1NotVal,I.getName()+".demorgan",
976 &I);
977 WorkList.push_back(And);
978 return BinaryOperator::createNot(And);
979 }
Chris Lattner3082c5a2003-02-18 19:28:33 +0000980
Chris Lattner3ac7c262003-08-13 20:16:26 +0000981 // (setcc1 A, B) | (setcc2 A, B) --> (setcc3 A, B)
982 if (SetCondInst *RHS = dyn_cast<SetCondInst>(I.getOperand(1)))
983 if (Instruction *R = AssociativeOpt(I, FoldSetCCLogical(*this, RHS)))
984 return R;
985
Chris Lattner113f4f42002-06-25 16:13:24 +0000986 return Changed ? &I : 0;
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000987}
988
989
990
Chris Lattner113f4f42002-06-25 16:13:24 +0000991Instruction *InstCombiner::visitXor(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000992 bool Changed = SimplifyCommutative(I);
Chris Lattner113f4f42002-06-25 16:13:24 +0000993 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000994
995 // xor X, X = 0
Chris Lattnere6794492002-08-12 21:17:25 +0000996 if (Op0 == Op1)
997 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000998
Chris Lattner97638592003-07-23 21:37:07 +0000999 if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1)) {
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001000 // xor X, 0 == X
Chris Lattner97638592003-07-23 21:37:07 +00001001 if (RHS->isNullValue())
Chris Lattnere6794492002-08-12 21:17:25 +00001002 return ReplaceInstUsesWith(I, Op0);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001003
Chris Lattner97638592003-07-23 21:37:07 +00001004 if (BinaryOperator *Op0I = dyn_cast<BinaryOperator>(Op0)) {
Chris Lattnerb8d6e402002-08-20 18:24:26 +00001005 // xor (setcc A, B), true = not (setcc A, B) = setncc A, B
Chris Lattner97638592003-07-23 21:37:07 +00001006 if (SetCondInst *SCI = dyn_cast<SetCondInst>(Op0I))
Chris Lattnerf95d9b92003-10-15 16:48:29 +00001007 if (RHS == ConstantBool::True && SCI->hasOneUse())
Chris Lattnerb8d6e402002-08-20 18:24:26 +00001008 return new SetCondInst(SCI->getInverseCondition(),
1009 SCI->getOperand(0), SCI->getOperand(1));
Chris Lattnere5806662003-11-04 23:50:51 +00001010
Chris Lattner8f2f5982003-11-05 01:06:05 +00001011 // ~(c-X) == X-c-1 == X+(-c-1)
Chris Lattnere5806662003-11-04 23:50:51 +00001012 if (Op0I->getOpcode() == Instruction::Sub && RHS->isAllOnesValue() &&
1013 isa<Constant>(Op0I->getOperand(0))) {
Chris Lattner8f2f5982003-11-05 01:06:05 +00001014 Constant *ConstantRHS = *-*cast<Constant>(Op0I->getOperand(0)) -
Chris Lattnere5806662003-11-04 23:50:51 +00001015 *ConstantInt::get(I.getType(), 1);
1016 return BinaryOperator::create(Instruction::Add, Op0I->getOperand(1),
1017 ConstantRHS);
1018 }
Chris Lattner97638592003-07-23 21:37:07 +00001019
1020 if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1)))
Chris Lattnere5806662003-11-04 23:50:51 +00001021 switch (Op0I->getOpcode()) {
1022 case Instruction::Add:
Chris Lattner0f68fa62003-11-04 23:37:10 +00001023 // ~(X-c) --> (-c-1)-X
1024 if (RHS->isAllOnesValue())
1025 return BinaryOperator::create(Instruction::Sub,
1026 *-*Op0CI -
1027 *ConstantInt::get(I.getType(), 1),
1028 Op0I->getOperand(0));
Chris Lattnere5806662003-11-04 23:50:51 +00001029 break;
1030 case Instruction::And:
Chris Lattner97638592003-07-23 21:37:07 +00001031 // (X & C1) ^ C2 --> (X & C1) | C2 iff (C1&C2) == 0
1032 if ((*RHS & *Op0CI)->isNullValue())
1033 return BinaryOperator::create(Instruction::Or, Op0, RHS);
Chris Lattnere5806662003-11-04 23:50:51 +00001034 break;
1035 case Instruction::Or:
Chris Lattner97638592003-07-23 21:37:07 +00001036 // (X | C1) ^ C2 --> (X | C1) & ~C2 iff (C1&C2) == C2
1037 if ((*RHS & *Op0CI) == RHS)
1038 return BinaryOperator::create(Instruction::And, Op0, ~*RHS);
Chris Lattnere5806662003-11-04 23:50:51 +00001039 break;
1040 default: break;
Chris Lattner97638592003-07-23 21:37:07 +00001041 }
Chris Lattnerb8d6e402002-08-20 18:24:26 +00001042 }
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001043 }
1044
Chris Lattnerbb74e222003-03-10 23:06:50 +00001045 if (Value *X = dyn_castNotVal(Op0)) // ~A ^ A == -1
Chris Lattner3082c5a2003-02-18 19:28:33 +00001046 if (X == Op1)
1047 return ReplaceInstUsesWith(I,
1048 ConstantIntegral::getAllOnesValue(I.getType()));
1049
Chris Lattnerbb74e222003-03-10 23:06:50 +00001050 if (Value *X = dyn_castNotVal(Op1)) // A ^ ~A == -1
Chris Lattner3082c5a2003-02-18 19:28:33 +00001051 if (X == Op0)
1052 return ReplaceInstUsesWith(I,
1053 ConstantIntegral::getAllOnesValue(I.getType()));
1054
Chris Lattner1bbb7b62003-03-10 18:24:17 +00001055 if (Instruction *Op1I = dyn_cast<Instruction>(Op1))
1056 if (Op1I->getOpcode() == Instruction::Or)
1057 if (Op1I->getOperand(0) == Op0) { // B^(B|A) == (A|B)^B
1058 cast<BinaryOperator>(Op1I)->swapOperands();
1059 I.swapOperands();
1060 std::swap(Op0, Op1);
1061 } else if (Op1I->getOperand(1) == Op0) { // B^(A|B) == (A|B)^B
1062 I.swapOperands();
1063 std::swap(Op0, Op1);
1064 }
1065
1066 if (Instruction *Op0I = dyn_cast<Instruction>(Op0))
Chris Lattnerf95d9b92003-10-15 16:48:29 +00001067 if (Op0I->getOpcode() == Instruction::Or && Op0I->hasOneUse()) {
Chris Lattner1bbb7b62003-03-10 18:24:17 +00001068 if (Op0I->getOperand(0) == Op1) // (B|A)^B == (A|B)^B
1069 cast<BinaryOperator>(Op0I)->swapOperands();
Chris Lattnerdcf240a2003-03-10 21:43:22 +00001070 if (Op0I->getOperand(1) == Op1) { // (A|B)^B == A & ~B
Chris Lattner1bbb7b62003-03-10 18:24:17 +00001071 Value *NotB = BinaryOperator::createNot(Op1, Op1->getName()+".not", &I);
1072 WorkList.push_back(cast<Instruction>(NotB));
Chris Lattnerdcf240a2003-03-10 21:43:22 +00001073 return BinaryOperator::create(Instruction::And, Op0I->getOperand(0),
1074 NotB);
Chris Lattner1bbb7b62003-03-10 18:24:17 +00001075 }
1076 }
1077
Chris Lattner7fb29e12003-03-11 00:12:48 +00001078 // (A & C1)^(B & C2) -> (A & C1)|(B & C2) iff C1^C2 == 0
1079 if (Constant *C1 = dyn_castMaskingAnd(Op0))
1080 if (Constant *C2 = dyn_castMaskingAnd(Op1))
Chris Lattner34428442003-05-27 16:40:51 +00001081 if (ConstantExpr::get(Instruction::And, C1, C2)->isNullValue())
Chris Lattner7fb29e12003-03-11 00:12:48 +00001082 return BinaryOperator::create(Instruction::Or, Op0, Op1);
1083
Chris Lattner3ac7c262003-08-13 20:16:26 +00001084 // (setcc1 A, B) ^ (setcc2 A, B) --> (setcc3 A, B)
1085 if (SetCondInst *RHS = dyn_cast<SetCondInst>(I.getOperand(1)))
1086 if (Instruction *R = AssociativeOpt(I, FoldSetCCLogical(*this, RHS)))
1087 return R;
1088
Chris Lattner113f4f42002-06-25 16:13:24 +00001089 return Changed ? &I : 0;
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001090}
1091
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001092// AddOne, SubOne - Add or subtract a constant one from an integer constant...
1093static Constant *AddOne(ConstantInt *C) {
Chris Lattner34428442003-05-27 16:40:51 +00001094 Constant *Result = ConstantExpr::get(Instruction::Add, C,
1095 ConstantInt::get(C->getType(), 1));
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001096 assert(Result && "Constant folding integer addition failed!");
1097 return Result;
1098}
1099static Constant *SubOne(ConstantInt *C) {
Chris Lattner34428442003-05-27 16:40:51 +00001100 Constant *Result = ConstantExpr::get(Instruction::Sub, C,
1101 ConstantInt::get(C->getType(), 1));
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001102 assert(Result && "Constant folding integer addition failed!");
1103 return Result;
1104}
1105
Chris Lattner1fc23f32002-05-09 20:11:54 +00001106// isTrueWhenEqual - Return true if the specified setcondinst instruction is
1107// true when both operands are equal...
1108//
Chris Lattner113f4f42002-06-25 16:13:24 +00001109static bool isTrueWhenEqual(Instruction &I) {
1110 return I.getOpcode() == Instruction::SetEQ ||
1111 I.getOpcode() == Instruction::SetGE ||
1112 I.getOpcode() == Instruction::SetLE;
Chris Lattner1fc23f32002-05-09 20:11:54 +00001113}
1114
Chris Lattner113f4f42002-06-25 16:13:24 +00001115Instruction *InstCombiner::visitSetCondInst(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +00001116 bool Changed = SimplifyCommutative(I);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001117 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1118 const Type *Ty = Op0->getType();
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001119
1120 // setcc X, X
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001121 if (Op0 == Op1)
1122 return ReplaceInstUsesWith(I, ConstantBool::get(isTrueWhenEqual(I)));
Chris Lattner1fc23f32002-05-09 20:11:54 +00001123
Chris Lattnerd07283a2003-08-13 05:38:46 +00001124 // setcc <global/alloca*>, 0 - Global/Stack value addresses are never null!
1125 if (isa<ConstantPointerNull>(Op1) &&
1126 (isa<GlobalValue>(Op0) || isa<AllocaInst>(Op0)))
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001127 return ReplaceInstUsesWith(I, ConstantBool::get(!isTrueWhenEqual(I)));
1128
Chris Lattnerd07283a2003-08-13 05:38:46 +00001129
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001130 // setcc's with boolean values can always be turned into bitwise operations
1131 if (Ty == Type::BoolTy) {
1132 // If this is <, >, or !=, we can change this into a simple xor instruction
1133 if (!isTrueWhenEqual(I))
Chris Lattner16930792003-11-03 04:25:02 +00001134 return BinaryOperator::create(Instruction::Xor, Op0, Op1);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001135
1136 // Otherwise we need to make a temporary intermediate instruction and insert
1137 // it into the instruction stream. This is what we are after:
1138 //
1139 // seteq bool %A, %B -> ~(A^B)
1140 // setle bool %A, %B -> ~A | B
1141 // setge bool %A, %B -> A | ~B
1142 //
1143 if (I.getOpcode() == Instruction::SetEQ) { // seteq case
1144 Instruction *Xor = BinaryOperator::create(Instruction::Xor, Op0, Op1,
1145 I.getName()+"tmp");
1146 InsertNewInstBefore(Xor, I);
Chris Lattner16930792003-11-03 04:25:02 +00001147 return BinaryOperator::createNot(Xor);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001148 }
1149
1150 // Handle the setXe cases...
1151 assert(I.getOpcode() == Instruction::SetGE ||
1152 I.getOpcode() == Instruction::SetLE);
1153
1154 if (I.getOpcode() == Instruction::SetGE)
1155 std::swap(Op0, Op1); // Change setge -> setle
1156
1157 // Now we just have the SetLE case.
Chris Lattner31ae8632002-08-14 17:51:49 +00001158 Instruction *Not = BinaryOperator::createNot(Op0, I.getName()+"tmp");
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001159 InsertNewInstBefore(Not, I);
Chris Lattner16930792003-11-03 04:25:02 +00001160 return BinaryOperator::create(Instruction::Or, Not, Op1);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001161 }
1162
1163 // Check to see if we are doing one of many comparisons against constant
1164 // integers at the end of their ranges...
1165 //
1166 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Chris Lattnerd492a0b2003-07-23 17:02:11 +00001167 // Simplify seteq and setne instructions...
1168 if (I.getOpcode() == Instruction::SetEQ ||
1169 I.getOpcode() == Instruction::SetNE) {
1170 bool isSetNE = I.getOpcode() == Instruction::SetNE;
1171
Chris Lattnercfbce7c2003-07-23 17:26:36 +00001172 // If the first operand is (and|or|xor) with a constant, and the second
Chris Lattnerd492a0b2003-07-23 17:02:11 +00001173 // operand is a constant, simplify a bit.
Chris Lattnerc992add2003-08-13 05:33:12 +00001174 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Op0)) {
1175 switch (BO->getOpcode()) {
1176 case Instruction::Add:
1177 if (CI->isNullValue()) {
1178 // Replace ((add A, B) != 0) with (A != -B) if A or B is
1179 // efficiently invertible, or if the add has just this one use.
1180 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
1181 if (Value *NegVal = dyn_castNegVal(BOp1))
1182 return new SetCondInst(I.getOpcode(), BOp0, NegVal);
1183 else if (Value *NegVal = dyn_castNegVal(BOp0))
1184 return new SetCondInst(I.getOpcode(), NegVal, BOp1);
Chris Lattnerf95d9b92003-10-15 16:48:29 +00001185 else if (BO->hasOneUse()) {
Chris Lattnerc992add2003-08-13 05:33:12 +00001186 Instruction *Neg = BinaryOperator::createNeg(BOp1, BO->getName());
1187 BO->setName("");
1188 InsertNewInstBefore(Neg, I);
1189 return new SetCondInst(I.getOpcode(), BOp0, Neg);
1190 }
1191 }
1192 break;
1193 case Instruction::Xor:
1194 // For the xor case, we can xor two constants together, eliminating
1195 // the explicit xor.
1196 if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1)))
1197 return BinaryOperator::create(I.getOpcode(), BO->getOperand(0),
1198 *CI ^ *BOC);
1199
1200 // FALLTHROUGH
1201 case Instruction::Sub:
1202 // Replace (([sub|xor] A, B) != 0) with (A != B)
1203 if (CI->isNullValue())
1204 return new SetCondInst(I.getOpcode(), BO->getOperand(0),
1205 BO->getOperand(1));
1206 break;
1207
1208 case Instruction::Or:
1209 // If bits are being or'd in that are not present in the constant we
1210 // are comparing against, then the comparison could never succeed!
1211 if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1)))
Chris Lattnerd492a0b2003-07-23 17:02:11 +00001212 if (!(*BOC & *~*CI)->isNullValue())
1213 return ReplaceInstUsesWith(I, ConstantBool::get(isSetNE));
Chris Lattnerc992add2003-08-13 05:33:12 +00001214 break;
1215
1216 case Instruction::And:
1217 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
Chris Lattnerd492a0b2003-07-23 17:02:11 +00001218 // If bits are being compared against that are and'd out, then the
1219 // comparison can never succeed!
1220 if (!(*CI & *~*BOC)->isNullValue())
1221 return ReplaceInstUsesWith(I, ConstantBool::get(isSetNE));
Chris Lattnerc992add2003-08-13 05:33:12 +00001222
1223 // Replace (and X, (1 << size(X)-1) != 0) with x < 0, converting X
1224 // to be a signed value as appropriate.
1225 if (isSignBit(BOC)) {
1226 Value *X = BO->getOperand(0);
1227 // If 'X' is not signed, insert a cast now...
1228 if (!BOC->getType()->isSigned()) {
1229 const Type *DestTy;
1230 switch (BOC->getType()->getPrimitiveID()) {
1231 case Type::UByteTyID: DestTy = Type::SByteTy; break;
1232 case Type::UShortTyID: DestTy = Type::ShortTy; break;
1233 case Type::UIntTyID: DestTy = Type::IntTy; break;
1234 case Type::ULongTyID: DestTy = Type::LongTy; break;
1235 default: assert(0 && "Invalid unsigned integer type!"); abort();
1236 }
1237 CastInst *NewCI = new CastInst(X,DestTy,X->getName()+".signed");
1238 InsertNewInstBefore(NewCI, I);
1239 X = NewCI;
1240 }
1241 return new SetCondInst(isSetNE ? Instruction::SetLT :
1242 Instruction::SetGE, X,
1243 Constant::getNullValue(X->getType()));
1244 }
Chris Lattnerd492a0b2003-07-23 17:02:11 +00001245 }
Chris Lattnerc992add2003-08-13 05:33:12 +00001246 default: break;
1247 }
1248 }
Chris Lattnere967b342003-06-04 05:10:11 +00001249 }
Chris Lattner791ac1a2003-06-01 03:35:25 +00001250
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001251 // Check to see if we are comparing against the minimum or maximum value...
Chris Lattnere6794492002-08-12 21:17:25 +00001252 if (CI->isMinValue()) {
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001253 if (I.getOpcode() == Instruction::SetLT) // A < MIN -> FALSE
1254 return ReplaceInstUsesWith(I, ConstantBool::False);
1255 if (I.getOpcode() == Instruction::SetGE) // A >= MIN -> TRUE
1256 return ReplaceInstUsesWith(I, ConstantBool::True);
1257 if (I.getOpcode() == Instruction::SetLE) // A <= MIN -> A == MIN
Chris Lattner16930792003-11-03 04:25:02 +00001258 return BinaryOperator::create(Instruction::SetEQ, Op0, Op1);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001259 if (I.getOpcode() == Instruction::SetGT) // A > MIN -> A != MIN
Chris Lattner16930792003-11-03 04:25:02 +00001260 return BinaryOperator::create(Instruction::SetNE, Op0, Op1);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001261
Chris Lattnere6794492002-08-12 21:17:25 +00001262 } else if (CI->isMaxValue()) {
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001263 if (I.getOpcode() == Instruction::SetGT) // A > MAX -> FALSE
1264 return ReplaceInstUsesWith(I, ConstantBool::False);
1265 if (I.getOpcode() == Instruction::SetLE) // A <= MAX -> TRUE
1266 return ReplaceInstUsesWith(I, ConstantBool::True);
1267 if (I.getOpcode() == Instruction::SetGE) // A >= MAX -> A == MAX
Chris Lattner16930792003-11-03 04:25:02 +00001268 return BinaryOperator::create(Instruction::SetEQ, Op0, Op1);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001269 if (I.getOpcode() == Instruction::SetLT) // A < MAX -> A != MAX
Chris Lattner16930792003-11-03 04:25:02 +00001270 return BinaryOperator::create(Instruction::SetNE, Op0, Op1);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001271
1272 // Comparing against a value really close to min or max?
1273 } else if (isMinValuePlusOne(CI)) {
1274 if (I.getOpcode() == Instruction::SetLT) // A < MIN+1 -> A == MIN
Chris Lattner16930792003-11-03 04:25:02 +00001275 return BinaryOperator::create(Instruction::SetEQ, Op0, SubOne(CI));
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001276 if (I.getOpcode() == Instruction::SetGE) // A >= MIN-1 -> A != MIN
Chris Lattner16930792003-11-03 04:25:02 +00001277 return BinaryOperator::create(Instruction::SetNE, Op0, SubOne(CI));
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001278
1279 } else if (isMaxValueMinusOne(CI)) {
1280 if (I.getOpcode() == Instruction::SetGT) // A > MAX-1 -> A == MAX
Chris Lattner16930792003-11-03 04:25:02 +00001281 return BinaryOperator::create(Instruction::SetEQ, Op0, AddOne(CI));
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001282 if (I.getOpcode() == Instruction::SetLE) // A <= MAX-1 -> A != MAX
Chris Lattner16930792003-11-03 04:25:02 +00001283 return BinaryOperator::create(Instruction::SetNE, Op0, AddOne(CI));
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001284 }
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001285 }
1286
Chris Lattner16930792003-11-03 04:25:02 +00001287 // Test to see if the operands of the setcc are casted versions of other
1288 // values. If the cast can be stripped off both arguments, we do so now.
Chris Lattner6444c372003-11-03 05:17:03 +00001289 if (CastInst *CI = dyn_cast<CastInst>(Op0)) {
1290 Value *CastOp0 = CI->getOperand(0);
1291 if (CastOp0->getType()->isLosslesslyConvertibleTo(CI->getType()) &&
Chris Lattner16930792003-11-03 04:25:02 +00001292 !isa<Argument>(Op1) &&
1293 (I.getOpcode() == Instruction::SetEQ ||
1294 I.getOpcode() == Instruction::SetNE)) {
1295 // We keep moving the cast from the left operand over to the right
1296 // operand, where it can often be eliminated completely.
Chris Lattner6444c372003-11-03 05:17:03 +00001297 Op0 = CastOp0;
Chris Lattner16930792003-11-03 04:25:02 +00001298
1299 // If operand #1 is a cast instruction, see if we can eliminate it as
1300 // well.
Chris Lattner6444c372003-11-03 05:17:03 +00001301 if (CastInst *CI2 = dyn_cast<CastInst>(Op1))
1302 if (CI2->getOperand(0)->getType()->isLosslesslyConvertibleTo(
Chris Lattner16930792003-11-03 04:25:02 +00001303 Op0->getType()))
Chris Lattner6444c372003-11-03 05:17:03 +00001304 Op1 = CI2->getOperand(0);
Chris Lattner16930792003-11-03 04:25:02 +00001305
1306 // If Op1 is a constant, we can fold the cast into the constant.
1307 if (Op1->getType() != Op0->getType())
1308 if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
1309 Op1 = ConstantExpr::getCast(Op1C, Op0->getType());
1310 } else {
1311 // Otherwise, cast the RHS right before the setcc
1312 Op1 = new CastInst(Op1, Op0->getType(), Op1->getName());
1313 InsertNewInstBefore(cast<Instruction>(Op1), I);
1314 }
1315 return BinaryOperator::create(I.getOpcode(), Op0, Op1);
1316 }
1317
Chris Lattner6444c372003-11-03 05:17:03 +00001318 // Handle the special case of: setcc (cast bool to X), <cst>
1319 // This comes up when you have code like
1320 // int X = A < B;
1321 // if (X) ...
1322 // For generality, we handle any zero-extension of any operand comparison
1323 // with a constant.
1324 if (ConstantInt *ConstantRHS = dyn_cast<ConstantInt>(Op1)) {
1325 const Type *SrcTy = CastOp0->getType();
1326 const Type *DestTy = Op0->getType();
1327 if (SrcTy->getPrimitiveSize() < DestTy->getPrimitiveSize() &&
1328 (SrcTy->isUnsigned() || SrcTy == Type::BoolTy)) {
1329 // Ok, we have an expansion of operand 0 into a new type. Get the
1330 // constant value, masink off bits which are not set in the RHS. These
1331 // could be set if the destination value is signed.
1332 uint64_t ConstVal = ConstantRHS->getRawValue();
1333 ConstVal &= (1ULL << DestTy->getPrimitiveSize()*8)-1;
1334
1335 // If the constant we are comparing it with has high bits set, which
1336 // don't exist in the original value, the values could never be equal,
1337 // because the source would be zero extended.
1338 unsigned SrcBits =
1339 SrcTy == Type::BoolTy ? 1 : SrcTy->getPrimitiveSize()*8;
Chris Lattner7c94d112003-11-05 17:31:36 +00001340 bool HasSignBit = ConstVal & (1ULL << (DestTy->getPrimitiveSize()*8-1));
1341 if (ConstVal & ~((1ULL << SrcBits)-1)) {
Chris Lattner6444c372003-11-03 05:17:03 +00001342 switch (I.getOpcode()) {
1343 default: assert(0 && "Unknown comparison type!");
1344 case Instruction::SetEQ:
1345 return ReplaceInstUsesWith(I, ConstantBool::False);
1346 case Instruction::SetNE:
1347 return ReplaceInstUsesWith(I, ConstantBool::True);
1348 case Instruction::SetLT:
1349 case Instruction::SetLE:
1350 if (DestTy->isSigned() && HasSignBit)
1351 return ReplaceInstUsesWith(I, ConstantBool::False);
1352 return ReplaceInstUsesWith(I, ConstantBool::True);
1353 case Instruction::SetGT:
1354 case Instruction::SetGE:
1355 if (DestTy->isSigned() && HasSignBit)
1356 return ReplaceInstUsesWith(I, ConstantBool::True);
1357 return ReplaceInstUsesWith(I, ConstantBool::False);
1358 }
1359 }
1360
1361 // Otherwise, we can replace the setcc with a setcc of the smaller
1362 // operand value.
1363 Op1 = ConstantExpr::getCast(cast<Constant>(Op1), SrcTy);
1364 return BinaryOperator::create(I.getOpcode(), CastOp0, Op1);
1365 }
1366 }
1367 }
Chris Lattner113f4f42002-06-25 16:13:24 +00001368 return Changed ? &I : 0;
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001369}
1370
1371
1372
Chris Lattnere8d6c602003-03-10 19:16:08 +00001373Instruction *InstCombiner::visitShiftInst(ShiftInst &I) {
Chris Lattner113f4f42002-06-25 16:13:24 +00001374 assert(I.getOperand(1)->getType() == Type::UByteTy);
1375 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001376 bool isLeftShift = I.getOpcode() == Instruction::Shl;
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001377
1378 // shl X, 0 == X and shr X, 0 == X
1379 // shl 0, X == 0 and shr 0, X == 0
1380 if (Op1 == Constant::getNullValue(Type::UByteTy) ||
Chris Lattnere6794492002-08-12 21:17:25 +00001381 Op0 == Constant::getNullValue(Op0->getType()))
1382 return ReplaceInstUsesWith(I, Op0);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001383
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001384 // shr int -1, X = -1 (for any arithmetic shift rights of ~0)
1385 if (!isLeftShift)
1386 if (ConstantSInt *CSI = dyn_cast<ConstantSInt>(Op0))
1387 if (CSI->isAllOnesValue())
1388 return ReplaceInstUsesWith(I, CSI);
1389
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001390 if (ConstantUInt *CUI = dyn_cast<ConstantUInt>(Op1)) {
Chris Lattner3204d4e2003-07-24 17:52:58 +00001391 // shl uint X, 32 = 0 and shr ubyte Y, 9 = 0, ... just don't eliminate shr
1392 // of a signed value.
1393 //
Chris Lattnere8d6c602003-03-10 19:16:08 +00001394 unsigned TypeBits = Op0->getType()->getPrimitiveSize()*8;
1395 if (CUI->getValue() >= TypeBits &&
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001396 (!Op0->getType()->isSigned() || isLeftShift))
Chris Lattnere8d6c602003-03-10 19:16:08 +00001397 return ReplaceInstUsesWith(I, Constant::getNullValue(Op0->getType()));
Chris Lattner55f3d942002-09-10 23:04:09 +00001398
Chris Lattnerede3fe02003-08-13 04:18:28 +00001399 // ((X*C1) << C2) == (X * (C1 << C2))
1400 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Op0))
1401 if (BO->getOpcode() == Instruction::Mul && isLeftShift)
1402 if (Constant *BOOp = dyn_cast<Constant>(BO->getOperand(1)))
1403 return BinaryOperator::create(Instruction::Mul, BO->getOperand(0),
1404 *BOOp << *CUI);
1405
1406
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001407 // If the operand is an bitwise operator with a constant RHS, and the
1408 // shift is the only use, we can pull it out of the shift.
Chris Lattnerf95d9b92003-10-15 16:48:29 +00001409 if (Op0->hasOneUse())
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001410 if (BinaryOperator *Op0BO = dyn_cast<BinaryOperator>(Op0))
1411 if (ConstantInt *Op0C = dyn_cast<ConstantInt>(Op0BO->getOperand(1))) {
1412 bool isValid = true; // Valid only for And, Or, Xor
1413 bool highBitSet = false; // Transform if high bit of constant set?
1414
1415 switch (Op0BO->getOpcode()) {
1416 default: isValid = false; break; // Do not perform transform!
1417 case Instruction::Or:
1418 case Instruction::Xor:
1419 highBitSet = false;
1420 break;
1421 case Instruction::And:
1422 highBitSet = true;
1423 break;
1424 }
1425
1426 // If this is a signed shift right, and the high bit is modified
1427 // by the logical operation, do not perform the transformation.
1428 // The highBitSet boolean indicates the value of the high bit of
1429 // the constant which would cause it to be modified for this
1430 // operation.
1431 //
1432 if (isValid && !isLeftShift && !I.getType()->isUnsigned()) {
1433 uint64_t Val = Op0C->getRawValue();
1434 isValid = ((Val & (1 << (TypeBits-1))) != 0) == highBitSet;
1435 }
1436
1437 if (isValid) {
1438 Constant *NewRHS =
1439 ConstantFoldShiftInstruction(I.getOpcode(), Op0C, CUI);
1440
1441 Instruction *NewShift =
1442 new ShiftInst(I.getOpcode(), Op0BO->getOperand(0), CUI,
1443 Op0BO->getName());
1444 Op0BO->setName("");
1445 InsertNewInstBefore(NewShift, I);
1446
1447 return BinaryOperator::create(Op0BO->getOpcode(), NewShift,
1448 NewRHS);
1449 }
1450 }
1451
Chris Lattner3204d4e2003-07-24 17:52:58 +00001452 // If this is a shift of a shift, see if we can fold the two together...
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001453 if (ShiftInst *Op0SI = dyn_cast<ShiftInst>(Op0))
Chris Lattnerab780df2003-07-24 18:38:56 +00001454 if (ConstantUInt *ShiftAmt1C =
1455 dyn_cast<ConstantUInt>(Op0SI->getOperand(1))) {
Chris Lattner3204d4e2003-07-24 17:52:58 +00001456 unsigned ShiftAmt1 = ShiftAmt1C->getValue();
1457 unsigned ShiftAmt2 = CUI->getValue();
1458
1459 // Check for (A << c1) << c2 and (A >> c1) >> c2
1460 if (I.getOpcode() == Op0SI->getOpcode()) {
1461 unsigned Amt = ShiftAmt1+ShiftAmt2; // Fold into one big shift...
1462 return new ShiftInst(I.getOpcode(), Op0SI->getOperand(0),
1463 ConstantUInt::get(Type::UByteTy, Amt));
1464 }
1465
Chris Lattnerab780df2003-07-24 18:38:56 +00001466 // Check for (A << c1) >> c2 or visaversa. If we are dealing with
1467 // signed types, we can only support the (A >> c1) << c2 configuration,
1468 // because it can not turn an arbitrary bit of A into a sign bit.
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001469 if (I.getType()->isUnsigned() || isLeftShift) {
Chris Lattner3204d4e2003-07-24 17:52:58 +00001470 // Calculate bitmask for what gets shifted off the edge...
1471 Constant *C = ConstantIntegral::getAllOnesValue(I.getType());
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001472 if (isLeftShift)
Chris Lattner3204d4e2003-07-24 17:52:58 +00001473 C = ConstantExpr::getShift(Instruction::Shl, C, ShiftAmt1C);
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001474 else
1475 C = ConstantExpr::getShift(Instruction::Shr, C, ShiftAmt1C);
Chris Lattner3204d4e2003-07-24 17:52:58 +00001476
1477 Instruction *Mask =
1478 BinaryOperator::create(Instruction::And, Op0SI->getOperand(0),
1479 C, Op0SI->getOperand(0)->getName()+".mask");
1480 InsertNewInstBefore(Mask, I);
1481
1482 // Figure out what flavor of shift we should use...
1483 if (ShiftAmt1 == ShiftAmt2)
1484 return ReplaceInstUsesWith(I, Mask); // (A << c) >> c === A & c2
1485 else if (ShiftAmt1 < ShiftAmt2) {
1486 return new ShiftInst(I.getOpcode(), Mask,
1487 ConstantUInt::get(Type::UByteTy, ShiftAmt2-ShiftAmt1));
1488 } else {
1489 return new ShiftInst(Op0SI->getOpcode(), Mask,
1490 ConstantUInt::get(Type::UByteTy, ShiftAmt1-ShiftAmt2));
1491 }
1492 }
1493 }
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001494 }
Chris Lattner2e0fb392002-10-08 16:16:40 +00001495
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001496 return 0;
1497}
1498
1499
Chris Lattner48a44f72002-05-02 17:06:02 +00001500// isEliminableCastOfCast - Return true if it is valid to eliminate the CI
1501// instruction.
1502//
Chris Lattnerdfae8be2003-07-24 17:35:25 +00001503static inline bool isEliminableCastOfCast(const Type *SrcTy, const Type *MidTy,
1504 const Type *DstTy) {
Chris Lattner48a44f72002-05-02 17:06:02 +00001505
Chris Lattner650b6da2002-08-02 20:00:25 +00001506 // It is legal to eliminate the instruction if casting A->B->A if the sizes
1507 // are identical and the bits don't get reinterpreted (for example
Chris Lattner0bb75912002-08-14 23:21:10 +00001508 // int->float->int would not be allowed)
Misha Brukmane5838c42003-05-20 18:45:36 +00001509 if (SrcTy == DstTy && SrcTy->isLosslesslyConvertibleTo(MidTy))
Chris Lattner650b6da2002-08-02 20:00:25 +00001510 return true;
Chris Lattner48a44f72002-05-02 17:06:02 +00001511
1512 // Allow free casting and conversion of sizes as long as the sign doesn't
1513 // change...
Chris Lattnerb0b412e2002-09-03 01:08:28 +00001514 if (SrcTy->isIntegral() && MidTy->isIntegral() && DstTy->isIntegral()) {
Chris Lattner650b6da2002-08-02 20:00:25 +00001515 unsigned SrcSize = SrcTy->getPrimitiveSize();
1516 unsigned MidSize = MidTy->getPrimitiveSize();
1517 unsigned DstSize = DstTy->getPrimitiveSize();
Chris Lattner650b6da2002-08-02 20:00:25 +00001518
Chris Lattner3732aca2002-08-15 16:15:25 +00001519 // Cases where we are monotonically decreasing the size of the type are
1520 // always ok, regardless of what sign changes are going on.
1521 //
Chris Lattner0bb75912002-08-14 23:21:10 +00001522 if (SrcSize >= MidSize && MidSize >= DstSize)
Chris Lattner650b6da2002-08-02 20:00:25 +00001523 return true;
Chris Lattner3732aca2002-08-15 16:15:25 +00001524
Chris Lattner555518c2002-09-23 23:39:43 +00001525 // Cases where the source and destination type are the same, but the middle
1526 // type is bigger are noops.
1527 //
1528 if (SrcSize == DstSize && MidSize > SrcSize)
1529 return true;
1530
Chris Lattner3732aca2002-08-15 16:15:25 +00001531 // If we are monotonically growing, things are more complex.
1532 //
1533 if (SrcSize <= MidSize && MidSize <= DstSize) {
1534 // We have eight combinations of signedness to worry about. Here's the
1535 // table:
1536 static const int SignTable[8] = {
1537 // CODE, SrcSigned, MidSigned, DstSigned, Comment
1538 1, // U U U Always ok
1539 1, // U U S Always ok
1540 3, // U S U Ok iff SrcSize != MidSize
1541 3, // U S S Ok iff SrcSize != MidSize
1542 0, // S U U Never ok
1543 2, // S U S Ok iff MidSize == DstSize
1544 1, // S S U Always ok
1545 1, // S S S Always ok
1546 };
1547
1548 // Choose an action based on the current entry of the signtable that this
1549 // cast of cast refers to...
1550 unsigned Row = SrcTy->isSigned()*4+MidTy->isSigned()*2+DstTy->isSigned();
1551 switch (SignTable[Row]) {
1552 case 0: return false; // Never ok
1553 case 1: return true; // Always ok
1554 case 2: return MidSize == DstSize; // Ok iff MidSize == DstSize
1555 case 3: // Ok iff SrcSize != MidSize
1556 return SrcSize != MidSize || SrcTy == Type::BoolTy;
1557 default: assert(0 && "Bad entry in sign table!");
1558 }
Chris Lattner3732aca2002-08-15 16:15:25 +00001559 }
Chris Lattner650b6da2002-08-02 20:00:25 +00001560 }
Chris Lattner48a44f72002-05-02 17:06:02 +00001561
1562 // Otherwise, we cannot succeed. Specifically we do not want to allow things
1563 // like: short -> ushort -> uint, because this can create wrong results if
1564 // the input short is negative!
1565 //
1566 return false;
1567}
1568
Chris Lattnerdfae8be2003-07-24 17:35:25 +00001569static bool ValueRequiresCast(const Value *V, const Type *Ty) {
1570 if (V->getType() == Ty || isa<Constant>(V)) return false;
1571 if (const CastInst *CI = dyn_cast<CastInst>(V))
1572 if (isEliminableCastOfCast(CI->getOperand(0)->getType(), CI->getType(), Ty))
1573 return false;
1574 return true;
1575}
1576
1577/// InsertOperandCastBefore - This inserts a cast of V to DestTy before the
1578/// InsertBefore instruction. This is specialized a bit to avoid inserting
1579/// casts that are known to not do anything...
1580///
1581Value *InstCombiner::InsertOperandCastBefore(Value *V, const Type *DestTy,
1582 Instruction *InsertBefore) {
1583 if (V->getType() == DestTy) return V;
1584 if (Constant *C = dyn_cast<Constant>(V))
1585 return ConstantExpr::getCast(C, DestTy);
1586
1587 CastInst *CI = new CastInst(V, DestTy, V->getName());
1588 InsertNewInstBefore(CI, *InsertBefore);
1589 return CI;
1590}
Chris Lattner48a44f72002-05-02 17:06:02 +00001591
1592// CastInst simplification
Chris Lattner260ab202002-04-18 17:39:14 +00001593//
Chris Lattner113f4f42002-06-25 16:13:24 +00001594Instruction *InstCombiner::visitCastInst(CastInst &CI) {
Chris Lattner55d4bda2003-06-23 21:59:52 +00001595 Value *Src = CI.getOperand(0);
1596
Chris Lattner48a44f72002-05-02 17:06:02 +00001597 // If the user is casting a value to the same type, eliminate this cast
1598 // instruction...
Chris Lattner55d4bda2003-06-23 21:59:52 +00001599 if (CI.getType() == Src->getType())
1600 return ReplaceInstUsesWith(CI, Src);
Chris Lattner48a44f72002-05-02 17:06:02 +00001601
Chris Lattner48a44f72002-05-02 17:06:02 +00001602 // If casting the result of another cast instruction, try to eliminate this
1603 // one!
1604 //
Chris Lattner55d4bda2003-06-23 21:59:52 +00001605 if (CastInst *CSrc = dyn_cast<CastInst>(Src)) {
Chris Lattnerdfae8be2003-07-24 17:35:25 +00001606 if (isEliminableCastOfCast(CSrc->getOperand(0)->getType(),
1607 CSrc->getType(), CI.getType())) {
Chris Lattner48a44f72002-05-02 17:06:02 +00001608 // This instruction now refers directly to the cast's src operand. This
1609 // has a good chance of making CSrc dead.
Chris Lattner113f4f42002-06-25 16:13:24 +00001610 CI.setOperand(0, CSrc->getOperand(0));
1611 return &CI;
Chris Lattner48a44f72002-05-02 17:06:02 +00001612 }
1613
Chris Lattner650b6da2002-08-02 20:00:25 +00001614 // If this is an A->B->A cast, and we are dealing with integral types, try
1615 // to convert this into a logical 'and' instruction.
1616 //
1617 if (CSrc->getOperand(0)->getType() == CI.getType() &&
Chris Lattnerb0b412e2002-09-03 01:08:28 +00001618 CI.getType()->isInteger() && CSrc->getType()->isInteger() &&
Chris Lattner650b6da2002-08-02 20:00:25 +00001619 CI.getType()->isUnsigned() && CSrc->getType()->isUnsigned() &&
1620 CSrc->getType()->getPrimitiveSize() < CI.getType()->getPrimitiveSize()){
1621 assert(CSrc->getType() != Type::ULongTy &&
1622 "Cannot have type bigger than ulong!");
Chris Lattner196897c2003-05-26 23:41:32 +00001623 uint64_t AndValue = (1ULL << CSrc->getType()->getPrimitiveSize()*8)-1;
Chris Lattner650b6da2002-08-02 20:00:25 +00001624 Constant *AndOp = ConstantUInt::get(CI.getType(), AndValue);
1625 return BinaryOperator::create(Instruction::And, CSrc->getOperand(0),
1626 AndOp);
1627 }
1628 }
1629
Chris Lattnerd0d51602003-06-21 23:12:02 +00001630 // If casting the result of a getelementptr instruction with no offset, turn
1631 // this into a cast of the original pointer!
1632 //
Chris Lattner55d4bda2003-06-23 21:59:52 +00001633 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Src)) {
Chris Lattnerd0d51602003-06-21 23:12:02 +00001634 bool AllZeroOperands = true;
1635 for (unsigned i = 1, e = GEP->getNumOperands(); i != e; ++i)
1636 if (!isa<Constant>(GEP->getOperand(i)) ||
1637 !cast<Constant>(GEP->getOperand(i))->isNullValue()) {
1638 AllZeroOperands = false;
1639 break;
1640 }
1641 if (AllZeroOperands) {
1642 CI.setOperand(0, GEP->getOperand(0));
1643 return &CI;
1644 }
1645 }
1646
Chris Lattnerf4ad1652003-11-02 05:57:39 +00001647 // If we are casting a malloc or alloca to a pointer to a type of the same
1648 // size, rewrite the allocation instruction to allocate the "right" type.
1649 //
1650 if (AllocationInst *AI = dyn_cast<AllocationInst>(Src))
Chris Lattnerd4d987d2003-11-02 06:54:48 +00001651 if (AI->hasOneUse() && !AI->isArrayAllocation())
Chris Lattnerf4ad1652003-11-02 05:57:39 +00001652 if (const PointerType *PTy = dyn_cast<PointerType>(CI.getType())) {
1653 // Get the type really allocated and the type casted to...
1654 const Type *AllocElTy = AI->getAllocatedType();
1655 unsigned AllocElTySize = TD->getTypeSize(AllocElTy);
1656 const Type *CastElTy = PTy->getElementType();
1657 unsigned CastElTySize = TD->getTypeSize(CastElTy);
Chris Lattner7c94d112003-11-05 17:31:36 +00001658
Chris Lattnerf4ad1652003-11-02 05:57:39 +00001659 // If the allocation is for an even multiple of the cast type size
Chris Lattneraf789322003-11-03 01:29:41 +00001660 if (CastElTySize && (AllocElTySize % CastElTySize == 0)) {
Chris Lattnerf4ad1652003-11-02 05:57:39 +00001661 Value *Amt = ConstantUInt::get(Type::UIntTy,
1662 AllocElTySize/CastElTySize);
1663 std::string Name = AI->getName(); AI->setName("");
1664 AllocationInst *New;
1665 if (isa<MallocInst>(AI))
1666 New = new MallocInst(CastElTy, Amt, Name);
1667 else
1668 New = new AllocaInst(CastElTy, Amt, Name);
1669 InsertNewInstBefore(New, CI);
1670 return ReplaceInstUsesWith(CI, New);
1671 }
1672 }
1673
Chris Lattnerdfae8be2003-07-24 17:35:25 +00001674 // If the source value is an instruction with only this use, we can attempt to
1675 // propagate the cast into the instruction. Also, only handle integral types
1676 // for now.
1677 if (Instruction *SrcI = dyn_cast<Instruction>(Src))
Chris Lattnerf95d9b92003-10-15 16:48:29 +00001678 if (SrcI->hasOneUse() && Src->getType()->isIntegral() &&
Chris Lattnerdfae8be2003-07-24 17:35:25 +00001679 CI.getType()->isInteger()) { // Don't mess with casts to bool here
1680 const Type *DestTy = CI.getType();
1681 unsigned SrcBitSize = getTypeSizeInBits(Src->getType());
1682 unsigned DestBitSize = getTypeSizeInBits(DestTy);
1683
1684 Value *Op0 = SrcI->getNumOperands() > 0 ? SrcI->getOperand(0) : 0;
1685 Value *Op1 = SrcI->getNumOperands() > 1 ? SrcI->getOperand(1) : 0;
1686
1687 switch (SrcI->getOpcode()) {
1688 case Instruction::Add:
1689 case Instruction::Mul:
1690 case Instruction::And:
1691 case Instruction::Or:
1692 case Instruction::Xor:
1693 // If we are discarding information, or just changing the sign, rewrite.
1694 if (DestBitSize <= SrcBitSize && DestBitSize != 1) {
1695 // Don't insert two casts if they cannot be eliminated. We allow two
1696 // casts to be inserted if the sizes are the same. This could only be
1697 // converting signedness, which is a noop.
1698 if (DestBitSize == SrcBitSize || !ValueRequiresCast(Op1, DestTy) ||
1699 !ValueRequiresCast(Op0, DestTy)) {
1700 Value *Op0c = InsertOperandCastBefore(Op0, DestTy, SrcI);
1701 Value *Op1c = InsertOperandCastBefore(Op1, DestTy, SrcI);
1702 return BinaryOperator::create(cast<BinaryOperator>(SrcI)
1703 ->getOpcode(), Op0c, Op1c);
1704 }
1705 }
1706 break;
1707 case Instruction::Shl:
1708 // Allow changing the sign of the source operand. Do not allow changing
1709 // the size of the shift, UNLESS the shift amount is a constant. We
1710 // mush not change variable sized shifts to a smaller size, because it
1711 // is undefined to shift more bits out than exist in the value.
1712 if (DestBitSize == SrcBitSize ||
1713 (DestBitSize < SrcBitSize && isa<Constant>(Op1))) {
1714 Value *Op0c = InsertOperandCastBefore(Op0, DestTy, SrcI);
1715 return new ShiftInst(Instruction::Shl, Op0c, Op1);
1716 }
1717 break;
1718 }
1719 }
1720
Chris Lattner260ab202002-04-18 17:39:14 +00001721 return 0;
Chris Lattnerca081252001-12-14 16:52:21 +00001722}
1723
Chris Lattner970c33a2003-06-19 17:00:31 +00001724// CallInst simplification
1725//
1726Instruction *InstCombiner::visitCallInst(CallInst &CI) {
Chris Lattneraec3d942003-10-07 22:32:43 +00001727 return visitCallSite(&CI);
Chris Lattner970c33a2003-06-19 17:00:31 +00001728}
1729
1730// InvokeInst simplification
1731//
1732Instruction *InstCombiner::visitInvokeInst(InvokeInst &II) {
Chris Lattneraec3d942003-10-07 22:32:43 +00001733 return visitCallSite(&II);
Chris Lattner970c33a2003-06-19 17:00:31 +00001734}
1735
1736// getPromotedType - Return the specified type promoted as it would be to pass
1737// though a va_arg area...
1738static const Type *getPromotedType(const Type *Ty) {
1739 switch (Ty->getPrimitiveID()) {
1740 case Type::SByteTyID:
1741 case Type::ShortTyID: return Type::IntTy;
1742 case Type::UByteTyID:
1743 case Type::UShortTyID: return Type::UIntTy;
1744 case Type::FloatTyID: return Type::DoubleTy;
1745 default: return Ty;
1746 }
1747}
1748
Chris Lattneraec3d942003-10-07 22:32:43 +00001749// visitCallSite - Improvements for call and invoke instructions.
1750//
1751Instruction *InstCombiner::visitCallSite(CallSite CS) {
Chris Lattner75b4d1d2003-10-07 22:54:13 +00001752 bool Changed = false;
1753
1754 // If the callee is a constexpr cast of a function, attempt to move the cast
1755 // to the arguments of the call/invoke.
Chris Lattneraec3d942003-10-07 22:32:43 +00001756 if (transformConstExprCastCall(CS)) return 0;
1757
Chris Lattner75b4d1d2003-10-07 22:54:13 +00001758 Value *Callee = CS.getCalledValue();
1759 const PointerType *PTy = cast<PointerType>(Callee->getType());
1760 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1761 if (FTy->isVarArg()) {
1762 // See if we can optimize any arguments passed through the varargs area of
1763 // the call.
1764 for (CallSite::arg_iterator I = CS.arg_begin()+FTy->getNumParams(),
1765 E = CS.arg_end(); I != E; ++I)
1766 if (CastInst *CI = dyn_cast<CastInst>(*I)) {
1767 // If this cast does not effect the value passed through the varargs
1768 // area, we can eliminate the use of the cast.
1769 Value *Op = CI->getOperand(0);
1770 if (CI->getType()->isLosslesslyConvertibleTo(Op->getType())) {
1771 *I = Op;
1772 Changed = true;
1773 }
1774 }
1775 }
Chris Lattneraec3d942003-10-07 22:32:43 +00001776
Chris Lattner75b4d1d2003-10-07 22:54:13 +00001777 return Changed ? CS.getInstruction() : 0;
Chris Lattneraec3d942003-10-07 22:32:43 +00001778}
1779
Chris Lattner970c33a2003-06-19 17:00:31 +00001780// transformConstExprCastCall - If the callee is a constexpr cast of a function,
1781// attempt to move the cast to the arguments of the call/invoke.
1782//
1783bool InstCombiner::transformConstExprCastCall(CallSite CS) {
1784 if (!isa<ConstantExpr>(CS.getCalledValue())) return false;
1785 ConstantExpr *CE = cast<ConstantExpr>(CS.getCalledValue());
1786 if (CE->getOpcode() != Instruction::Cast ||
1787 !isa<ConstantPointerRef>(CE->getOperand(0)))
1788 return false;
1789 ConstantPointerRef *CPR = cast<ConstantPointerRef>(CE->getOperand(0));
1790 if (!isa<Function>(CPR->getValue())) return false;
1791 Function *Callee = cast<Function>(CPR->getValue());
1792 Instruction *Caller = CS.getInstruction();
1793
1794 // Okay, this is a cast from a function to a different type. Unless doing so
1795 // would cause a type conversion of one of our arguments, change this call to
1796 // be a direct call with arguments casted to the appropriate types.
1797 //
1798 const FunctionType *FT = Callee->getFunctionType();
1799 const Type *OldRetTy = Caller->getType();
1800
1801 if (Callee->isExternal() &&
1802 !OldRetTy->isLosslesslyConvertibleTo(FT->getReturnType()))
1803 return false; // Cannot transform this return value...
1804
1805 unsigned NumActualArgs = unsigned(CS.arg_end()-CS.arg_begin());
1806 unsigned NumCommonArgs = std::min(FT->getNumParams(), NumActualArgs);
1807
1808 CallSite::arg_iterator AI = CS.arg_begin();
1809 for (unsigned i = 0, e = NumCommonArgs; i != e; ++i, ++AI) {
1810 const Type *ParamTy = FT->getParamType(i);
1811 bool isConvertible = (*AI)->getType()->isLosslesslyConvertibleTo(ParamTy);
1812 if (Callee->isExternal() && !isConvertible) return false;
1813 }
1814
1815 if (FT->getNumParams() < NumActualArgs && !FT->isVarArg() &&
1816 Callee->isExternal())
1817 return false; // Do not delete arguments unless we have a function body...
1818
1819 // Okay, we decided that this is a safe thing to do: go ahead and start
1820 // inserting cast instructions as necessary...
1821 std::vector<Value*> Args;
1822 Args.reserve(NumActualArgs);
1823
1824 AI = CS.arg_begin();
1825 for (unsigned i = 0; i != NumCommonArgs; ++i, ++AI) {
1826 const Type *ParamTy = FT->getParamType(i);
1827 if ((*AI)->getType() == ParamTy) {
1828 Args.push_back(*AI);
1829 } else {
1830 Instruction *Cast = new CastInst(*AI, ParamTy, "tmp");
1831 InsertNewInstBefore(Cast, *Caller);
1832 Args.push_back(Cast);
1833 }
1834 }
1835
1836 // If the function takes more arguments than the call was taking, add them
1837 // now...
1838 for (unsigned i = NumCommonArgs; i != FT->getNumParams(); ++i)
1839 Args.push_back(Constant::getNullValue(FT->getParamType(i)));
1840
1841 // If we are removing arguments to the function, emit an obnoxious warning...
1842 if (FT->getNumParams() < NumActualArgs)
1843 if (!FT->isVarArg()) {
1844 std::cerr << "WARNING: While resolving call to function '"
1845 << Callee->getName() << "' arguments were dropped!\n";
1846 } else {
1847 // Add all of the arguments in their promoted form to the arg list...
1848 for (unsigned i = FT->getNumParams(); i != NumActualArgs; ++i, ++AI) {
1849 const Type *PTy = getPromotedType((*AI)->getType());
1850 if (PTy != (*AI)->getType()) {
1851 // Must promote to pass through va_arg area!
1852 Instruction *Cast = new CastInst(*AI, PTy, "tmp");
1853 InsertNewInstBefore(Cast, *Caller);
1854 Args.push_back(Cast);
1855 } else {
1856 Args.push_back(*AI);
1857 }
1858 }
1859 }
1860
1861 if (FT->getReturnType() == Type::VoidTy)
1862 Caller->setName(""); // Void type should not have a name...
1863
1864 Instruction *NC;
1865 if (InvokeInst *II = dyn_cast<InvokeInst>(Caller)) {
1866 NC = new InvokeInst(Callee, II->getNormalDest(), II->getExceptionalDest(),
1867 Args, Caller->getName(), Caller);
1868 } else {
1869 NC = new CallInst(Callee, Args, Caller->getName(), Caller);
1870 }
1871
1872 // Insert a cast of the return type as necessary...
1873 Value *NV = NC;
1874 if (Caller->getType() != NV->getType() && !Caller->use_empty()) {
1875 if (NV->getType() != Type::VoidTy) {
1876 NV = NC = new CastInst(NC, Caller->getType(), "tmp");
Chris Lattner686767f2003-10-30 00:46:41 +00001877
1878 // If this is an invoke instruction, we should insert it after the first
1879 // non-phi, instruction in the normal successor block.
1880 if (InvokeInst *II = dyn_cast<InvokeInst>(Caller)) {
1881 BasicBlock::iterator I = II->getNormalDest()->begin();
1882 while (isa<PHINode>(I)) ++I;
1883 InsertNewInstBefore(NC, *I);
1884 } else {
1885 // Otherwise, it's a call, just insert cast right after the call instr
1886 InsertNewInstBefore(NC, *Caller);
1887 }
Chris Lattner970c33a2003-06-19 17:00:31 +00001888 AddUsesToWorkList(*Caller);
1889 } else {
1890 NV = Constant::getNullValue(Caller->getType());
1891 }
1892 }
1893
1894 if (Caller->getType() != Type::VoidTy && !Caller->use_empty())
1895 Caller->replaceAllUsesWith(NV);
1896 Caller->getParent()->getInstList().erase(Caller);
1897 removeFromWorkList(Caller);
1898 return true;
1899}
1900
1901
Chris Lattner48a44f72002-05-02 17:06:02 +00001902
Chris Lattnerbbbdd852002-05-06 18:06:38 +00001903// PHINode simplification
1904//
Chris Lattner113f4f42002-06-25 16:13:24 +00001905Instruction *InstCombiner::visitPHINode(PHINode &PN) {
Chris Lattnerbbbdd852002-05-06 18:06:38 +00001906 // If the PHI node only has one incoming value, eliminate the PHI node...
Chris Lattnere6794492002-08-12 21:17:25 +00001907 if (PN.getNumIncomingValues() == 1)
1908 return ReplaceInstUsesWith(PN, PN.getIncomingValue(0));
Chris Lattner9cd1e662002-08-20 15:35:35 +00001909
1910 // Otherwise if all of the incoming values are the same for the PHI, replace
1911 // the PHI node with the incoming value.
1912 //
Chris Lattnerf6c0efa2002-08-22 20:22:01 +00001913 Value *InVal = 0;
1914 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
1915 if (PN.getIncomingValue(i) != &PN) // Not the PHI node itself...
1916 if (InVal && PN.getIncomingValue(i) != InVal)
1917 return 0; // Not the same, bail out.
1918 else
1919 InVal = PN.getIncomingValue(i);
1920
1921 // The only case that could cause InVal to be null is if we have a PHI node
1922 // that only has entries for itself. In this case, there is no entry into the
1923 // loop, so kill the PHI.
1924 //
1925 if (InVal == 0) InVal = Constant::getNullValue(PN.getType());
Chris Lattnerbbbdd852002-05-06 18:06:38 +00001926
Chris Lattner9cd1e662002-08-20 15:35:35 +00001927 // All of the incoming values are the same, replace the PHI node now.
1928 return ReplaceInstUsesWith(PN, InVal);
Chris Lattnerbbbdd852002-05-06 18:06:38 +00001929}
1930
Chris Lattner48a44f72002-05-02 17:06:02 +00001931
Chris Lattner113f4f42002-06-25 16:13:24 +00001932Instruction *InstCombiner::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Chris Lattner471bd762003-05-22 19:07:21 +00001933 // Is it 'getelementptr %P, long 0' or 'getelementptr %P'
Chris Lattner113f4f42002-06-25 16:13:24 +00001934 // If so, eliminate the noop.
Chris Lattnerae7a0d32002-08-02 19:29:35 +00001935 if ((GEP.getNumOperands() == 2 &&
Chris Lattner136dab72002-09-11 01:21:33 +00001936 GEP.getOperand(1) == Constant::getNullValue(Type::LongTy)) ||
Chris Lattnere6794492002-08-12 21:17:25 +00001937 GEP.getNumOperands() == 1)
1938 return ReplaceInstUsesWith(GEP, GEP.getOperand(0));
Chris Lattner48a44f72002-05-02 17:06:02 +00001939
Chris Lattnerae7a0d32002-08-02 19:29:35 +00001940 // Combine Indices - If the source pointer to this getelementptr instruction
1941 // is a getelementptr instruction, combine the indices of the two
1942 // getelementptr instructions into a single instruction.
1943 //
Chris Lattnerc59af1d2002-08-17 22:21:59 +00001944 if (GetElementPtrInst *Src = dyn_cast<GetElementPtrInst>(GEP.getOperand(0))) {
Chris Lattnerae7a0d32002-08-02 19:29:35 +00001945 std::vector<Value *> Indices;
Chris Lattnerca081252001-12-14 16:52:21 +00001946
Chris Lattnerae7a0d32002-08-02 19:29:35 +00001947 // Can we combine the two pointer arithmetics offsets?
Chris Lattner471bd762003-05-22 19:07:21 +00001948 if (Src->getNumOperands() == 2 && isa<Constant>(Src->getOperand(1)) &&
1949 isa<Constant>(GEP.getOperand(1))) {
Chris Lattner235af562003-03-05 22:33:14 +00001950 // Replace: gep (gep %P, long C1), long C2, ...
1951 // With: gep %P, long (C1+C2), ...
Chris Lattner34428442003-05-27 16:40:51 +00001952 Value *Sum = ConstantExpr::get(Instruction::Add,
1953 cast<Constant>(Src->getOperand(1)),
1954 cast<Constant>(GEP.getOperand(1)));
Chris Lattner235af562003-03-05 22:33:14 +00001955 assert(Sum && "Constant folding of longs failed!?");
1956 GEP.setOperand(0, Src->getOperand(0));
1957 GEP.setOperand(1, Sum);
1958 AddUsesToWorkList(*Src); // Reduce use count of Src
1959 return &GEP;
Chris Lattner471bd762003-05-22 19:07:21 +00001960 } else if (Src->getNumOperands() == 2) {
Chris Lattner235af562003-03-05 22:33:14 +00001961 // Replace: gep (gep %P, long B), long A, ...
1962 // With: T = long A+B; gep %P, T, ...
1963 //
1964 Value *Sum = BinaryOperator::create(Instruction::Add, Src->getOperand(1),
1965 GEP.getOperand(1),
1966 Src->getName()+".sum", &GEP);
1967 GEP.setOperand(0, Src->getOperand(0));
1968 GEP.setOperand(1, Sum);
1969 WorkList.push_back(cast<Instruction>(Sum));
1970 return &GEP;
Chris Lattner5d606a02002-11-04 16:43:32 +00001971 } else if (*GEP.idx_begin() == Constant::getNullValue(Type::LongTy) &&
Chris Lattnera8339e32002-09-17 21:05:42 +00001972 Src->getNumOperands() != 1) {
Chris Lattnerae7a0d32002-08-02 19:29:35 +00001973 // Otherwise we can do the fold if the first index of the GEP is a zero
1974 Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end());
1975 Indices.insert(Indices.end(), GEP.idx_begin()+1, GEP.idx_end());
Chris Lattner5d606a02002-11-04 16:43:32 +00001976 } else if (Src->getOperand(Src->getNumOperands()-1) ==
1977 Constant::getNullValue(Type::LongTy)) {
1978 // If the src gep ends with a constant array index, merge this get into
1979 // it, even if we have a non-zero array index.
1980 Indices.insert(Indices.end(), Src->idx_begin(), Src->idx_end()-1);
1981 Indices.insert(Indices.end(), GEP.idx_begin(), GEP.idx_end());
Chris Lattnerae7a0d32002-08-02 19:29:35 +00001982 }
1983
1984 if (!Indices.empty())
1985 return new GetElementPtrInst(Src->getOperand(0), Indices, GEP.getName());
Chris Lattnerc59af1d2002-08-17 22:21:59 +00001986
1987 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(GEP.getOperand(0))) {
1988 // GEP of global variable. If all of the indices for this GEP are
1989 // constants, we can promote this to a constexpr instead of an instruction.
1990
1991 // Scan for nonconstants...
1992 std::vector<Constant*> Indices;
1993 User::op_iterator I = GEP.idx_begin(), E = GEP.idx_end();
1994 for (; I != E && isa<Constant>(*I); ++I)
1995 Indices.push_back(cast<Constant>(*I));
1996
1997 if (I == E) { // If they are all constants...
Chris Lattner46b3d302003-04-16 22:40:51 +00001998 Constant *CE =
Chris Lattnerc59af1d2002-08-17 22:21:59 +00001999 ConstantExpr::getGetElementPtr(ConstantPointerRef::get(GV), Indices);
2000
2001 // Replace all uses of the GEP with the new constexpr...
2002 return ReplaceInstUsesWith(GEP, CE);
2003 }
Chris Lattnerca081252001-12-14 16:52:21 +00002004 }
2005
Chris Lattnerca081252001-12-14 16:52:21 +00002006 return 0;
2007}
2008
Chris Lattner1085bdf2002-11-04 16:18:53 +00002009Instruction *InstCombiner::visitAllocationInst(AllocationInst &AI) {
2010 // Convert: malloc Ty, C - where C is a constant != 1 into: malloc [C x Ty], 1
2011 if (AI.isArrayAllocation()) // Check C != 1
2012 if (const ConstantUInt *C = dyn_cast<ConstantUInt>(AI.getArraySize())) {
2013 const Type *NewTy = ArrayType::get(AI.getAllocatedType(), C->getValue());
Chris Lattnera2620ac2002-11-09 00:49:43 +00002014 AllocationInst *New = 0;
Chris Lattner1085bdf2002-11-04 16:18:53 +00002015
2016 // Create and insert the replacement instruction...
2017 if (isa<MallocInst>(AI))
2018 New = new MallocInst(NewTy, 0, AI.getName(), &AI);
Chris Lattnera2620ac2002-11-09 00:49:43 +00002019 else {
2020 assert(isa<AllocaInst>(AI) && "Unknown type of allocation inst!");
Chris Lattner1085bdf2002-11-04 16:18:53 +00002021 New = new AllocaInst(NewTy, 0, AI.getName(), &AI);
Chris Lattnera2620ac2002-11-09 00:49:43 +00002022 }
Chris Lattner1085bdf2002-11-04 16:18:53 +00002023
2024 // Scan to the end of the allocation instructions, to skip over a block of
2025 // allocas if possible...
2026 //
2027 BasicBlock::iterator It = New;
2028 while (isa<AllocationInst>(*It)) ++It;
2029
2030 // Now that I is pointing to the first non-allocation-inst in the block,
2031 // insert our getelementptr instruction...
2032 //
2033 std::vector<Value*> Idx(2, Constant::getNullValue(Type::LongTy));
2034 Value *V = new GetElementPtrInst(New, Idx, New->getName()+".sub", It);
2035
2036 // Now make everything use the getelementptr instead of the original
2037 // allocation.
2038 ReplaceInstUsesWith(AI, V);
2039 return &AI;
2040 }
2041 return 0;
2042}
2043
Chris Lattner0f1d8a32003-06-26 05:06:25 +00002044/// GetGEPGlobalInitializer - Given a constant, and a getelementptr
2045/// constantexpr, return the constant value being addressed by the constant
2046/// expression, or null if something is funny.
2047///
2048static Constant *GetGEPGlobalInitializer(Constant *C, ConstantExpr *CE) {
2049 if (CE->getOperand(1) != Constant::getNullValue(Type::LongTy))
2050 return 0; // Do not allow stepping over the value!
2051
2052 // Loop over all of the operands, tracking down which value we are
2053 // addressing...
2054 for (unsigned i = 2, e = CE->getNumOperands(); i != e; ++i)
2055 if (ConstantUInt *CU = dyn_cast<ConstantUInt>(CE->getOperand(i))) {
2056 ConstantStruct *CS = cast<ConstantStruct>(C);
2057 if (CU->getValue() >= CS->getValues().size()) return 0;
2058 C = cast<Constant>(CS->getValues()[CU->getValue()]);
2059 } else if (ConstantSInt *CS = dyn_cast<ConstantSInt>(CE->getOperand(i))) {
2060 ConstantArray *CA = cast<ConstantArray>(C);
2061 if ((uint64_t)CS->getValue() >= CA->getValues().size()) return 0;
2062 C = cast<Constant>(CA->getValues()[CS->getValue()]);
2063 } else
2064 return 0;
2065 return C;
2066}
2067
2068Instruction *InstCombiner::visitLoadInst(LoadInst &LI) {
2069 Value *Op = LI.getOperand(0);
2070 if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(Op))
2071 Op = CPR->getValue();
2072
2073 // Instcombine load (constant global) into the value loaded...
2074 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Op))
Chris Lattnerbdb0ce02003-07-22 21:46:59 +00002075 if (GV->isConstant() && !GV->isExternal())
Chris Lattner0f1d8a32003-06-26 05:06:25 +00002076 return ReplaceInstUsesWith(LI, GV->getInitializer());
2077
2078 // Instcombine load (constantexpr_GEP global, 0, ...) into the value loaded...
2079 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Op))
2080 if (CE->getOpcode() == Instruction::GetElementPtr)
2081 if (ConstantPointerRef *G=dyn_cast<ConstantPointerRef>(CE->getOperand(0)))
2082 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(G->getValue()))
Chris Lattnerbdb0ce02003-07-22 21:46:59 +00002083 if (GV->isConstant() && !GV->isExternal())
Chris Lattner0f1d8a32003-06-26 05:06:25 +00002084 if (Constant *V = GetGEPGlobalInitializer(GV->getInitializer(), CE))
2085 return ReplaceInstUsesWith(LI, V);
2086 return 0;
2087}
2088
2089
Chris Lattner9eef8a72003-06-04 04:46:00 +00002090Instruction *InstCombiner::visitBranchInst(BranchInst &BI) {
2091 // Change br (not X), label True, label False to: br X, label False, True
Chris Lattner45789ac2003-06-05 20:12:51 +00002092 if (BI.isConditional() && !isa<Constant>(BI.getCondition()))
Chris Lattnere967b342003-06-04 05:10:11 +00002093 if (Value *V = dyn_castNotVal(BI.getCondition())) {
2094 BasicBlock *TrueDest = BI.getSuccessor(0);
2095 BasicBlock *FalseDest = BI.getSuccessor(1);
2096 // Swap Destinations and condition...
2097 BI.setCondition(V);
2098 BI.setSuccessor(0, FalseDest);
2099 BI.setSuccessor(1, TrueDest);
2100 return &BI;
2101 }
Chris Lattner9eef8a72003-06-04 04:46:00 +00002102 return 0;
2103}
Chris Lattner1085bdf2002-11-04 16:18:53 +00002104
Chris Lattnerca081252001-12-14 16:52:21 +00002105
Chris Lattner99f48c62002-09-02 04:59:56 +00002106void InstCombiner::removeFromWorkList(Instruction *I) {
2107 WorkList.erase(std::remove(WorkList.begin(), WorkList.end(), I),
2108 WorkList.end());
2109}
2110
Chris Lattner113f4f42002-06-25 16:13:24 +00002111bool InstCombiner::runOnFunction(Function &F) {
Chris Lattner260ab202002-04-18 17:39:14 +00002112 bool Changed = false;
Chris Lattnerf4ad1652003-11-02 05:57:39 +00002113 TD = &getAnalysis<TargetData>();
Chris Lattnerca081252001-12-14 16:52:21 +00002114
Chris Lattner260ab202002-04-18 17:39:14 +00002115 WorkList.insert(WorkList.end(), inst_begin(F), inst_end(F));
Chris Lattnerca081252001-12-14 16:52:21 +00002116
2117 while (!WorkList.empty()) {
2118 Instruction *I = WorkList.back(); // Get an instruction from the worklist
2119 WorkList.pop_back();
2120
Misha Brukman632df282002-10-29 23:06:16 +00002121 // Check to see if we can DCE or ConstantPropagate the instruction...
Chris Lattner99f48c62002-09-02 04:59:56 +00002122 // Check to see if we can DIE the instruction...
2123 if (isInstructionTriviallyDead(I)) {
2124 // Add operands to the worklist...
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002125 if (I->getNumOperands() < 4)
2126 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
2127 if (Instruction *Op = dyn_cast<Instruction>(I->getOperand(i)))
2128 WorkList.push_back(Op);
Chris Lattner99f48c62002-09-02 04:59:56 +00002129 ++NumDeadInst;
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002130
2131 I->getParent()->getInstList().erase(I);
2132 removeFromWorkList(I);
2133 continue;
2134 }
Chris Lattner99f48c62002-09-02 04:59:56 +00002135
Misha Brukman632df282002-10-29 23:06:16 +00002136 // Instruction isn't dead, see if we can constant propagate it...
Chris Lattner99f48c62002-09-02 04:59:56 +00002137 if (Constant *C = ConstantFoldInstruction(I)) {
2138 // Add operands to the worklist...
2139 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
2140 if (Instruction *Op = dyn_cast<Instruction>(I->getOperand(i)))
2141 WorkList.push_back(Op);
Chris Lattnerc6509f42002-12-05 22:41:53 +00002142 ReplaceInstUsesWith(*I, C);
2143
Chris Lattner99f48c62002-09-02 04:59:56 +00002144 ++NumConstProp;
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002145 I->getParent()->getInstList().erase(I);
Chris Lattner800aaaf2003-10-07 15:17:02 +00002146 removeFromWorkList(I);
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002147 continue;
Chris Lattner99f48c62002-09-02 04:59:56 +00002148 }
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002149
Chris Lattnerca081252001-12-14 16:52:21 +00002150 // Now that we have an instruction, try combining it to simplify it...
Chris Lattnerae7a0d32002-08-02 19:29:35 +00002151 if (Instruction *Result = visit(*I)) {
Chris Lattner0b18c1d2002-05-10 15:38:35 +00002152 ++NumCombined;
Chris Lattner260ab202002-04-18 17:39:14 +00002153 // Should we replace the old instruction with a new one?
Chris Lattner053c0932002-05-14 15:24:07 +00002154 if (Result != I) {
2155 // Instructions can end up on the worklist more than once. Make sure
2156 // we do not process an instruction that has been deleted.
Chris Lattner99f48c62002-09-02 04:59:56 +00002157 removeFromWorkList(I);
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002158
2159 // Move the name to the new instruction first...
2160 std::string OldName = I->getName(); I->setName("");
Chris Lattner950fc782003-10-07 22:58:41 +00002161 Result->setName(OldName);
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002162
2163 // Insert the new instruction into the basic block...
2164 BasicBlock *InstParent = I->getParent();
2165 InstParent->getInstList().insert(I, Result);
2166
2167 // Everything uses the new instruction now...
2168 I->replaceAllUsesWith(Result);
2169
2170 // Erase the old instruction.
2171 InstParent->getInstList().erase(I);
Chris Lattner113f4f42002-06-25 16:13:24 +00002172 } else {
Chris Lattnerae7a0d32002-08-02 19:29:35 +00002173 BasicBlock::iterator II = I;
2174
2175 // If the instruction was modified, it's possible that it is now dead.
2176 // if so, remove it.
2177 if (dceInstruction(II)) {
2178 // Instructions may end up in the worklist more than once. Erase them
2179 // all.
Chris Lattner99f48c62002-09-02 04:59:56 +00002180 removeFromWorkList(I);
Chris Lattnerae7a0d32002-08-02 19:29:35 +00002181 Result = 0;
2182 }
Chris Lattner053c0932002-05-14 15:24:07 +00002183 }
Chris Lattner260ab202002-04-18 17:39:14 +00002184
Chris Lattnerae7a0d32002-08-02 19:29:35 +00002185 if (Result) {
2186 WorkList.push_back(Result);
2187 AddUsesToWorkList(*Result);
2188 }
Chris Lattner260ab202002-04-18 17:39:14 +00002189 Changed = true;
Chris Lattnerca081252001-12-14 16:52:21 +00002190 }
2191 }
2192
Chris Lattner260ab202002-04-18 17:39:14 +00002193 return Changed;
Chris Lattner04805fa2002-02-26 21:46:54 +00002194}
2195
2196Pass *createInstructionCombiningPass() {
Chris Lattner260ab202002-04-18 17:39:14 +00002197 return new InstCombiner();
Chris Lattner04805fa2002-02-26 21:46:54 +00002198}