blob: 04755de79cddefe894ea3cb12be95f793bbbfaaa [file] [log] [blame]
Nick Lewycky05450ae2006-08-28 22:44:55 +00001//===-- PredicateSimplifier.cpp - Path Sensitive Simplifier -----------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file was developed by Nick Lewycky and is distributed under the
6// University of Illinois Open Source License. See LICENSE.TXT for details.
7//
8//===------------------------------------------------------------------===//
9//
10// Path-sensitive optimizer. In a branch where x == y, replace uses of
11// x with y. Permits further optimization, such as the elimination of
12// the unreachable call:
13//
14// void test(int *p, int *q)
15// {
16// if (p != q)
17// return;
18//
19// if (*p != *q)
20// foo(); // unreachable
21// }
22//
23//===------------------------------------------------------------------===//
24//
25// This optimization works by substituting %q for %p when protected by a
Nick Lewycky3947a762006-08-30 02:46:48 +000026// conditional that assures us of that fact. Properties are stored as
27// relationships between two values.
Nick Lewycky05450ae2006-08-28 22:44:55 +000028//
29//===------------------------------------------------------------------===//
30
Nick Lewycky05450ae2006-08-28 22:44:55 +000031#define DEBUG_TYPE "predsimplify"
32#include "llvm/Transforms/Scalar.h"
33#include "llvm/Constants.h"
34#include "llvm/Instructions.h"
35#include "llvm/Pass.h"
36#include "llvm/ADT/Statistic.h"
37#include "llvm/ADT/STLExtras.h"
38#include "llvm/Analysis/Dominators.h"
39#include "llvm/Support/CFG.h"
40#include "llvm/Support/Debug.h"
41#include <iostream>
42using namespace llvm;
43
Nick Lewyckydc08cd52006-09-10 02:27:07 +000044typedef DominatorTree::Node DTNodeType;
45
Nick Lewycky05450ae2006-08-28 22:44:55 +000046namespace {
47 Statistic<>
48 NumVarsReplaced("predsimplify", "Number of argument substitutions");
49 Statistic<>
Nick Lewycky3947a762006-08-30 02:46:48 +000050 NumInstruction("predsimplify", "Number of instructions removed");
Nick Lewycky05450ae2006-08-28 22:44:55 +000051
Nick Lewycky406fc0c2006-09-20 17:04:01 +000052 class PropertySet;
Nick Lewycky05450ae2006-08-28 22:44:55 +000053
Nick Lewyckydc08cd52006-09-10 02:27:07 +000054 /// Similar to EquivalenceClasses, this stores the set of equivalent
Nick Lewycky406fc0c2006-09-20 17:04:01 +000055 /// types. Beyond EquivalenceClasses, it allows us to specify which
56 /// element will act as leader.
57 template<typename ElemTy>
Nick Lewyckydc08cd52006-09-10 02:27:07 +000058 class VISIBILITY_HIDDEN Synonyms {
59 std::map<ElemTy, unsigned> mapping;
60 std::vector<ElemTy> leaders;
Nick Lewycky406fc0c2006-09-20 17:04:01 +000061 PropertySet *PS;
Nick Lewyckydc08cd52006-09-10 02:27:07 +000062
63 public:
64 typedef unsigned iterator;
65 typedef const unsigned const_iterator;
66
Nick Lewycky406fc0c2006-09-20 17:04:01 +000067 Synonyms(PropertySet *PS) : PS(PS) {}
68
Nick Lewyckydc08cd52006-09-10 02:27:07 +000069 // Inspection
70
71 bool empty() const {
72 return leaders.empty();
73 }
74
75 iterator findLeader(ElemTy e) {
76 typename std::map<ElemTy, unsigned>::iterator MI = mapping.find(e);
77 if (MI == mapping.end()) return 0;
78
79 return MI->second;
80 }
81
82 const_iterator findLeader(ElemTy e) const {
83 typename std::map<ElemTy, unsigned>::const_iterator MI =
84 mapping.find(e);
85 if (MI == mapping.end()) return 0;
86
87 return MI->second;
88 }
89
90 ElemTy &getLeader(iterator I) {
Nick Lewycky025f4c02006-09-18 21:09:35 +000091 assert(I && I <= leaders.size() && "Illegal leader to get.");
Nick Lewyckydc08cd52006-09-10 02:27:07 +000092 return leaders[I-1];
93 }
94
95 const ElemTy &getLeader(const_iterator I) const {
Nick Lewycky025f4c02006-09-18 21:09:35 +000096 assert(I && I <= leaders.size() && "Illegal leaders to get.");
Nick Lewyckydc08cd52006-09-10 02:27:07 +000097 return leaders[I-1];
98 }
99
100#ifdef DEBUG
101 void debug(std::ostream &os) const {
102 for (unsigned i = 1, e = leaders.size()+1; i != e; ++i) {
Nick Lewycky668a1d02006-09-13 19:32:53 +0000103 os << i << ". " << *getLeader(i) << ": [";
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000104 for (std::map<Value *, unsigned>::const_iterator
105 I = mapping.begin(), E = mapping.end(); I != E; ++I) {
106 if ((*I).second == i && (*I).first != leaders[i-1]) {
107 os << *(*I).first << " ";
Nick Lewycky977be252006-09-13 19:24:01 +0000108 }
109 }
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000110 os << "]\n";
111 }
112 }
113#endif
114
115 // Mutators
116
117 /// Combine two sets referring to the same element, inserting the
118 /// elements as needed. Returns a valid iterator iff two already
119 /// existing disjoint synonym sets were combined. The iterator
Nick Lewycky406fc0c2006-09-20 17:04:01 +0000120 /// points to the no longer existing element.
121 iterator unionSets(ElemTy E1, ElemTy E2);
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000122
123 /// Returns an iterator pointing to the synonym set containing
124 /// element e. If none exists, a new one is created and returned.
125 iterator findOrInsert(ElemTy e) {
126 iterator I = findLeader(e);
127 if (I) return I;
128
129 leaders.push_back(e);
130 I = leaders.size();
131 mapping[e] = I;
132 return I;
133 }
134 };
135
Nick Lewycky05450ae2006-08-28 22:44:55 +0000136 /// Represents the set of equivalent Value*s and provides insertion
137 /// and fast lookup. Also stores the set of inequality relationships.
138 class PropertySet {
Nick Lewycky8f389d82006-09-23 15:13:08 +0000139 /// Returns true if V1 is a better choice than V2.
Nick Lewycky406fc0c2006-09-20 17:04:01 +0000140 bool compare(Value *V1, Value *V2) const {
141 if (isa<Constant>(V1)) {
142 if (!isa<Constant>(V2)) {
143 return true;
144 }
145 } else if (isa<Argument>(V1)) {
146 if (!isa<Constant>(V2) && !isa<Argument>(V2)) {
147 return true;
148 }
149 }
150 if (Instruction *I1 = dyn_cast<Instruction>(V1)) {
151 if (Instruction *I2 = dyn_cast<Instruction>(V2)) {
152 BasicBlock *BB1 = I1->getParent(),
153 *BB2 = I2->getParent();
154 if (BB1 == BB2) {
155 for (BasicBlock::const_iterator I = BB1->begin(), E = BB1->end();
156 I != E; ++I) {
157 if (&*I == I1) return true;
158 if (&*I == I2) return false;
159 }
160 assert(0 && "Instructions not found in parent BasicBlock?");
161 } else
162 return DT->getNode(BB1)->properlyDominates(DT->getNode(BB2));
163 }
164 }
165 return false;
166 }
167
Nick Lewycky05450ae2006-08-28 22:44:55 +0000168 struct Property;
169 public:
Nick Lewycky406fc0c2006-09-20 17:04:01 +0000170 /// Choose the canonical Value in a synonym set.
171 /// Leaves the more canonical choice in V1.
172 void order(Value *&V1, Value *&V2) const {
173 if (compare(V2, V1)) std::swap(V1, V2);
174 }
175
176 PropertySet(DominatorTree *DT) : union_find(this), DT(DT) {}
177
178 class Synonyms<Value *> union_find;
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000179
Nick Lewycky05450ae2006-08-28 22:44:55 +0000180 typedef std::vector<Property>::iterator PropertyIterator;
181 typedef std::vector<Property>::const_iterator ConstPropertyIterator;
Nick Lewycky406fc0c2006-09-20 17:04:01 +0000182 typedef Synonyms<Value *>::iterator SynonymIterator;
Nick Lewycky05450ae2006-08-28 22:44:55 +0000183
184 enum Ops {
185 EQ,
186 NE
187 };
188
189 Value *canonicalize(Value *V) const {
190 Value *C = lookup(V);
191 return C ? C : V;
192 }
193
194 Value *lookup(Value *V) const {
Nick Lewycky406fc0c2006-09-20 17:04:01 +0000195 SynonymIterator SI = union_find.findLeader(V);
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000196 if (!SI) return NULL;
197 return union_find.getLeader(SI);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000198 }
199
200 bool empty() const {
Nick Lewycky3947a762006-08-30 02:46:48 +0000201 return union_find.empty();
Nick Lewycky05450ae2006-08-28 22:44:55 +0000202 }
203
204 void addEqual(Value *V1, Value *V2) {
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000205 // If %x = 0. and %y = -0., seteq %x, %y is true, but
206 // copysign(%x) is not the same as copysign(%y).
Nick Lewycky977be252006-09-13 19:24:01 +0000207 if (V1->getType()->isFloatingPoint()) return;
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000208
Nick Lewycky05450ae2006-08-28 22:44:55 +0000209 order(V1, V2);
210 if (isa<Constant>(V2)) return; // refuse to set false == true.
211
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000212 SynonymIterator deleted = union_find.unionSets(V1, V2);
213 if (deleted) {
214 SynonymIterator replacement = union_find.findLeader(V1);
215 // Move Properties
216 for (PropertyIterator I = Properties.begin(), E = Properties.end();
217 I != E; ++I) {
218 if (I->I1 == deleted) I->I1 = replacement;
219 else if (I->I1 > deleted) --I->I1;
220 if (I->I2 == deleted) I->I2 = replacement;
221 else if (I->I2 > deleted) --I->I2;
222 }
223 }
Nick Lewycky05450ae2006-08-28 22:44:55 +0000224 addImpliedProperties(EQ, V1, V2);
225 }
226
227 void addNotEqual(Value *V1, Value *V2) {
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000228 // If %x = NAN then seteq %x, %x is false.
Nick Lewycky977be252006-09-13 19:24:01 +0000229 if (V1->getType()->isFloatingPoint()) return;
230
231 // For example, %x = setne int 0, 0 causes "0 != 0".
232 if (isa<Constant>(V1) && isa<Constant>(V2)) return;
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000233
Nick Lewycky6e39c7e2006-08-31 00:39:16 +0000234 if (findProperty(NE, V1, V2) != Properties.end())
235 return; // found.
Nick Lewycky05450ae2006-08-28 22:44:55 +0000236
237 // Add the property.
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000238 SynonymIterator I1 = union_find.findOrInsert(V1),
239 I2 = union_find.findOrInsert(V2);
Nick Lewycky977be252006-09-13 19:24:01 +0000240
241 // Technically this means that the block is unreachable.
242 if (I1 == I2) return;
243
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000244 Properties.push_back(Property(NE, I1, I2));
Nick Lewycky05450ae2006-08-28 22:44:55 +0000245 addImpliedProperties(NE, V1, V2);
246 }
247
248 PropertyIterator findProperty(Ops Opcode, Value *V1, Value *V2) {
249 assert(Opcode != EQ && "Can't findProperty on EQ."
250 "Use the lookup method instead.");
251
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000252 SynonymIterator I1 = union_find.findLeader(V1),
253 I2 = union_find.findLeader(V2);
254 if (!I1 || !I2) return Properties.end();
Nick Lewycky05450ae2006-08-28 22:44:55 +0000255
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000256 return
257 find(Properties.begin(), Properties.end(), Property(Opcode, I1, I2));
Nick Lewycky05450ae2006-08-28 22:44:55 +0000258 }
259
260 ConstPropertyIterator
261 findProperty(Ops Opcode, Value *V1, Value *V2) const {
262 assert(Opcode != EQ && "Can't findProperty on EQ."
263 "Use the lookup method instead.");
264
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000265 SynonymIterator I1 = union_find.findLeader(V1),
266 I2 = union_find.findLeader(V2);
267 if (!I1 || !I2) return Properties.end();
Nick Lewycky05450ae2006-08-28 22:44:55 +0000268
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000269 return
270 find(Properties.begin(), Properties.end(), Property(Opcode, I1, I2));
Nick Lewycky05450ae2006-08-28 22:44:55 +0000271 }
272
273 private:
274 // Represents Head OP [Tail1, Tail2, ...]
275 // For example: %x != %a, %x != %b.
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000276 struct VISIBILITY_HIDDEN Property {
Nick Lewycky406fc0c2006-09-20 17:04:01 +0000277 typedef SynonymIterator Iter;
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000278
279 Property(Ops opcode, Iter i1, Iter i2)
280 : Opcode(opcode), I1(i1), I2(i2)
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000281 { assert(opcode != EQ && "Equality belongs in the synonym set, "
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000282 "not a property."); }
283
284 bool operator==(const Property &P) const {
285 return (Opcode == P.Opcode) &&
286 ((I1 == P.I1 && I2 == P.I2) ||
287 (I1 == P.I2 && I2 == P.I1));
288 }
Nick Lewycky05450ae2006-08-28 22:44:55 +0000289
Nick Lewycky05450ae2006-08-28 22:44:55 +0000290 Ops Opcode;
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000291 Iter I1, I2;
Nick Lewycky05450ae2006-08-28 22:44:55 +0000292 };
293
Nick Lewycky05450ae2006-08-28 22:44:55 +0000294 void add(Ops Opcode, Value *V1, Value *V2, bool invert) {
295 switch (Opcode) {
296 case EQ:
297 if (invert) addNotEqual(V1, V2);
298 else addEqual(V1, V2);
299 break;
300 case NE:
301 if (invert) addEqual(V1, V2);
302 else addNotEqual(V1, V2);
303 break;
304 default:
305 assert(0 && "Unknown property opcode.");
306 }
307 }
308
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000309 // Finds the properties implied by an equivalence and adds them too.
Nick Lewycky05450ae2006-08-28 22:44:55 +0000310 // Example: ("seteq %a, %b", true, EQ) --> (%a, %b, EQ)
311 // ("seteq %a, %b", false, EQ) --> (%a, %b, NE)
312 void addImpliedProperties(Ops Opcode, Value *V1, Value *V2) {
313 order(V1, V2);
314
315 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(V2)) {
316 switch (BO->getOpcode()) {
317 case Instruction::SetEQ:
318 if (V1 == ConstantBool::True)
319 add(Opcode, BO->getOperand(0), BO->getOperand(1), false);
320 if (V1 == ConstantBool::False)
321 add(Opcode, BO->getOperand(0), BO->getOperand(1), true);
322 break;
323 case Instruction::SetNE:
324 if (V1 == ConstantBool::True)
325 add(Opcode, BO->getOperand(0), BO->getOperand(1), true);
326 if (V1 == ConstantBool::False)
327 add(Opcode, BO->getOperand(0), BO->getOperand(1), false);
328 break;
329 case Instruction::SetLT:
330 case Instruction::SetGT:
331 if (V1 == ConstantBool::True)
332 add(Opcode, BO->getOperand(0), BO->getOperand(1), true);
333 break;
334 case Instruction::SetLE:
335 case Instruction::SetGE:
336 if (V1 == ConstantBool::False)
337 add(Opcode, BO->getOperand(0), BO->getOperand(1), true);
338 break;
339 case Instruction::And:
340 if (V1 == ConstantBool::True) {
341 add(Opcode, ConstantBool::True, BO->getOperand(0), false);
342 add(Opcode, ConstantBool::True, BO->getOperand(1), false);
343 }
344 break;
345 case Instruction::Or:
346 if (V1 == ConstantBool::False) {
347 add(Opcode, ConstantBool::False, BO->getOperand(0), false);
348 add(Opcode, ConstantBool::False, BO->getOperand(1), false);
349 }
350 break;
351 case Instruction::Xor:
352 if (V1 == ConstantBool::True) {
353 if (BO->getOperand(0) == ConstantBool::True)
354 add(Opcode, ConstantBool::False, BO->getOperand(1), false);
355 if (BO->getOperand(1) == ConstantBool::True)
356 add(Opcode, ConstantBool::False, BO->getOperand(0), false);
357 }
358 if (V1 == ConstantBool::False) {
359 if (BO->getOperand(0) == ConstantBool::True)
360 add(Opcode, ConstantBool::True, BO->getOperand(1), false);
361 if (BO->getOperand(1) == ConstantBool::True)
362 add(Opcode, ConstantBool::True, BO->getOperand(0), false);
363 }
364 break;
365 default:
366 break;
367 }
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000368 } else if (SelectInst *SI = dyn_cast<SelectInst>(V2)) {
369 if (Opcode != EQ && Opcode != NE) return;
370
371 ConstantBool *True = (Opcode==EQ) ? ConstantBool::True
372 : ConstantBool::False,
373 *False = (Opcode==EQ) ? ConstantBool::False
374 : ConstantBool::True;
375
376 if (V1 == SI->getTrueValue())
377 addEqual(SI->getCondition(), True);
378 else if (V1 == SI->getFalseValue())
379 addEqual(SI->getCondition(), False);
380 else if (Opcode == EQ)
381 assert("Result of select not equal to either value.");
Nick Lewycky05450ae2006-08-28 22:44:55 +0000382 }
383 }
384
Nick Lewycky406fc0c2006-09-20 17:04:01 +0000385 DominatorTree *DT;
Nick Lewycky05450ae2006-08-28 22:44:55 +0000386 public:
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000387#ifdef DEBUG
Nick Lewycky05450ae2006-08-28 22:44:55 +0000388 void debug(std::ostream &os) const {
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000389 static const char *OpcodeTable[] = { "EQ", "NE" };
390
391 union_find.debug(os);
392 for (std::vector<Property>::const_iterator I = Properties.begin(),
393 E = Properties.end(); I != E; ++I) {
394 os << (*I).I1 << " " << OpcodeTable[(*I).Opcode] << " "
395 << (*I).I2 << "\n";
Nick Lewycky6e39c7e2006-08-31 00:39:16 +0000396 }
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000397 os << "\n";
Nick Lewycky05450ae2006-08-28 22:44:55 +0000398 }
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000399#endif
Nick Lewycky05450ae2006-08-28 22:44:55 +0000400
401 std::vector<Property> Properties;
402 };
403
404 /// PredicateSimplifier - This class is a simplifier that replaces
405 /// one equivalent variable with another. It also tracks what
406 /// can't be equal and will solve setcc instructions when possible.
407 class PredicateSimplifier : public FunctionPass {
408 public:
409 bool runOnFunction(Function &F);
410 virtual void getAnalysisUsage(AnalysisUsage &AU) const;
411
412 private:
413 // Try to replace the Use of the instruction with something simpler.
414 Value *resolve(SetCondInst *SCI, const PropertySet &);
415 Value *resolve(BinaryOperator *BO, const PropertySet &);
Nick Lewycky3947a762006-08-30 02:46:48 +0000416 Value *resolve(SelectInst *SI, const PropertySet &);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000417 Value *resolve(Value *V, const PropertySet &);
418
419 // Used by terminator instructions to proceed from the current basic
420 // block to the next. Verifies that "current" dominates "next",
421 // then calls visitBasicBlock.
Nick Lewycky025f4c02006-09-18 21:09:35 +0000422 void proceedToSuccessor(TerminatorInst *TI, unsigned edge,
423 PropertySet &CurrentPS, PropertySet &NextPS);
424 void proceedToSuccessors(PropertySet &CurrentPS, BasicBlock *Current);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000425
426 // Visits each instruction in the basic block.
Nick Lewycky025f4c02006-09-18 21:09:35 +0000427 void visitBasicBlock(BasicBlock *Block, PropertySet &KnownProperties);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000428
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000429 // Tries to simplify each Instruction and add new properties to
430 // the PropertySet. Returns true if it erase the instruction.
Nick Lewycky025f4c02006-09-18 21:09:35 +0000431 void visitInstruction(Instruction *I, PropertySet &);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000432 // For each instruction, add the properties to KnownProperties.
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000433
Nick Lewycky025f4c02006-09-18 21:09:35 +0000434 void visit(TerminatorInst *TI, PropertySet &);
435 void visit(BranchInst *BI, PropertySet &);
436 void visit(SwitchInst *SI, PropertySet);
437 void visit(LoadInst *LI, PropertySet &);
438 void visit(StoreInst *SI, PropertySet &);
439 void visit(BinaryOperator *BO, PropertySet &);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000440
441 DominatorTree *DT;
442 bool modified;
443 };
444
445 RegisterPass<PredicateSimplifier> X("predsimplify",
446 "Predicate Simplifier");
Nick Lewycky406fc0c2006-09-20 17:04:01 +0000447
448 template <typename ElemTy>
449 typename Synonyms<ElemTy>::iterator
450 Synonyms<ElemTy>::unionSets(ElemTy E1, ElemTy E2) {
451 PS->order(E1, E2);
452
453 iterator I1 = findLeader(E1),
454 I2 = findLeader(E2);
455
456 if (!I1 && !I2) { // neither entry is in yet
457 leaders.push_back(E1);
458 I1 = leaders.size();
459 mapping[E1] = I1;
460 mapping[E2] = I1;
461 return 0;
462 }
463
464 if (!I1 && I2) {
465 mapping[E1] = I2;
466 std::swap(getLeader(I2), E1);
467 return 0;
468 }
469
470 if (I1 && !I2) {
471 mapping[E2] = I1;
472 return 0;
473 }
474
475 if (I1 == I2) return 0;
476
477 // This is the case where we have two sets, [%a1, %a2, %a3] and
478 // [%p1, %p2, %p3] and someone says that %a2 == %p3. We need to
479 // combine the two synsets.
480
481 if (I1 > I2) --I1;
482
483 for (std::map<Value *, unsigned>::iterator I = mapping.begin(),
484 E = mapping.end(); I != E; ++I) {
485 if (I->second == I2) I->second = I1;
486 else if (I->second > I2) --I->second;
487 }
488
489 leaders.erase(leaders.begin() + I2 - 1);
490
491 return I2;
492 }
Nick Lewycky05450ae2006-08-28 22:44:55 +0000493}
494
495FunctionPass *llvm::createPredicateSimplifierPass() {
496 return new PredicateSimplifier();
497}
498
499bool PredicateSimplifier::runOnFunction(Function &F) {
500 DT = &getAnalysis<DominatorTree>();
501
502 modified = false;
Nick Lewycky406fc0c2006-09-20 17:04:01 +0000503 PropertySet KnownProperties(DT);
Nick Lewycky025f4c02006-09-18 21:09:35 +0000504 visitBasicBlock(DT->getRootNode()->getBlock(), KnownProperties);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000505 return modified;
506}
507
508void PredicateSimplifier::getAnalysisUsage(AnalysisUsage &AU) const {
509 AU.addRequired<DominatorTree>();
Nick Lewycky025f4c02006-09-18 21:09:35 +0000510 AU.setPreservesCFG();
Nick Lewycky05450ae2006-08-28 22:44:55 +0000511}
512
513// resolve catches cases addProperty won't because it wasn't used as a
514// condition in the branch, and that visit won't, because the instruction
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000515// was defined outside of the scope that the properties apply to.
Nick Lewycky05450ae2006-08-28 22:44:55 +0000516Value *PredicateSimplifier::resolve(SetCondInst *SCI,
517 const PropertySet &KP) {
518 // Attempt to resolve the SetCondInst to a boolean.
519
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000520 Value *SCI0 = resolve(SCI->getOperand(0), KP),
521 *SCI1 = resolve(SCI->getOperand(1), KP);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000522
Nick Lewycky009aa1d2006-09-21 01:05:35 +0000523 PropertySet::ConstPropertyIterator NE =
524 KP.findProperty(PropertySet::NE, SCI0, SCI1);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000525
Nick Lewycky009aa1d2006-09-21 01:05:35 +0000526 if (NE != KP.Properties.end()) {
527 switch (SCI->getOpcode()) {
528 case Instruction::SetEQ: return ConstantBool::False;
529 case Instruction::SetNE: return ConstantBool::True;
530 case Instruction::SetLE:
531 case Instruction::SetGE:
532 case Instruction::SetLT:
533 case Instruction::SetGT:
534 break;
535 default:
536 assert(0 && "Unknown opcode in SetCondInst.");
537 break;
Nick Lewycky3fc68cc2006-09-11 17:23:34 +0000538 }
Nick Lewycky3fc68cc2006-09-11 17:23:34 +0000539 }
Nick Lewyckyaf2f1fe2006-09-20 23:02:24 +0000540 return SCI;
Nick Lewycky05450ae2006-08-28 22:44:55 +0000541}
542
543Value *PredicateSimplifier::resolve(BinaryOperator *BO,
544 const PropertySet &KP) {
Nick Lewycky05450ae2006-08-28 22:44:55 +0000545 Value *lhs = resolve(BO->getOperand(0), KP),
546 *rhs = resolve(BO->getOperand(1), KP);
Nick Lewycky009aa1d2006-09-21 01:05:35 +0000547
Nick Lewycky8f389d82006-09-23 15:13:08 +0000548 ConstantIntegral *CI1 = dyn_cast<ConstantIntegral>(lhs),
549 *CI2 = dyn_cast<ConstantIntegral>(rhs);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000550
Nick Lewycky009aa1d2006-09-21 01:05:35 +0000551 if (CI1 && CI2) return ConstantExpr::get(BO->getOpcode(), CI1, CI2);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000552
Nick Lewycky009aa1d2006-09-21 01:05:35 +0000553 if (SetCondInst *SCI = dyn_cast<SetCondInst>(BO))
554 return resolve(SCI, KP);
555
Nick Lewycky05450ae2006-08-28 22:44:55 +0000556 return BO;
557}
558
Nick Lewycky3947a762006-08-30 02:46:48 +0000559Value *PredicateSimplifier::resolve(SelectInst *SI, const PropertySet &KP) {
560 Value *Condition = resolve(SI->getCondition(), KP);
561 if (Condition == ConstantBool::True)
562 return resolve(SI->getTrueValue(), KP);
563 else if (Condition == ConstantBool::False)
564 return resolve(SI->getFalseValue(), KP);
565 return SI;
566}
567
Nick Lewycky05450ae2006-08-28 22:44:55 +0000568Value *PredicateSimplifier::resolve(Value *V, const PropertySet &KP) {
569 if (isa<Constant>(V) || isa<BasicBlock>(V) || KP.empty()) return V;
570
571 V = KP.canonicalize(V);
572
573 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(V))
574 return resolve(BO, KP);
Nick Lewycky3947a762006-08-30 02:46:48 +0000575 else if (SelectInst *SI = dyn_cast<SelectInst>(V))
576 return resolve(SI, KP);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000577
578 return V;
579}
580
Nick Lewycky025f4c02006-09-18 21:09:35 +0000581void PredicateSimplifier::visitBasicBlock(BasicBlock *BB,
Nick Lewycky05450ae2006-08-28 22:44:55 +0000582 PropertySet &KnownProperties) {
Nick Lewyckycf2112a2006-09-13 18:55:37 +0000583 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E;) {
Nick Lewycky025f4c02006-09-18 21:09:35 +0000584 visitInstruction(I++, KnownProperties);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000585 }
586}
587
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000588void PredicateSimplifier::visitInstruction(Instruction *I,
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000589 PropertySet &KnownProperties) {
Nick Lewyckydc08cd52006-09-10 02:27:07 +0000590 // Try to replace the whole instruction.
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000591 Value *V = resolve(I, KnownProperties);
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000592 if (V != I) {
593 modified = true;
594 ++NumInstruction;
Nick Lewycky406fc0c2006-09-20 17:04:01 +0000595 DEBUG(std::cerr << "Removing " << *I);
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000596 I->replaceAllUsesWith(V);
Nick Lewyckycf2112a2006-09-13 18:55:37 +0000597 I->eraseFromParent();
Nick Lewyckya3a68bd2006-09-02 19:40:38 +0000598 return;
599 }
600
601 // Try to substitute operands.
602 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
Nick Lewycky05450ae2006-08-28 22:44:55 +0000603 Value *Oper = I->getOperand(i);
604 Value *V = resolve(Oper, KnownProperties);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000605 if (V != Oper) {
606 modified = true;
607 ++NumVarsReplaced;
Nick Lewycky8f389d82006-09-23 15:13:08 +0000608 DEBUG(std::cerr << "Resolving " << *I);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000609 I->setOperand(i, V);
610 DEBUG(std::cerr << "into " << *I);
611 }
612 }
613
Nick Lewycky05450ae2006-08-28 22:44:55 +0000614 if (TerminatorInst *TI = dyn_cast<TerminatorInst>(I))
Nick Lewycky025f4c02006-09-18 21:09:35 +0000615 visit(TI, KnownProperties);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000616 else if (LoadInst *LI = dyn_cast<LoadInst>(I))
Nick Lewycky025f4c02006-09-18 21:09:35 +0000617 visit(LI, KnownProperties);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000618 else if (StoreInst *SI = dyn_cast<StoreInst>(I))
Nick Lewycky025f4c02006-09-18 21:09:35 +0000619 visit(SI, KnownProperties);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000620 else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(I))
Nick Lewycky025f4c02006-09-18 21:09:35 +0000621 visit(BO, KnownProperties);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000622}
623
Nick Lewycky025f4c02006-09-18 21:09:35 +0000624// The basic block on the target of the specified edge must be known
625// to be immediately dominated by the parent of the TerminatorInst.
626void PredicateSimplifier::proceedToSuccessor(TerminatorInst *TI,
627 unsigned edge,
628 PropertySet &CurrentPS,
629 PropertySet &NextPS) {
630 assert(edge < TI->getNumSuccessors() && "Invalid index for edge.");
631
632 BasicBlock *BB = TI->getParent(),
633 *BBNext = TI->getSuccessor(edge);
634
635 if (BBNext->getSinglePredecessor() == BB)
636 visitBasicBlock(BBNext, NextPS);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000637 else
Nick Lewycky025f4c02006-09-18 21:09:35 +0000638 visitBasicBlock(BBNext, CurrentPS);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000639}
640
Nick Lewycky025f4c02006-09-18 21:09:35 +0000641void PredicateSimplifier::proceedToSuccessors(PropertySet &KP,
642 BasicBlock *BBCurrent) {
643 DTNodeType *Current = DT->getNode(BBCurrent);
644 for (DTNodeType::iterator I = Current->begin(), E = Current->end();
645 I != E; ++I) {
646 PropertySet Copy(KP);
647 visitBasicBlock((*I)->getBlock(), Copy);
648 }
Nick Lewycky05450ae2006-08-28 22:44:55 +0000649}
650
Nick Lewycky025f4c02006-09-18 21:09:35 +0000651void PredicateSimplifier::visit(TerminatorInst *TI, PropertySet &KP) {
Nick Lewycky05450ae2006-08-28 22:44:55 +0000652 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
Nick Lewycky025f4c02006-09-18 21:09:35 +0000653 visit(BI, KP);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000654 return;
655 }
656 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Nick Lewycky025f4c02006-09-18 21:09:35 +0000657 visit(SI, KP);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000658 return;
659 }
660
Nick Lewycky025f4c02006-09-18 21:09:35 +0000661 proceedToSuccessors(KP, TI->getParent());
Nick Lewycky05450ae2006-08-28 22:44:55 +0000662}
663
Nick Lewycky025f4c02006-09-18 21:09:35 +0000664void PredicateSimplifier::visit(BranchInst *BI, PropertySet &KP) {
665 BasicBlock *BB = BI->getParent();
666
Nick Lewycky05450ae2006-08-28 22:44:55 +0000667 if (BI->isUnconditional()) {
Nick Lewycky025f4c02006-09-18 21:09:35 +0000668 proceedToSuccessors(KP, BB);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000669 return;
670 }
671
672 Value *Condition = BI->getCondition();
673
Nick Lewycky3947a762006-08-30 02:46:48 +0000674 BasicBlock *TrueDest = BI->getSuccessor(0),
675 *FalseDest = BI->getSuccessor(1);
676
Nick Lewycky025f4c02006-09-18 21:09:35 +0000677 if (Condition == ConstantBool::True || TrueDest == FalseDest) {
678 proceedToSuccessors(KP, BB);
Nick Lewycky3947a762006-08-30 02:46:48 +0000679 return;
680 } else if (Condition == ConstantBool::False) {
Nick Lewycky025f4c02006-09-18 21:09:35 +0000681 proceedToSuccessors(KP, BB);
Nick Lewycky3947a762006-08-30 02:46:48 +0000682 return;
683 }
684
Nick Lewycky025f4c02006-09-18 21:09:35 +0000685 DTNodeType *Node = DT->getNode(BB);
686 for (DTNodeType::iterator I = Node->begin(), E = Node->end(); I != E; ++I) {
687 if ((*I)->getBlock() == TrueDest) {
688 PropertySet TrueProperties(KP);
689 TrueProperties.addEqual(ConstantBool::True, Condition);
690 proceedToSuccessor(BI, 0, KP, TrueProperties);
691 continue;
692 }
Nick Lewycky05450ae2006-08-28 22:44:55 +0000693
Nick Lewycky025f4c02006-09-18 21:09:35 +0000694 if ((*I)->getBlock() == FalseDest) {
695 PropertySet FalseProperties(KP);
696 FalseProperties.addEqual(ConstantBool::False, Condition);
697 proceedToSuccessor(BI, 1, KP, FalseProperties);
698 continue;
699 }
700
701 visitBasicBlock((*I)->getBlock(), KP);
702 }
Nick Lewycky05450ae2006-08-28 22:44:55 +0000703}
704
Nick Lewycky025f4c02006-09-18 21:09:35 +0000705void PredicateSimplifier::visit(SwitchInst *SI, PropertySet KP) {
Nick Lewycky05450ae2006-08-28 22:44:55 +0000706 Value *Condition = SI->getCondition();
Nick Lewycky05450ae2006-08-28 22:44:55 +0000707
708 // Set the EQProperty in each of the cases BBs,
709 // and the NEProperties in the default BB.
710 PropertySet DefaultProperties(KP);
711
Nick Lewycky025f4c02006-09-18 21:09:35 +0000712 DTNodeType *Node = DT->getNode(SI->getParent());
713 for (DTNodeType::iterator I = Node->begin(), E = Node->end(); I != E; ++I) {
714 BasicBlock *BB = (*I)->getBlock();
Nick Lewycky05450ae2006-08-28 22:44:55 +0000715
Nick Lewycky025f4c02006-09-18 21:09:35 +0000716 PropertySet Copy(KP);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000717
Nick Lewycky025f4c02006-09-18 21:09:35 +0000718 if (BB == SI->getDefaultDest()) {
719 PropertySet NewProperties(KP);
720 for (unsigned i = 1, e = SI->getNumCases(); i < e; ++i)
721 NewProperties.addNotEqual(Condition, SI->getCaseValue(i));
722
723 proceedToSuccessor(SI, 0, Copy, NewProperties);
724 } else if (ConstantInt *CI = SI->findCaseDest(BB)) {
Nick Lewycky05450ae2006-08-28 22:44:55 +0000725 PropertySet NewProperties(KP);
726 NewProperties.addEqual(Condition, CI);
Nick Lewycky025f4c02006-09-18 21:09:35 +0000727 proceedToSuccessor(SI, SI->findCaseValue(CI), Copy, NewProperties);
728 } else
729 visitBasicBlock(BB, Copy);
Nick Lewycky05450ae2006-08-28 22:44:55 +0000730 }
Nick Lewycky05450ae2006-08-28 22:44:55 +0000731}
732
Nick Lewycky025f4c02006-09-18 21:09:35 +0000733void PredicateSimplifier::visit(LoadInst *LI, PropertySet &KP) {
Nick Lewycky05450ae2006-08-28 22:44:55 +0000734 Value *Ptr = LI->getPointerOperand();
735 KP.addNotEqual(Constant::getNullValue(Ptr->getType()), Ptr);
736}
737
Nick Lewycky025f4c02006-09-18 21:09:35 +0000738void PredicateSimplifier::visit(StoreInst *SI, PropertySet &KP) {
Nick Lewycky05450ae2006-08-28 22:44:55 +0000739 Value *Ptr = SI->getPointerOperand();
740 KP.addNotEqual(Constant::getNullValue(Ptr->getType()), Ptr);
741}
742
Nick Lewycky025f4c02006-09-18 21:09:35 +0000743void PredicateSimplifier::visit(BinaryOperator *BO, PropertySet &KP) {
Nick Lewycky05450ae2006-08-28 22:44:55 +0000744 Instruction::BinaryOps ops = BO->getOpcode();
Nick Lewycky05450ae2006-08-28 22:44:55 +0000745
Nick Lewycky3947a762006-08-30 02:46:48 +0000746 switch (ops) {
747 case Instruction::Div:
748 case Instruction::Rem: {
749 Value *Divisor = BO->getOperand(1);
750 KP.addNotEqual(Constant::getNullValue(Divisor->getType()), Divisor);
751 break;
752 }
753 default:
754 break;
755 }
Nick Lewycky05450ae2006-08-28 22:44:55 +0000756}