blob: 67b99c56e7e54d6aaf32b4488dd1e65771917ff0 [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:
Chris Lattnerdd1a86d2004-05-04 15:19:33 +000015// %Y = add int %X, 1
16// %Z = add int %Y, 1
Chris Lattnerca081252001-12-14 16:52:21 +000017// into:
Chris Lattnerdd1a86d2004-05-04 15:19:33 +000018// %Z = add int %X, 2
Chris Lattnerca081252001-12-14 16:52:21 +000019//
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 Lattner7d2a5392004-03-13 23:54:27 +000036#define DEBUG_TYPE "instcombine"
Chris Lattnerb4cfa7f2002-05-07 20:03:00 +000037#include "llvm/Transforms/Scalar.h"
Chris Lattner471bd762003-05-22 19:07:21 +000038#include "llvm/Instructions.h"
Chris Lattner51ea1272004-02-28 05:22:00 +000039#include "llvm/Intrinsics.h"
Chris Lattner04805fa2002-02-26 21:46:54 +000040#include "llvm/Pass.h"
Chris Lattner34428442003-05-27 16:40:51 +000041#include "llvm/Constants.h"
Chris Lattner1085bdf2002-11-04 16:18:53 +000042#include "llvm/DerivedTypes.h"
Chris Lattner0f1d8a32003-06-26 05:06:25 +000043#include "llvm/GlobalVariable.h"
Chris Lattnerf4ad1652003-11-02 05:57:39 +000044#include "llvm/Target/TargetData.h"
45#include "llvm/Transforms/Utils/BasicBlockUtils.h"
46#include "llvm/Transforms/Utils/Local.h"
Chris Lattner69193f92004-04-05 01:30:19 +000047#include "llvm/Support/CallSite.h"
48#include "llvm/Support/GetElementPtrTypeIterator.h"
Chris Lattner60a65912002-02-12 21:07:25 +000049#include "llvm/Support/InstIterator.h"
Chris Lattner260ab202002-04-18 17:39:14 +000050#include "llvm/Support/InstVisitor.h"
Chris Lattner7d2a5392004-03-13 23:54:27 +000051#include "Support/Debug.h"
Chris Lattnerbf3a0992002-10-01 22:38:41 +000052#include "Support/Statistic.h"
Chris Lattner053c0932002-05-14 15:24:07 +000053#include <algorithm>
Chris Lattner8427bff2003-12-07 01:24:23 +000054using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000055
Chris Lattner260ab202002-04-18 17:39:14 +000056namespace {
Chris Lattnerbf3a0992002-10-01 22:38:41 +000057 Statistic<> NumCombined ("instcombine", "Number of insts combined");
58 Statistic<> NumConstProp("instcombine", "Number of constant folds");
59 Statistic<> NumDeadInst ("instcombine", "Number of dead inst eliminated");
60
Chris Lattnerc8e66542002-04-27 06:56:12 +000061 class InstCombiner : public FunctionPass,
Chris Lattner260ab202002-04-18 17:39:14 +000062 public InstVisitor<InstCombiner, Instruction*> {
63 // Worklist of all of the instructions that need to be simplified.
64 std::vector<Instruction*> WorkList;
Chris Lattnerf4ad1652003-11-02 05:57:39 +000065 TargetData *TD;
Chris Lattner260ab202002-04-18 17:39:14 +000066
Chris Lattner51ea1272004-02-28 05:22:00 +000067 /// AddUsersToWorkList - When an instruction is simplified, add all users of
68 /// the instruction to the work lists because they might get more simplified
69 /// now.
70 ///
71 void AddUsersToWorkList(Instruction &I) {
Chris Lattner113f4f42002-06-25 16:13:24 +000072 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
Chris Lattner260ab202002-04-18 17:39:14 +000073 UI != UE; ++UI)
74 WorkList.push_back(cast<Instruction>(*UI));
75 }
76
Chris Lattner51ea1272004-02-28 05:22:00 +000077 /// AddUsesToWorkList - When an instruction is simplified, add operands to
78 /// the work lists because they might get more simplified now.
79 ///
80 void AddUsesToWorkList(Instruction &I) {
81 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
82 if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i)))
83 WorkList.push_back(Op);
84 }
85
Chris Lattner99f48c62002-09-02 04:59:56 +000086 // removeFromWorkList - remove all instances of I from the worklist.
87 void removeFromWorkList(Instruction *I);
Chris Lattner260ab202002-04-18 17:39:14 +000088 public:
Chris Lattner113f4f42002-06-25 16:13:24 +000089 virtual bool runOnFunction(Function &F);
Chris Lattner260ab202002-04-18 17:39:14 +000090
Chris Lattnerf12cc842002-04-28 21:27:06 +000091 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Chris Lattnerf4ad1652003-11-02 05:57:39 +000092 AU.addRequired<TargetData>();
Chris Lattner820d9712002-10-21 20:00:28 +000093 AU.setPreservesCFG();
Chris Lattnerf12cc842002-04-28 21:27:06 +000094 }
95
Chris Lattner69193f92004-04-05 01:30:19 +000096 TargetData &getTargetData() const { return *TD; }
97
Chris Lattner260ab202002-04-18 17:39:14 +000098 // Visitation implementation - Implement instruction combining for different
99 // instruction types. The semantics are as follows:
100 // Return Value:
101 // null - No change was made
Chris Lattnere6794492002-08-12 21:17:25 +0000102 // I - Change was made, I is still valid, I may be dead though
Chris Lattner260ab202002-04-18 17:39:14 +0000103 // otherwise - Change was made, replace I with returned instruction
104 //
Chris Lattner113f4f42002-06-25 16:13:24 +0000105 Instruction *visitAdd(BinaryOperator &I);
106 Instruction *visitSub(BinaryOperator &I);
107 Instruction *visitMul(BinaryOperator &I);
108 Instruction *visitDiv(BinaryOperator &I);
109 Instruction *visitRem(BinaryOperator &I);
110 Instruction *visitAnd(BinaryOperator &I);
111 Instruction *visitOr (BinaryOperator &I);
112 Instruction *visitXor(BinaryOperator &I);
113 Instruction *visitSetCondInst(BinaryOperator &I);
Chris Lattnere8d6c602003-03-10 19:16:08 +0000114 Instruction *visitShiftInst(ShiftInst &I);
Chris Lattner113f4f42002-06-25 16:13:24 +0000115 Instruction *visitCastInst(CastInst &CI);
Chris Lattnerb909e8b2004-03-12 05:52:32 +0000116 Instruction *visitSelectInst(SelectInst &CI);
Chris Lattner970c33a2003-06-19 17:00:31 +0000117 Instruction *visitCallInst(CallInst &CI);
118 Instruction *visitInvokeInst(InvokeInst &II);
Chris Lattner113f4f42002-06-25 16:13:24 +0000119 Instruction *visitPHINode(PHINode &PN);
120 Instruction *visitGetElementPtrInst(GetElementPtrInst &GEP);
Chris Lattner1085bdf2002-11-04 16:18:53 +0000121 Instruction *visitAllocationInst(AllocationInst &AI);
Chris Lattner8427bff2003-12-07 01:24:23 +0000122 Instruction *visitFreeInst(FreeInst &FI);
Chris Lattner0f1d8a32003-06-26 05:06:25 +0000123 Instruction *visitLoadInst(LoadInst &LI);
Chris Lattner9eef8a72003-06-04 04:46:00 +0000124 Instruction *visitBranchInst(BranchInst &BI);
Chris Lattner260ab202002-04-18 17:39:14 +0000125
126 // visitInstruction - Specify what to return for unhandled instructions...
Chris Lattner113f4f42002-06-25 16:13:24 +0000127 Instruction *visitInstruction(Instruction &I) { return 0; }
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000128
Chris Lattner970c33a2003-06-19 17:00:31 +0000129 private:
Chris Lattneraec3d942003-10-07 22:32:43 +0000130 Instruction *visitCallSite(CallSite CS);
Chris Lattner970c33a2003-06-19 17:00:31 +0000131 bool transformConstExprCastCall(CallSite CS);
132
Chris Lattner69193f92004-04-05 01:30:19 +0000133 public:
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000134 // InsertNewInstBefore - insert an instruction New before instruction Old
135 // in the program. Add the new instruction to the worklist.
136 //
Chris Lattnere79e8542004-02-23 06:38:22 +0000137 Value *InsertNewInstBefore(Instruction *New, Instruction &Old) {
Chris Lattner65217ff2002-08-23 18:32:43 +0000138 assert(New && New->getParent() == 0 &&
139 "New instruction already inserted into a basic block!");
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000140 BasicBlock *BB = Old.getParent();
141 BB->getInstList().insert(&Old, New); // Insert inst
142 WorkList.push_back(New); // Add to worklist
Chris Lattnere79e8542004-02-23 06:38:22 +0000143 return New;
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000144 }
145
146 // ReplaceInstUsesWith - This method is to be used when an instruction is
147 // found to be dead, replacable with another preexisting expression. Here
148 // we add all uses of I to the worklist, replace all uses of I with the new
149 // value, then return I, so that the inst combiner will know that I was
150 // modified.
151 //
152 Instruction *ReplaceInstUsesWith(Instruction &I, Value *V) {
Chris Lattner51ea1272004-02-28 05:22:00 +0000153 AddUsersToWorkList(I); // Add all modified instrs to worklist
Chris Lattner8953b902004-04-05 02:10:19 +0000154 if (&I != V) {
155 I.replaceAllUsesWith(V);
156 return &I;
157 } else {
158 // If we are replacing the instruction with itself, this must be in a
159 // segment of unreachable code, so just clobber the instruction.
160 I.replaceAllUsesWith(Constant::getNullValue(I.getType()));
161 return &I;
162 }
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000163 }
Chris Lattner51ea1272004-02-28 05:22:00 +0000164
165 // EraseInstFromFunction - When dealing with an instruction that has side
166 // effects or produces a void value, we can't rely on DCE to delete the
167 // instruction. Instead, visit methods should return the value returned by
168 // this function.
169 Instruction *EraseInstFromFunction(Instruction &I) {
170 assert(I.use_empty() && "Cannot erase instruction that is used!");
171 AddUsesToWorkList(I);
172 removeFromWorkList(&I);
173 I.getParent()->getInstList().erase(&I);
174 return 0; // Don't do anything with FI
175 }
176
177
Chris Lattner3ac7c262003-08-13 20:16:26 +0000178 private:
Chris Lattnerdfae8be2003-07-24 17:35:25 +0000179 /// InsertOperandCastBefore - This inserts a cast of V to DestTy before the
180 /// InsertBefore instruction. This is specialized a bit to avoid inserting
181 /// casts that are known to not do anything...
182 ///
183 Value *InsertOperandCastBefore(Value *V, const Type *DestTy,
184 Instruction *InsertBefore);
185
Chris Lattner7fb29e12003-03-11 00:12:48 +0000186 // SimplifyCommutative - This performs a few simplifications for commutative
187 // operators...
188 bool SimplifyCommutative(BinaryOperator &I);
Chris Lattnerba1cb382003-09-19 17:17:26 +0000189
190 Instruction *OptAndOp(Instruction *Op, ConstantIntegral *OpRHS,
191 ConstantIntegral *AndRHS, BinaryOperator &TheAnd);
Chris Lattner260ab202002-04-18 17:39:14 +0000192 };
Chris Lattnerb28b6802002-07-23 18:06:35 +0000193
Chris Lattnerc8b70922002-07-26 21:12:46 +0000194 RegisterOpt<InstCombiner> X("instcombine", "Combine redundant instructions");
Chris Lattner260ab202002-04-18 17:39:14 +0000195}
196
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000197// getComplexity: Assign a complexity or rank value to LLVM Values...
198// 0 -> Constant, 1 -> Other, 2 -> Argument, 2 -> Unary, 3 -> OtherInst
199static unsigned getComplexity(Value *V) {
200 if (isa<Instruction>(V)) {
201 if (BinaryOperator::isNeg(V) || BinaryOperator::isNot(V))
202 return 2;
203 return 3;
204 }
205 if (isa<Argument>(V)) return 2;
206 return isa<Constant>(V) ? 0 : 1;
207}
Chris Lattner260ab202002-04-18 17:39:14 +0000208
Chris Lattner7fb29e12003-03-11 00:12:48 +0000209// isOnlyUse - Return true if this instruction will be deleted if we stop using
210// it.
211static bool isOnlyUse(Value *V) {
Chris Lattnerf95d9b92003-10-15 16:48:29 +0000212 return V->hasOneUse() || isa<Constant>(V);
Chris Lattner7fb29e12003-03-11 00:12:48 +0000213}
214
Chris Lattnere79e8542004-02-23 06:38:22 +0000215// getSignedIntegralType - Given an unsigned integral type, return the signed
216// version of it that has the same size.
217static const Type *getSignedIntegralType(const Type *Ty) {
218 switch (Ty->getPrimitiveID()) {
219 default: assert(0 && "Invalid unsigned integer type!"); abort();
220 case Type::UByteTyID: return Type::SByteTy;
221 case Type::UShortTyID: return Type::ShortTy;
222 case Type::UIntTyID: return Type::IntTy;
223 case Type::ULongTyID: return Type::LongTy;
224 }
225}
226
Chris Lattner92295c52004-03-12 23:53:13 +0000227// getUnsignedIntegralType - Given an signed integral type, return the unsigned
228// version of it that has the same size.
229static const Type *getUnsignedIntegralType(const Type *Ty) {
230 switch (Ty->getPrimitiveID()) {
231 default: assert(0 && "Invalid signed integer type!"); abort();
232 case Type::SByteTyID: return Type::UByteTy;
233 case Type::ShortTyID: return Type::UShortTy;
234 case Type::IntTyID: return Type::UIntTy;
235 case Type::LongTyID: return Type::ULongTy;
236 }
237}
238
Chris Lattnere79e8542004-02-23 06:38:22 +0000239// getPromotedType - Return the specified type promoted as it would be to pass
240// though a va_arg area...
241static const Type *getPromotedType(const Type *Ty) {
242 switch (Ty->getPrimitiveID()) {
243 case Type::SByteTyID:
244 case Type::ShortTyID: return Type::IntTy;
245 case Type::UByteTyID:
246 case Type::UShortTyID: return Type::UIntTy;
247 case Type::FloatTyID: return Type::DoubleTy;
248 default: return Ty;
249 }
250}
251
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000252// SimplifyCommutative - This performs a few simplifications for commutative
253// operators:
Chris Lattner260ab202002-04-18 17:39:14 +0000254//
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000255// 1. Order operands such that they are listed from right (least complex) to
256// left (most complex). This puts constants before unary operators before
257// binary operators.
258//
Chris Lattner7fb29e12003-03-11 00:12:48 +0000259// 2. Transform: (op (op V, C1), C2) ==> (op V, (op C1, C2))
260// 3. Transform: (op (op V1, C1), (op V2, C2)) ==> (op (op V1, V2), (op C1,C2))
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000261//
Chris Lattner7fb29e12003-03-11 00:12:48 +0000262bool InstCombiner::SimplifyCommutative(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000263 bool Changed = false;
264 if (getComplexity(I.getOperand(0)) < getComplexity(I.getOperand(1)))
265 Changed = !I.swapOperands();
266
267 if (!I.isAssociative()) return Changed;
268 Instruction::BinaryOps Opcode = I.getOpcode();
Chris Lattner7fb29e12003-03-11 00:12:48 +0000269 if (BinaryOperator *Op = dyn_cast<BinaryOperator>(I.getOperand(0)))
270 if (Op->getOpcode() == Opcode && isa<Constant>(Op->getOperand(1))) {
271 if (isa<Constant>(I.getOperand(1))) {
Chris Lattner34428442003-05-27 16:40:51 +0000272 Constant *Folded = ConstantExpr::get(I.getOpcode(),
273 cast<Constant>(I.getOperand(1)),
274 cast<Constant>(Op->getOperand(1)));
Chris Lattner7fb29e12003-03-11 00:12:48 +0000275 I.setOperand(0, Op->getOperand(0));
276 I.setOperand(1, Folded);
277 return true;
278 } else if (BinaryOperator *Op1=dyn_cast<BinaryOperator>(I.getOperand(1)))
279 if (Op1->getOpcode() == Opcode && isa<Constant>(Op1->getOperand(1)) &&
280 isOnlyUse(Op) && isOnlyUse(Op1)) {
281 Constant *C1 = cast<Constant>(Op->getOperand(1));
282 Constant *C2 = cast<Constant>(Op1->getOperand(1));
283
284 // Fold (op (op V1, C1), (op V2, C2)) ==> (op (op V1, V2), (op C1,C2))
Chris Lattner34428442003-05-27 16:40:51 +0000285 Constant *Folded = ConstantExpr::get(I.getOpcode(), C1, C2);
Chris Lattner7fb29e12003-03-11 00:12:48 +0000286 Instruction *New = BinaryOperator::create(Opcode, Op->getOperand(0),
287 Op1->getOperand(0),
288 Op1->getName(), &I);
289 WorkList.push_back(New);
290 I.setOperand(0, New);
291 I.setOperand(1, Folded);
292 return true;
293 }
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000294 }
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000295 return Changed;
Chris Lattner260ab202002-04-18 17:39:14 +0000296}
Chris Lattnerca081252001-12-14 16:52:21 +0000297
Chris Lattnerbb74e222003-03-10 23:06:50 +0000298// dyn_castNegVal - Given a 'sub' instruction, return the RHS of the instruction
299// if the LHS is a constant zero (which is the 'negate' form).
Chris Lattner9fa53de2002-05-06 16:49:18 +0000300//
Chris Lattnerbb74e222003-03-10 23:06:50 +0000301static inline Value *dyn_castNegVal(Value *V) {
302 if (BinaryOperator::isNeg(V))
303 return BinaryOperator::getNegArgument(cast<BinaryOperator>(V));
304
Chris Lattner9244df62003-04-30 22:19:10 +0000305 // Constants can be considered to be negated values if they can be folded...
306 if (Constant *C = dyn_cast<Constant>(V))
Chris Lattner34428442003-05-27 16:40:51 +0000307 return ConstantExpr::get(Instruction::Sub,
308 Constant::getNullValue(V->getType()), C);
Chris Lattnerbb74e222003-03-10 23:06:50 +0000309 return 0;
Chris Lattner9fa53de2002-05-06 16:49:18 +0000310}
311
Chris Lattnerc1e7cc02004-01-12 19:35:11 +0000312static Constant *NotConstant(Constant *C) {
313 return ConstantExpr::get(Instruction::Xor, C,
314 ConstantIntegral::getAllOnesValue(C->getType()));
315}
316
Chris Lattnerbb74e222003-03-10 23:06:50 +0000317static inline Value *dyn_castNotVal(Value *V) {
318 if (BinaryOperator::isNot(V))
319 return BinaryOperator::getNotArgument(cast<BinaryOperator>(V));
320
321 // Constants can be considered to be not'ed values...
Chris Lattnerdd65d862003-04-30 22:34:06 +0000322 if (ConstantIntegral *C = dyn_cast<ConstantIntegral>(V))
Chris Lattnerc1e7cc02004-01-12 19:35:11 +0000323 return NotConstant(C);
Chris Lattnerbb74e222003-03-10 23:06:50 +0000324 return 0;
325}
326
Chris Lattner7fb29e12003-03-11 00:12:48 +0000327// dyn_castFoldableMul - If this value is a multiply that can be folded into
328// other computations (because it has a constant operand), return the
329// non-constant operand of the multiply.
330//
331static inline Value *dyn_castFoldableMul(Value *V) {
Chris Lattnerf95d9b92003-10-15 16:48:29 +0000332 if (V->hasOneUse() && V->getType()->isInteger())
Chris Lattner7fb29e12003-03-11 00:12:48 +0000333 if (Instruction *I = dyn_cast<Instruction>(V))
334 if (I->getOpcode() == Instruction::Mul)
335 if (isa<Constant>(I->getOperand(1)))
336 return I->getOperand(0);
337 return 0;
Chris Lattner3082c5a2003-02-18 19:28:33 +0000338}
Chris Lattner31ae8632002-08-14 17:51:49 +0000339
Chris Lattner7fb29e12003-03-11 00:12:48 +0000340// dyn_castMaskingAnd - If this value is an And instruction masking a value with
341// a constant, return the constant being anded with.
342//
Chris Lattner01d56392003-08-12 19:17:27 +0000343template<class ValueType>
344static inline Constant *dyn_castMaskingAnd(ValueType *V) {
Chris Lattner7fb29e12003-03-11 00:12:48 +0000345 if (Instruction *I = dyn_cast<Instruction>(V))
346 if (I->getOpcode() == Instruction::And)
347 return dyn_cast<Constant>(I->getOperand(1));
348
349 // If this is a constant, it acts just like we were masking with it.
350 return dyn_cast<Constant>(V);
351}
Chris Lattner3082c5a2003-02-18 19:28:33 +0000352
353// Log2 - Calculate the log base 2 for the specified value if it is exactly a
354// power of 2.
355static unsigned Log2(uint64_t Val) {
356 assert(Val > 1 && "Values 0 and 1 should be handled elsewhere!");
357 unsigned Count = 0;
358 while (Val != 1) {
359 if (Val & 1) return 0; // Multiple bits set?
360 Val >>= 1;
361 ++Count;
362 }
363 return Count;
Chris Lattner31ae8632002-08-14 17:51:49 +0000364}
365
Chris Lattnerb8b97502003-08-13 19:01:45 +0000366
367/// AssociativeOpt - Perform an optimization on an associative operator. This
368/// function is designed to check a chain of associative operators for a
369/// potential to apply a certain optimization. Since the optimization may be
370/// applicable if the expression was reassociated, this checks the chain, then
371/// reassociates the expression as necessary to expose the optimization
372/// opportunity. This makes use of a special Functor, which must define
373/// 'shouldApply' and 'apply' methods.
374///
375template<typename Functor>
376Instruction *AssociativeOpt(BinaryOperator &Root, const Functor &F) {
377 unsigned Opcode = Root.getOpcode();
378 Value *LHS = Root.getOperand(0);
379
380 // Quick check, see if the immediate LHS matches...
381 if (F.shouldApply(LHS))
382 return F.apply(Root);
383
384 // Otherwise, if the LHS is not of the same opcode as the root, return.
385 Instruction *LHSI = dyn_cast<Instruction>(LHS);
Chris Lattnerf95d9b92003-10-15 16:48:29 +0000386 while (LHSI && LHSI->getOpcode() == Opcode && LHSI->hasOneUse()) {
Chris Lattnerb8b97502003-08-13 19:01:45 +0000387 // Should we apply this transform to the RHS?
388 bool ShouldApply = F.shouldApply(LHSI->getOperand(1));
389
390 // If not to the RHS, check to see if we should apply to the LHS...
391 if (!ShouldApply && F.shouldApply(LHSI->getOperand(0))) {
392 cast<BinaryOperator>(LHSI)->swapOperands(); // Make the LHS the RHS
393 ShouldApply = true;
394 }
395
396 // If the functor wants to apply the optimization to the RHS of LHSI,
397 // reassociate the expression from ((? op A) op B) to (? op (A op B))
398 if (ShouldApply) {
399 BasicBlock *BB = Root.getParent();
Chris Lattnerb8b97502003-08-13 19:01:45 +0000400
401 // Now all of the instructions are in the current basic block, go ahead
402 // and perform the reassociation.
403 Instruction *TmpLHSI = cast<Instruction>(Root.getOperand(0));
404
405 // First move the selected RHS to the LHS of the root...
406 Root.setOperand(0, LHSI->getOperand(1));
407
408 // Make what used to be the LHS of the root be the user of the root...
409 Value *ExtraOperand = TmpLHSI->getOperand(1);
Chris Lattner284d3b02004-04-16 18:08:07 +0000410 if (&Root == TmpLHSI) {
Chris Lattner8953b902004-04-05 02:10:19 +0000411 Root.replaceAllUsesWith(Constant::getNullValue(TmpLHSI->getType()));
412 return 0;
413 }
Chris Lattner284d3b02004-04-16 18:08:07 +0000414 Root.replaceAllUsesWith(TmpLHSI); // Users now use TmpLHSI
Chris Lattnerb8b97502003-08-13 19:01:45 +0000415 TmpLHSI->setOperand(1, &Root); // TmpLHSI now uses the root
Chris Lattner284d3b02004-04-16 18:08:07 +0000416 TmpLHSI->getParent()->getInstList().remove(TmpLHSI);
417 BasicBlock::iterator ARI = &Root; ++ARI;
418 BB->getInstList().insert(ARI, TmpLHSI); // Move TmpLHSI to after Root
419 ARI = Root;
Chris Lattnerb8b97502003-08-13 19:01:45 +0000420
421 // Now propagate the ExtraOperand down the chain of instructions until we
422 // get to LHSI.
423 while (TmpLHSI != LHSI) {
424 Instruction *NextLHSI = cast<Instruction>(TmpLHSI->getOperand(0));
Chris Lattner284d3b02004-04-16 18:08:07 +0000425 // Move the instruction to immediately before the chain we are
426 // constructing to avoid breaking dominance properties.
427 NextLHSI->getParent()->getInstList().remove(NextLHSI);
428 BB->getInstList().insert(ARI, NextLHSI);
429 ARI = NextLHSI;
430
Chris Lattnerb8b97502003-08-13 19:01:45 +0000431 Value *NextOp = NextLHSI->getOperand(1);
432 NextLHSI->setOperand(1, ExtraOperand);
433 TmpLHSI = NextLHSI;
434 ExtraOperand = NextOp;
435 }
436
437 // Now that the instructions are reassociated, have the functor perform
438 // the transformation...
439 return F.apply(Root);
440 }
441
442 LHSI = dyn_cast<Instruction>(LHSI->getOperand(0));
443 }
444 return 0;
445}
446
447
448// AddRHS - Implements: X + X --> X << 1
449struct AddRHS {
450 Value *RHS;
451 AddRHS(Value *rhs) : RHS(rhs) {}
452 bool shouldApply(Value *LHS) const { return LHS == RHS; }
453 Instruction *apply(BinaryOperator &Add) const {
454 return new ShiftInst(Instruction::Shl, Add.getOperand(0),
455 ConstantInt::get(Type::UByteTy, 1));
456 }
457};
458
459// AddMaskingAnd - Implements (A & C1)+(B & C2) --> (A & C1)|(B & C2)
460// iff C1&C2 == 0
461struct AddMaskingAnd {
462 Constant *C2;
463 AddMaskingAnd(Constant *c) : C2(c) {}
464 bool shouldApply(Value *LHS) const {
465 if (Constant *C1 = dyn_castMaskingAnd(LHS))
466 return ConstantExpr::get(Instruction::And, C1, C2)->isNullValue();
467 return false;
468 }
469 Instruction *apply(BinaryOperator &Add) const {
470 return BinaryOperator::create(Instruction::Or, Add.getOperand(0),
471 Add.getOperand(1));
472 }
473};
474
Chris Lattner183b3362004-04-09 19:05:30 +0000475static Value *FoldOperationIntoSelectOperand(Instruction &BI, Value *SO,
476 InstCombiner *IC) {
477 // Figure out if the constant is the left or the right argument.
478 bool ConstIsRHS = isa<Constant>(BI.getOperand(1));
479 Constant *ConstOperand = cast<Constant>(BI.getOperand(ConstIsRHS));
Chris Lattnerb8b97502003-08-13 19:01:45 +0000480
Chris Lattner183b3362004-04-09 19:05:30 +0000481 if (Constant *SOC = dyn_cast<Constant>(SO)) {
482 if (ConstIsRHS)
483 return ConstantExpr::get(BI.getOpcode(), SOC, ConstOperand);
484 return ConstantExpr::get(BI.getOpcode(), ConstOperand, SOC);
485 }
486
487 Value *Op0 = SO, *Op1 = ConstOperand;
488 if (!ConstIsRHS)
489 std::swap(Op0, Op1);
490 Instruction *New;
491 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(&BI))
492 New = BinaryOperator::create(BO->getOpcode(), Op0, Op1);
493 else if (ShiftInst *SI = dyn_cast<ShiftInst>(&BI))
494 New = new ShiftInst(SI->getOpcode(), Op0, Op1);
Chris Lattnerf9d96652004-04-10 19:15:56 +0000495 else {
Chris Lattner183b3362004-04-09 19:05:30 +0000496 assert(0 && "Unknown binary instruction type!");
Chris Lattnerf9d96652004-04-10 19:15:56 +0000497 abort();
498 }
Chris Lattner183b3362004-04-09 19:05:30 +0000499 return IC->InsertNewInstBefore(New, BI);
500}
501
502// FoldBinOpIntoSelect - Given an instruction with a select as one operand and a
503// constant as the other operand, try to fold the binary operator into the
504// select arguments.
505static Instruction *FoldBinOpIntoSelect(Instruction &BI, SelectInst *SI,
506 InstCombiner *IC) {
507 // Don't modify shared select instructions
508 if (!SI->hasOneUse()) return 0;
509 Value *TV = SI->getOperand(1);
510 Value *FV = SI->getOperand(2);
511
512 if (isa<Constant>(TV) || isa<Constant>(FV)) {
513 Value *SelectTrueVal = FoldOperationIntoSelectOperand(BI, TV, IC);
514 Value *SelectFalseVal = FoldOperationIntoSelectOperand(BI, FV, IC);
515
516 return new SelectInst(SI->getCondition(), SelectTrueVal,
517 SelectFalseVal);
518 }
519 return 0;
520}
Chris Lattnerb8b97502003-08-13 19:01:45 +0000521
Chris Lattner113f4f42002-06-25 16:13:24 +0000522Instruction *InstCombiner::visitAdd(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000523 bool Changed = SimplifyCommutative(I);
Chris Lattner113f4f42002-06-25 16:13:24 +0000524 Value *LHS = I.getOperand(0), *RHS = I.getOperand(1);
Chris Lattner9fa53de2002-05-06 16:49:18 +0000525
Chris Lattnercf4a9962004-04-10 22:01:55 +0000526 if (Constant *RHSC = dyn_cast<Constant>(RHS)) {
527 // X + 0 --> X
528 if (!I.getType()->isFloatingPoint() && // -0 + +0 = +0, so it's not a noop
529 RHSC->isNullValue())
530 return ReplaceInstUsesWith(I, LHS);
531
532 // X + (signbit) --> X ^ signbit
533 if (ConstantInt *CI = dyn_cast<ConstantInt>(RHSC)) {
534 unsigned NumBits = CI->getType()->getPrimitiveSize()*8;
535 uint64_t Val = CI->getRawValue() & (1ULL << NumBits)-1;
536 if (Val == (1ULL << NumBits-1))
537 return BinaryOperator::create(Instruction::Xor, LHS, RHS);
538 }
539 }
Chris Lattner9fa53de2002-05-06 16:49:18 +0000540
Chris Lattnerb8b97502003-08-13 19:01:45 +0000541 // X + X --> X << 1
542 if (I.getType()->isInteger())
543 if (Instruction *Result = AssociativeOpt(I, AddRHS(RHS))) return Result;
Chris Lattnerede3fe02003-08-13 04:18:28 +0000544
Chris Lattner147e9752002-05-08 22:46:53 +0000545 // -A + B --> B - A
Chris Lattnerbb74e222003-03-10 23:06:50 +0000546 if (Value *V = dyn_castNegVal(LHS))
Chris Lattner147e9752002-05-08 22:46:53 +0000547 return BinaryOperator::create(Instruction::Sub, RHS, V);
Chris Lattner9fa53de2002-05-06 16:49:18 +0000548
549 // A + -B --> A - B
Chris Lattnerbb74e222003-03-10 23:06:50 +0000550 if (!isa<Constant>(RHS))
551 if (Value *V = dyn_castNegVal(RHS))
552 return BinaryOperator::create(Instruction::Sub, LHS, V);
Chris Lattner260ab202002-04-18 17:39:14 +0000553
Chris Lattner57c8d992003-02-18 19:57:07 +0000554 // X*C + X --> X * (C+1)
555 if (dyn_castFoldableMul(LHS) == RHS) {
Chris Lattner34428442003-05-27 16:40:51 +0000556 Constant *CP1 =
557 ConstantExpr::get(Instruction::Add,
558 cast<Constant>(cast<Instruction>(LHS)->getOperand(1)),
559 ConstantInt::get(I.getType(), 1));
Chris Lattner57c8d992003-02-18 19:57:07 +0000560 return BinaryOperator::create(Instruction::Mul, RHS, CP1);
561 }
562
563 // X + X*C --> X * (C+1)
564 if (dyn_castFoldableMul(RHS) == LHS) {
Chris Lattner34428442003-05-27 16:40:51 +0000565 Constant *CP1 =
566 ConstantExpr::get(Instruction::Add,
567 cast<Constant>(cast<Instruction>(RHS)->getOperand(1)),
568 ConstantInt::get(I.getType(), 1));
Chris Lattner57c8d992003-02-18 19:57:07 +0000569 return BinaryOperator::create(Instruction::Mul, LHS, CP1);
570 }
571
Chris Lattnerb8b97502003-08-13 19:01:45 +0000572 // (A & C1)+(B & C2) --> (A & C1)|(B & C2) iff C1&C2 == 0
573 if (Constant *C2 = dyn_castMaskingAnd(RHS))
574 if (Instruction *R = AssociativeOpt(I, AddMaskingAnd(C2))) return R;
Chris Lattner7fb29e12003-03-11 00:12:48 +0000575
Chris Lattnerb9cde762003-10-02 15:11:26 +0000576 if (ConstantInt *CRHS = dyn_cast<ConstantInt>(RHS)) {
577 if (Instruction *ILHS = dyn_cast<Instruction>(LHS)) {
578 switch (ILHS->getOpcode()) {
579 case Instruction::Xor:
580 // ~X + C --> (C-1) - X
581 if (ConstantInt *XorRHS = dyn_cast<ConstantInt>(ILHS->getOperand(1)))
582 if (XorRHS->isAllOnesValue())
583 return BinaryOperator::create(Instruction::Sub,
Chris Lattnerc1e7cc02004-01-12 19:35:11 +0000584 ConstantExpr::get(Instruction::Sub,
585 CRHS, ConstantInt::get(I.getType(), 1)),
Chris Lattnerb9cde762003-10-02 15:11:26 +0000586 ILHS->getOperand(0));
587 break;
Chris Lattner183b3362004-04-09 19:05:30 +0000588 case Instruction::Select:
589 // Try to fold constant add into select arguments.
590 if (Instruction *R = FoldBinOpIntoSelect(I,cast<SelectInst>(ILHS),this))
591 return R;
592
Chris Lattnerb9cde762003-10-02 15:11:26 +0000593 default: break;
594 }
595 }
596 }
597
Chris Lattner113f4f42002-06-25 16:13:24 +0000598 return Changed ? &I : 0;
Chris Lattner260ab202002-04-18 17:39:14 +0000599}
600
Chris Lattnerbdb0ce02003-07-22 21:46:59 +0000601// isSignBit - Return true if the value represented by the constant only has the
602// highest order bit set.
603static bool isSignBit(ConstantInt *CI) {
604 unsigned NumBits = CI->getType()->getPrimitiveSize()*8;
605 return (CI->getRawValue() & ~(-1LL << NumBits)) == (1ULL << (NumBits-1));
606}
607
Chris Lattnerdfae8be2003-07-24 17:35:25 +0000608static unsigned getTypeSizeInBits(const Type *Ty) {
609 return Ty == Type::BoolTy ? 1 : Ty->getPrimitiveSize()*8;
610}
611
Chris Lattner022167f2004-03-13 00:11:49 +0000612/// RemoveNoopCast - Strip off nonconverting casts from the value.
613///
614static Value *RemoveNoopCast(Value *V) {
615 if (CastInst *CI = dyn_cast<CastInst>(V)) {
616 const Type *CTy = CI->getType();
617 const Type *OpTy = CI->getOperand(0)->getType();
618 if (CTy->isInteger() && OpTy->isInteger()) {
619 if (CTy->getPrimitiveSize() == OpTy->getPrimitiveSize())
620 return RemoveNoopCast(CI->getOperand(0));
621 } else if (isa<PointerType>(CTy) && isa<PointerType>(OpTy))
622 return RemoveNoopCast(CI->getOperand(0));
623 }
624 return V;
625}
626
Chris Lattner113f4f42002-06-25 16:13:24 +0000627Instruction *InstCombiner::visitSub(BinaryOperator &I) {
Chris Lattner113f4f42002-06-25 16:13:24 +0000628 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000629
Chris Lattnere6794492002-08-12 21:17:25 +0000630 if (Op0 == Op1) // sub X, X -> 0
631 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
Chris Lattner260ab202002-04-18 17:39:14 +0000632
Chris Lattnere6794492002-08-12 21:17:25 +0000633 // If this is a 'B = x-(-A)', change to B = x+A...
Chris Lattnerbb74e222003-03-10 23:06:50 +0000634 if (Value *V = dyn_castNegVal(Op1))
Chris Lattner147e9752002-05-08 22:46:53 +0000635 return BinaryOperator::create(Instruction::Add, Op0, V);
Chris Lattner9fa53de2002-05-06 16:49:18 +0000636
Chris Lattner8f2f5982003-11-05 01:06:05 +0000637 if (ConstantInt *C = dyn_cast<ConstantInt>(Op0)) {
638 // Replace (-1 - A) with (~A)...
Chris Lattner3082c5a2003-02-18 19:28:33 +0000639 if (C->isAllOnesValue())
640 return BinaryOperator::createNot(Op1);
Chris Lattnerad3c4952002-05-09 01:29:19 +0000641
Chris Lattner8f2f5982003-11-05 01:06:05 +0000642 // C - ~X == X + (1+C)
643 if (BinaryOperator::isNot(Op1))
644 return BinaryOperator::create(Instruction::Add,
Chris Lattnerc1e7cc02004-01-12 19:35:11 +0000645 BinaryOperator::getNotArgument(cast<BinaryOperator>(Op1)),
646 ConstantExpr::get(Instruction::Add, C,
647 ConstantInt::get(I.getType(), 1)));
Chris Lattner92295c52004-03-12 23:53:13 +0000648 // -((uint)X >> 31) -> ((int)X >> 31)
649 // -((int)X >> 31) -> ((uint)X >> 31)
Chris Lattner022167f2004-03-13 00:11:49 +0000650 if (C->isNullValue()) {
651 Value *NoopCastedRHS = RemoveNoopCast(Op1);
652 if (ShiftInst *SI = dyn_cast<ShiftInst>(NoopCastedRHS))
Chris Lattner92295c52004-03-12 23:53:13 +0000653 if (SI->getOpcode() == Instruction::Shr)
654 if (ConstantUInt *CU = dyn_cast<ConstantUInt>(SI->getOperand(1))) {
655 const Type *NewTy;
Chris Lattner022167f2004-03-13 00:11:49 +0000656 if (SI->getType()->isSigned())
657 NewTy = getUnsignedIntegralType(SI->getType());
Chris Lattner92295c52004-03-12 23:53:13 +0000658 else
Chris Lattner022167f2004-03-13 00:11:49 +0000659 NewTy = getSignedIntegralType(SI->getType());
Chris Lattner92295c52004-03-12 23:53:13 +0000660 // Check to see if we are shifting out everything but the sign bit.
Chris Lattner022167f2004-03-13 00:11:49 +0000661 if (CU->getValue() == SI->getType()->getPrimitiveSize()*8-1) {
Chris Lattner92295c52004-03-12 23:53:13 +0000662 // Ok, the transformation is safe. Insert a cast of the incoming
663 // value, then the new shift, then the new cast.
664 Instruction *FirstCast = new CastInst(SI->getOperand(0), NewTy,
665 SI->getOperand(0)->getName());
666 Value *InV = InsertNewInstBefore(FirstCast, I);
667 Instruction *NewShift = new ShiftInst(Instruction::Shr, FirstCast,
668 CU, SI->getName());
Chris Lattner022167f2004-03-13 00:11:49 +0000669 if (NewShift->getType() == I.getType())
670 return NewShift;
671 else {
672 InV = InsertNewInstBefore(NewShift, I);
673 return new CastInst(NewShift, I.getType());
674 }
Chris Lattner92295c52004-03-12 23:53:13 +0000675 }
676 }
Chris Lattner022167f2004-03-13 00:11:49 +0000677 }
Chris Lattner183b3362004-04-09 19:05:30 +0000678
679 // Try to fold constant sub into select arguments.
680 if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
681 if (Instruction *R = FoldBinOpIntoSelect(I, SI, this))
682 return R;
Chris Lattner8f2f5982003-11-05 01:06:05 +0000683 }
684
Chris Lattner3082c5a2003-02-18 19:28:33 +0000685 if (BinaryOperator *Op1I = dyn_cast<BinaryOperator>(Op1))
Chris Lattnerf95d9b92003-10-15 16:48:29 +0000686 if (Op1I->hasOneUse()) {
Chris Lattner3082c5a2003-02-18 19:28:33 +0000687 // Replace (x - (y - z)) with (x + (z - y)) if the (y - z) subexpression
688 // is not used by anyone else...
689 //
Chris Lattnerc2f0aa52004-02-02 20:09:56 +0000690 if (Op1I->getOpcode() == Instruction::Sub &&
691 !Op1I->getType()->isFloatingPoint()) {
Chris Lattner3082c5a2003-02-18 19:28:33 +0000692 // Swap the two operands of the subexpr...
693 Value *IIOp0 = Op1I->getOperand(0), *IIOp1 = Op1I->getOperand(1);
694 Op1I->setOperand(0, IIOp1);
695 Op1I->setOperand(1, IIOp0);
696
697 // Create the new top level add instruction...
698 return BinaryOperator::create(Instruction::Add, Op0, Op1);
699 }
700
701 // Replace (A - (A & B)) with (A & ~B) if this is the only use of (A&B)...
702 //
703 if (Op1I->getOpcode() == Instruction::And &&
704 (Op1I->getOperand(0) == Op0 || Op1I->getOperand(1) == Op0)) {
705 Value *OtherOp = Op1I->getOperand(Op1I->getOperand(0) == Op0);
706
707 Instruction *NewNot = BinaryOperator::createNot(OtherOp, "B.not", &I);
708 return BinaryOperator::create(Instruction::And, Op0, NewNot);
709 }
Chris Lattner57c8d992003-02-18 19:57:07 +0000710
711 // X - X*C --> X * (1-C)
712 if (dyn_castFoldableMul(Op1I) == Op0) {
Chris Lattner34428442003-05-27 16:40:51 +0000713 Constant *CP1 =
714 ConstantExpr::get(Instruction::Sub,
715 ConstantInt::get(I.getType(), 1),
716 cast<Constant>(cast<Instruction>(Op1)->getOperand(1)));
Chris Lattner57c8d992003-02-18 19:57:07 +0000717 assert(CP1 && "Couldn't constant fold 1-C?");
718 return BinaryOperator::create(Instruction::Mul, Op0, CP1);
719 }
Chris Lattnerad3c4952002-05-09 01:29:19 +0000720 }
Chris Lattner3082c5a2003-02-18 19:28:33 +0000721
Chris Lattner57c8d992003-02-18 19:57:07 +0000722 // X*C - X --> X * (C-1)
723 if (dyn_castFoldableMul(Op0) == Op1) {
Chris Lattner34428442003-05-27 16:40:51 +0000724 Constant *CP1 =
725 ConstantExpr::get(Instruction::Sub,
726 cast<Constant>(cast<Instruction>(Op0)->getOperand(1)),
727 ConstantInt::get(I.getType(), 1));
Chris Lattner57c8d992003-02-18 19:57:07 +0000728 assert(CP1 && "Couldn't constant fold C - 1?");
729 return BinaryOperator::create(Instruction::Mul, Op1, CP1);
730 }
731
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000732 return 0;
Chris Lattner260ab202002-04-18 17:39:14 +0000733}
734
Chris Lattnere79e8542004-02-23 06:38:22 +0000735/// isSignBitCheck - Given an exploded setcc instruction, return true if it is
736/// really just returns true if the most significant (sign) bit is set.
737static bool isSignBitCheck(unsigned Opcode, Value *LHS, ConstantInt *RHS) {
738 if (RHS->getType()->isSigned()) {
739 // True if source is LHS < 0 or LHS <= -1
740 return Opcode == Instruction::SetLT && RHS->isNullValue() ||
741 Opcode == Instruction::SetLE && RHS->isAllOnesValue();
742 } else {
743 ConstantUInt *RHSC = cast<ConstantUInt>(RHS);
744 // True if source is LHS > 127 or LHS >= 128, where the constants depend on
745 // the size of the integer type.
746 if (Opcode == Instruction::SetGE)
747 return RHSC->getValue() == 1ULL<<(RHS->getType()->getPrimitiveSize()*8-1);
748 if (Opcode == Instruction::SetGT)
749 return RHSC->getValue() ==
750 (1ULL << (RHS->getType()->getPrimitiveSize()*8-1))-1;
751 }
752 return false;
753}
754
Chris Lattner113f4f42002-06-25 16:13:24 +0000755Instruction *InstCombiner::visitMul(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +0000756 bool Changed = SimplifyCommutative(I);
Chris Lattner3082c5a2003-02-18 19:28:33 +0000757 Value *Op0 = I.getOperand(0);
Chris Lattner260ab202002-04-18 17:39:14 +0000758
Chris Lattnere6794492002-08-12 21:17:25 +0000759 // Simplify mul instructions with a constant RHS...
Chris Lattner3082c5a2003-02-18 19:28:33 +0000760 if (Constant *Op1 = dyn_cast<Constant>(I.getOperand(1))) {
761 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Chris Lattnerede3fe02003-08-13 04:18:28 +0000762
763 // ((X << C1)*C2) == (X * (C2 << C1))
764 if (ShiftInst *SI = dyn_cast<ShiftInst>(Op0))
765 if (SI->getOpcode() == Instruction::Shl)
766 if (Constant *ShOp = dyn_cast<Constant>(SI->getOperand(1)))
767 return BinaryOperator::create(Instruction::Mul, SI->getOperand(0),
Chris Lattnerc1e7cc02004-01-12 19:35:11 +0000768 ConstantExpr::get(Instruction::Shl, CI, ShOp));
769
Chris Lattnercce81be2003-09-11 22:24:54 +0000770 if (CI->isNullValue())
771 return ReplaceInstUsesWith(I, Op1); // X * 0 == 0
772 if (CI->equalsInt(1)) // X * 1 == X
773 return ReplaceInstUsesWith(I, Op0);
774 if (CI->isAllOnesValue()) // X * -1 == 0 - X
Chris Lattner35236d82003-06-25 17:09:20 +0000775 return BinaryOperator::createNeg(Op0, I.getName());
Chris Lattner31ba1292002-04-29 22:24:47 +0000776
Chris Lattnercce81be2003-09-11 22:24:54 +0000777 int64_t Val = (int64_t)cast<ConstantInt>(CI)->getRawValue();
Chris Lattner3082c5a2003-02-18 19:28:33 +0000778 if (uint64_t C = Log2(Val)) // Replace X*(2^C) with X << C
779 return new ShiftInst(Instruction::Shl, Op0,
780 ConstantUInt::get(Type::UByteTy, C));
781 } else {
782 ConstantFP *Op1F = cast<ConstantFP>(Op1);
783 if (Op1F->isNullValue())
784 return ReplaceInstUsesWith(I, Op1);
Chris Lattner31ba1292002-04-29 22:24:47 +0000785
Chris Lattner3082c5a2003-02-18 19:28:33 +0000786 // "In IEEE floating point, x*1 is not equivalent to x for nans. However,
787 // ANSI says we can drop signals, so we can do this anyway." (from GCC)
788 if (Op1F->getValue() == 1.0)
789 return ReplaceInstUsesWith(I, Op0); // Eliminate 'mul double %X, 1.0'
790 }
Chris Lattner183b3362004-04-09 19:05:30 +0000791
792 // Try to fold constant mul into select arguments.
793 if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
794 if (Instruction *R = FoldBinOpIntoSelect(I, SI, this))
795 return R;
Chris Lattner260ab202002-04-18 17:39:14 +0000796 }
797
Chris Lattner934a64cf2003-03-10 23:23:04 +0000798 if (Value *Op0v = dyn_castNegVal(Op0)) // -X * -Y = X*Y
799 if (Value *Op1v = dyn_castNegVal(I.getOperand(1)))
800 return BinaryOperator::create(Instruction::Mul, Op0v, Op1v);
801
Chris Lattner2635b522004-02-23 05:39:21 +0000802 // If one of the operands of the multiply is a cast from a boolean value, then
803 // we know the bool is either zero or one, so this is a 'masking' multiply.
804 // See if we can simplify things based on how the boolean was originally
805 // formed.
806 CastInst *BoolCast = 0;
807 if (CastInst *CI = dyn_cast<CastInst>(I.getOperand(0)))
808 if (CI->getOperand(0)->getType() == Type::BoolTy)
809 BoolCast = CI;
810 if (!BoolCast)
811 if (CastInst *CI = dyn_cast<CastInst>(I.getOperand(1)))
812 if (CI->getOperand(0)->getType() == Type::BoolTy)
813 BoolCast = CI;
814 if (BoolCast) {
815 if (SetCondInst *SCI = dyn_cast<SetCondInst>(BoolCast->getOperand(0))) {
816 Value *SCIOp0 = SCI->getOperand(0), *SCIOp1 = SCI->getOperand(1);
817 const Type *SCOpTy = SCIOp0->getType();
818
Chris Lattnere79e8542004-02-23 06:38:22 +0000819 // If the setcc is true iff the sign bit of X is set, then convert this
820 // multiply into a shift/and combination.
821 if (isa<ConstantInt>(SCIOp1) &&
822 isSignBitCheck(SCI->getOpcode(), SCIOp0, cast<ConstantInt>(SCIOp1))) {
Chris Lattner2635b522004-02-23 05:39:21 +0000823 // Shift the X value right to turn it into "all signbits".
824 Constant *Amt = ConstantUInt::get(Type::UByteTy,
825 SCOpTy->getPrimitiveSize()*8-1);
Chris Lattnere79e8542004-02-23 06:38:22 +0000826 if (SCIOp0->getType()->isUnsigned()) {
827 const Type *NewTy = getSignedIntegralType(SCIOp0->getType());
828 SCIOp0 = InsertNewInstBefore(new CastInst(SCIOp0, NewTy,
829 SCIOp0->getName()), I);
830 }
831
832 Value *V =
833 InsertNewInstBefore(new ShiftInst(Instruction::Shr, SCIOp0, Amt,
834 BoolCast->getOperand(0)->getName()+
835 ".mask"), I);
Chris Lattner2635b522004-02-23 05:39:21 +0000836
837 // If the multiply type is not the same as the source type, sign extend
838 // or truncate to the multiply type.
839 if (I.getType() != V->getType())
Chris Lattnere79e8542004-02-23 06:38:22 +0000840 V = InsertNewInstBefore(new CastInst(V, I.getType(), V->getName()),I);
Chris Lattner2635b522004-02-23 05:39:21 +0000841
842 Value *OtherOp = Op0 == BoolCast ? I.getOperand(1) : Op0;
843 return BinaryOperator::create(Instruction::And, V, OtherOp);
844 }
845 }
846 }
847
Chris Lattner113f4f42002-06-25 16:13:24 +0000848 return Changed ? &I : 0;
Chris Lattner260ab202002-04-18 17:39:14 +0000849}
850
Chris Lattner113f4f42002-06-25 16:13:24 +0000851Instruction *InstCombiner::visitDiv(BinaryOperator &I) {
Chris Lattner3082c5a2003-02-18 19:28:33 +0000852 if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1))) {
Chris Lattnere20c3342004-04-26 14:01:59 +0000853 // div X, 1 == X
Chris Lattnere6794492002-08-12 21:17:25 +0000854 if (RHS->equalsInt(1))
855 return ReplaceInstUsesWith(I, I.getOperand(0));
Chris Lattner3082c5a2003-02-18 19:28:33 +0000856
Chris Lattnere20c3342004-04-26 14:01:59 +0000857 // div X, -1 == -X
858 if (RHS->isAllOnesValue())
859 return BinaryOperator::createNeg(I.getOperand(0));
860
Chris Lattner3082c5a2003-02-18 19:28:33 +0000861 // Check to see if this is an unsigned division with an exact power of 2,
862 // if so, convert to a right shift.
863 if (ConstantUInt *C = dyn_cast<ConstantUInt>(RHS))
864 if (uint64_t Val = C->getValue()) // Don't break X / 0
865 if (uint64_t C = Log2(Val))
866 return new ShiftInst(Instruction::Shr, I.getOperand(0),
867 ConstantUInt::get(Type::UByteTy, C));
868 }
869
870 // 0 / X == 0, we don't need to preserve faults!
871 if (ConstantInt *LHS = dyn_cast<ConstantInt>(I.getOperand(0)))
872 if (LHS->equalsInt(0))
873 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
874
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000875 return 0;
876}
877
878
Chris Lattner113f4f42002-06-25 16:13:24 +0000879Instruction *InstCombiner::visitRem(BinaryOperator &I) {
Chris Lattner3082c5a2003-02-18 19:28:33 +0000880 if (ConstantInt *RHS = dyn_cast<ConstantInt>(I.getOperand(1))) {
881 if (RHS->equalsInt(1)) // X % 1 == 0
882 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
Chris Lattner56b50512004-03-26 16:11:24 +0000883 if (RHS->isAllOnesValue()) // X % -1 == 0
884 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
Chris Lattner3082c5a2003-02-18 19:28:33 +0000885
886 // Check to see if this is an unsigned remainder with an exact power of 2,
887 // if so, convert to a bitwise and.
888 if (ConstantUInt *C = dyn_cast<ConstantUInt>(RHS))
889 if (uint64_t Val = C->getValue()) // Don't break X % 0 (divide by zero)
Chris Lattnerd9e58132004-05-07 15:35:56 +0000890 if (!(Val & (Val-1))) // Power of 2
Chris Lattner3082c5a2003-02-18 19:28:33 +0000891 return BinaryOperator::create(Instruction::And, I.getOperand(0),
892 ConstantUInt::get(I.getType(), Val-1));
893 }
894
895 // 0 % X == 0, we don't need to preserve faults!
896 if (ConstantInt *LHS = dyn_cast<ConstantInt>(I.getOperand(0)))
897 if (LHS->equalsInt(0))
Chris Lattnere6794492002-08-12 21:17:25 +0000898 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
899
Chris Lattnerf4cdbf32002-05-06 16:14:14 +0000900 return 0;
901}
902
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000903// isMaxValueMinusOne - return true if this is Max-1
Chris Lattnere6794492002-08-12 21:17:25 +0000904static bool isMaxValueMinusOne(const ConstantInt *C) {
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000905 if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(C)) {
906 // Calculate -1 casted to the right type...
907 unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
908 uint64_t Val = ~0ULL; // All ones
909 Val >>= 64-TypeBits; // Shift out unwanted 1 bits...
910 return CU->getValue() == Val-1;
911 }
912
913 const ConstantSInt *CS = cast<ConstantSInt>(C);
914
915 // Calculate 0111111111..11111
916 unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
917 int64_t Val = INT64_MAX; // All ones
918 Val >>= 64-TypeBits; // Shift out unwanted 1 bits...
919 return CS->getValue() == Val-1;
920}
921
922// isMinValuePlusOne - return true if this is Min+1
Chris Lattnere6794492002-08-12 21:17:25 +0000923static bool isMinValuePlusOne(const ConstantInt *C) {
Chris Lattner6d14f2a2002-08-09 23:47:40 +0000924 if (const ConstantUInt *CU = dyn_cast<ConstantUInt>(C))
925 return CU->getValue() == 1;
926
927 const ConstantSInt *CS = cast<ConstantSInt>(C);
928
929 // Calculate 1111111111000000000000
930 unsigned TypeBits = C->getType()->getPrimitiveSize()*8;
931 int64_t Val = -1; // All ones
932 Val <<= TypeBits-1; // Shift over to the right spot
933 return CS->getValue() == Val+1;
934}
935
Chris Lattner3ac7c262003-08-13 20:16:26 +0000936/// getSetCondCode - Encode a setcc opcode into a three bit mask. These bits
937/// are carefully arranged to allow folding of expressions such as:
938///
939/// (A < B) | (A > B) --> (A != B)
940///
941/// Bit value '4' represents that the comparison is true if A > B, bit value '2'
942/// represents that the comparison is true if A == B, and bit value '1' is true
943/// if A < B.
944///
945static unsigned getSetCondCode(const SetCondInst *SCI) {
946 switch (SCI->getOpcode()) {
947 // False -> 0
948 case Instruction::SetGT: return 1;
949 case Instruction::SetEQ: return 2;
950 case Instruction::SetGE: return 3;
951 case Instruction::SetLT: return 4;
952 case Instruction::SetNE: return 5;
953 case Instruction::SetLE: return 6;
954 // True -> 7
955 default:
956 assert(0 && "Invalid SetCC opcode!");
957 return 0;
958 }
959}
960
961/// getSetCCValue - This is the complement of getSetCondCode, which turns an
962/// opcode and two operands into either a constant true or false, or a brand new
963/// SetCC instruction.
964static Value *getSetCCValue(unsigned Opcode, Value *LHS, Value *RHS) {
965 switch (Opcode) {
966 case 0: return ConstantBool::False;
967 case 1: return new SetCondInst(Instruction::SetGT, LHS, RHS);
968 case 2: return new SetCondInst(Instruction::SetEQ, LHS, RHS);
969 case 3: return new SetCondInst(Instruction::SetGE, LHS, RHS);
970 case 4: return new SetCondInst(Instruction::SetLT, LHS, RHS);
971 case 5: return new SetCondInst(Instruction::SetNE, LHS, RHS);
972 case 6: return new SetCondInst(Instruction::SetLE, LHS, RHS);
973 case 7: return ConstantBool::True;
974 default: assert(0 && "Illegal SetCCCode!"); return 0;
975 }
976}
977
978// FoldSetCCLogical - Implements (setcc1 A, B) & (setcc2 A, B) --> (setcc3 A, B)
979struct FoldSetCCLogical {
980 InstCombiner &IC;
981 Value *LHS, *RHS;
982 FoldSetCCLogical(InstCombiner &ic, SetCondInst *SCI)
983 : IC(ic), LHS(SCI->getOperand(0)), RHS(SCI->getOperand(1)) {}
984 bool shouldApply(Value *V) const {
985 if (SetCondInst *SCI = dyn_cast<SetCondInst>(V))
986 return (SCI->getOperand(0) == LHS && SCI->getOperand(1) == RHS ||
987 SCI->getOperand(0) == RHS && SCI->getOperand(1) == LHS);
988 return false;
989 }
990 Instruction *apply(BinaryOperator &Log) const {
991 SetCondInst *SCI = cast<SetCondInst>(Log.getOperand(0));
992 if (SCI->getOperand(0) != LHS) {
993 assert(SCI->getOperand(1) == LHS);
994 SCI->swapOperands(); // Swap the LHS and RHS of the SetCC
995 }
996
997 unsigned LHSCode = getSetCondCode(SCI);
998 unsigned RHSCode = getSetCondCode(cast<SetCondInst>(Log.getOperand(1)));
999 unsigned Code;
1000 switch (Log.getOpcode()) {
1001 case Instruction::And: Code = LHSCode & RHSCode; break;
1002 case Instruction::Or: Code = LHSCode | RHSCode; break;
1003 case Instruction::Xor: Code = LHSCode ^ RHSCode; break;
Chris Lattner2caaaba2003-09-22 20:33:34 +00001004 default: assert(0 && "Illegal logical opcode!"); return 0;
Chris Lattner3ac7c262003-08-13 20:16:26 +00001005 }
1006
1007 Value *RV = getSetCCValue(Code, LHS, RHS);
1008 if (Instruction *I = dyn_cast<Instruction>(RV))
1009 return I;
1010 // Otherwise, it's a constant boolean value...
1011 return IC.ReplaceInstUsesWith(Log, RV);
1012 }
1013};
1014
1015
Chris Lattnerba1cb382003-09-19 17:17:26 +00001016// OptAndOp - This handles expressions of the form ((val OP C1) & C2). Where
1017// the Op parameter is 'OP', OpRHS is 'C1', and AndRHS is 'C2'. Op is
1018// guaranteed to be either a shift instruction or a binary operator.
1019Instruction *InstCombiner::OptAndOp(Instruction *Op,
1020 ConstantIntegral *OpRHS,
1021 ConstantIntegral *AndRHS,
1022 BinaryOperator &TheAnd) {
1023 Value *X = Op->getOperand(0);
Chris Lattnerfcf21a72004-01-12 19:47:05 +00001024 Constant *Together = 0;
1025 if (!isa<ShiftInst>(Op))
1026 Together = ConstantExpr::get(Instruction::And, AndRHS, OpRHS);
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001027
Chris Lattnerba1cb382003-09-19 17:17:26 +00001028 switch (Op->getOpcode()) {
1029 case Instruction::Xor:
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001030 if (Together->isNullValue()) {
Chris Lattnerba1cb382003-09-19 17:17:26 +00001031 // (X ^ C1) & C2 --> (X & C2) iff (C1&C2) == 0
1032 return BinaryOperator::create(Instruction::And, X, AndRHS);
Chris Lattnerf95d9b92003-10-15 16:48:29 +00001033 } else if (Op->hasOneUse()) {
Chris Lattnerba1cb382003-09-19 17:17:26 +00001034 // (X ^ C1) & C2 --> (X & C2) ^ (C1&C2)
1035 std::string OpName = Op->getName(); Op->setName("");
1036 Instruction *And = BinaryOperator::create(Instruction::And,
1037 X, AndRHS, OpName);
1038 InsertNewInstBefore(And, TheAnd);
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001039 return BinaryOperator::create(Instruction::Xor, And, Together);
Chris Lattnerba1cb382003-09-19 17:17:26 +00001040 }
1041 break;
1042 case Instruction::Or:
1043 // (X | C1) & C2 --> X & C2 iff C1 & C1 == 0
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001044 if (Together->isNullValue())
Chris Lattnerba1cb382003-09-19 17:17:26 +00001045 return BinaryOperator::create(Instruction::And, X, AndRHS);
1046 else {
Chris Lattnerba1cb382003-09-19 17:17:26 +00001047 if (Together == AndRHS) // (X | C) & C --> C
1048 return ReplaceInstUsesWith(TheAnd, AndRHS);
1049
Chris Lattnerf95d9b92003-10-15 16:48:29 +00001050 if (Op->hasOneUse() && Together != OpRHS) {
Chris Lattnerba1cb382003-09-19 17:17:26 +00001051 // (X | C1) & C2 --> (X | (C1&C2)) & C2
1052 std::string Op0Name = Op->getName(); Op->setName("");
1053 Instruction *Or = BinaryOperator::create(Instruction::Or, X,
1054 Together, Op0Name);
1055 InsertNewInstBefore(Or, TheAnd);
1056 return BinaryOperator::create(Instruction::And, Or, AndRHS);
1057 }
1058 }
1059 break;
1060 case Instruction::Add:
Chris Lattnerf95d9b92003-10-15 16:48:29 +00001061 if (Op->hasOneUse()) {
Chris Lattnerba1cb382003-09-19 17:17:26 +00001062 // Adding a one to a single bit bit-field should be turned into an XOR
1063 // of the bit. First thing to check is to see if this AND is with a
1064 // single bit constant.
1065 unsigned long long AndRHSV = cast<ConstantInt>(AndRHS)->getRawValue();
1066
1067 // Clear bits that are not part of the constant.
1068 AndRHSV &= (1ULL << AndRHS->getType()->getPrimitiveSize()*8)-1;
1069
1070 // If there is only one bit set...
1071 if ((AndRHSV & (AndRHSV-1)) == 0) {
1072 // Ok, at this point, we know that we are masking the result of the
1073 // ADD down to exactly one bit. If the constant we are adding has
1074 // no bits set below this bit, then we can eliminate the ADD.
1075 unsigned long long AddRHS = cast<ConstantInt>(OpRHS)->getRawValue();
1076
1077 // Check to see if any bits below the one bit set in AndRHSV are set.
1078 if ((AddRHS & (AndRHSV-1)) == 0) {
1079 // If not, the only thing that can effect the output of the AND is
1080 // the bit specified by AndRHSV. If that bit is set, the effect of
1081 // the XOR is to toggle the bit. If it is clear, then the ADD has
1082 // no effect.
1083 if ((AddRHS & AndRHSV) == 0) { // Bit is not set, noop
1084 TheAnd.setOperand(0, X);
1085 return &TheAnd;
1086 } else {
1087 std::string Name = Op->getName(); Op->setName("");
1088 // Pull the XOR out of the AND.
1089 Instruction *NewAnd =
1090 BinaryOperator::create(Instruction::And, X, AndRHS, Name);
1091 InsertNewInstBefore(NewAnd, TheAnd);
1092 return BinaryOperator::create(Instruction::Xor, NewAnd, AndRHS);
1093 }
1094 }
1095 }
1096 }
1097 break;
Chris Lattner2da29172003-09-19 19:05:02 +00001098
1099 case Instruction::Shl: {
1100 // We know that the AND will not produce any of the bits shifted in, so if
1101 // the anded constant includes them, clear them now!
1102 //
1103 Constant *AllOne = ConstantIntegral::getAllOnesValue(AndRHS->getType());
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001104 Constant *CI = ConstantExpr::get(Instruction::And, AndRHS,
1105 ConstantExpr::get(Instruction::Shl, AllOne, OpRHS));
Chris Lattner2da29172003-09-19 19:05:02 +00001106 if (CI != AndRHS) {
1107 TheAnd.setOperand(1, CI);
1108 return &TheAnd;
1109 }
1110 break;
1111 }
1112 case Instruction::Shr:
1113 // We know that the AND will not produce any of the bits shifted in, so if
1114 // the anded constant includes them, clear them now! This only applies to
1115 // unsigned shifts, because a signed shr may bring in set bits!
1116 //
1117 if (AndRHS->getType()->isUnsigned()) {
1118 Constant *AllOne = ConstantIntegral::getAllOnesValue(AndRHS->getType());
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001119 Constant *CI = ConstantExpr::get(Instruction::And, AndRHS,
1120 ConstantExpr::get(Instruction::Shr, AllOne, OpRHS));
Chris Lattner2da29172003-09-19 19:05:02 +00001121 if (CI != AndRHS) {
1122 TheAnd.setOperand(1, CI);
1123 return &TheAnd;
1124 }
1125 }
1126 break;
Chris Lattnerba1cb382003-09-19 17:17:26 +00001127 }
1128 return 0;
1129}
1130
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001131
Chris Lattner113f4f42002-06-25 16:13:24 +00001132Instruction *InstCombiner::visitAnd(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +00001133 bool Changed = SimplifyCommutative(I);
Chris Lattner113f4f42002-06-25 16:13:24 +00001134 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001135
1136 // and X, X = X and X, 0 == 0
Chris Lattnere6794492002-08-12 21:17:25 +00001137 if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType()))
1138 return ReplaceInstUsesWith(I, Op1);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001139
1140 // and X, -1 == X
Chris Lattner49b47ae2003-07-23 17:57:01 +00001141 if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1)) {
Chris Lattnere6794492002-08-12 21:17:25 +00001142 if (RHS->isAllOnesValue())
1143 return ReplaceInstUsesWith(I, Op0);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001144
Chris Lattnerba1cb382003-09-19 17:17:26 +00001145 // Optimize a variety of ((val OP C1) & C2) combinations...
1146 if (isa<BinaryOperator>(Op0) || isa<ShiftInst>(Op0)) {
1147 Instruction *Op0I = cast<Instruction>(Op0);
Chris Lattner33217db2003-07-23 19:36:21 +00001148 Value *X = Op0I->getOperand(0);
Chris Lattner16464b32003-07-23 19:25:52 +00001149 if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1)))
Chris Lattnerba1cb382003-09-19 17:17:26 +00001150 if (Instruction *Res = OptAndOp(Op0I, Op0CI, RHS, I))
1151 return Res;
Chris Lattner33217db2003-07-23 19:36:21 +00001152 }
Chris Lattner183b3362004-04-09 19:05:30 +00001153
1154 // Try to fold constant and into select arguments.
1155 if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
1156 if (Instruction *R = FoldBinOpIntoSelect(I, SI, this))
1157 return R;
Chris Lattner49b47ae2003-07-23 17:57:01 +00001158 }
1159
Chris Lattnerbb74e222003-03-10 23:06:50 +00001160 Value *Op0NotVal = dyn_castNotVal(Op0);
1161 Value *Op1NotVal = dyn_castNotVal(Op1);
Chris Lattner3082c5a2003-02-18 19:28:33 +00001162
1163 // (~A & ~B) == (~(A | B)) - Demorgan's Law
Chris Lattnerbb74e222003-03-10 23:06:50 +00001164 if (Op0NotVal && Op1NotVal && isOnlyUse(Op0) && isOnlyUse(Op1)) {
Chris Lattner3082c5a2003-02-18 19:28:33 +00001165 Instruction *Or = BinaryOperator::create(Instruction::Or, Op0NotVal,
Chris Lattner49b47ae2003-07-23 17:57:01 +00001166 Op1NotVal,I.getName()+".demorgan");
1167 InsertNewInstBefore(Or, I);
Chris Lattner3082c5a2003-02-18 19:28:33 +00001168 return BinaryOperator::createNot(Or);
1169 }
1170
1171 if (Op0NotVal == Op1 || Op1NotVal == Op0) // A & ~A == ~A & A == 0
1172 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
Chris Lattner65217ff2002-08-23 18:32:43 +00001173
Chris Lattner3ac7c262003-08-13 20:16:26 +00001174 // (setcc1 A, B) & (setcc2 A, B) --> (setcc3 A, B)
1175 if (SetCondInst *RHS = dyn_cast<SetCondInst>(I.getOperand(1)))
1176 if (Instruction *R = AssociativeOpt(I, FoldSetCCLogical(*this, RHS)))
1177 return R;
1178
Chris Lattner113f4f42002-06-25 16:13:24 +00001179 return Changed ? &I : 0;
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001180}
1181
1182
1183
Chris Lattner113f4f42002-06-25 16:13:24 +00001184Instruction *InstCombiner::visitOr(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +00001185 bool Changed = SimplifyCommutative(I);
Chris Lattner113f4f42002-06-25 16:13:24 +00001186 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001187
1188 // or X, X = X or X, 0 == X
Chris Lattnere6794492002-08-12 21:17:25 +00001189 if (Op0 == Op1 || Op1 == Constant::getNullValue(I.getType()))
1190 return ReplaceInstUsesWith(I, Op0);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001191
1192 // or X, -1 == -1
Chris Lattner8f0d1562003-07-23 18:29:44 +00001193 if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1)) {
Chris Lattnere6794492002-08-12 21:17:25 +00001194 if (RHS->isAllOnesValue())
1195 return ReplaceInstUsesWith(I, Op1);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001196
Chris Lattner8f0d1562003-07-23 18:29:44 +00001197 if (Instruction *Op0I = dyn_cast<Instruction>(Op0)) {
1198 // (X & C1) | C2 --> (X | C2) & (C1|C2)
1199 if (Op0I->getOpcode() == Instruction::And && isOnlyUse(Op0))
1200 if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1))) {
1201 std::string Op0Name = Op0I->getName(); Op0I->setName("");
1202 Instruction *Or = BinaryOperator::create(Instruction::Or,
1203 Op0I->getOperand(0), RHS,
1204 Op0Name);
1205 InsertNewInstBefore(Or, I);
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001206 return BinaryOperator::create(Instruction::And, Or,
1207 ConstantExpr::get(Instruction::Or, RHS, Op0CI));
Chris Lattner8f0d1562003-07-23 18:29:44 +00001208 }
1209
1210 // (X ^ C1) | C2 --> (X | C2) ^ (C1&~C2)
1211 if (Op0I->getOpcode() == Instruction::Xor && isOnlyUse(Op0))
1212 if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1))) {
1213 std::string Op0Name = Op0I->getName(); Op0I->setName("");
1214 Instruction *Or = BinaryOperator::create(Instruction::Or,
1215 Op0I->getOperand(0), RHS,
1216 Op0Name);
1217 InsertNewInstBefore(Or, I);
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001218 return BinaryOperator::create(Instruction::Xor, Or,
1219 ConstantExpr::get(Instruction::And, Op0CI,
1220 NotConstant(RHS)));
Chris Lattner8f0d1562003-07-23 18:29:44 +00001221 }
1222 }
Chris Lattner183b3362004-04-09 19:05:30 +00001223
1224 // Try to fold constant and into select arguments.
1225 if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
1226 if (Instruction *R = FoldBinOpIntoSelect(I, SI, this))
1227 return R;
Chris Lattner8f0d1562003-07-23 18:29:44 +00001228 }
1229
Chris Lattner812aab72003-08-12 19:11:07 +00001230 // (A & C1)|(A & C2) == A & (C1|C2)
Chris Lattner01d56392003-08-12 19:17:27 +00001231 if (Instruction *LHS = dyn_cast<BinaryOperator>(Op0))
1232 if (Instruction *RHS = dyn_cast<BinaryOperator>(Op1))
1233 if (LHS->getOperand(0) == RHS->getOperand(0))
1234 if (Constant *C0 = dyn_castMaskingAnd(LHS))
1235 if (Constant *C1 = dyn_castMaskingAnd(RHS))
1236 return BinaryOperator::create(Instruction::And, LHS->getOperand(0),
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001237 ConstantExpr::get(Instruction::Or, C0, C1));
Chris Lattner812aab72003-08-12 19:11:07 +00001238
Chris Lattner3e327a42003-03-10 23:13:59 +00001239 Value *Op0NotVal = dyn_castNotVal(Op0);
1240 Value *Op1NotVal = dyn_castNotVal(Op1);
Chris Lattner3082c5a2003-02-18 19:28:33 +00001241
Chris Lattner3e327a42003-03-10 23:13:59 +00001242 if (Op1 == Op0NotVal) // ~A | A == -1
1243 return ReplaceInstUsesWith(I,
1244 ConstantIntegral::getAllOnesValue(I.getType()));
1245
1246 if (Op0 == Op1NotVal) // A | ~A == -1
1247 return ReplaceInstUsesWith(I,
1248 ConstantIntegral::getAllOnesValue(I.getType()));
1249
1250 // (~A | ~B) == (~(A & B)) - Demorgan's Law
1251 if (Op0NotVal && Op1NotVal && isOnlyUse(Op0) && isOnlyUse(Op1)) {
1252 Instruction *And = BinaryOperator::create(Instruction::And, Op0NotVal,
1253 Op1NotVal,I.getName()+".demorgan",
1254 &I);
1255 WorkList.push_back(And);
1256 return BinaryOperator::createNot(And);
1257 }
Chris Lattner3082c5a2003-02-18 19:28:33 +00001258
Chris Lattner3ac7c262003-08-13 20:16:26 +00001259 // (setcc1 A, B) | (setcc2 A, B) --> (setcc3 A, B)
1260 if (SetCondInst *RHS = dyn_cast<SetCondInst>(I.getOperand(1)))
1261 if (Instruction *R = AssociativeOpt(I, FoldSetCCLogical(*this, RHS)))
1262 return R;
1263
Chris Lattner113f4f42002-06-25 16:13:24 +00001264 return Changed ? &I : 0;
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001265}
1266
Chris Lattnerc2076352004-02-16 01:20:27 +00001267// XorSelf - Implements: X ^ X --> 0
1268struct XorSelf {
1269 Value *RHS;
1270 XorSelf(Value *rhs) : RHS(rhs) {}
1271 bool shouldApply(Value *LHS) const { return LHS == RHS; }
1272 Instruction *apply(BinaryOperator &Xor) const {
1273 return &Xor;
1274 }
1275};
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001276
1277
Chris Lattner113f4f42002-06-25 16:13:24 +00001278Instruction *InstCombiner::visitXor(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +00001279 bool Changed = SimplifyCommutative(I);
Chris Lattner113f4f42002-06-25 16:13:24 +00001280 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001281
Chris Lattnerc2076352004-02-16 01:20:27 +00001282 // xor X, X = 0, even if X is nested in a sequence of Xor's.
1283 if (Instruction *Result = AssociativeOpt(I, XorSelf(Op1))) {
1284 assert(Result == &I && "AssociativeOpt didn't work?");
Chris Lattnere6794492002-08-12 21:17:25 +00001285 return ReplaceInstUsesWith(I, Constant::getNullValue(I.getType()));
Chris Lattnerc2076352004-02-16 01:20:27 +00001286 }
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001287
Chris Lattner97638592003-07-23 21:37:07 +00001288 if (ConstantIntegral *RHS = dyn_cast<ConstantIntegral>(Op1)) {
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001289 // xor X, 0 == X
Chris Lattner97638592003-07-23 21:37:07 +00001290 if (RHS->isNullValue())
Chris Lattnere6794492002-08-12 21:17:25 +00001291 return ReplaceInstUsesWith(I, Op0);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001292
Chris Lattner97638592003-07-23 21:37:07 +00001293 if (BinaryOperator *Op0I = dyn_cast<BinaryOperator>(Op0)) {
Chris Lattnerb8d6e402002-08-20 18:24:26 +00001294 // xor (setcc A, B), true = not (setcc A, B) = setncc A, B
Chris Lattner97638592003-07-23 21:37:07 +00001295 if (SetCondInst *SCI = dyn_cast<SetCondInst>(Op0I))
Chris Lattnerf95d9b92003-10-15 16:48:29 +00001296 if (RHS == ConstantBool::True && SCI->hasOneUse())
Chris Lattnerb8d6e402002-08-20 18:24:26 +00001297 return new SetCondInst(SCI->getInverseCondition(),
1298 SCI->getOperand(0), SCI->getOperand(1));
Chris Lattnere5806662003-11-04 23:50:51 +00001299
Chris Lattner8f2f5982003-11-05 01:06:05 +00001300 // ~(c-X) == X-c-1 == X+(-c-1)
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001301 if (Op0I->getOpcode() == Instruction::Sub && RHS->isAllOnesValue())
1302 if (Constant *Op0I0C = dyn_cast<Constant>(Op0I->getOperand(0))) {
1303 Constant *NegOp0I0C = ConstantExpr::get(Instruction::Sub,
1304 Constant::getNullValue(Op0I0C->getType()), Op0I0C);
1305 Constant *ConstantRHS = ConstantExpr::get(Instruction::Sub, NegOp0I0C,
1306 ConstantInt::get(I.getType(), 1));
1307 return BinaryOperator::create(Instruction::Add, Op0I->getOperand(1),
1308 ConstantRHS);
1309 }
Chris Lattner97638592003-07-23 21:37:07 +00001310
1311 if (ConstantInt *Op0CI = dyn_cast<ConstantInt>(Op0I->getOperand(1)))
Chris Lattnere5806662003-11-04 23:50:51 +00001312 switch (Op0I->getOpcode()) {
1313 case Instruction::Add:
Chris Lattner0f68fa62003-11-04 23:37:10 +00001314 // ~(X-c) --> (-c-1)-X
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001315 if (RHS->isAllOnesValue()) {
1316 Constant *NegOp0CI = ConstantExpr::get(Instruction::Sub,
1317 Constant::getNullValue(Op0CI->getType()), Op0CI);
Chris Lattner0f68fa62003-11-04 23:37:10 +00001318 return BinaryOperator::create(Instruction::Sub,
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001319 ConstantExpr::get(Instruction::Sub, NegOp0CI,
1320 ConstantInt::get(I.getType(), 1)),
Chris Lattner0f68fa62003-11-04 23:37:10 +00001321 Op0I->getOperand(0));
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001322 }
Chris Lattnere5806662003-11-04 23:50:51 +00001323 break;
1324 case Instruction::And:
Chris Lattner97638592003-07-23 21:37:07 +00001325 // (X & C1) ^ C2 --> (X & C1) | C2 iff (C1&C2) == 0
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001326 if (ConstantExpr::get(Instruction::And, RHS, Op0CI)->isNullValue())
Chris Lattner97638592003-07-23 21:37:07 +00001327 return BinaryOperator::create(Instruction::Or, Op0, RHS);
Chris Lattnere5806662003-11-04 23:50:51 +00001328 break;
1329 case Instruction::Or:
Chris Lattner97638592003-07-23 21:37:07 +00001330 // (X | C1) ^ C2 --> (X | C1) & ~C2 iff (C1&C2) == C2
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001331 if (ConstantExpr::get(Instruction::And, RHS, Op0CI) == RHS)
1332 return BinaryOperator::create(Instruction::And, Op0,
1333 NotConstant(RHS));
Chris Lattnere5806662003-11-04 23:50:51 +00001334 break;
1335 default: break;
Chris Lattner97638592003-07-23 21:37:07 +00001336 }
Chris Lattnerb8d6e402002-08-20 18:24:26 +00001337 }
Chris Lattner183b3362004-04-09 19:05:30 +00001338
1339 // Try to fold constant and into select arguments.
1340 if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
1341 if (Instruction *R = FoldBinOpIntoSelect(I, SI, this))
1342 return R;
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001343 }
1344
Chris Lattnerbb74e222003-03-10 23:06:50 +00001345 if (Value *X = dyn_castNotVal(Op0)) // ~A ^ A == -1
Chris Lattner3082c5a2003-02-18 19:28:33 +00001346 if (X == Op1)
1347 return ReplaceInstUsesWith(I,
1348 ConstantIntegral::getAllOnesValue(I.getType()));
1349
Chris Lattnerbb74e222003-03-10 23:06:50 +00001350 if (Value *X = dyn_castNotVal(Op1)) // A ^ ~A == -1
Chris Lattner3082c5a2003-02-18 19:28:33 +00001351 if (X == Op0)
1352 return ReplaceInstUsesWith(I,
1353 ConstantIntegral::getAllOnesValue(I.getType()));
1354
Chris Lattner1bbb7b62003-03-10 18:24:17 +00001355 if (Instruction *Op1I = dyn_cast<Instruction>(Op1))
Chris Lattnerb36d9082004-02-16 03:54:20 +00001356 if (Op1I->getOpcode() == Instruction::Or) {
Chris Lattner1bbb7b62003-03-10 18:24:17 +00001357 if (Op1I->getOperand(0) == Op0) { // B^(B|A) == (A|B)^B
1358 cast<BinaryOperator>(Op1I)->swapOperands();
1359 I.swapOperands();
1360 std::swap(Op0, Op1);
1361 } else if (Op1I->getOperand(1) == Op0) { // B^(A|B) == (A|B)^B
1362 I.swapOperands();
1363 std::swap(Op0, Op1);
Chris Lattnerb36d9082004-02-16 03:54:20 +00001364 }
1365 } else if (Op1I->getOpcode() == Instruction::Xor) {
1366 if (Op0 == Op1I->getOperand(0)) // A^(A^B) == B
1367 return ReplaceInstUsesWith(I, Op1I->getOperand(1));
1368 else if (Op0 == Op1I->getOperand(1)) // A^(B^A) == B
1369 return ReplaceInstUsesWith(I, Op1I->getOperand(0));
1370 }
Chris Lattner1bbb7b62003-03-10 18:24:17 +00001371
1372 if (Instruction *Op0I = dyn_cast<Instruction>(Op0))
Chris Lattnerf95d9b92003-10-15 16:48:29 +00001373 if (Op0I->getOpcode() == Instruction::Or && Op0I->hasOneUse()) {
Chris Lattner1bbb7b62003-03-10 18:24:17 +00001374 if (Op0I->getOperand(0) == Op1) // (B|A)^B == (A|B)^B
1375 cast<BinaryOperator>(Op0I)->swapOperands();
Chris Lattnerdcf240a2003-03-10 21:43:22 +00001376 if (Op0I->getOperand(1) == Op1) { // (A|B)^B == A & ~B
Chris Lattner1bbb7b62003-03-10 18:24:17 +00001377 Value *NotB = BinaryOperator::createNot(Op1, Op1->getName()+".not", &I);
1378 WorkList.push_back(cast<Instruction>(NotB));
Chris Lattnerdcf240a2003-03-10 21:43:22 +00001379 return BinaryOperator::create(Instruction::And, Op0I->getOperand(0),
1380 NotB);
Chris Lattner1bbb7b62003-03-10 18:24:17 +00001381 }
Chris Lattnerb36d9082004-02-16 03:54:20 +00001382 } else if (Op0I->getOpcode() == Instruction::Xor) {
1383 if (Op1 == Op0I->getOperand(0)) // (A^B)^A == B
1384 return ReplaceInstUsesWith(I, Op0I->getOperand(1));
1385 else if (Op1 == Op0I->getOperand(1)) // (B^A)^A == B
1386 return ReplaceInstUsesWith(I, Op0I->getOperand(0));
Chris Lattner1bbb7b62003-03-10 18:24:17 +00001387 }
1388
Chris Lattner7fb29e12003-03-11 00:12:48 +00001389 // (A & C1)^(B & C2) -> (A & C1)|(B & C2) iff C1^C2 == 0
1390 if (Constant *C1 = dyn_castMaskingAnd(Op0))
1391 if (Constant *C2 = dyn_castMaskingAnd(Op1))
Chris Lattner34428442003-05-27 16:40:51 +00001392 if (ConstantExpr::get(Instruction::And, C1, C2)->isNullValue())
Chris Lattner7fb29e12003-03-11 00:12:48 +00001393 return BinaryOperator::create(Instruction::Or, Op0, Op1);
1394
Chris Lattner3ac7c262003-08-13 20:16:26 +00001395 // (setcc1 A, B) ^ (setcc2 A, B) --> (setcc3 A, B)
1396 if (SetCondInst *RHS = dyn_cast<SetCondInst>(I.getOperand(1)))
1397 if (Instruction *R = AssociativeOpt(I, FoldSetCCLogical(*this, RHS)))
1398 return R;
1399
Chris Lattner113f4f42002-06-25 16:13:24 +00001400 return Changed ? &I : 0;
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001401}
1402
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001403// AddOne, SubOne - Add or subtract a constant one from an integer constant...
1404static Constant *AddOne(ConstantInt *C) {
Chris Lattner34428442003-05-27 16:40:51 +00001405 Constant *Result = ConstantExpr::get(Instruction::Add, C,
1406 ConstantInt::get(C->getType(), 1));
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001407 assert(Result && "Constant folding integer addition failed!");
1408 return Result;
1409}
1410static Constant *SubOne(ConstantInt *C) {
Chris Lattner34428442003-05-27 16:40:51 +00001411 Constant *Result = ConstantExpr::get(Instruction::Sub, C,
1412 ConstantInt::get(C->getType(), 1));
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001413 assert(Result && "Constant folding integer addition failed!");
1414 return Result;
1415}
1416
Chris Lattner1fc23f32002-05-09 20:11:54 +00001417// isTrueWhenEqual - Return true if the specified setcondinst instruction is
1418// true when both operands are equal...
1419//
Chris Lattner113f4f42002-06-25 16:13:24 +00001420static bool isTrueWhenEqual(Instruction &I) {
1421 return I.getOpcode() == Instruction::SetEQ ||
1422 I.getOpcode() == Instruction::SetGE ||
1423 I.getOpcode() == Instruction::SetLE;
Chris Lattner1fc23f32002-05-09 20:11:54 +00001424}
1425
Chris Lattner113f4f42002-06-25 16:13:24 +00001426Instruction *InstCombiner::visitSetCondInst(BinaryOperator &I) {
Chris Lattnerdcf240a2003-03-10 21:43:22 +00001427 bool Changed = SimplifyCommutative(I);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001428 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
1429 const Type *Ty = Op0->getType();
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001430
1431 // setcc X, X
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001432 if (Op0 == Op1)
1433 return ReplaceInstUsesWith(I, ConstantBool::get(isTrueWhenEqual(I)));
Chris Lattner1fc23f32002-05-09 20:11:54 +00001434
Chris Lattnerd07283a2003-08-13 05:38:46 +00001435 // setcc <global/alloca*>, 0 - Global/Stack value addresses are never null!
1436 if (isa<ConstantPointerNull>(Op1) &&
1437 (isa<GlobalValue>(Op0) || isa<AllocaInst>(Op0)))
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001438 return ReplaceInstUsesWith(I, ConstantBool::get(!isTrueWhenEqual(I)));
1439
Chris Lattnerd07283a2003-08-13 05:38:46 +00001440
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001441 // setcc's with boolean values can always be turned into bitwise operations
1442 if (Ty == Type::BoolTy) {
1443 // If this is <, >, or !=, we can change this into a simple xor instruction
1444 if (!isTrueWhenEqual(I))
Chris Lattner16930792003-11-03 04:25:02 +00001445 return BinaryOperator::create(Instruction::Xor, Op0, Op1);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001446
1447 // Otherwise we need to make a temporary intermediate instruction and insert
1448 // it into the instruction stream. This is what we are after:
1449 //
1450 // seteq bool %A, %B -> ~(A^B)
1451 // setle bool %A, %B -> ~A | B
1452 // setge bool %A, %B -> A | ~B
1453 //
1454 if (I.getOpcode() == Instruction::SetEQ) { // seteq case
1455 Instruction *Xor = BinaryOperator::create(Instruction::Xor, Op0, Op1,
1456 I.getName()+"tmp");
1457 InsertNewInstBefore(Xor, I);
Chris Lattner16930792003-11-03 04:25:02 +00001458 return BinaryOperator::createNot(Xor);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001459 }
1460
1461 // Handle the setXe cases...
1462 assert(I.getOpcode() == Instruction::SetGE ||
1463 I.getOpcode() == Instruction::SetLE);
1464
1465 if (I.getOpcode() == Instruction::SetGE)
1466 std::swap(Op0, Op1); // Change setge -> setle
1467
1468 // Now we just have the SetLE case.
Chris Lattner31ae8632002-08-14 17:51:49 +00001469 Instruction *Not = BinaryOperator::createNot(Op0, I.getName()+"tmp");
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001470 InsertNewInstBefore(Not, I);
Chris Lattner16930792003-11-03 04:25:02 +00001471 return BinaryOperator::create(Instruction::Or, Not, Op1);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001472 }
1473
1474 // Check to see if we are doing one of many comparisons against constant
1475 // integers at the end of their ranges...
1476 //
1477 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op1)) {
Chris Lattnerd492a0b2003-07-23 17:02:11 +00001478 // Simplify seteq and setne instructions...
1479 if (I.getOpcode() == Instruction::SetEQ ||
1480 I.getOpcode() == Instruction::SetNE) {
1481 bool isSetNE = I.getOpcode() == Instruction::SetNE;
1482
Chris Lattnercfbce7c2003-07-23 17:26:36 +00001483 // If the first operand is (and|or|xor) with a constant, and the second
Chris Lattnerd492a0b2003-07-23 17:02:11 +00001484 // operand is a constant, simplify a bit.
Chris Lattnerc992add2003-08-13 05:33:12 +00001485 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Op0)) {
1486 switch (BO->getOpcode()) {
1487 case Instruction::Add:
1488 if (CI->isNullValue()) {
1489 // Replace ((add A, B) != 0) with (A != -B) if A or B is
1490 // efficiently invertible, or if the add has just this one use.
1491 Value *BOp0 = BO->getOperand(0), *BOp1 = BO->getOperand(1);
1492 if (Value *NegVal = dyn_castNegVal(BOp1))
1493 return new SetCondInst(I.getOpcode(), BOp0, NegVal);
1494 else if (Value *NegVal = dyn_castNegVal(BOp0))
1495 return new SetCondInst(I.getOpcode(), NegVal, BOp1);
Chris Lattnerf95d9b92003-10-15 16:48:29 +00001496 else if (BO->hasOneUse()) {
Chris Lattnerc992add2003-08-13 05:33:12 +00001497 Instruction *Neg = BinaryOperator::createNeg(BOp1, BO->getName());
1498 BO->setName("");
1499 InsertNewInstBefore(Neg, I);
1500 return new SetCondInst(I.getOpcode(), BOp0, Neg);
1501 }
1502 }
1503 break;
1504 case Instruction::Xor:
1505 // For the xor case, we can xor two constants together, eliminating
1506 // the explicit xor.
1507 if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1)))
1508 return BinaryOperator::create(I.getOpcode(), BO->getOperand(0),
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001509 ConstantExpr::get(Instruction::Xor, CI, BOC));
Chris Lattnerc992add2003-08-13 05:33:12 +00001510
1511 // FALLTHROUGH
1512 case Instruction::Sub:
1513 // Replace (([sub|xor] A, B) != 0) with (A != B)
1514 if (CI->isNullValue())
1515 return new SetCondInst(I.getOpcode(), BO->getOperand(0),
1516 BO->getOperand(1));
1517 break;
1518
1519 case Instruction::Or:
1520 // If bits are being or'd in that are not present in the constant we
1521 // are comparing against, then the comparison could never succeed!
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001522 if (Constant *BOC = dyn_cast<Constant>(BO->getOperand(1))) {
1523 Constant *NotCI = NotConstant(CI);
1524 if (!ConstantExpr::get(Instruction::And, BOC, NotCI)->isNullValue())
Chris Lattnerd492a0b2003-07-23 17:02:11 +00001525 return ReplaceInstUsesWith(I, ConstantBool::get(isSetNE));
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001526 }
Chris Lattnerc992add2003-08-13 05:33:12 +00001527 break;
1528
1529 case Instruction::And:
1530 if (ConstantInt *BOC = dyn_cast<ConstantInt>(BO->getOperand(1))) {
Chris Lattnerd492a0b2003-07-23 17:02:11 +00001531 // If bits are being compared against that are and'd out, then the
1532 // comparison can never succeed!
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001533 if (!ConstantExpr::get(Instruction::And, CI,
1534 NotConstant(BOC))->isNullValue())
Chris Lattnerd492a0b2003-07-23 17:02:11 +00001535 return ReplaceInstUsesWith(I, ConstantBool::get(isSetNE));
Chris Lattnerc992add2003-08-13 05:33:12 +00001536
1537 // Replace (and X, (1 << size(X)-1) != 0) with x < 0, converting X
1538 // to be a signed value as appropriate.
1539 if (isSignBit(BOC)) {
1540 Value *X = BO->getOperand(0);
1541 // If 'X' is not signed, insert a cast now...
1542 if (!BOC->getType()->isSigned()) {
Chris Lattnere79e8542004-02-23 06:38:22 +00001543 const Type *DestTy = getSignedIntegralType(BOC->getType());
Chris Lattnerc992add2003-08-13 05:33:12 +00001544 CastInst *NewCI = new CastInst(X,DestTy,X->getName()+".signed");
1545 InsertNewInstBefore(NewCI, I);
1546 X = NewCI;
1547 }
1548 return new SetCondInst(isSetNE ? Instruction::SetLT :
1549 Instruction::SetGE, X,
1550 Constant::getNullValue(X->getType()));
1551 }
Chris Lattnerd492a0b2003-07-23 17:02:11 +00001552 }
Chris Lattnerc992add2003-08-13 05:33:12 +00001553 default: break;
1554 }
1555 }
Chris Lattner2b55ea32004-02-23 07:16:20 +00001556 } else { // Not a SetEQ/SetNE
1557 // If the LHS is a cast from an integral value of the same size,
1558 if (CastInst *Cast = dyn_cast<CastInst>(Op0)) {
1559 Value *CastOp = Cast->getOperand(0);
1560 const Type *SrcTy = CastOp->getType();
1561 unsigned SrcTySize = SrcTy->getPrimitiveSize();
1562 if (SrcTy != Cast->getType() && SrcTy->isInteger() &&
1563 SrcTySize == Cast->getType()->getPrimitiveSize()) {
1564 assert((SrcTy->isSigned() ^ Cast->getType()->isSigned()) &&
1565 "Source and destination signednesses should differ!");
1566 if (Cast->getType()->isSigned()) {
1567 // If this is a signed comparison, check for comparisons in the
1568 // vicinity of zero.
1569 if (I.getOpcode() == Instruction::SetLT && CI->isNullValue())
1570 // X < 0 => x > 127
1571 return BinaryOperator::create(Instruction::SetGT, CastOp,
1572 ConstantUInt::get(SrcTy, (1ULL << (SrcTySize*8-1))-1));
1573 else if (I.getOpcode() == Instruction::SetGT &&
1574 cast<ConstantSInt>(CI)->getValue() == -1)
1575 // X > -1 => x < 128
Chris Lattnerc40b9d72004-02-23 21:46:42 +00001576 return BinaryOperator::create(Instruction::SetLT, CastOp,
Chris Lattner2b55ea32004-02-23 07:16:20 +00001577 ConstantUInt::get(SrcTy, 1ULL << (SrcTySize*8-1)));
1578 } else {
1579 ConstantUInt *CUI = cast<ConstantUInt>(CI);
1580 if (I.getOpcode() == Instruction::SetLT &&
1581 CUI->getValue() == 1ULL << (SrcTySize*8-1))
1582 // X < 128 => X > -1
1583 return BinaryOperator::create(Instruction::SetGT, CastOp,
1584 ConstantSInt::get(SrcTy, -1));
1585 else if (I.getOpcode() == Instruction::SetGT &&
1586 CUI->getValue() == (1ULL << (SrcTySize*8-1))-1)
1587 // X > 127 => X < 0
1588 return BinaryOperator::create(Instruction::SetLT, CastOp,
1589 Constant::getNullValue(SrcTy));
1590 }
1591 }
1592 }
Chris Lattnere967b342003-06-04 05:10:11 +00001593 }
Chris Lattner791ac1a2003-06-01 03:35:25 +00001594
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001595 // Check to see if we are comparing against the minimum or maximum value...
Chris Lattnere6794492002-08-12 21:17:25 +00001596 if (CI->isMinValue()) {
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001597 if (I.getOpcode() == Instruction::SetLT) // A < MIN -> FALSE
1598 return ReplaceInstUsesWith(I, ConstantBool::False);
1599 if (I.getOpcode() == Instruction::SetGE) // A >= MIN -> TRUE
1600 return ReplaceInstUsesWith(I, ConstantBool::True);
1601 if (I.getOpcode() == Instruction::SetLE) // A <= MIN -> A == MIN
Chris Lattner16930792003-11-03 04:25:02 +00001602 return BinaryOperator::create(Instruction::SetEQ, Op0, Op1);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001603 if (I.getOpcode() == Instruction::SetGT) // A > MIN -> A != MIN
Chris Lattner16930792003-11-03 04:25:02 +00001604 return BinaryOperator::create(Instruction::SetNE, Op0, Op1);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001605
Chris Lattnere6794492002-08-12 21:17:25 +00001606 } else if (CI->isMaxValue()) {
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001607 if (I.getOpcode() == Instruction::SetGT) // A > MAX -> FALSE
1608 return ReplaceInstUsesWith(I, ConstantBool::False);
1609 if (I.getOpcode() == Instruction::SetLE) // A <= MAX -> TRUE
1610 return ReplaceInstUsesWith(I, ConstantBool::True);
1611 if (I.getOpcode() == Instruction::SetGE) // A >= MAX -> A == MAX
Chris Lattner16930792003-11-03 04:25:02 +00001612 return BinaryOperator::create(Instruction::SetEQ, Op0, Op1);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001613 if (I.getOpcode() == Instruction::SetLT) // A < MAX -> A != MAX
Chris Lattner16930792003-11-03 04:25:02 +00001614 return BinaryOperator::create(Instruction::SetNE, Op0, Op1);
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001615
1616 // Comparing against a value really close to min or max?
1617 } else if (isMinValuePlusOne(CI)) {
1618 if (I.getOpcode() == Instruction::SetLT) // A < MIN+1 -> A == MIN
Chris Lattner16930792003-11-03 04:25:02 +00001619 return BinaryOperator::create(Instruction::SetEQ, Op0, SubOne(CI));
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001620 if (I.getOpcode() == Instruction::SetGE) // A >= MIN-1 -> A != MIN
Chris Lattner16930792003-11-03 04:25:02 +00001621 return BinaryOperator::create(Instruction::SetNE, Op0, SubOne(CI));
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001622
1623 } else if (isMaxValueMinusOne(CI)) {
1624 if (I.getOpcode() == Instruction::SetGT) // A > MAX-1 -> A == MAX
Chris Lattner16930792003-11-03 04:25:02 +00001625 return BinaryOperator::create(Instruction::SetEQ, Op0, AddOne(CI));
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001626 if (I.getOpcode() == Instruction::SetLE) // A <= MAX-1 -> A != MAX
Chris Lattner16930792003-11-03 04:25:02 +00001627 return BinaryOperator::create(Instruction::SetNE, Op0, AddOne(CI));
Chris Lattner6d14f2a2002-08-09 23:47:40 +00001628 }
Chris Lattner59611142004-02-23 05:47:48 +00001629
1630 // If we still have a setle or setge instruction, turn it into the
1631 // appropriate setlt or setgt instruction. Since the border cases have
1632 // already been handled above, this requires little checking.
1633 //
1634 if (I.getOpcode() == Instruction::SetLE)
1635 return BinaryOperator::create(Instruction::SetLT, Op0, AddOne(CI));
1636 if (I.getOpcode() == Instruction::SetGE)
1637 return BinaryOperator::create(Instruction::SetGT, Op0, SubOne(CI));
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001638 }
1639
Chris Lattner16930792003-11-03 04:25:02 +00001640 // Test to see if the operands of the setcc are casted versions of other
1641 // values. If the cast can be stripped off both arguments, we do so now.
Chris Lattner6444c372003-11-03 05:17:03 +00001642 if (CastInst *CI = dyn_cast<CastInst>(Op0)) {
1643 Value *CastOp0 = CI->getOperand(0);
1644 if (CastOp0->getType()->isLosslesslyConvertibleTo(CI->getType()) &&
Chris Lattner7d2a5392004-03-13 23:54:27 +00001645 (isa<Constant>(Op1) || isa<CastInst>(Op1)) &&
Chris Lattner16930792003-11-03 04:25:02 +00001646 (I.getOpcode() == Instruction::SetEQ ||
1647 I.getOpcode() == Instruction::SetNE)) {
1648 // We keep moving the cast from the left operand over to the right
1649 // operand, where it can often be eliminated completely.
Chris Lattner6444c372003-11-03 05:17:03 +00001650 Op0 = CastOp0;
Chris Lattner16930792003-11-03 04:25:02 +00001651
1652 // If operand #1 is a cast instruction, see if we can eliminate it as
1653 // well.
Chris Lattner6444c372003-11-03 05:17:03 +00001654 if (CastInst *CI2 = dyn_cast<CastInst>(Op1))
1655 if (CI2->getOperand(0)->getType()->isLosslesslyConvertibleTo(
Chris Lattner16930792003-11-03 04:25:02 +00001656 Op0->getType()))
Chris Lattner6444c372003-11-03 05:17:03 +00001657 Op1 = CI2->getOperand(0);
Chris Lattner16930792003-11-03 04:25:02 +00001658
1659 // If Op1 is a constant, we can fold the cast into the constant.
1660 if (Op1->getType() != Op0->getType())
1661 if (Constant *Op1C = dyn_cast<Constant>(Op1)) {
1662 Op1 = ConstantExpr::getCast(Op1C, Op0->getType());
1663 } else {
1664 // Otherwise, cast the RHS right before the setcc
1665 Op1 = new CastInst(Op1, Op0->getType(), Op1->getName());
1666 InsertNewInstBefore(cast<Instruction>(Op1), I);
1667 }
1668 return BinaryOperator::create(I.getOpcode(), Op0, Op1);
1669 }
1670
Chris Lattner6444c372003-11-03 05:17:03 +00001671 // Handle the special case of: setcc (cast bool to X), <cst>
1672 // This comes up when you have code like
1673 // int X = A < B;
1674 // if (X) ...
1675 // For generality, we handle any zero-extension of any operand comparison
1676 // with a constant.
1677 if (ConstantInt *ConstantRHS = dyn_cast<ConstantInt>(Op1)) {
1678 const Type *SrcTy = CastOp0->getType();
1679 const Type *DestTy = Op0->getType();
1680 if (SrcTy->getPrimitiveSize() < DestTy->getPrimitiveSize() &&
1681 (SrcTy->isUnsigned() || SrcTy == Type::BoolTy)) {
1682 // Ok, we have an expansion of operand 0 into a new type. Get the
1683 // constant value, masink off bits which are not set in the RHS. These
1684 // could be set if the destination value is signed.
1685 uint64_t ConstVal = ConstantRHS->getRawValue();
1686 ConstVal &= (1ULL << DestTy->getPrimitiveSize()*8)-1;
1687
1688 // If the constant we are comparing it with has high bits set, which
1689 // don't exist in the original value, the values could never be equal,
1690 // because the source would be zero extended.
1691 unsigned SrcBits =
1692 SrcTy == Type::BoolTy ? 1 : SrcTy->getPrimitiveSize()*8;
Chris Lattner7c94d112003-11-05 17:31:36 +00001693 bool HasSignBit = ConstVal & (1ULL << (DestTy->getPrimitiveSize()*8-1));
1694 if (ConstVal & ~((1ULL << SrcBits)-1)) {
Chris Lattner6444c372003-11-03 05:17:03 +00001695 switch (I.getOpcode()) {
1696 default: assert(0 && "Unknown comparison type!");
1697 case Instruction::SetEQ:
1698 return ReplaceInstUsesWith(I, ConstantBool::False);
1699 case Instruction::SetNE:
1700 return ReplaceInstUsesWith(I, ConstantBool::True);
1701 case Instruction::SetLT:
1702 case Instruction::SetLE:
1703 if (DestTy->isSigned() && HasSignBit)
1704 return ReplaceInstUsesWith(I, ConstantBool::False);
1705 return ReplaceInstUsesWith(I, ConstantBool::True);
1706 case Instruction::SetGT:
1707 case Instruction::SetGE:
1708 if (DestTy->isSigned() && HasSignBit)
1709 return ReplaceInstUsesWith(I, ConstantBool::True);
1710 return ReplaceInstUsesWith(I, ConstantBool::False);
1711 }
1712 }
1713
1714 // Otherwise, we can replace the setcc with a setcc of the smaller
1715 // operand value.
1716 Op1 = ConstantExpr::getCast(cast<Constant>(Op1), SrcTy);
1717 return BinaryOperator::create(I.getOpcode(), CastOp0, Op1);
1718 }
1719 }
1720 }
Chris Lattner113f4f42002-06-25 16:13:24 +00001721 return Changed ? &I : 0;
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001722}
1723
1724
1725
Chris Lattnere8d6c602003-03-10 19:16:08 +00001726Instruction *InstCombiner::visitShiftInst(ShiftInst &I) {
Chris Lattner113f4f42002-06-25 16:13:24 +00001727 assert(I.getOperand(1)->getType() == Type::UByteTy);
1728 Value *Op0 = I.getOperand(0), *Op1 = I.getOperand(1);
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001729 bool isLeftShift = I.getOpcode() == Instruction::Shl;
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001730
1731 // shl X, 0 == X and shr X, 0 == X
1732 // shl 0, X == 0 and shr 0, X == 0
1733 if (Op1 == Constant::getNullValue(Type::UByteTy) ||
Chris Lattnere6794492002-08-12 21:17:25 +00001734 Op0 == Constant::getNullValue(Op0->getType()))
1735 return ReplaceInstUsesWith(I, Op0);
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001736
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001737 // shr int -1, X = -1 (for any arithmetic shift rights of ~0)
1738 if (!isLeftShift)
1739 if (ConstantSInt *CSI = dyn_cast<ConstantSInt>(Op0))
1740 if (CSI->isAllOnesValue())
1741 return ReplaceInstUsesWith(I, CSI);
1742
Chris Lattner183b3362004-04-09 19:05:30 +00001743 // Try to fold constant and into select arguments.
1744 if (isa<Constant>(Op0))
1745 if (SelectInst *SI = dyn_cast<SelectInst>(Op1))
1746 if (Instruction *R = FoldBinOpIntoSelect(I, SI, this))
1747 return R;
1748
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001749 if (ConstantUInt *CUI = dyn_cast<ConstantUInt>(Op1)) {
Chris Lattner3204d4e2003-07-24 17:52:58 +00001750 // shl uint X, 32 = 0 and shr ubyte Y, 9 = 0, ... just don't eliminate shr
1751 // of a signed value.
1752 //
Chris Lattnere8d6c602003-03-10 19:16:08 +00001753 unsigned TypeBits = Op0->getType()->getPrimitiveSize()*8;
Chris Lattnerf5ce2542004-02-23 20:30:06 +00001754 if (CUI->getValue() >= TypeBits) {
1755 if (!Op0->getType()->isSigned() || isLeftShift)
1756 return ReplaceInstUsesWith(I, Constant::getNullValue(Op0->getType()));
1757 else {
1758 I.setOperand(1, ConstantUInt::get(Type::UByteTy, TypeBits-1));
1759 return &I;
1760 }
1761 }
Chris Lattner55f3d942002-09-10 23:04:09 +00001762
Chris Lattnerede3fe02003-08-13 04:18:28 +00001763 // ((X*C1) << C2) == (X * (C1 << C2))
1764 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Op0))
1765 if (BO->getOpcode() == Instruction::Mul && isLeftShift)
1766 if (Constant *BOOp = dyn_cast<Constant>(BO->getOperand(1)))
1767 return BinaryOperator::create(Instruction::Mul, BO->getOperand(0),
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001768 ConstantExpr::get(Instruction::Shl, BOOp, CUI));
Chris Lattnerede3fe02003-08-13 04:18:28 +00001769
Chris Lattner183b3362004-04-09 19:05:30 +00001770 // Try to fold constant and into select arguments.
1771 if (SelectInst *SI = dyn_cast<SelectInst>(Op0))
1772 if (Instruction *R = FoldBinOpIntoSelect(I, SI, this))
1773 return R;
Chris Lattnerede3fe02003-08-13 04:18:28 +00001774
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001775 // If the operand is an bitwise operator with a constant RHS, and the
1776 // shift is the only use, we can pull it out of the shift.
Chris Lattnerf95d9b92003-10-15 16:48:29 +00001777 if (Op0->hasOneUse())
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001778 if (BinaryOperator *Op0BO = dyn_cast<BinaryOperator>(Op0))
1779 if (ConstantInt *Op0C = dyn_cast<ConstantInt>(Op0BO->getOperand(1))) {
1780 bool isValid = true; // Valid only for And, Or, Xor
1781 bool highBitSet = false; // Transform if high bit of constant set?
1782
1783 switch (Op0BO->getOpcode()) {
1784 default: isValid = false; break; // Do not perform transform!
1785 case Instruction::Or:
1786 case Instruction::Xor:
1787 highBitSet = false;
1788 break;
1789 case Instruction::And:
1790 highBitSet = true;
1791 break;
1792 }
1793
1794 // If this is a signed shift right, and the high bit is modified
1795 // by the logical operation, do not perform the transformation.
1796 // The highBitSet boolean indicates the value of the high bit of
1797 // the constant which would cause it to be modified for this
1798 // operation.
1799 //
1800 if (isValid && !isLeftShift && !I.getType()->isUnsigned()) {
1801 uint64_t Val = Op0C->getRawValue();
1802 isValid = ((Val & (1 << (TypeBits-1))) != 0) == highBitSet;
1803 }
1804
1805 if (isValid) {
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001806 Constant *NewRHS = ConstantExpr::get(I.getOpcode(), Op0C, CUI);
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001807
1808 Instruction *NewShift =
1809 new ShiftInst(I.getOpcode(), Op0BO->getOperand(0), CUI,
1810 Op0BO->getName());
1811 Op0BO->setName("");
1812 InsertNewInstBefore(NewShift, I);
1813
1814 return BinaryOperator::create(Op0BO->getOpcode(), NewShift,
1815 NewRHS);
1816 }
1817 }
1818
Chris Lattner3204d4e2003-07-24 17:52:58 +00001819 // If this is a shift of a shift, see if we can fold the two together...
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001820 if (ShiftInst *Op0SI = dyn_cast<ShiftInst>(Op0))
Chris Lattnerab780df2003-07-24 18:38:56 +00001821 if (ConstantUInt *ShiftAmt1C =
1822 dyn_cast<ConstantUInt>(Op0SI->getOperand(1))) {
Chris Lattner3204d4e2003-07-24 17:52:58 +00001823 unsigned ShiftAmt1 = ShiftAmt1C->getValue();
1824 unsigned ShiftAmt2 = CUI->getValue();
1825
1826 // Check for (A << c1) << c2 and (A >> c1) >> c2
1827 if (I.getOpcode() == Op0SI->getOpcode()) {
1828 unsigned Amt = ShiftAmt1+ShiftAmt2; // Fold into one big shift...
Chris Lattnerf5ce2542004-02-23 20:30:06 +00001829 if (Op0->getType()->getPrimitiveSize()*8 < Amt)
1830 Amt = Op0->getType()->getPrimitiveSize()*8;
Chris Lattner3204d4e2003-07-24 17:52:58 +00001831 return new ShiftInst(I.getOpcode(), Op0SI->getOperand(0),
1832 ConstantUInt::get(Type::UByteTy, Amt));
1833 }
1834
Chris Lattnerab780df2003-07-24 18:38:56 +00001835 // Check for (A << c1) >> c2 or visaversa. If we are dealing with
1836 // signed types, we can only support the (A >> c1) << c2 configuration,
1837 // because it can not turn an arbitrary bit of A into a sign bit.
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001838 if (I.getType()->isUnsigned() || isLeftShift) {
Chris Lattner3204d4e2003-07-24 17:52:58 +00001839 // Calculate bitmask for what gets shifted off the edge...
1840 Constant *C = ConstantIntegral::getAllOnesValue(I.getType());
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001841 if (isLeftShift)
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001842 C = ConstantExpr::get(Instruction::Shl, C, ShiftAmt1C);
Chris Lattnerdeaa0dd2003-08-12 21:53:41 +00001843 else
Chris Lattnerc1e7cc02004-01-12 19:35:11 +00001844 C = ConstantExpr::get(Instruction::Shr, C, ShiftAmt1C);
Chris Lattner3204d4e2003-07-24 17:52:58 +00001845
1846 Instruction *Mask =
1847 BinaryOperator::create(Instruction::And, Op0SI->getOperand(0),
1848 C, Op0SI->getOperand(0)->getName()+".mask");
1849 InsertNewInstBefore(Mask, I);
1850
1851 // Figure out what flavor of shift we should use...
1852 if (ShiftAmt1 == ShiftAmt2)
1853 return ReplaceInstUsesWith(I, Mask); // (A << c) >> c === A & c2
1854 else if (ShiftAmt1 < ShiftAmt2) {
1855 return new ShiftInst(I.getOpcode(), Mask,
1856 ConstantUInt::get(Type::UByteTy, ShiftAmt2-ShiftAmt1));
1857 } else {
1858 return new ShiftInst(Op0SI->getOpcode(), Mask,
1859 ConstantUInt::get(Type::UByteTy, ShiftAmt1-ShiftAmt2));
1860 }
1861 }
1862 }
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001863 }
Chris Lattner2e0fb392002-10-08 16:16:40 +00001864
Chris Lattnerf4cdbf32002-05-06 16:14:14 +00001865 return 0;
1866}
1867
1868
Chris Lattner48a44f72002-05-02 17:06:02 +00001869// isEliminableCastOfCast - Return true if it is valid to eliminate the CI
1870// instruction.
1871//
Chris Lattnerdfae8be2003-07-24 17:35:25 +00001872static inline bool isEliminableCastOfCast(const Type *SrcTy, const Type *MidTy,
1873 const Type *DstTy) {
Chris Lattner48a44f72002-05-02 17:06:02 +00001874
Chris Lattner650b6da2002-08-02 20:00:25 +00001875 // It is legal to eliminate the instruction if casting A->B->A if the sizes
1876 // are identical and the bits don't get reinterpreted (for example
Chris Lattner0bb75912002-08-14 23:21:10 +00001877 // int->float->int would not be allowed)
Misha Brukmane5838c42003-05-20 18:45:36 +00001878 if (SrcTy == DstTy && SrcTy->isLosslesslyConvertibleTo(MidTy))
Chris Lattner650b6da2002-08-02 20:00:25 +00001879 return true;
Chris Lattner48a44f72002-05-02 17:06:02 +00001880
1881 // Allow free casting and conversion of sizes as long as the sign doesn't
1882 // change...
Chris Lattnerb0b412e2002-09-03 01:08:28 +00001883 if (SrcTy->isIntegral() && MidTy->isIntegral() && DstTy->isIntegral()) {
Chris Lattner650b6da2002-08-02 20:00:25 +00001884 unsigned SrcSize = SrcTy->getPrimitiveSize();
1885 unsigned MidSize = MidTy->getPrimitiveSize();
1886 unsigned DstSize = DstTy->getPrimitiveSize();
Chris Lattner650b6da2002-08-02 20:00:25 +00001887
Chris Lattner3732aca2002-08-15 16:15:25 +00001888 // Cases where we are monotonically decreasing the size of the type are
1889 // always ok, regardless of what sign changes are going on.
1890 //
Chris Lattner0bb75912002-08-14 23:21:10 +00001891 if (SrcSize >= MidSize && MidSize >= DstSize)
Chris Lattner650b6da2002-08-02 20:00:25 +00001892 return true;
Chris Lattner3732aca2002-08-15 16:15:25 +00001893
Chris Lattner555518c2002-09-23 23:39:43 +00001894 // Cases where the source and destination type are the same, but the middle
1895 // type is bigger are noops.
1896 //
1897 if (SrcSize == DstSize && MidSize > SrcSize)
1898 return true;
1899
Chris Lattner3732aca2002-08-15 16:15:25 +00001900 // If we are monotonically growing, things are more complex.
1901 //
1902 if (SrcSize <= MidSize && MidSize <= DstSize) {
1903 // We have eight combinations of signedness to worry about. Here's the
1904 // table:
1905 static const int SignTable[8] = {
1906 // CODE, SrcSigned, MidSigned, DstSigned, Comment
1907 1, // U U U Always ok
1908 1, // U U S Always ok
1909 3, // U S U Ok iff SrcSize != MidSize
1910 3, // U S S Ok iff SrcSize != MidSize
1911 0, // S U U Never ok
1912 2, // S U S Ok iff MidSize == DstSize
1913 1, // S S U Always ok
1914 1, // S S S Always ok
1915 };
1916
1917 // Choose an action based on the current entry of the signtable that this
1918 // cast of cast refers to...
1919 unsigned Row = SrcTy->isSigned()*4+MidTy->isSigned()*2+DstTy->isSigned();
1920 switch (SignTable[Row]) {
1921 case 0: return false; // Never ok
1922 case 1: return true; // Always ok
1923 case 2: return MidSize == DstSize; // Ok iff MidSize == DstSize
1924 case 3: // Ok iff SrcSize != MidSize
1925 return SrcSize != MidSize || SrcTy == Type::BoolTy;
1926 default: assert(0 && "Bad entry in sign table!");
1927 }
Chris Lattner3732aca2002-08-15 16:15:25 +00001928 }
Chris Lattner650b6da2002-08-02 20:00:25 +00001929 }
Chris Lattner48a44f72002-05-02 17:06:02 +00001930
1931 // Otherwise, we cannot succeed. Specifically we do not want to allow things
1932 // like: short -> ushort -> uint, because this can create wrong results if
1933 // the input short is negative!
1934 //
1935 return false;
1936}
1937
Chris Lattnerdfae8be2003-07-24 17:35:25 +00001938static bool ValueRequiresCast(const Value *V, const Type *Ty) {
1939 if (V->getType() == Ty || isa<Constant>(V)) return false;
1940 if (const CastInst *CI = dyn_cast<CastInst>(V))
1941 if (isEliminableCastOfCast(CI->getOperand(0)->getType(), CI->getType(), Ty))
1942 return false;
1943 return true;
1944}
1945
1946/// InsertOperandCastBefore - This inserts a cast of V to DestTy before the
1947/// InsertBefore instruction. This is specialized a bit to avoid inserting
1948/// casts that are known to not do anything...
1949///
1950Value *InstCombiner::InsertOperandCastBefore(Value *V, const Type *DestTy,
1951 Instruction *InsertBefore) {
1952 if (V->getType() == DestTy) return V;
1953 if (Constant *C = dyn_cast<Constant>(V))
1954 return ConstantExpr::getCast(C, DestTy);
1955
1956 CastInst *CI = new CastInst(V, DestTy, V->getName());
1957 InsertNewInstBefore(CI, *InsertBefore);
1958 return CI;
1959}
Chris Lattner48a44f72002-05-02 17:06:02 +00001960
1961// CastInst simplification
Chris Lattner260ab202002-04-18 17:39:14 +00001962//
Chris Lattner113f4f42002-06-25 16:13:24 +00001963Instruction *InstCombiner::visitCastInst(CastInst &CI) {
Chris Lattner55d4bda2003-06-23 21:59:52 +00001964 Value *Src = CI.getOperand(0);
1965
Chris Lattner48a44f72002-05-02 17:06:02 +00001966 // If the user is casting a value to the same type, eliminate this cast
1967 // instruction...
Chris Lattner55d4bda2003-06-23 21:59:52 +00001968 if (CI.getType() == Src->getType())
1969 return ReplaceInstUsesWith(CI, Src);
Chris Lattner48a44f72002-05-02 17:06:02 +00001970
Chris Lattner48a44f72002-05-02 17:06:02 +00001971 // If casting the result of another cast instruction, try to eliminate this
1972 // one!
1973 //
Chris Lattner55d4bda2003-06-23 21:59:52 +00001974 if (CastInst *CSrc = dyn_cast<CastInst>(Src)) {
Chris Lattnerdfae8be2003-07-24 17:35:25 +00001975 if (isEliminableCastOfCast(CSrc->getOperand(0)->getType(),
1976 CSrc->getType(), CI.getType())) {
Chris Lattner48a44f72002-05-02 17:06:02 +00001977 // This instruction now refers directly to the cast's src operand. This
1978 // has a good chance of making CSrc dead.
Chris Lattner113f4f42002-06-25 16:13:24 +00001979 CI.setOperand(0, CSrc->getOperand(0));
1980 return &CI;
Chris Lattner48a44f72002-05-02 17:06:02 +00001981 }
1982
Chris Lattner650b6da2002-08-02 20:00:25 +00001983 // If this is an A->B->A cast, and we are dealing with integral types, try
1984 // to convert this into a logical 'and' instruction.
1985 //
1986 if (CSrc->getOperand(0)->getType() == CI.getType() &&
Chris Lattnerb0b412e2002-09-03 01:08:28 +00001987 CI.getType()->isInteger() && CSrc->getType()->isInteger() &&
Chris Lattner650b6da2002-08-02 20:00:25 +00001988 CI.getType()->isUnsigned() && CSrc->getType()->isUnsigned() &&
1989 CSrc->getType()->getPrimitiveSize() < CI.getType()->getPrimitiveSize()){
1990 assert(CSrc->getType() != Type::ULongTy &&
1991 "Cannot have type bigger than ulong!");
Chris Lattner196897c2003-05-26 23:41:32 +00001992 uint64_t AndValue = (1ULL << CSrc->getType()->getPrimitiveSize()*8)-1;
Chris Lattner650b6da2002-08-02 20:00:25 +00001993 Constant *AndOp = ConstantUInt::get(CI.getType(), AndValue);
1994 return BinaryOperator::create(Instruction::And, CSrc->getOperand(0),
1995 AndOp);
1996 }
1997 }
1998
Chris Lattnerd0d51602003-06-21 23:12:02 +00001999 // If casting the result of a getelementptr instruction with no offset, turn
2000 // this into a cast of the original pointer!
2001 //
Chris Lattner55d4bda2003-06-23 21:59:52 +00002002 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Src)) {
Chris Lattnerd0d51602003-06-21 23:12:02 +00002003 bool AllZeroOperands = true;
2004 for (unsigned i = 1, e = GEP->getNumOperands(); i != e; ++i)
2005 if (!isa<Constant>(GEP->getOperand(i)) ||
2006 !cast<Constant>(GEP->getOperand(i))->isNullValue()) {
2007 AllZeroOperands = false;
2008 break;
2009 }
2010 if (AllZeroOperands) {
2011 CI.setOperand(0, GEP->getOperand(0));
2012 return &CI;
2013 }
2014 }
2015
Chris Lattnerf4ad1652003-11-02 05:57:39 +00002016 // If we are casting a malloc or alloca to a pointer to a type of the same
2017 // size, rewrite the allocation instruction to allocate the "right" type.
2018 //
2019 if (AllocationInst *AI = dyn_cast<AllocationInst>(Src))
Chris Lattnerd4d987d2003-11-02 06:54:48 +00002020 if (AI->hasOneUse() && !AI->isArrayAllocation())
Chris Lattnerf4ad1652003-11-02 05:57:39 +00002021 if (const PointerType *PTy = dyn_cast<PointerType>(CI.getType())) {
2022 // Get the type really allocated and the type casted to...
2023 const Type *AllocElTy = AI->getAllocatedType();
2024 unsigned AllocElTySize = TD->getTypeSize(AllocElTy);
2025 const Type *CastElTy = PTy->getElementType();
2026 unsigned CastElTySize = TD->getTypeSize(CastElTy);
Chris Lattner7c94d112003-11-05 17:31:36 +00002027
Chris Lattnerf4ad1652003-11-02 05:57:39 +00002028 // If the allocation is for an even multiple of the cast type size
Chris Lattneraf789322003-11-03 01:29:41 +00002029 if (CastElTySize && (AllocElTySize % CastElTySize == 0)) {
Chris Lattnerf4ad1652003-11-02 05:57:39 +00002030 Value *Amt = ConstantUInt::get(Type::UIntTy,
2031 AllocElTySize/CastElTySize);
2032 std::string Name = AI->getName(); AI->setName("");
2033 AllocationInst *New;
2034 if (isa<MallocInst>(AI))
2035 New = new MallocInst(CastElTy, Amt, Name);
2036 else
2037 New = new AllocaInst(CastElTy, Amt, Name);
Chris Lattner652064e2004-04-30 04:37:52 +00002038 InsertNewInstBefore(New, *AI);
Chris Lattnerf4ad1652003-11-02 05:57:39 +00002039 return ReplaceInstUsesWith(CI, New);
2040 }
2041 }
2042
Chris Lattnerdfae8be2003-07-24 17:35:25 +00002043 // If the source value is an instruction with only this use, we can attempt to
2044 // propagate the cast into the instruction. Also, only handle integral types
2045 // for now.
2046 if (Instruction *SrcI = dyn_cast<Instruction>(Src))
Chris Lattnerf95d9b92003-10-15 16:48:29 +00002047 if (SrcI->hasOneUse() && Src->getType()->isIntegral() &&
Chris Lattnerdfae8be2003-07-24 17:35:25 +00002048 CI.getType()->isInteger()) { // Don't mess with casts to bool here
2049 const Type *DestTy = CI.getType();
2050 unsigned SrcBitSize = getTypeSizeInBits(Src->getType());
2051 unsigned DestBitSize = getTypeSizeInBits(DestTy);
2052
2053 Value *Op0 = SrcI->getNumOperands() > 0 ? SrcI->getOperand(0) : 0;
2054 Value *Op1 = SrcI->getNumOperands() > 1 ? SrcI->getOperand(1) : 0;
2055
2056 switch (SrcI->getOpcode()) {
2057 case Instruction::Add:
2058 case Instruction::Mul:
2059 case Instruction::And:
2060 case Instruction::Or:
2061 case Instruction::Xor:
2062 // If we are discarding information, or just changing the sign, rewrite.
2063 if (DestBitSize <= SrcBitSize && DestBitSize != 1) {
2064 // Don't insert two casts if they cannot be eliminated. We allow two
2065 // casts to be inserted if the sizes are the same. This could only be
2066 // converting signedness, which is a noop.
2067 if (DestBitSize == SrcBitSize || !ValueRequiresCast(Op1, DestTy) ||
2068 !ValueRequiresCast(Op0, DestTy)) {
2069 Value *Op0c = InsertOperandCastBefore(Op0, DestTy, SrcI);
2070 Value *Op1c = InsertOperandCastBefore(Op1, DestTy, SrcI);
2071 return BinaryOperator::create(cast<BinaryOperator>(SrcI)
2072 ->getOpcode(), Op0c, Op1c);
2073 }
2074 }
2075 break;
2076 case Instruction::Shl:
2077 // Allow changing the sign of the source operand. Do not allow changing
2078 // the size of the shift, UNLESS the shift amount is a constant. We
2079 // mush not change variable sized shifts to a smaller size, because it
2080 // is undefined to shift more bits out than exist in the value.
2081 if (DestBitSize == SrcBitSize ||
2082 (DestBitSize < SrcBitSize && isa<Constant>(Op1))) {
2083 Value *Op0c = InsertOperandCastBefore(Op0, DestTy, SrcI);
2084 return new ShiftInst(Instruction::Shl, Op0c, Op1);
2085 }
2086 break;
2087 }
2088 }
2089
Chris Lattner260ab202002-04-18 17:39:14 +00002090 return 0;
Chris Lattnerca081252001-12-14 16:52:21 +00002091}
2092
Chris Lattner56e4d3d2004-04-09 23:46:01 +00002093/// GetSelectFoldableOperands - We want to turn code that looks like this:
2094/// %C = or %A, %B
2095/// %D = select %cond, %C, %A
2096/// into:
2097/// %C = select %cond, %B, 0
2098/// %D = or %A, %C
2099///
2100/// Assuming that the specified instruction is an operand to the select, return
2101/// a bitmask indicating which operands of this instruction are foldable if they
2102/// equal the other incoming value of the select.
2103///
2104static unsigned GetSelectFoldableOperands(Instruction *I) {
2105 switch (I->getOpcode()) {
2106 case Instruction::Add:
2107 case Instruction::Mul:
2108 case Instruction::And:
2109 case Instruction::Or:
2110 case Instruction::Xor:
2111 return 3; // Can fold through either operand.
2112 case Instruction::Sub: // Can only fold on the amount subtracted.
2113 case Instruction::Shl: // Can only fold on the shift amount.
2114 case Instruction::Shr:
2115 return 1;
2116 default:
2117 return 0; // Cannot fold
2118 }
2119}
2120
2121/// GetSelectFoldableConstant - For the same transformation as the previous
2122/// function, return the identity constant that goes into the select.
2123static Constant *GetSelectFoldableConstant(Instruction *I) {
2124 switch (I->getOpcode()) {
2125 default: assert(0 && "This cannot happen!"); abort();
2126 case Instruction::Add:
2127 case Instruction::Sub:
2128 case Instruction::Or:
2129 case Instruction::Xor:
2130 return Constant::getNullValue(I->getType());
2131 case Instruction::Shl:
2132 case Instruction::Shr:
2133 return Constant::getNullValue(Type::UByteTy);
2134 case Instruction::And:
2135 return ConstantInt::getAllOnesValue(I->getType());
2136 case Instruction::Mul:
2137 return ConstantInt::get(I->getType(), 1);
2138 }
2139}
2140
Chris Lattnerb909e8b2004-03-12 05:52:32 +00002141Instruction *InstCombiner::visitSelectInst(SelectInst &SI) {
Chris Lattner533bc492004-03-30 19:37:13 +00002142 Value *CondVal = SI.getCondition();
2143 Value *TrueVal = SI.getTrueValue();
2144 Value *FalseVal = SI.getFalseValue();
2145
2146 // select true, X, Y -> X
2147 // select false, X, Y -> Y
2148 if (ConstantBool *C = dyn_cast<ConstantBool>(CondVal))
Chris Lattnerb909e8b2004-03-12 05:52:32 +00002149 if (C == ConstantBool::True)
Chris Lattner533bc492004-03-30 19:37:13 +00002150 return ReplaceInstUsesWith(SI, TrueVal);
Chris Lattnerb909e8b2004-03-12 05:52:32 +00002151 else {
2152 assert(C == ConstantBool::False);
Chris Lattner533bc492004-03-30 19:37:13 +00002153 return ReplaceInstUsesWith(SI, FalseVal);
Chris Lattnerb909e8b2004-03-12 05:52:32 +00002154 }
Chris Lattner533bc492004-03-30 19:37:13 +00002155
2156 // select C, X, X -> X
2157 if (TrueVal == FalseVal)
2158 return ReplaceInstUsesWith(SI, TrueVal);
2159
Chris Lattner1c631e82004-04-08 04:43:23 +00002160 if (SI.getType() == Type::BoolTy)
2161 if (ConstantBool *C = dyn_cast<ConstantBool>(TrueVal)) {
2162 if (C == ConstantBool::True) {
2163 // Change: A = select B, true, C --> A = or B, C
2164 return BinaryOperator::create(Instruction::Or, CondVal, FalseVal);
2165 } else {
2166 // Change: A = select B, false, C --> A = and !B, C
2167 Value *NotCond =
2168 InsertNewInstBefore(BinaryOperator::createNot(CondVal,
2169 "not."+CondVal->getName()), SI);
2170 return BinaryOperator::create(Instruction::And, NotCond, FalseVal);
2171 }
2172 } else if (ConstantBool *C = dyn_cast<ConstantBool>(FalseVal)) {
2173 if (C == ConstantBool::False) {
2174 // Change: A = select B, C, false --> A = and B, C
2175 return BinaryOperator::create(Instruction::And, CondVal, TrueVal);
2176 } else {
2177 // Change: A = select B, C, true --> A = or !B, C
2178 Value *NotCond =
2179 InsertNewInstBefore(BinaryOperator::createNot(CondVal,
2180 "not."+CondVal->getName()), SI);
2181 return BinaryOperator::create(Instruction::Or, NotCond, TrueVal);
2182 }
2183 }
2184
Chris Lattner183b3362004-04-09 19:05:30 +00002185 // Selecting between two integer constants?
2186 if (ConstantInt *TrueValC = dyn_cast<ConstantInt>(TrueVal))
2187 if (ConstantInt *FalseValC = dyn_cast<ConstantInt>(FalseVal)) {
2188 // select C, 1, 0 -> cast C to int
2189 if (FalseValC->isNullValue() && TrueValC->getRawValue() == 1) {
2190 return new CastInst(CondVal, SI.getType());
2191 } else if (TrueValC->isNullValue() && FalseValC->getRawValue() == 1) {
2192 // select C, 0, 1 -> cast !C to int
2193 Value *NotCond =
2194 InsertNewInstBefore(BinaryOperator::createNot(CondVal,
Chris Lattnercf7baf32004-04-09 18:19:44 +00002195 "not."+CondVal->getName()), SI);
Chris Lattner183b3362004-04-09 19:05:30 +00002196 return new CastInst(NotCond, SI.getType());
Chris Lattnercf7baf32004-04-09 18:19:44 +00002197 }
Chris Lattner533bc492004-03-30 19:37:13 +00002198 }
Chris Lattner623fba12004-04-10 22:21:27 +00002199
2200 // See if we are selecting two values based on a comparison of the two values.
2201 if (SetCondInst *SCI = dyn_cast<SetCondInst>(CondVal)) {
2202 if (SCI->getOperand(0) == TrueVal && SCI->getOperand(1) == FalseVal) {
2203 // Transform (X == Y) ? X : Y -> Y
2204 if (SCI->getOpcode() == Instruction::SetEQ)
2205 return ReplaceInstUsesWith(SI, FalseVal);
2206 // Transform (X != Y) ? X : Y -> X
2207 if (SCI->getOpcode() == Instruction::SetNE)
2208 return ReplaceInstUsesWith(SI, TrueVal);
2209 // NOTE: if we wanted to, this is where to detect MIN/MAX/ABS/etc.
2210
2211 } else if (SCI->getOperand(0) == FalseVal && SCI->getOperand(1) == TrueVal){
2212 // Transform (X == Y) ? Y : X -> X
2213 if (SCI->getOpcode() == Instruction::SetEQ)
Chris Lattner24cf0202004-04-11 01:39:19 +00002214 return ReplaceInstUsesWith(SI, FalseVal);
Chris Lattner623fba12004-04-10 22:21:27 +00002215 // Transform (X != Y) ? Y : X -> Y
2216 if (SCI->getOpcode() == Instruction::SetNE)
Chris Lattner24cf0202004-04-11 01:39:19 +00002217 return ReplaceInstUsesWith(SI, TrueVal);
Chris Lattner623fba12004-04-10 22:21:27 +00002218 // NOTE: if we wanted to, this is where to detect MIN/MAX/ABS/etc.
2219 }
2220 }
Chris Lattner1c631e82004-04-08 04:43:23 +00002221
Chris Lattner56e4d3d2004-04-09 23:46:01 +00002222 // See if we can fold the select into one of our operands.
2223 if (SI.getType()->isInteger()) {
2224 // See the comment above GetSelectFoldableOperands for a description of the
2225 // transformation we are doing here.
2226 if (Instruction *TVI = dyn_cast<Instruction>(TrueVal))
2227 if (TVI->hasOneUse() && TVI->getNumOperands() == 2 &&
2228 !isa<Constant>(FalseVal))
2229 if (unsigned SFO = GetSelectFoldableOperands(TVI)) {
2230 unsigned OpToFold = 0;
2231 if ((SFO & 1) && FalseVal == TVI->getOperand(0)) {
2232 OpToFold = 1;
2233 } else if ((SFO & 2) && FalseVal == TVI->getOperand(1)) {
2234 OpToFold = 2;
2235 }
2236
2237 if (OpToFold) {
2238 Constant *C = GetSelectFoldableConstant(TVI);
2239 std::string Name = TVI->getName(); TVI->setName("");
2240 Instruction *NewSel =
2241 new SelectInst(SI.getCondition(), TVI->getOperand(2-OpToFold), C,
2242 Name);
2243 InsertNewInstBefore(NewSel, SI);
2244 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(TVI))
2245 return BinaryOperator::create(BO->getOpcode(), FalseVal, NewSel);
2246 else if (ShiftInst *SI = dyn_cast<ShiftInst>(TVI))
2247 return new ShiftInst(SI->getOpcode(), FalseVal, NewSel);
2248 else {
2249 assert(0 && "Unknown instruction!!");
2250 }
2251 }
2252 }
2253
2254 if (Instruction *FVI = dyn_cast<Instruction>(FalseVal))
2255 if (FVI->hasOneUse() && FVI->getNumOperands() == 2 &&
2256 !isa<Constant>(TrueVal))
2257 if (unsigned SFO = GetSelectFoldableOperands(FVI)) {
2258 unsigned OpToFold = 0;
2259 if ((SFO & 1) && TrueVal == FVI->getOperand(0)) {
2260 OpToFold = 1;
2261 } else if ((SFO & 2) && TrueVal == FVI->getOperand(1)) {
2262 OpToFold = 2;
2263 }
2264
2265 if (OpToFold) {
2266 Constant *C = GetSelectFoldableConstant(FVI);
2267 std::string Name = FVI->getName(); FVI->setName("");
2268 Instruction *NewSel =
2269 new SelectInst(SI.getCondition(), C, FVI->getOperand(2-OpToFold),
2270 Name);
2271 InsertNewInstBefore(NewSel, SI);
2272 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(FVI))
2273 return BinaryOperator::create(BO->getOpcode(), TrueVal, NewSel);
2274 else if (ShiftInst *SI = dyn_cast<ShiftInst>(FVI))
2275 return new ShiftInst(SI->getOpcode(), TrueVal, NewSel);
2276 else {
2277 assert(0 && "Unknown instruction!!");
2278 }
2279 }
2280 }
2281 }
Chris Lattnerb909e8b2004-03-12 05:52:32 +00002282 return 0;
2283}
2284
2285
Chris Lattner970c33a2003-06-19 17:00:31 +00002286// CallInst simplification
2287//
2288Instruction *InstCombiner::visitCallInst(CallInst &CI) {
Chris Lattner51ea1272004-02-28 05:22:00 +00002289 // Intrinsics cannot occur in an invoke, so handle them here instead of in
2290 // visitCallSite.
2291 if (Function *F = CI.getCalledFunction())
2292 switch (F->getIntrinsicID()) {
2293 case Intrinsic::memmove:
2294 case Intrinsic::memcpy:
2295 case Intrinsic::memset:
2296 // memmove/cpy/set of zero bytes is a noop.
2297 if (Constant *NumBytes = dyn_cast<Constant>(CI.getOperand(3))) {
2298 if (NumBytes->isNullValue())
2299 return EraseInstFromFunction(CI);
2300 }
2301 break;
2302 default:
2303 break;
2304 }
2305
Chris Lattneraec3d942003-10-07 22:32:43 +00002306 return visitCallSite(&CI);
Chris Lattner970c33a2003-06-19 17:00:31 +00002307}
2308
2309// InvokeInst simplification
2310//
2311Instruction *InstCombiner::visitInvokeInst(InvokeInst &II) {
Chris Lattneraec3d942003-10-07 22:32:43 +00002312 return visitCallSite(&II);
Chris Lattner970c33a2003-06-19 17:00:31 +00002313}
2314
Chris Lattneraec3d942003-10-07 22:32:43 +00002315// visitCallSite - Improvements for call and invoke instructions.
2316//
2317Instruction *InstCombiner::visitCallSite(CallSite CS) {
Chris Lattner75b4d1d2003-10-07 22:54:13 +00002318 bool Changed = false;
2319
2320 // If the callee is a constexpr cast of a function, attempt to move the cast
2321 // to the arguments of the call/invoke.
Chris Lattneraec3d942003-10-07 22:32:43 +00002322 if (transformConstExprCastCall(CS)) return 0;
2323
Chris Lattner75b4d1d2003-10-07 22:54:13 +00002324 Value *Callee = CS.getCalledValue();
2325 const PointerType *PTy = cast<PointerType>(Callee->getType());
2326 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2327 if (FTy->isVarArg()) {
2328 // See if we can optimize any arguments passed through the varargs area of
2329 // the call.
2330 for (CallSite::arg_iterator I = CS.arg_begin()+FTy->getNumParams(),
2331 E = CS.arg_end(); I != E; ++I)
2332 if (CastInst *CI = dyn_cast<CastInst>(*I)) {
2333 // If this cast does not effect the value passed through the varargs
2334 // area, we can eliminate the use of the cast.
2335 Value *Op = CI->getOperand(0);
2336 if (CI->getType()->isLosslesslyConvertibleTo(Op->getType())) {
2337 *I = Op;
2338 Changed = true;
2339 }
2340 }
2341 }
Chris Lattneraec3d942003-10-07 22:32:43 +00002342
Chris Lattner75b4d1d2003-10-07 22:54:13 +00002343 return Changed ? CS.getInstruction() : 0;
Chris Lattneraec3d942003-10-07 22:32:43 +00002344}
2345
Chris Lattner970c33a2003-06-19 17:00:31 +00002346// transformConstExprCastCall - If the callee is a constexpr cast of a function,
2347// attempt to move the cast to the arguments of the call/invoke.
2348//
2349bool InstCombiner::transformConstExprCastCall(CallSite CS) {
2350 if (!isa<ConstantExpr>(CS.getCalledValue())) return false;
2351 ConstantExpr *CE = cast<ConstantExpr>(CS.getCalledValue());
2352 if (CE->getOpcode() != Instruction::Cast ||
2353 !isa<ConstantPointerRef>(CE->getOperand(0)))
2354 return false;
2355 ConstantPointerRef *CPR = cast<ConstantPointerRef>(CE->getOperand(0));
2356 if (!isa<Function>(CPR->getValue())) return false;
2357 Function *Callee = cast<Function>(CPR->getValue());
2358 Instruction *Caller = CS.getInstruction();
2359
2360 // Okay, this is a cast from a function to a different type. Unless doing so
2361 // would cause a type conversion of one of our arguments, change this call to
2362 // be a direct call with arguments casted to the appropriate types.
2363 //
2364 const FunctionType *FT = Callee->getFunctionType();
2365 const Type *OldRetTy = Caller->getType();
2366
Chris Lattner1f7942f2004-01-14 06:06:08 +00002367 // Check to see if we are changing the return type...
2368 if (OldRetTy != FT->getReturnType()) {
2369 if (Callee->isExternal() &&
2370 !OldRetTy->isLosslesslyConvertibleTo(FT->getReturnType()) &&
2371 !Caller->use_empty())
2372 return false; // Cannot transform this return value...
2373
2374 // If the callsite is an invoke instruction, and the return value is used by
2375 // a PHI node in a successor, we cannot change the return type of the call
2376 // because there is no place to put the cast instruction (without breaking
2377 // the critical edge). Bail out in this case.
2378 if (!Caller->use_empty())
2379 if (InvokeInst *II = dyn_cast<InvokeInst>(Caller))
2380 for (Value::use_iterator UI = II->use_begin(), E = II->use_end();
2381 UI != E; ++UI)
2382 if (PHINode *PN = dyn_cast<PHINode>(*UI))
2383 if (PN->getParent() == II->getNormalDest() ||
Chris Lattnerfae8ab32004-02-08 21:44:31 +00002384 PN->getParent() == II->getUnwindDest())
Chris Lattner1f7942f2004-01-14 06:06:08 +00002385 return false;
2386 }
Chris Lattner970c33a2003-06-19 17:00:31 +00002387
2388 unsigned NumActualArgs = unsigned(CS.arg_end()-CS.arg_begin());
2389 unsigned NumCommonArgs = std::min(FT->getNumParams(), NumActualArgs);
2390
2391 CallSite::arg_iterator AI = CS.arg_begin();
2392 for (unsigned i = 0, e = NumCommonArgs; i != e; ++i, ++AI) {
2393 const Type *ParamTy = FT->getParamType(i);
2394 bool isConvertible = (*AI)->getType()->isLosslesslyConvertibleTo(ParamTy);
2395 if (Callee->isExternal() && !isConvertible) return false;
2396 }
2397
2398 if (FT->getNumParams() < NumActualArgs && !FT->isVarArg() &&
2399 Callee->isExternal())
2400 return false; // Do not delete arguments unless we have a function body...
2401
2402 // Okay, we decided that this is a safe thing to do: go ahead and start
2403 // inserting cast instructions as necessary...
2404 std::vector<Value*> Args;
2405 Args.reserve(NumActualArgs);
2406
2407 AI = CS.arg_begin();
2408 for (unsigned i = 0; i != NumCommonArgs; ++i, ++AI) {
2409 const Type *ParamTy = FT->getParamType(i);
2410 if ((*AI)->getType() == ParamTy) {
2411 Args.push_back(*AI);
2412 } else {
Chris Lattner1c631e82004-04-08 04:43:23 +00002413 Args.push_back(InsertNewInstBefore(new CastInst(*AI, ParamTy, "tmp"),
2414 *Caller));
Chris Lattner970c33a2003-06-19 17:00:31 +00002415 }
2416 }
2417
2418 // If the function takes more arguments than the call was taking, add them
2419 // now...
2420 for (unsigned i = NumCommonArgs; i != FT->getNumParams(); ++i)
2421 Args.push_back(Constant::getNullValue(FT->getParamType(i)));
2422
2423 // If we are removing arguments to the function, emit an obnoxious warning...
2424 if (FT->getNumParams() < NumActualArgs)
2425 if (!FT->isVarArg()) {
2426 std::cerr << "WARNING: While resolving call to function '"
2427 << Callee->getName() << "' arguments were dropped!\n";
2428 } else {
2429 // Add all of the arguments in their promoted form to the arg list...
2430 for (unsigned i = FT->getNumParams(); i != NumActualArgs; ++i, ++AI) {
2431 const Type *PTy = getPromotedType((*AI)->getType());
2432 if (PTy != (*AI)->getType()) {
2433 // Must promote to pass through va_arg area!
2434 Instruction *Cast = new CastInst(*AI, PTy, "tmp");
2435 InsertNewInstBefore(Cast, *Caller);
2436 Args.push_back(Cast);
2437 } else {
2438 Args.push_back(*AI);
2439 }
2440 }
2441 }
2442
2443 if (FT->getReturnType() == Type::VoidTy)
2444 Caller->setName(""); // Void type should not have a name...
2445
2446 Instruction *NC;
2447 if (InvokeInst *II = dyn_cast<InvokeInst>(Caller)) {
Chris Lattnerfae8ab32004-02-08 21:44:31 +00002448 NC = new InvokeInst(Callee, II->getNormalDest(), II->getUnwindDest(),
Chris Lattner970c33a2003-06-19 17:00:31 +00002449 Args, Caller->getName(), Caller);
2450 } else {
2451 NC = new CallInst(Callee, Args, Caller->getName(), Caller);
2452 }
2453
2454 // Insert a cast of the return type as necessary...
2455 Value *NV = NC;
2456 if (Caller->getType() != NV->getType() && !Caller->use_empty()) {
2457 if (NV->getType() != Type::VoidTy) {
2458 NV = NC = new CastInst(NC, Caller->getType(), "tmp");
Chris Lattner686767f2003-10-30 00:46:41 +00002459
2460 // If this is an invoke instruction, we should insert it after the first
2461 // non-phi, instruction in the normal successor block.
2462 if (InvokeInst *II = dyn_cast<InvokeInst>(Caller)) {
2463 BasicBlock::iterator I = II->getNormalDest()->begin();
2464 while (isa<PHINode>(I)) ++I;
2465 InsertNewInstBefore(NC, *I);
2466 } else {
2467 // Otherwise, it's a call, just insert cast right after the call instr
2468 InsertNewInstBefore(NC, *Caller);
2469 }
Chris Lattner51ea1272004-02-28 05:22:00 +00002470 AddUsersToWorkList(*Caller);
Chris Lattner970c33a2003-06-19 17:00:31 +00002471 } else {
2472 NV = Constant::getNullValue(Caller->getType());
2473 }
2474 }
2475
2476 if (Caller->getType() != Type::VoidTy && !Caller->use_empty())
2477 Caller->replaceAllUsesWith(NV);
2478 Caller->getParent()->getInstList().erase(Caller);
2479 removeFromWorkList(Caller);
2480 return true;
2481}
2482
2483
Chris Lattner48a44f72002-05-02 17:06:02 +00002484
Chris Lattnerbbbdd852002-05-06 18:06:38 +00002485// PHINode simplification
2486//
Chris Lattner113f4f42002-06-25 16:13:24 +00002487Instruction *InstCombiner::visitPHINode(PHINode &PN) {
Chris Lattner91daeb52003-12-19 05:58:40 +00002488 if (Value *V = hasConstantValue(&PN))
2489 return ReplaceInstUsesWith(PN, V);
Chris Lattner4db2d222004-02-16 05:07:08 +00002490
2491 // If the only user of this instruction is a cast instruction, and all of the
2492 // incoming values are constants, change this PHI to merge together the casted
2493 // constants.
2494 if (PN.hasOneUse())
2495 if (CastInst *CI = dyn_cast<CastInst>(PN.use_back()))
2496 if (CI->getType() != PN.getType()) { // noop casts will be folded
2497 bool AllConstant = true;
2498 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
2499 if (!isa<Constant>(PN.getIncomingValue(i))) {
2500 AllConstant = false;
2501 break;
2502 }
2503 if (AllConstant) {
2504 // Make a new PHI with all casted values.
2505 PHINode *New = new PHINode(CI->getType(), PN.getName(), &PN);
2506 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
2507 Constant *OldArg = cast<Constant>(PN.getIncomingValue(i));
2508 New->addIncoming(ConstantExpr::getCast(OldArg, New->getType()),
2509 PN.getIncomingBlock(i));
2510 }
2511
2512 // Update the cast instruction.
2513 CI->setOperand(0, New);
2514 WorkList.push_back(CI); // revisit the cast instruction to fold.
2515 WorkList.push_back(New); // Make sure to revisit the new Phi
2516 return &PN; // PN is now dead!
2517 }
2518 }
Chris Lattner91daeb52003-12-19 05:58:40 +00002519 return 0;
Chris Lattnerbbbdd852002-05-06 18:06:38 +00002520}
2521
Chris Lattner69193f92004-04-05 01:30:19 +00002522static Value *InsertSignExtendToPtrTy(Value *V, const Type *DTy,
2523 Instruction *InsertPoint,
2524 InstCombiner *IC) {
2525 unsigned PS = IC->getTargetData().getPointerSize();
2526 const Type *VTy = V->getType();
2527 Instruction *Cast;
2528 if (!VTy->isSigned() && VTy->getPrimitiveSize() < PS)
2529 // We must insert a cast to ensure we sign-extend.
2530 V = IC->InsertNewInstBefore(new CastInst(V, VTy->getSignedVersion(),
2531 V->getName()), *InsertPoint);
2532 return IC->InsertNewInstBefore(new CastInst(V, DTy, V->getName()),
2533 *InsertPoint);
2534}
2535
Chris Lattner48a44f72002-05-02 17:06:02 +00002536
Chris Lattner113f4f42002-06-25 16:13:24 +00002537Instruction *InstCombiner::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Chris Lattner5f667a62004-05-07 22:09:22 +00002538 Value *PtrOp = GEP.getOperand(0);
Chris Lattner471bd762003-05-22 19:07:21 +00002539 // Is it 'getelementptr %P, long 0' or 'getelementptr %P'
Chris Lattner113f4f42002-06-25 16:13:24 +00002540 // If so, eliminate the noop.
Chris Lattner8d0bacb2004-02-22 05:25:17 +00002541 if (GEP.getNumOperands() == 1)
Chris Lattner5f667a62004-05-07 22:09:22 +00002542 return ReplaceInstUsesWith(GEP, PtrOp);
Chris Lattner8d0bacb2004-02-22 05:25:17 +00002543
2544 bool HasZeroPointerIndex = false;
2545 if (Constant *C = dyn_cast<Constant>(GEP.getOperand(1)))
2546 HasZeroPointerIndex = C->isNullValue();
2547
2548 if (GEP.getNumOperands() == 2 && HasZeroPointerIndex)
Chris Lattner5f667a62004-05-07 22:09:22 +00002549 return ReplaceInstUsesWith(GEP, PtrOp);
Chris Lattner48a44f72002-05-02 17:06:02 +00002550
Chris Lattner69193f92004-04-05 01:30:19 +00002551 // Eliminate unneeded casts for indices.
2552 bool MadeChange = false;
Chris Lattner2b2412d2004-04-07 18:38:20 +00002553 gep_type_iterator GTI = gep_type_begin(GEP);
2554 for (unsigned i = 1, e = GEP.getNumOperands(); i != e; ++i, ++GTI)
2555 if (isa<SequentialType>(*GTI)) {
2556 if (CastInst *CI = dyn_cast<CastInst>(GEP.getOperand(i))) {
2557 Value *Src = CI->getOperand(0);
2558 const Type *SrcTy = Src->getType();
2559 const Type *DestTy = CI->getType();
2560 if (Src->getType()->isInteger()) {
2561 if (SrcTy->getPrimitiveSize() == DestTy->getPrimitiveSize()) {
2562 // We can always eliminate a cast from ulong or long to the other.
2563 // We can always eliminate a cast from uint to int or the other on
2564 // 32-bit pointer platforms.
2565 if (DestTy->getPrimitiveSize() >= TD->getPointerSize()) {
2566 MadeChange = true;
2567 GEP.setOperand(i, Src);
2568 }
2569 } else if (SrcTy->getPrimitiveSize() < DestTy->getPrimitiveSize() &&
2570 SrcTy->getPrimitiveSize() == 4) {
2571 // We can always eliminate a cast from int to [u]long. We can
2572 // eliminate a cast from uint to [u]long iff the target is a 32-bit
2573 // pointer target.
2574 if (SrcTy->isSigned() ||
2575 SrcTy->getPrimitiveSize() >= TD->getPointerSize()) {
2576 MadeChange = true;
2577 GEP.setOperand(i, Src);
2578 }
Chris Lattner69193f92004-04-05 01:30:19 +00002579 }
2580 }
2581 }
Chris Lattner2b2412d2004-04-07 18:38:20 +00002582 // If we are using a wider index than needed for this platform, shrink it
2583 // to what we need. If the incoming value needs a cast instruction,
2584 // insert it. This explicit cast can make subsequent optimizations more
2585 // obvious.
2586 Value *Op = GEP.getOperand(i);
2587 if (Op->getType()->getPrimitiveSize() > TD->getPointerSize())
Chris Lattner1e9ac1a2004-04-17 18:16:10 +00002588 if (Constant *C = dyn_cast<Constant>(Op)) {
2589 GEP.setOperand(i, ConstantExpr::getCast(C, TD->getIntPtrType()));
2590 MadeChange = true;
2591 } else {
Chris Lattner2b2412d2004-04-07 18:38:20 +00002592 Op = InsertNewInstBefore(new CastInst(Op, TD->getIntPtrType(),
2593 Op->getName()), GEP);
2594 GEP.setOperand(i, Op);
2595 MadeChange = true;
2596 }
Chris Lattner69193f92004-04-05 01:30:19 +00002597 }
2598 if (MadeChange) return &GEP;
2599
Chris Lattnerae7a0d32002-08-02 19:29:35 +00002600 // Combine Indices - If the source pointer to this getelementptr instruction
2601 // is a getelementptr instruction, combine the indices of the two
2602 // getelementptr instructions into a single instruction.
2603 //
Chris Lattner57c67b02004-03-25 22:59:29 +00002604 std::vector<Value*> SrcGEPOperands;
Chris Lattner5f667a62004-05-07 22:09:22 +00002605 if (GetElementPtrInst *Src = dyn_cast<GetElementPtrInst>(PtrOp)) {
Chris Lattner57c67b02004-03-25 22:59:29 +00002606 SrcGEPOperands.assign(Src->op_begin(), Src->op_end());
Chris Lattner5f667a62004-05-07 22:09:22 +00002607 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(PtrOp)) {
Chris Lattner57c67b02004-03-25 22:59:29 +00002608 if (CE->getOpcode() == Instruction::GetElementPtr)
2609 SrcGEPOperands.assign(CE->op_begin(), CE->op_end());
2610 }
2611
2612 if (!SrcGEPOperands.empty()) {
Chris Lattner5f667a62004-05-07 22:09:22 +00002613 // Note that if our source is a gep chain itself that we wait for that
2614 // chain to be resolved before we perform this transformation. This
2615 // avoids us creating a TON of code in some cases.
2616 //
2617 if (isa<GetElementPtrInst>(SrcGEPOperands[0]) &&
2618 cast<Instruction>(SrcGEPOperands[0])->getNumOperands() == 2)
2619 return 0; // Wait until our source is folded to completion.
2620
Chris Lattnerae7a0d32002-08-02 19:29:35 +00002621 std::vector<Value *> Indices;
Chris Lattner5f667a62004-05-07 22:09:22 +00002622
2623 // Find out whether the last index in the source GEP is a sequential idx.
2624 bool EndsWithSequential = false;
2625 for (gep_type_iterator I = gep_type_begin(*cast<User>(PtrOp)),
2626 E = gep_type_end(*cast<User>(PtrOp)); I != E; ++I)
Chris Lattner8ec5f882004-05-08 22:41:42 +00002627 EndsWithSequential = !isa<StructType>(*I);
Chris Lattnerca081252001-12-14 16:52:21 +00002628
Chris Lattnerae7a0d32002-08-02 19:29:35 +00002629 // Can we combine the two pointer arithmetics offsets?
Chris Lattner5f667a62004-05-07 22:09:22 +00002630 if (EndsWithSequential) {
Chris Lattner235af562003-03-05 22:33:14 +00002631 // Replace: gep (gep %P, long B), long A, ...
2632 // With: T = long A+B; gep %P, T, ...
2633 //
Chris Lattner5f667a62004-05-07 22:09:22 +00002634 Value *Sum, *SO1 = SrcGEPOperands.back(), *GO1 = GEP.getOperand(1);
Chris Lattner69193f92004-04-05 01:30:19 +00002635 if (SO1 == Constant::getNullValue(SO1->getType())) {
2636 Sum = GO1;
2637 } else if (GO1 == Constant::getNullValue(GO1->getType())) {
2638 Sum = SO1;
2639 } else {
2640 // If they aren't the same type, convert both to an integer of the
2641 // target's pointer size.
2642 if (SO1->getType() != GO1->getType()) {
2643 if (Constant *SO1C = dyn_cast<Constant>(SO1)) {
2644 SO1 = ConstantExpr::getCast(SO1C, GO1->getType());
2645 } else if (Constant *GO1C = dyn_cast<Constant>(GO1)) {
2646 GO1 = ConstantExpr::getCast(GO1C, SO1->getType());
2647 } else {
2648 unsigned PS = TD->getPointerSize();
2649 Instruction *Cast;
2650 if (SO1->getType()->getPrimitiveSize() == PS) {
2651 // Convert GO1 to SO1's type.
2652 GO1 = InsertSignExtendToPtrTy(GO1, SO1->getType(), &GEP, this);
2653
2654 } else if (GO1->getType()->getPrimitiveSize() == PS) {
2655 // Convert SO1 to GO1's type.
2656 SO1 = InsertSignExtendToPtrTy(SO1, GO1->getType(), &GEP, this);
2657 } else {
2658 const Type *PT = TD->getIntPtrType();
2659 SO1 = InsertSignExtendToPtrTy(SO1, PT, &GEP, this);
2660 GO1 = InsertSignExtendToPtrTy(GO1, PT, &GEP, this);
2661 }
2662 }
2663 }
Chris Lattner5f667a62004-05-07 22:09:22 +00002664 if (isa<Constant>(SO1) && isa<Constant>(GO1))
2665 Sum = ConstantExpr::getAdd(cast<Constant>(SO1), cast<Constant>(GO1));
2666 else {
2667 Sum = BinaryOperator::create(Instruction::Add, SO1, GO1,
2668 PtrOp->getName()+".sum", &GEP);
2669 WorkList.push_back(cast<Instruction>(Sum));
2670 }
Chris Lattner69193f92004-04-05 01:30:19 +00002671 }
Chris Lattner5f667a62004-05-07 22:09:22 +00002672
2673 // Recycle the GEP we already have if possible.
2674 if (SrcGEPOperands.size() == 2) {
2675 GEP.setOperand(0, SrcGEPOperands[0]);
2676 GEP.setOperand(1, Sum);
2677 return &GEP;
2678 } else {
2679 Indices.insert(Indices.end(), SrcGEPOperands.begin()+1,
2680 SrcGEPOperands.end()-1);
2681 Indices.push_back(Sum);
2682 Indices.insert(Indices.end(), GEP.op_begin()+2, GEP.op_end());
2683 }
Chris Lattner69193f92004-04-05 01:30:19 +00002684 } else if (isa<Constant>(*GEP.idx_begin()) &&
2685 cast<Constant>(*GEP.idx_begin())->isNullValue() &&
Chris Lattner57c67b02004-03-25 22:59:29 +00002686 SrcGEPOperands.size() != 1) {
Chris Lattnerae7a0d32002-08-02 19:29:35 +00002687 // Otherwise we can do the fold if the first index of the GEP is a zero
Chris Lattner57c67b02004-03-25 22:59:29 +00002688 Indices.insert(Indices.end(), SrcGEPOperands.begin()+1,
2689 SrcGEPOperands.end());
Chris Lattnerae7a0d32002-08-02 19:29:35 +00002690 Indices.insert(Indices.end(), GEP.idx_begin()+1, GEP.idx_end());
2691 }
2692
2693 if (!Indices.empty())
Chris Lattner57c67b02004-03-25 22:59:29 +00002694 return new GetElementPtrInst(SrcGEPOperands[0], Indices, GEP.getName());
Chris Lattnerc59af1d2002-08-17 22:21:59 +00002695
Chris Lattner5f667a62004-05-07 22:09:22 +00002696 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(PtrOp)) {
Chris Lattnerc59af1d2002-08-17 22:21:59 +00002697 // GEP of global variable. If all of the indices for this GEP are
2698 // constants, we can promote this to a constexpr instead of an instruction.
2699
2700 // Scan for nonconstants...
2701 std::vector<Constant*> Indices;
2702 User::op_iterator I = GEP.idx_begin(), E = GEP.idx_end();
2703 for (; I != E && isa<Constant>(*I); ++I)
2704 Indices.push_back(cast<Constant>(*I));
2705
2706 if (I == E) { // If they are all constants...
Chris Lattner46b3d302003-04-16 22:40:51 +00002707 Constant *CE =
Chris Lattnerc59af1d2002-08-17 22:21:59 +00002708 ConstantExpr::getGetElementPtr(ConstantPointerRef::get(GV), Indices);
2709
2710 // Replace all uses of the GEP with the new constexpr...
2711 return ReplaceInstUsesWith(GEP, CE);
2712 }
Chris Lattner5f667a62004-05-07 22:09:22 +00002713 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(PtrOp)) {
Chris Lattner8d0bacb2004-02-22 05:25:17 +00002714 if (CE->getOpcode() == Instruction::Cast) {
2715 if (HasZeroPointerIndex) {
2716 // transform: GEP (cast [10 x ubyte]* X to [0 x ubyte]*), long 0, ...
2717 // into : GEP [10 x ubyte]* X, long 0, ...
2718 //
2719 // This occurs when the program declares an array extern like "int X[];"
2720 //
2721 Constant *X = CE->getOperand(0);
2722 const PointerType *CPTy = cast<PointerType>(CE->getType());
2723 if (const PointerType *XTy = dyn_cast<PointerType>(X->getType()))
2724 if (const ArrayType *XATy =
2725 dyn_cast<ArrayType>(XTy->getElementType()))
2726 if (const ArrayType *CATy =
2727 dyn_cast<ArrayType>(CPTy->getElementType()))
2728 if (CATy->getElementType() == XATy->getElementType()) {
2729 // At this point, we know that the cast source type is a pointer
2730 // to an array of the same type as the destination pointer
2731 // array. Because the array type is never stepped over (there
2732 // is a leading zero) we can fold the cast into this GEP.
2733 GEP.setOperand(0, X);
2734 return &GEP;
2735 }
2736 }
2737 }
Chris Lattnerca081252001-12-14 16:52:21 +00002738 }
2739
Chris Lattnerca081252001-12-14 16:52:21 +00002740 return 0;
2741}
2742
Chris Lattner1085bdf2002-11-04 16:18:53 +00002743Instruction *InstCombiner::visitAllocationInst(AllocationInst &AI) {
2744 // Convert: malloc Ty, C - where C is a constant != 1 into: malloc [C x Ty], 1
2745 if (AI.isArrayAllocation()) // Check C != 1
2746 if (const ConstantUInt *C = dyn_cast<ConstantUInt>(AI.getArraySize())) {
2747 const Type *NewTy = ArrayType::get(AI.getAllocatedType(), C->getValue());
Chris Lattnera2620ac2002-11-09 00:49:43 +00002748 AllocationInst *New = 0;
Chris Lattner1085bdf2002-11-04 16:18:53 +00002749
2750 // Create and insert the replacement instruction...
2751 if (isa<MallocInst>(AI))
Chris Lattnerabb77c92004-03-19 06:08:10 +00002752 New = new MallocInst(NewTy, 0, AI.getName());
Chris Lattnera2620ac2002-11-09 00:49:43 +00002753 else {
2754 assert(isa<AllocaInst>(AI) && "Unknown type of allocation inst!");
Chris Lattnerabb77c92004-03-19 06:08:10 +00002755 New = new AllocaInst(NewTy, 0, AI.getName());
Chris Lattnera2620ac2002-11-09 00:49:43 +00002756 }
Chris Lattnerabb77c92004-03-19 06:08:10 +00002757
2758 InsertNewInstBefore(New, AI);
Chris Lattner1085bdf2002-11-04 16:18:53 +00002759
2760 // Scan to the end of the allocation instructions, to skip over a block of
2761 // allocas if possible...
2762 //
2763 BasicBlock::iterator It = New;
2764 while (isa<AllocationInst>(*It)) ++It;
2765
2766 // Now that I is pointing to the first non-allocation-inst in the block,
2767 // insert our getelementptr instruction...
2768 //
Chris Lattner69193f92004-04-05 01:30:19 +00002769 std::vector<Value*> Idx(2, Constant::getNullValue(Type::IntTy));
Chris Lattner1085bdf2002-11-04 16:18:53 +00002770 Value *V = new GetElementPtrInst(New, Idx, New->getName()+".sub", It);
2771
2772 // Now make everything use the getelementptr instead of the original
2773 // allocation.
Chris Lattnerabb77c92004-03-19 06:08:10 +00002774 return ReplaceInstUsesWith(AI, V);
Chris Lattner1085bdf2002-11-04 16:18:53 +00002775 }
Chris Lattnerabb77c92004-03-19 06:08:10 +00002776
2777 // If alloca'ing a zero byte object, replace the alloca with a null pointer.
2778 // Note that we only do this for alloca's, because malloc should allocate and
2779 // return a unique pointer, even for a zero byte allocation.
2780 if (isa<AllocaInst>(AI) && TD->getTypeSize(AI.getAllocatedType()) == 0)
2781 return ReplaceInstUsesWith(AI, Constant::getNullValue(AI.getType()));
2782
Chris Lattner1085bdf2002-11-04 16:18:53 +00002783 return 0;
2784}
2785
Chris Lattner8427bff2003-12-07 01:24:23 +00002786Instruction *InstCombiner::visitFreeInst(FreeInst &FI) {
2787 Value *Op = FI.getOperand(0);
2788
2789 // Change free <ty>* (cast <ty2>* X to <ty>*) into free <ty2>* X
2790 if (CastInst *CI = dyn_cast<CastInst>(Op))
2791 if (isa<PointerType>(CI->getOperand(0)->getType())) {
2792 FI.setOperand(0, CI->getOperand(0));
2793 return &FI;
2794 }
2795
Chris Lattnerf3a36602004-02-28 04:57:37 +00002796 // If we have 'free null' delete the instruction. This can happen in stl code
2797 // when lots of inlining happens.
Chris Lattner51ea1272004-02-28 05:22:00 +00002798 if (isa<ConstantPointerNull>(Op))
2799 return EraseInstFromFunction(FI);
Chris Lattnerf3a36602004-02-28 04:57:37 +00002800
Chris Lattner8427bff2003-12-07 01:24:23 +00002801 return 0;
2802}
2803
2804
Chris Lattner0f1d8a32003-06-26 05:06:25 +00002805/// GetGEPGlobalInitializer - Given a constant, and a getelementptr
2806/// constantexpr, return the constant value being addressed by the constant
2807/// expression, or null if something is funny.
2808///
2809static Constant *GetGEPGlobalInitializer(Constant *C, ConstantExpr *CE) {
Chris Lattner69193f92004-04-05 01:30:19 +00002810 if (CE->getOperand(1) != Constant::getNullValue(CE->getOperand(1)->getType()))
Chris Lattner0f1d8a32003-06-26 05:06:25 +00002811 return 0; // Do not allow stepping over the value!
2812
2813 // Loop over all of the operands, tracking down which value we are
2814 // addressing...
2815 for (unsigned i = 2, e = CE->getNumOperands(); i != e; ++i)
2816 if (ConstantUInt *CU = dyn_cast<ConstantUInt>(CE->getOperand(i))) {
Chris Lattner76b2ff42004-02-15 05:55:15 +00002817 ConstantStruct *CS = dyn_cast<ConstantStruct>(C);
2818 if (CS == 0) return 0;
Chris Lattner0f1d8a32003-06-26 05:06:25 +00002819 if (CU->getValue() >= CS->getValues().size()) return 0;
2820 C = cast<Constant>(CS->getValues()[CU->getValue()]);
2821 } else if (ConstantSInt *CS = dyn_cast<ConstantSInt>(CE->getOperand(i))) {
Chris Lattner76b2ff42004-02-15 05:55:15 +00002822 ConstantArray *CA = dyn_cast<ConstantArray>(C);
2823 if (CA == 0) return 0;
Chris Lattner0f1d8a32003-06-26 05:06:25 +00002824 if ((uint64_t)CS->getValue() >= CA->getValues().size()) return 0;
2825 C = cast<Constant>(CA->getValues()[CS->getValue()]);
2826 } else
2827 return 0;
2828 return C;
2829}
2830
2831Instruction *InstCombiner::visitLoadInst(LoadInst &LI) {
2832 Value *Op = LI.getOperand(0);
Chris Lattner7e8af382004-01-12 04:13:56 +00002833 if (LI.isVolatile()) return 0;
2834
Chris Lattner6679e462004-04-14 03:28:36 +00002835 if (Constant *C = dyn_cast<Constant>(Op))
2836 if (C->isNullValue()) // load null -> 0
2837 return ReplaceInstUsesWith(LI, Constant::getNullValue(LI.getType()));
2838 else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(C))
2839 Op = CPR->getValue();
Chris Lattner0f1d8a32003-06-26 05:06:25 +00002840
2841 // Instcombine load (constant global) into the value loaded...
2842 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Op))
Chris Lattnerbdb0ce02003-07-22 21:46:59 +00002843 if (GV->isConstant() && !GV->isExternal())
Chris Lattner0f1d8a32003-06-26 05:06:25 +00002844 return ReplaceInstUsesWith(LI, GV->getInitializer());
2845
2846 // Instcombine load (constantexpr_GEP global, 0, ...) into the value loaded...
2847 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Op))
2848 if (CE->getOpcode() == Instruction::GetElementPtr)
2849 if (ConstantPointerRef *G=dyn_cast<ConstantPointerRef>(CE->getOperand(0)))
2850 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(G->getValue()))
Chris Lattnerbdb0ce02003-07-22 21:46:59 +00002851 if (GV->isConstant() && !GV->isExternal())
Chris Lattner0f1d8a32003-06-26 05:06:25 +00002852 if (Constant *V = GetGEPGlobalInitializer(GV->getInitializer(), CE))
2853 return ReplaceInstUsesWith(LI, V);
Chris Lattnere228ee52004-04-08 20:39:49 +00002854
2855 // load (cast X) --> cast (load X) iff safe
2856 if (CastInst *CI = dyn_cast<CastInst>(Op)) {
2857 const Type *DestPTy = cast<PointerType>(CI->getType())->getElementType();
2858 if (const PointerType *SrcTy =
2859 dyn_cast<PointerType>(CI->getOperand(0)->getType())) {
2860 const Type *SrcPTy = SrcTy->getElementType();
Chris Lattnerd9e58132004-05-07 15:35:56 +00002861 if (SrcPTy->isSized() && DestPTy->isSized() &&
2862 TD->getTypeSize(SrcPTy) == TD->getTypeSize(DestPTy) &&
Chris Lattnere228ee52004-04-08 20:39:49 +00002863 (SrcPTy->isInteger() || isa<PointerType>(SrcPTy)) &&
2864 (DestPTy->isInteger() || isa<PointerType>(DestPTy))) {
2865 // Okay, we are casting from one integer or pointer type to another of
2866 // the same size. Instead of casting the pointer before the load, cast
2867 // the result of the loaded value.
2868 Value *NewLoad = InsertNewInstBefore(new LoadInst(CI->getOperand(0),
2869 CI->getName()), LI);
2870 // Now cast the result of the load.
2871 return new CastInst(NewLoad, LI.getType());
2872 }
2873 }
2874 }
2875
Chris Lattner0f1d8a32003-06-26 05:06:25 +00002876 return 0;
2877}
2878
2879
Chris Lattner9eef8a72003-06-04 04:46:00 +00002880Instruction *InstCombiner::visitBranchInst(BranchInst &BI) {
2881 // Change br (not X), label True, label False to: br X, label False, True
Chris Lattner4f7acca2004-02-27 06:27:46 +00002882 if (BI.isConditional() && !isa<Constant>(BI.getCondition())) {
Chris Lattnere967b342003-06-04 05:10:11 +00002883 if (Value *V = dyn_castNotVal(BI.getCondition())) {
2884 BasicBlock *TrueDest = BI.getSuccessor(0);
2885 BasicBlock *FalseDest = BI.getSuccessor(1);
2886 // Swap Destinations and condition...
2887 BI.setCondition(V);
2888 BI.setSuccessor(0, FalseDest);
2889 BI.setSuccessor(1, TrueDest);
2890 return &BI;
Chris Lattner4f7acca2004-02-27 06:27:46 +00002891 } else if (SetCondInst *I = dyn_cast<SetCondInst>(BI.getCondition())) {
2892 // Cannonicalize setne -> seteq
2893 if ((I->getOpcode() == Instruction::SetNE ||
2894 I->getOpcode() == Instruction::SetLE ||
2895 I->getOpcode() == Instruction::SetGE) && I->hasOneUse()) {
2896 std::string Name = I->getName(); I->setName("");
2897 Instruction::BinaryOps NewOpcode =
2898 SetCondInst::getInverseCondition(I->getOpcode());
2899 Value *NewSCC = BinaryOperator::create(NewOpcode, I->getOperand(0),
2900 I->getOperand(1), Name, I);
2901 BasicBlock *TrueDest = BI.getSuccessor(0);
2902 BasicBlock *FalseDest = BI.getSuccessor(1);
2903 // Swap Destinations and condition...
2904 BI.setCondition(NewSCC);
2905 BI.setSuccessor(0, FalseDest);
2906 BI.setSuccessor(1, TrueDest);
2907 removeFromWorkList(I);
2908 I->getParent()->getInstList().erase(I);
2909 WorkList.push_back(cast<Instruction>(NewSCC));
2910 return &BI;
2911 }
Chris Lattnere967b342003-06-04 05:10:11 +00002912 }
Chris Lattner4f7acca2004-02-27 06:27:46 +00002913 }
Chris Lattner9eef8a72003-06-04 04:46:00 +00002914 return 0;
2915}
Chris Lattner1085bdf2002-11-04 16:18:53 +00002916
Chris Lattnerca081252001-12-14 16:52:21 +00002917
Chris Lattner99f48c62002-09-02 04:59:56 +00002918void InstCombiner::removeFromWorkList(Instruction *I) {
2919 WorkList.erase(std::remove(WorkList.begin(), WorkList.end(), I),
2920 WorkList.end());
2921}
2922
Chris Lattner113f4f42002-06-25 16:13:24 +00002923bool InstCombiner::runOnFunction(Function &F) {
Chris Lattner260ab202002-04-18 17:39:14 +00002924 bool Changed = false;
Chris Lattnerf4ad1652003-11-02 05:57:39 +00002925 TD = &getAnalysis<TargetData>();
Chris Lattnerca081252001-12-14 16:52:21 +00002926
Chris Lattnerb643a9e2004-05-01 23:19:52 +00002927 for (inst_iterator i = inst_begin(F), e = inst_end(F); i != e; ++i)
2928 WorkList.push_back(&*i);
Chris Lattner2d3a7a62004-04-27 15:13:33 +00002929
Chris Lattnerca081252001-12-14 16:52:21 +00002930
2931 while (!WorkList.empty()) {
2932 Instruction *I = WorkList.back(); // Get an instruction from the worklist
2933 WorkList.pop_back();
2934
Misha Brukman632df282002-10-29 23:06:16 +00002935 // Check to see if we can DCE or ConstantPropagate the instruction...
Chris Lattner99f48c62002-09-02 04:59:56 +00002936 // Check to see if we can DIE the instruction...
2937 if (isInstructionTriviallyDead(I)) {
2938 // Add operands to the worklist...
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002939 if (I->getNumOperands() < 4)
Chris Lattner51ea1272004-02-28 05:22:00 +00002940 AddUsesToWorkList(*I);
Chris Lattner99f48c62002-09-02 04:59:56 +00002941 ++NumDeadInst;
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002942
2943 I->getParent()->getInstList().erase(I);
2944 removeFromWorkList(I);
2945 continue;
2946 }
Chris Lattner99f48c62002-09-02 04:59:56 +00002947
Misha Brukman632df282002-10-29 23:06:16 +00002948 // Instruction isn't dead, see if we can constant propagate it...
Chris Lattner99f48c62002-09-02 04:59:56 +00002949 if (Constant *C = ConstantFoldInstruction(I)) {
2950 // Add operands to the worklist...
Chris Lattner51ea1272004-02-28 05:22:00 +00002951 AddUsesToWorkList(*I);
Chris Lattnerc6509f42002-12-05 22:41:53 +00002952 ReplaceInstUsesWith(*I, C);
2953
Chris Lattner99f48c62002-09-02 04:59:56 +00002954 ++NumConstProp;
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002955 I->getParent()->getInstList().erase(I);
Chris Lattner800aaaf2003-10-07 15:17:02 +00002956 removeFromWorkList(I);
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002957 continue;
Chris Lattner99f48c62002-09-02 04:59:56 +00002958 }
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002959
Chris Lattner57c67b02004-03-25 22:59:29 +00002960 // Check to see if any of the operands of this instruction are a
2961 // ConstantPointerRef. Since they sneak in all over the place and inhibit
2962 // optimization, we want to strip them out unconditionally!
2963 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
2964 if (ConstantPointerRef *CPR =
2965 dyn_cast<ConstantPointerRef>(I->getOperand(i))) {
2966 I->setOperand(i, CPR->getValue());
2967 Changed = true;
2968 }
2969
Chris Lattnerca081252001-12-14 16:52:21 +00002970 // Now that we have an instruction, try combining it to simplify it...
Chris Lattnerae7a0d32002-08-02 19:29:35 +00002971 if (Instruction *Result = visit(*I)) {
Chris Lattner0b18c1d2002-05-10 15:38:35 +00002972 ++NumCombined;
Chris Lattner260ab202002-04-18 17:39:14 +00002973 // Should we replace the old instruction with a new one?
Chris Lattner053c0932002-05-14 15:24:07 +00002974 if (Result != I) {
Chris Lattner7d2a5392004-03-13 23:54:27 +00002975 DEBUG(std::cerr << "IC: Old = " << *I
2976 << " New = " << *Result);
2977
Chris Lattner053c0932002-05-14 15:24:07 +00002978 // Instructions can end up on the worklist more than once. Make sure
2979 // we do not process an instruction that has been deleted.
Chris Lattner99f48c62002-09-02 04:59:56 +00002980 removeFromWorkList(I);
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002981
2982 // Move the name to the new instruction first...
2983 std::string OldName = I->getName(); I->setName("");
Chris Lattner950fc782003-10-07 22:58:41 +00002984 Result->setName(OldName);
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002985
2986 // Insert the new instruction into the basic block...
2987 BasicBlock *InstParent = I->getParent();
2988 InstParent->getInstList().insert(I, Result);
2989
Chris Lattner63d75af2004-05-01 23:27:23 +00002990 // Make sure that we reprocess all operands now that we reduced their
2991 // use counts.
Chris Lattnerb643a9e2004-05-01 23:19:52 +00002992 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
2993 if (Instruction *OpI = dyn_cast<Instruction>(I->getOperand(i)))
2994 WorkList.push_back(OpI);
2995
Chris Lattnere8ed4ef2003-10-06 17:11:01 +00002996 // Everything uses the new instruction now...
2997 I->replaceAllUsesWith(Result);
2998
2999 // Erase the old instruction.
3000 InstParent->getInstList().erase(I);
Chris Lattner113f4f42002-06-25 16:13:24 +00003001 } else {
Chris Lattner7d2a5392004-03-13 23:54:27 +00003002 DEBUG(std::cerr << "IC: MOD = " << *I);
3003
Chris Lattnerae7a0d32002-08-02 19:29:35 +00003004 // If the instruction was modified, it's possible that it is now dead.
3005 // if so, remove it.
Chris Lattner63d75af2004-05-01 23:27:23 +00003006 if (isInstructionTriviallyDead(I)) {
3007 // Make sure we process all operands now that we are reducing their
3008 // use counts.
3009 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
3010 if (Instruction *OpI = dyn_cast<Instruction>(I->getOperand(i)))
3011 WorkList.push_back(OpI);
3012
3013 // Instructions may end up in the worklist more than once. Erase all
3014 // occurrances of this instruction.
Chris Lattner99f48c62002-09-02 04:59:56 +00003015 removeFromWorkList(I);
Chris Lattner63d75af2004-05-01 23:27:23 +00003016 I->getParent()->getInstList().erase(I);
Chris Lattnerae7a0d32002-08-02 19:29:35 +00003017 Result = 0;
3018 }
Chris Lattner053c0932002-05-14 15:24:07 +00003019 }
Chris Lattner260ab202002-04-18 17:39:14 +00003020
Chris Lattnerae7a0d32002-08-02 19:29:35 +00003021 if (Result) {
3022 WorkList.push_back(Result);
Chris Lattner51ea1272004-02-28 05:22:00 +00003023 AddUsersToWorkList(*Result);
Chris Lattnerae7a0d32002-08-02 19:29:35 +00003024 }
Chris Lattner260ab202002-04-18 17:39:14 +00003025 Changed = true;
Chris Lattnerca081252001-12-14 16:52:21 +00003026 }
3027 }
3028
Chris Lattner260ab202002-04-18 17:39:14 +00003029 return Changed;
Chris Lattner04805fa2002-02-26 21:46:54 +00003030}
3031
Chris Lattner8427bff2003-12-07 01:24:23 +00003032Pass *llvm::createInstructionCombiningPass() {
Chris Lattner260ab202002-04-18 17:39:14 +00003033 return new InstCombiner();
Chris Lattner04805fa2002-02-26 21:46:54 +00003034}
Brian Gaeke960707c2003-11-11 22:41:34 +00003035