Make PredicateSimplifier not use DominatorTree.
[oota-llvm.git] / lib / Transforms / Scalar / PredicateSimplifier.cpp
1 //===-- 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 // The InequalityGraph focusses on four properties; equals, not equals,
26 // less-than and less-than-or-equals-to. The greater-than forms are also held
27 // just to allow walking from a lesser node to a greater one. These properties
28 // are stored in a lattice; LE can become LT or EQ, NE can become LT or GT.
29 //
30 // These relationships define a graph between values of the same type. Each
31 // Value is stored in a map table that retrieves the associated Node. This
32 // is how EQ relationships are stored; the map contains pointers from equal
33 // Value to the same node. The node contains a most canonical Value* form
34 // and the list of known relationships with other nodes.
35 //
36 // If two nodes are known to be inequal, then they will contain pointers to
37 // each other with an "NE" relationship. If node getNode(%x) is less than
38 // getNode(%y), then the %x node will contain <%y, GT> and %y will contain
39 // <%x, LT>. This allows us to tie nodes together into a graph like this:
40 //
41 //   %a < %b < %c < %d
42 //
43 // with four nodes representing the properties. The InequalityGraph provides
44 // querying with "isRelatedBy" and mutators "addEquality" and "addInequality".
45 // To find a relationship, we start with one of the nodes any binary search
46 // through its list to find where the relationships with the second node start.
47 // Then we iterate through those to find the first relationship that dominates
48 // our context node.
49 //
50 // To create these properties, we wait until a branch or switch instruction
51 // implies that a particular value is true (or false). The VRPSolver is
52 // responsible for analyzing the variable and seeing what new inferences
53 // can be made from each property. For example:
54 //
55 //   %P = icmp ne i32* %ptr, null
56 //   %a = and i1 %P, %Q
57 //   br i1 %a label %cond_true, label %cond_false
58 //
59 // For the true branch, the VRPSolver will start with %a EQ true and look at
60 // the definition of %a and find that it can infer that %P and %Q are both
61 // true. From %P being true, it can infer that %ptr NE null. For the false
62 // branch it can't infer anything from the "and" instruction.
63 //
64 // Besides branches, we can also infer properties from instruction that may
65 // have undefined behaviour in certain cases. For example, the dividend of
66 // a division may never be zero. After the division instruction, we may assume
67 // that the dividend is not equal to zero.
68 //
69 //===----------------------------------------------------------------------===//
70 //
71 // The ValueRanges class stores the known integer bounds of a Value. When we
72 // encounter i8 %a u< %b, the ValueRanges stores that %a = [1, 255] and
73 // %b = [0, 254]. Because we store these by Value*, you should always
74 // canonicalize through the InequalityGraph first.
75 //
76 // It never stores an empty range, because that means that the code is
77 // unreachable. It never stores a single-element range since that's an equality
78 // relationship and better stored in the InequalityGraph, nor an empty range
79 // since that is better stored in UnreachableBlocks.
80 //
81 //===----------------------------------------------------------------------===//
82
83 #define DEBUG_TYPE "predsimplify"
84 #include "llvm/Transforms/Scalar.h"
85 #include "llvm/Constants.h"
86 #include "llvm/DerivedTypes.h"
87 #include "llvm/Instructions.h"
88 #include "llvm/Pass.h"
89 #include "llvm/ADT/DepthFirstIterator.h"
90 #include "llvm/ADT/SetOperations.h"
91 #include "llvm/ADT/SetVector.h"
92 #include "llvm/ADT/Statistic.h"
93 #include "llvm/ADT/STLExtras.h"
94 #include "llvm/Analysis/Dominators.h"
95 #include "llvm/Analysis/ET-Forest.h"
96 #include "llvm/Support/CFG.h"
97 #include "llvm/Support/Compiler.h"
98 #include "llvm/Support/ConstantRange.h"
99 #include "llvm/Support/Debug.h"
100 #include "llvm/Support/InstVisitor.h"
101 #include "llvm/Target/TargetData.h"
102 #include "llvm/Transforms/Utils/Local.h"
103 #include <algorithm>
104 #include <deque>
105 #include <sstream>
106 using namespace llvm;
107
108 STATISTIC(NumVarsReplaced, "Number of argument substitutions");
109 STATISTIC(NumInstruction , "Number of instructions removed");
110 STATISTIC(NumSimple      , "Number of simple replacements");
111 STATISTIC(NumBlocks      , "Number of blocks marked unreachable");
112 STATISTIC(NumSnuggle     , "Number of comparisons snuggled");
113
114 namespace {
115   // SLT SGT ULT UGT EQ
116   //   0   1   0   1  0 -- GT                  10
117   //   0   1   0   1  1 -- GE                  11
118   //   0   1   1   0  0 -- SGTULT              12
119   //   0   1   1   0  1 -- SGEULE              13
120   //   0   1   1   1  0 -- SGT                 14
121   //   0   1   1   1  1 -- SGE                 15
122   //   1   0   0   1  0 -- SLTUGT              18
123   //   1   0   0   1  1 -- SLEUGE              19
124   //   1   0   1   0  0 -- LT                  20
125   //   1   0   1   0  1 -- LE                  21
126   //   1   0   1   1  0 -- SLT                 22
127   //   1   0   1   1  1 -- SLE                 23
128   //   1   1   0   1  0 -- UGT                 26
129   //   1   1   0   1  1 -- UGE                 27
130   //   1   1   1   0  0 -- ULT                 28
131   //   1   1   1   0  1 -- ULE                 29
132   //   1   1   1   1  0 -- NE                  30
133   enum LatticeBits {
134     EQ_BIT = 1, UGT_BIT = 2, ULT_BIT = 4, SGT_BIT = 8, SLT_BIT = 16
135   };
136   enum LatticeVal {
137     GT = SGT_BIT | UGT_BIT,
138     GE = GT | EQ_BIT,
139     LT = SLT_BIT | ULT_BIT,
140     LE = LT | EQ_BIT,
141     NE = SLT_BIT | SGT_BIT | ULT_BIT | UGT_BIT,
142     SGTULT = SGT_BIT | ULT_BIT,
143     SGEULE = SGTULT | EQ_BIT,
144     SLTUGT = SLT_BIT | UGT_BIT,
145     SLEUGE = SLTUGT | EQ_BIT,
146     ULT = SLT_BIT | SGT_BIT | ULT_BIT,
147     UGT = SLT_BIT | SGT_BIT | UGT_BIT,
148     SLT = SLT_BIT | ULT_BIT | UGT_BIT,
149     SGT = SGT_BIT | ULT_BIT | UGT_BIT,
150     SLE = SLT | EQ_BIT,
151     SGE = SGT | EQ_BIT,
152     ULE = ULT | EQ_BIT,
153     UGE = UGT | EQ_BIT
154   };
155
156   static bool validPredicate(LatticeVal LV) {
157     switch (LV) {
158       case GT: case GE: case LT: case LE: case NE:
159       case SGTULT: case SGT: case SGEULE:
160       case SLTUGT: case SLT: case SLEUGE:
161       case ULT: case UGT:
162       case SLE: case SGE: case ULE: case UGE:
163         return true;
164       default:
165         return false;
166     }
167   }
168
169   /// reversePredicate - reverse the direction of the inequality
170   static LatticeVal reversePredicate(LatticeVal LV) {
171     unsigned reverse = LV ^ (SLT_BIT|SGT_BIT|ULT_BIT|UGT_BIT); //preserve EQ_BIT
172
173     if ((reverse & (SLT_BIT|SGT_BIT)) == 0)
174       reverse |= (SLT_BIT|SGT_BIT);
175
176     if ((reverse & (ULT_BIT|UGT_BIT)) == 0)
177       reverse |= (ULT_BIT|UGT_BIT);
178
179     LatticeVal Rev = static_cast<LatticeVal>(reverse);
180     assert(validPredicate(Rev) && "Failed reversing predicate.");
181     return Rev;
182   }
183
184   /// This is a StrictWeakOrdering predicate that sorts ETNodes by how many
185   /// descendants they have. With this, you can iterate through a list sorted
186   /// by this operation and the first matching entry is the most specific
187   /// match for your basic block. The order provided is stable; ETNodes with
188   /// the same number of children are sorted by pointer address.
189   struct VISIBILITY_HIDDEN OrderByDominance {
190     bool operator()(const ETNode *LHS, const ETNode *RHS) const {
191       unsigned LHS_spread = LHS->getDFSNumOut() - LHS->getDFSNumIn();
192       unsigned RHS_spread = RHS->getDFSNumOut() - RHS->getDFSNumIn();
193       if (LHS_spread != RHS_spread) return LHS_spread < RHS_spread;
194       else return LHS < RHS;
195     }
196   };
197
198   /// The InequalityGraph stores the relationships between values.
199   /// Each Value in the graph is assigned to a Node. Nodes are pointer
200   /// comparable for equality. The caller is expected to maintain the logical
201   /// consistency of the system.
202   ///
203   /// The InequalityGraph class may invalidate Node*s after any mutator call.
204   /// @brief The InequalityGraph stores the relationships between values.
205   class VISIBILITY_HIDDEN InequalityGraph {
206     ETNode *TreeRoot;
207
208     InequalityGraph();                  // DO NOT IMPLEMENT
209     InequalityGraph(InequalityGraph &); // DO NOT IMPLEMENT
210   public:
211     explicit InequalityGraph(ETNode *TreeRoot) : TreeRoot(TreeRoot) {}
212
213     class Node;
214
215     /// An Edge is contained inside a Node making one end of the edge implicit
216     /// and contains a pointer to the other end. The edge contains a lattice
217     /// value specifying the relationship and an ETNode specifying the root
218     /// in the dominator tree to which this edge applies.
219     class VISIBILITY_HIDDEN Edge {
220     public:
221       Edge(unsigned T, LatticeVal V, ETNode *ST)
222         : To(T), LV(V), Subtree(ST) {}
223
224       unsigned To;
225       LatticeVal LV;
226       ETNode *Subtree;
227
228       bool operator<(const Edge &edge) const {
229         if (To != edge.To) return To < edge.To;
230         else return OrderByDominance()(Subtree, edge.Subtree);
231       }
232       bool operator<(unsigned to) const {
233         return To < to;
234       }
235     };
236
237     /// A single node in the InequalityGraph. This stores the canonical Value
238     /// for the node, as well as the relationships with the neighbours.
239     ///
240     /// @brief A single node in the InequalityGraph.
241     class VISIBILITY_HIDDEN Node {
242       friend class InequalityGraph;
243
244       typedef SmallVector<Edge, 4> RelationsType;
245       RelationsType Relations;
246
247       Value *Canonical;
248
249       // TODO: can this idea improve performance?
250       //friend class std::vector<Node>;
251       //Node(Node &N) { RelationsType.swap(N.RelationsType); }
252
253     public:
254       typedef RelationsType::iterator       iterator;
255       typedef RelationsType::const_iterator const_iterator;
256
257       Node(Value *V) : Canonical(V) {}
258
259     private:
260 #ifndef NDEBUG
261     public:
262       virtual ~Node() {}
263       virtual void dump() const {
264         dump(*cerr.stream());
265       }
266     private:
267       void dump(std::ostream &os) const  {
268         os << *getValue() << ":\n";
269         for (Node::const_iterator NI = begin(), NE = end(); NI != NE; ++NI) {
270           static const std::string names[32] =
271             { "000000", "000001", "000002", "000003", "000004", "000005",
272               "000006", "000007", "000008", "000009", "     >", "    >=",
273               "  s>u<", "s>=u<=", "    s>", "   s>=", "000016", "000017",
274               "  s<u>", "s<=u>=", "     <", "    <=", "    s<", "   s<=",
275               "000024", "000025", "    u>", "   u>=", "    u<", "   u<=",
276               "    !=", "000031" };
277           os << "  " << names[NI->LV] << " " << NI->To
278              << " (" << NI->Subtree->getDFSNumIn() << ")\n";
279         }
280       }
281 #endif
282
283     public:
284       iterator begin()             { return Relations.begin(); }
285       iterator end()               { return Relations.end();   }
286       const_iterator begin() const { return Relations.begin(); }
287       const_iterator end()   const { return Relations.end();   }
288
289       iterator find(unsigned n, ETNode *Subtree) {
290         iterator E = end();
291         for (iterator I = std::lower_bound(begin(), E, n);
292              I != E && I->To == n; ++I) {
293           if (Subtree->DominatedBy(I->Subtree))
294             return I;
295         }
296         return E;
297       }
298
299       const_iterator find(unsigned n, ETNode *Subtree) const {
300         const_iterator E = end();
301         for (const_iterator I = std::lower_bound(begin(), E, n);
302              I != E && I->To == n; ++I) {
303           if (Subtree->DominatedBy(I->Subtree))
304             return I;
305         }
306         return E;
307       }
308
309       Value *getValue() const
310       {
311         return Canonical;
312       }
313
314       /// Updates the lattice value for a given node. Create a new entry if
315       /// one doesn't exist, otherwise it merges the values. The new lattice
316       /// value must not be inconsistent with any previously existing value.
317       void update(unsigned n, LatticeVal R, ETNode *Subtree) {
318         assert(validPredicate(R) && "Invalid predicate.");
319         iterator I = find(n, Subtree);
320         if (I == end()) {
321           Edge edge(n, R, Subtree);
322           iterator Insert = std::lower_bound(begin(), end(), edge);
323           Relations.insert(Insert, edge);
324         } else {
325           LatticeVal LV = static_cast<LatticeVal>(I->LV & R);
326           assert(validPredicate(LV) && "Invalid union of lattice values.");
327           if (LV != I->LV) {
328             if (Subtree != I->Subtree) {
329               assert(Subtree->DominatedBy(I->Subtree) &&
330                      "Find returned subtree that doesn't apply.");
331
332               Edge edge(n, R, Subtree);
333               iterator Insert = std::lower_bound(begin(), end(), edge);
334               Relations.insert(Insert, edge); // invalidates I
335               I = find(n, Subtree);
336             }
337
338             // Also, we have to tighten any edge that Subtree dominates.
339             for (iterator B = begin(); I->To == n; --I) {
340               if (I->Subtree->DominatedBy(Subtree)) {
341                 LatticeVal LV = static_cast<LatticeVal>(I->LV & R);
342                 assert(validPredicate(LV) && "Invalid union of lattice values");
343                 I->LV = LV;
344               }
345               if (I == B) break;
346             }
347           }
348         }
349       }
350     };
351
352   private:
353     struct VISIBILITY_HIDDEN NodeMapEdge {
354       Value *V;
355       unsigned index;
356       ETNode *Subtree;
357
358       NodeMapEdge(Value *V, unsigned index, ETNode *Subtree)
359         : V(V), index(index), Subtree(Subtree) {}
360
361       bool operator==(const NodeMapEdge &RHS) const {
362         return V == RHS.V &&
363                Subtree == RHS.Subtree;
364       }
365
366       bool operator<(const NodeMapEdge &RHS) const {
367         if (V != RHS.V) return V < RHS.V;
368         return OrderByDominance()(Subtree, RHS.Subtree);
369       }
370
371       bool operator<(Value *RHS) const {
372         return V < RHS;
373       }
374     };
375
376     typedef std::vector<NodeMapEdge> NodeMapType;
377     NodeMapType NodeMap;
378
379     std::vector<Node> Nodes;
380
381   public:
382     /// node - returns the node object at a given index retrieved from getNode.
383     /// Index zero is reserved and may not be passed in here. The pointer
384     /// returned is valid until the next call to newNode or getOrInsertNode.
385     Node *node(unsigned index) {
386       assert(index != 0 && "Zero index is reserved for not found.");
387       assert(index <= Nodes.size() && "Index out of range.");
388       return &Nodes[index-1];
389     }
390
391     /// Returns the node currently representing Value V, or zero if no such
392     /// node exists.
393     unsigned getNode(Value *V, ETNode *Subtree) {
394       NodeMapType::iterator E = NodeMap.end();
395       NodeMapEdge Edge(V, 0, Subtree);
396       NodeMapType::iterator I = std::lower_bound(NodeMap.begin(), E, Edge);
397       while (I != E && I->V == V) {
398         if (Subtree->DominatedBy(I->Subtree))
399           return I->index;
400         ++I;
401       }
402       return 0;
403     }
404
405     /// getOrInsertNode - always returns a valid node index, creating a node
406     /// to match the Value if needed.
407     unsigned getOrInsertNode(Value *V, ETNode *Subtree) {
408       if (unsigned n = getNode(V, Subtree))
409         return n;
410       else
411         return newNode(V);
412     }
413
414     /// newNode - creates a new node for a given Value and returns the index.
415     unsigned newNode(Value *V) {
416       Nodes.push_back(Node(V));
417
418       NodeMapEdge MapEntry = NodeMapEdge(V, Nodes.size(), TreeRoot);
419       assert(!std::binary_search(NodeMap.begin(), NodeMap.end(), MapEntry) &&
420              "Attempt to create a duplicate Node.");
421       NodeMap.insert(std::lower_bound(NodeMap.begin(), NodeMap.end(),
422                                       MapEntry), MapEntry);
423       return MapEntry.index;
424     }
425
426     /// If the Value is in the graph, return the canonical form. Otherwise,
427     /// return the original Value.
428     Value *canonicalize(Value *V, ETNode *Subtree) {
429       if (isa<Constant>(V)) return V;
430
431       if (unsigned n = getNode(V, Subtree))
432         return node(n)->getValue();
433       else 
434         return V;
435     }
436
437     /// isRelatedBy - true iff n1 op n2
438     bool isRelatedBy(unsigned n1, unsigned n2, ETNode *Subtree, LatticeVal LV) {
439       if (n1 == n2) return LV & EQ_BIT;
440
441       Node *N1 = node(n1);
442       Node::iterator I = N1->find(n2, Subtree), E = N1->end();
443       if (I != E) return (I->LV & LV) == I->LV;
444
445       return false;
446     }
447
448     // The add* methods assume that your input is logically valid and may 
449     // assertion-fail or infinitely loop if you attempt a contradiction.
450
451     void addEquality(unsigned n, Value *V, ETNode *Subtree) {
452       assert(canonicalize(node(n)->getValue(), Subtree) == node(n)->getValue()
453              && "Node's 'canonical' choice isn't best within this subtree.");
454
455       // Suppose that we are given "%x -> node #1 (%y)". The problem is that
456       // we may already have "%z -> node #2 (%x)" somewhere above us in the
457       // graph. We need to find those edges and add "%z -> node #1 (%y)"
458       // to keep the lookups canonical.
459
460       std::vector<Value *> ToRepoint;
461       ToRepoint.push_back(V);
462
463       if (unsigned Conflict = getNode(V, Subtree)) {
464         for (NodeMapType::iterator I = NodeMap.begin(), E = NodeMap.end();
465              I != E; ++I) {
466           if (I->index == Conflict && Subtree->DominatedBy(I->Subtree))
467             ToRepoint.push_back(I->V);
468         }
469       }
470
471       for (std::vector<Value *>::iterator VI = ToRepoint.begin(),
472            VE = ToRepoint.end(); VI != VE; ++VI) {
473         Value *V = *VI;
474
475         // XXX: review this code. This may be doing too many insertions.
476         NodeMapEdge Edge(V, n, Subtree);
477         NodeMapType::iterator E = NodeMap.end();
478         NodeMapType::iterator I = std::lower_bound(NodeMap.begin(), E, Edge);
479         if (I == E || I->V != V || I->Subtree != Subtree) {
480           // New Value
481           NodeMap.insert(I, Edge);
482         } else if (I != E && I->V == V && I->Subtree == Subtree) {
483           // Update best choice
484           I->index = n;
485         }
486
487 #ifndef NDEBUG
488         Node *N = node(n);
489         if (isa<Constant>(V)) {
490           if (isa<Constant>(N->getValue())) {
491             assert(V == N->getValue() && "Constant equals different constant?");
492           }
493         }
494 #endif
495       }
496     }
497
498     /// addInequality - Sets n1 op n2.
499     /// It is also an error to call this on an inequality that is already true.
500     void addInequality(unsigned n1, unsigned n2, ETNode *Subtree,
501                        LatticeVal LV1) {
502       assert(n1 != n2 && "A node can't be inequal to itself.");
503
504       if (LV1 != NE)
505         assert(!isRelatedBy(n1, n2, Subtree, reversePredicate(LV1)) &&
506                "Contradictory inequality.");
507
508       Node *N1 = node(n1);
509       Node *N2 = node(n2);
510
511       // Suppose we're adding %n1 < %n2. Find all the %a < %n1 and
512       // add %a < %n2 too. This keeps the graph fully connected.
513       if (LV1 != NE) {
514         // Break up the relationship into signed and unsigned comparison parts.
515         // If the signed parts of %a op1 %n1 match that of %n1 op2 %n2, and
516         // op1 and op2 aren't NE, then add %a op3 %n2. The new relationship
517         // should have the EQ_BIT iff it's set for both op1 and op2.
518
519         unsigned LV1_s = LV1 & (SLT_BIT|SGT_BIT);
520         unsigned LV1_u = LV1 & (ULT_BIT|UGT_BIT);
521
522         for (Node::iterator I = N1->begin(), E = N1->end(); I != E; ++I) {
523           if (I->LV != NE && I->To != n2) {
524
525             ETNode *Local_Subtree = NULL;
526             if (Subtree->DominatedBy(I->Subtree))
527               Local_Subtree = Subtree;
528             else if (I->Subtree->DominatedBy(Subtree))
529               Local_Subtree = I->Subtree;
530
531             if (Local_Subtree) {
532               unsigned new_relationship = 0;
533               LatticeVal ILV = reversePredicate(I->LV);
534               unsigned ILV_s = ILV & (SLT_BIT|SGT_BIT);
535               unsigned ILV_u = ILV & (ULT_BIT|UGT_BIT);
536
537               if (LV1_s != (SLT_BIT|SGT_BIT) && ILV_s == LV1_s)
538                 new_relationship |= ILV_s;
539               if (LV1_u != (ULT_BIT|UGT_BIT) && ILV_u == LV1_u)
540                 new_relationship |= ILV_u;
541
542               if (new_relationship) {
543                 if ((new_relationship & (SLT_BIT|SGT_BIT)) == 0)
544                   new_relationship |= (SLT_BIT|SGT_BIT);
545                 if ((new_relationship & (ULT_BIT|UGT_BIT)) == 0)
546                   new_relationship |= (ULT_BIT|UGT_BIT);
547                 if ((LV1 & EQ_BIT) && (ILV & EQ_BIT))
548                   new_relationship |= EQ_BIT;
549
550                 LatticeVal NewLV = static_cast<LatticeVal>(new_relationship);
551
552                 node(I->To)->update(n2, NewLV, Local_Subtree);
553                 N2->update(I->To, reversePredicate(NewLV), Local_Subtree);
554               }
555             }
556           }
557         }
558
559         for (Node::iterator I = N2->begin(), E = N2->end(); I != E; ++I) {
560           if (I->LV != NE && I->To != n1) {
561             ETNode *Local_Subtree = NULL;
562             if (Subtree->DominatedBy(I->Subtree))
563               Local_Subtree = Subtree;
564             else if (I->Subtree->DominatedBy(Subtree))
565               Local_Subtree = I->Subtree;
566
567             if (Local_Subtree) {
568               unsigned new_relationship = 0;
569               unsigned ILV_s = I->LV & (SLT_BIT|SGT_BIT);
570               unsigned ILV_u = I->LV & (ULT_BIT|UGT_BIT);
571
572               if (LV1_s != (SLT_BIT|SGT_BIT) && ILV_s == LV1_s)
573                 new_relationship |= ILV_s;
574
575               if (LV1_u != (ULT_BIT|UGT_BIT) && ILV_u == LV1_u)
576                 new_relationship |= ILV_u;
577
578               if (new_relationship) {
579                 if ((new_relationship & (SLT_BIT|SGT_BIT)) == 0)
580                   new_relationship |= (SLT_BIT|SGT_BIT);
581                 if ((new_relationship & (ULT_BIT|UGT_BIT)) == 0)
582                   new_relationship |= (ULT_BIT|UGT_BIT);
583                 if ((LV1 & EQ_BIT) && (I->LV & EQ_BIT))
584                   new_relationship |= EQ_BIT;
585
586                 LatticeVal NewLV = static_cast<LatticeVal>(new_relationship);
587
588                 N1->update(I->To, NewLV, Local_Subtree);
589                 node(I->To)->update(n1, reversePredicate(NewLV), Local_Subtree);
590               }
591             }
592           }
593         }
594       }
595
596       N1->update(n2, LV1, Subtree);
597       N2->update(n1, reversePredicate(LV1), Subtree);
598     }
599
600     /// remove - Removes a Value from the graph. If the value is the canonical
601     /// choice for a Node, destroys the Node from the graph deleting all edges
602     /// to and from it. This method does not renumber the nodes.
603     void remove(Value *V) {
604       for (unsigned i = 0; i < NodeMap.size();) {
605         NodeMapType::iterator I = NodeMap.begin()+i;
606         if (I->V == V) {
607           Node *N = node(I->index);
608           if (node(I->index)->getValue() == V) {
609             for (Node::iterator NI = N->begin(), NE = N->end(); NI != NE; ++NI){
610               Node::iterator Iter = node(NI->To)->find(I->index, TreeRoot);
611               do {
612                 node(NI->To)->Relations.erase(Iter);
613                 Iter = node(NI->To)->find(I->index, TreeRoot);
614               } while (Iter != node(NI->To)->end());
615             }
616             N->Canonical = NULL;
617           }
618           N->Relations.clear();
619           NodeMap.erase(I);
620         } else ++i;
621       }
622     }
623
624 #ifndef NDEBUG
625     virtual ~InequalityGraph() {}
626     virtual void dump() {
627       dump(*cerr.stream());
628     }
629
630     void dump(std::ostream &os) {
631     std::set<Node *> VisitedNodes;
632     for (NodeMapType::const_iterator I = NodeMap.begin(), E = NodeMap.end();
633          I != E; ++I) {
634       Node *N = node(I->index);
635       os << *I->V << " == " << I->index
636          << "(" << I->Subtree->getDFSNumIn() << ")\n";
637       if (VisitedNodes.insert(N).second) {
638         os << I->index << ". ";
639         if (!N->getValue()) os << "(deleted node)\n";
640         else N->dump(os);
641       }
642     }
643   }
644 #endif
645   };
646
647   class VRPSolver;
648
649   /// ValueRanges tracks the known integer ranges and anti-ranges of the nodes
650   /// in the InequalityGraph.
651   class VISIBILITY_HIDDEN ValueRanges {
652
653     /// A ScopedRange ties an InequalityGraph node with a ConstantRange under
654     /// the scope of a rooted subtree in the dominator tree.
655     class VISIBILITY_HIDDEN ScopedRange {
656     public:
657       ScopedRange(Value *V, ConstantRange CR, ETNode *ST)
658         : V(V), CR(CR), Subtree(ST) {}
659
660       Value *V;
661       ConstantRange CR;
662       ETNode *Subtree;
663
664       bool operator<(const ScopedRange &range) const {
665         if (V != range.V) return V < range.V;
666         else return OrderByDominance()(Subtree, range.Subtree);
667       }
668
669       bool operator<(const Value *value) const {
670         return V < value;
671       }
672     };
673
674     TargetData *TD;
675
676     std::vector<ScopedRange> Ranges;
677     typedef std::vector<ScopedRange>::iterator iterator;
678
679     // XXX: this is a copy of the code in InequalityGraph::Node. Perhaps a
680     // intrusive domtree-scoped container is in order?
681
682     iterator begin() { return Ranges.begin(); }
683     iterator end()   { return Ranges.end();   }
684
685     iterator find(Value *V, ETNode *Subtree) {
686       iterator E = end();
687       for (iterator I = std::lower_bound(begin(), E, V);
688            I != E && I->V == V; ++I) {
689         if (Subtree->DominatedBy(I->Subtree))
690           return I;
691       }
692       return E;
693     }
694
695     void update(Value *V, ConstantRange CR, ETNode *Subtree) {
696       assert(!CR.isEmptySet() && "Empty ConstantRange!");
697       if (CR.isFullSet()) return;
698
699       iterator I = find(V, Subtree);
700       if (I == end()) {
701         ScopedRange range(V, CR, Subtree);
702         iterator Insert = std::lower_bound(begin(), end(), range);
703         Ranges.insert(Insert, range);
704       } else {
705         CR = CR.intersectWith(I->CR);
706         assert(!CR.isEmptySet() && "Empty intersection of ConstantRanges!");
707
708         if (CR != I->CR) {
709           if (Subtree != I->Subtree) {
710             assert(Subtree->DominatedBy(I->Subtree) &&
711                    "Find returned subtree that doesn't apply.");
712
713             ScopedRange range(V, CR, Subtree);
714             iterator Insert = std::lower_bound(begin(), end(), range);
715             Ranges.insert(Insert, range); // invalidates I
716             I = find(V, Subtree);
717           }
718
719           // Also, we have to tighten any edge that Subtree dominates.
720           for (iterator B = begin(); I->V == V; --I) {
721             if (I->Subtree->DominatedBy(Subtree)) {
722               I->CR = CR.intersectWith(I->CR);
723               assert(!I->CR.isEmptySet() &&
724                      "Empty intersection of ConstantRanges!");
725             }
726             if (I == B) break;
727           }
728         }
729       }
730     }
731
732     /// range - Creates a ConstantRange representing the set of all values
733     /// that match the ICmpInst::Predicate with any of the values in CR.
734     ConstantRange range(ICmpInst::Predicate ICmpOpcode,
735                         const ConstantRange &CR) {
736       uint32_t W = CR.getBitWidth();
737       switch (ICmpOpcode) {
738         default: assert(!"Invalid ICmp opcode to range()");
739         case ICmpInst::ICMP_EQ:
740           return ConstantRange(CR.getLower(), CR.getUpper());
741         case ICmpInst::ICMP_NE:
742           if (CR.isSingleElement())
743             return ConstantRange(CR.getUpper(), CR.getLower());
744           return ConstantRange(W);
745         case ICmpInst::ICMP_ULT:
746           return ConstantRange(APInt::getMinValue(W), CR.getUnsignedMax());
747         case ICmpInst::ICMP_SLT:
748           return ConstantRange(APInt::getSignedMinValue(W), CR.getSignedMax());
749         case ICmpInst::ICMP_ULE: {
750           APInt UMax(CR.getUnsignedMax());
751           if (UMax == APInt::getMaxValue(W))
752             return ConstantRange(W);
753           return ConstantRange(APInt::getMinValue(W), UMax + 1);
754         }
755         case ICmpInst::ICMP_SLE: {
756           APInt SMax(CR.getSignedMax());
757           if (SMax     == APInt::getSignedMaxValue(W) ||
758               SMax + 1 == APInt::getSignedMaxValue(W))
759             return ConstantRange(W);
760           return ConstantRange(APInt::getSignedMinValue(W), SMax + 1);
761         }
762         case ICmpInst::ICMP_UGT:
763           return ConstantRange(CR.getUnsignedMin() + 1, APInt::getNullValue(W));
764         case ICmpInst::ICMP_SGT:
765           return ConstantRange(CR.getSignedMin() + 1,
766                                APInt::getSignedMinValue(W));
767         case ICmpInst::ICMP_UGE: {
768           APInt UMin(CR.getUnsignedMin());
769           if (UMin == APInt::getMinValue(W))
770             return ConstantRange(W);
771           return ConstantRange(UMin, APInt::getNullValue(W));
772         }
773         case ICmpInst::ICMP_SGE: {
774           APInt SMin(CR.getSignedMin());
775           if (SMin == APInt::getSignedMinValue(W))
776             return ConstantRange(W);
777           return ConstantRange(SMin, APInt::getSignedMinValue(W));
778         }
779       }
780     }
781
782     /// create - Creates a ConstantRange that matches the given LatticeVal
783     /// relation with a given integer.
784     ConstantRange create(LatticeVal LV, const ConstantRange &CR) {
785       assert(!CR.isEmptySet() && "Can't deal with empty set.");
786
787       if (LV == NE)
788         return range(ICmpInst::ICMP_NE, CR);
789
790       unsigned LV_s = LV & (SGT_BIT|SLT_BIT);
791       unsigned LV_u = LV & (UGT_BIT|ULT_BIT);
792       bool hasEQ = LV & EQ_BIT;
793
794       ConstantRange Range(CR.getBitWidth());
795
796       if (LV_s == SGT_BIT) {
797         Range = Range.intersectWith(range(
798                     hasEQ ? ICmpInst::ICMP_SGE : ICmpInst::ICMP_SGT, CR));
799       } else if (LV_s == SLT_BIT) {
800         Range = Range.intersectWith(range(
801                     hasEQ ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_SLT, CR));
802       }
803
804       if (LV_u == UGT_BIT) {
805         Range = Range.intersectWith(range(
806                     hasEQ ? ICmpInst::ICMP_UGE : ICmpInst::ICMP_UGT, CR));
807       } else if (LV_u == ULT_BIT) {
808         Range = Range.intersectWith(range(
809                     hasEQ ? ICmpInst::ICMP_ULE : ICmpInst::ICMP_ULT, CR));
810       }
811
812       return Range;
813     }
814
815 #ifndef NDEBUG
816     bool isCanonical(Value *V, ETNode *Subtree, VRPSolver *VRP);
817 #endif
818
819   public:
820
821     explicit ValueRanges(TargetData *TD) : TD(TD) {}
822
823     // rangeFromValue - converts a Value into a range. If the value is a
824     // constant it constructs the single element range, otherwise it performs
825     // a lookup. The width W must be retrieved from typeToWidth and may not
826     // be zero.
827     ConstantRange rangeFromValue(Value *V, ETNode *Subtree, uint32_t W) {
828       if (ConstantInt *C = dyn_cast<ConstantInt>(V)) {
829         return ConstantRange(C->getValue());
830       } else if (isa<ConstantPointerNull>(V)) {
831         return ConstantRange(APInt::getNullValue(W));
832       } else {
833         iterator I = find(V, Subtree);
834         if (I != end())
835           return I->CR;
836       }
837       return ConstantRange(W);
838     }
839
840     // typeToWidth - returns the number of bits necessary to store a value of
841     // this type, or zero if unknown.
842     uint32_t typeToWidth(const Type *Ty) const {
843       if (TD)
844         return TD->getTypeSizeInBits(Ty);
845
846       if (const IntegerType *ITy = dyn_cast<IntegerType>(Ty))
847         return ITy->getBitWidth();
848
849       return 0;
850     }
851
852     bool isRelatedBy(Value *V1, Value *V2, ETNode *Subtree, LatticeVal LV) {
853       uint32_t W = typeToWidth(V1->getType());
854       if (!W) return false;
855
856       ConstantRange CR1 = rangeFromValue(V1, Subtree, W);
857       ConstantRange CR2 = rangeFromValue(V2, Subtree, W);
858
859       // True iff all values in CR1 are LV to all values in CR2.
860       switch (LV) {
861       default: assert(!"Impossible lattice value!");
862       case NE:
863         return CR1.intersectWith(CR2).isEmptySet();
864       case ULT:
865         return CR1.getUnsignedMax().ult(CR2.getUnsignedMin());
866       case ULE:
867         return CR1.getUnsignedMax().ule(CR2.getUnsignedMin());
868       case UGT:
869         return CR1.getUnsignedMin().ugt(CR2.getUnsignedMax());
870       case UGE:
871         return CR1.getUnsignedMin().uge(CR2.getUnsignedMax());
872       case SLT:
873         return CR1.getSignedMax().slt(CR2.getSignedMin());
874       case SLE:
875         return CR1.getSignedMax().sle(CR2.getSignedMin());
876       case SGT:
877         return CR1.getSignedMin().sgt(CR2.getSignedMax());
878       case SGE:
879         return CR1.getSignedMin().sge(CR2.getSignedMax());
880       case LT:
881         return CR1.getUnsignedMax().ult(CR2.getUnsignedMin()) &&
882                CR1.getSignedMax().slt(CR2.getUnsignedMin());
883       case LE:
884         return CR1.getUnsignedMax().ule(CR2.getUnsignedMin()) &&
885                CR1.getSignedMax().sle(CR2.getUnsignedMin());
886       case GT:
887         return CR1.getUnsignedMin().ugt(CR2.getUnsignedMax()) &&
888                CR1.getSignedMin().sgt(CR2.getSignedMax());
889       case GE:
890         return CR1.getUnsignedMin().uge(CR2.getUnsignedMax()) &&
891                CR1.getSignedMin().sge(CR2.getSignedMax());
892       case SLTUGT:
893         return CR1.getSignedMax().slt(CR2.getSignedMin()) &&
894                CR1.getUnsignedMin().ugt(CR2.getUnsignedMax());
895       case SLEUGE:
896         return CR1.getSignedMax().sle(CR2.getSignedMin()) &&
897                CR1.getUnsignedMin().uge(CR2.getUnsignedMax());
898       case SGTULT:
899         return CR1.getSignedMin().sgt(CR2.getSignedMax()) &&
900                CR1.getUnsignedMax().ult(CR2.getUnsignedMin());
901       case SGEULE:
902         return CR1.getSignedMin().sge(CR2.getSignedMax()) &&
903                CR1.getUnsignedMax().ule(CR2.getUnsignedMin());
904       }
905     }
906
907     void addToWorklist(Value *V, Constant *C, ICmpInst::Predicate Pred,
908                        VRPSolver *VRP);
909     void markBlock(VRPSolver *VRP);
910
911     void mergeInto(Value **I, unsigned n, Value *New, ETNode *Subtree,
912                    VRPSolver *VRP) {
913       assert(isCanonical(New, Subtree, VRP) && "Best choice not canonical?");
914
915       uint32_t W = typeToWidth(New->getType());
916       if (!W) return;
917
918       ConstantRange CR_New = rangeFromValue(New, Subtree, W);
919       ConstantRange Merged = CR_New;
920
921       for (; n != 0; ++I, --n) {
922         ConstantRange CR_Kill = rangeFromValue(*I, Subtree, W);
923         if (CR_Kill.isFullSet()) continue;
924         Merged = Merged.intersectWith(CR_Kill);
925       }
926
927       if (Merged.isFullSet() || Merged == CR_New) return;
928
929       applyRange(New, Merged, Subtree, VRP);
930     }
931
932     void applyRange(Value *V, const ConstantRange &CR, ETNode *Subtree,
933                     VRPSolver *VRP) {
934       assert(isCanonical(V, Subtree, VRP) && "Value not canonical.");
935
936       if (const APInt *I = CR.getSingleElement()) {
937         const Type *Ty = V->getType();
938         if (Ty->isInteger()) {
939           addToWorklist(V, ConstantInt::get(*I), ICmpInst::ICMP_EQ, VRP);
940           return;
941         } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
942           assert(*I == 0 && "Pointer is null but not zero?");
943           addToWorklist(V, ConstantPointerNull::get(PTy),
944                       ICmpInst::ICMP_EQ, VRP);
945           return;
946         }
947       }
948
949       ConstantRange Merged = CR.intersectWith(
950                                 rangeFromValue(V, Subtree, CR.getBitWidth()));
951       if (Merged.isEmptySet()) {
952         markBlock(VRP);
953         return;
954       }
955
956       update(V, Merged, Subtree);
957     }
958
959     void addNotEquals(Value *V1, Value *V2, ETNode *Subtree, VRPSolver *VRP) {
960       uint32_t W = typeToWidth(V1->getType());
961       if (!W) return;
962
963       ConstantRange CR1 = rangeFromValue(V1, Subtree, W);
964       ConstantRange CR2 = rangeFromValue(V2, Subtree, W);
965
966       if (const APInt *I = CR1.getSingleElement()) {
967         if (CR2.isFullSet()) {
968           ConstantRange NewCR2(CR1.getUpper(), CR1.getLower());
969           applyRange(V2, NewCR2, Subtree, VRP);
970         } else if (*I == CR2.getLower()) {
971           APInt NewLower(CR2.getLower() + 1),
972                 NewUpper(CR2.getUpper());
973           if (NewLower == NewUpper)
974             NewLower = NewUpper = APInt::getMinValue(W);
975
976           ConstantRange NewCR2(NewLower, NewUpper);
977           applyRange(V2, NewCR2, Subtree, VRP);
978         } else if (*I == CR2.getUpper() - 1) {
979           APInt NewLower(CR2.getLower()),
980                 NewUpper(CR2.getUpper() - 1);
981           if (NewLower == NewUpper)
982             NewLower = NewUpper = APInt::getMinValue(W);
983
984           ConstantRange NewCR2(NewLower, NewUpper);
985           applyRange(V2, NewCR2, Subtree, VRP);
986         }
987       }
988
989       if (const APInt *I = CR2.getSingleElement()) {
990         if (CR1.isFullSet()) {
991           ConstantRange NewCR1(CR2.getUpper(), CR2.getLower());
992           applyRange(V1, NewCR1, Subtree, VRP);
993         } else if (*I == CR1.getLower()) {
994           APInt NewLower(CR1.getLower() + 1),
995                 NewUpper(CR1.getUpper());
996           if (NewLower == NewUpper)
997             NewLower = NewUpper = APInt::getMinValue(W);
998
999           ConstantRange NewCR1(NewLower, NewUpper);
1000           applyRange(V1, NewCR1, Subtree, VRP);
1001         } else if (*I == CR1.getUpper() - 1) {
1002           APInt NewLower(CR1.getLower()),
1003                 NewUpper(CR1.getUpper() - 1);
1004           if (NewLower == NewUpper)
1005             NewLower = NewUpper = APInt::getMinValue(W);
1006
1007           ConstantRange NewCR1(NewLower, NewUpper);
1008           applyRange(V1, NewCR1, Subtree, VRP);
1009         }
1010       }
1011     }
1012
1013     void addInequality(Value *V1, Value *V2, ETNode *Subtree, LatticeVal LV,
1014                        VRPSolver *VRP) {
1015       assert(!isRelatedBy(V1, V2, Subtree, LV) && "Asked to do useless work.");
1016
1017       assert(isCanonical(V1, Subtree, VRP) && "Value not canonical.");
1018       assert(isCanonical(V2, Subtree, VRP) && "Value not canonical.");
1019
1020       if (LV == NE) {
1021         addNotEquals(V1, V2, Subtree, VRP);
1022         return;
1023       }
1024
1025       uint32_t W = typeToWidth(V1->getType());
1026       if (!W) return;
1027
1028       ConstantRange CR1 = rangeFromValue(V1, Subtree, W);
1029       ConstantRange CR2 = rangeFromValue(V2, Subtree, W);
1030
1031       if (!CR1.isSingleElement()) {
1032         ConstantRange NewCR1 = CR1.intersectWith(create(LV, CR2));
1033         if (NewCR1 != CR1)
1034           applyRange(V1, NewCR1, Subtree, VRP);
1035       }
1036
1037       if (!CR2.isSingleElement()) {
1038         ConstantRange NewCR2 = CR2.intersectWith(create(reversePredicate(LV),
1039                                                         CR1));
1040         if (NewCR2 != CR2)
1041           applyRange(V2, NewCR2, Subtree, VRP);
1042       }
1043     }
1044   };
1045
1046   /// UnreachableBlocks keeps tracks of blocks that are for one reason or
1047   /// another discovered to be unreachable. This is used to cull the graph when
1048   /// analyzing instructions, and to mark blocks with the "unreachable"
1049   /// terminator instruction after the function has executed.
1050   class VISIBILITY_HIDDEN UnreachableBlocks {
1051   private:
1052     std::vector<BasicBlock *> DeadBlocks;
1053
1054   public:
1055     /// mark - mark a block as dead
1056     void mark(BasicBlock *BB) {
1057       std::vector<BasicBlock *>::iterator E = DeadBlocks.end();
1058       std::vector<BasicBlock *>::iterator I =
1059         std::lower_bound(DeadBlocks.begin(), E, BB);
1060
1061       if (I == E || *I != BB) DeadBlocks.insert(I, BB);
1062     }
1063
1064     /// isDead - returns whether a block is known to be dead already
1065     bool isDead(BasicBlock *BB) {
1066       std::vector<BasicBlock *>::iterator E = DeadBlocks.end();
1067       std::vector<BasicBlock *>::iterator I =
1068         std::lower_bound(DeadBlocks.begin(), E, BB);
1069
1070       return I != E && *I == BB;
1071     }
1072
1073     /// kill - replace the dead blocks' terminator with an UnreachableInst.
1074     bool kill() {
1075       bool modified = false;
1076       for (std::vector<BasicBlock *>::iterator I = DeadBlocks.begin(),
1077            E = DeadBlocks.end(); I != E; ++I) {
1078         BasicBlock *BB = *I;
1079
1080         DOUT << "unreachable block: " << BB->getName() << "\n";
1081
1082         for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB);
1083              SI != SE; ++SI) {
1084           BasicBlock *Succ = *SI;
1085           Succ->removePredecessor(BB);
1086         }
1087
1088         TerminatorInst *TI = BB->getTerminator();
1089         TI->replaceAllUsesWith(UndefValue::get(TI->getType()));
1090         TI->eraseFromParent();
1091         new UnreachableInst(BB);
1092         ++NumBlocks;
1093         modified = true;
1094       }
1095       DeadBlocks.clear();
1096       return modified;
1097     }
1098   };
1099
1100   /// VRPSolver keeps track of how changes to one variable affect other
1101   /// variables, and forwards changes along to the InequalityGraph. It
1102   /// also maintains the correct choice for "canonical" in the IG.
1103   /// @brief VRPSolver calculates inferences from a new relationship.
1104   class VISIBILITY_HIDDEN VRPSolver {
1105   private:
1106     friend class ValueRanges;
1107
1108     struct Operation {
1109       Value *LHS, *RHS;
1110       ICmpInst::Predicate Op;
1111
1112       BasicBlock *ContextBB;
1113       Instruction *ContextInst;
1114     };
1115     std::deque<Operation> WorkList;
1116
1117     InequalityGraph &IG;
1118     UnreachableBlocks &UB;
1119     ValueRanges &VR;
1120
1121     ETForest *Forest;
1122     ETNode *Top;
1123     BasicBlock *TopBB;
1124     Instruction *TopInst;
1125     bool &modified;
1126
1127     typedef InequalityGraph::Node Node;
1128
1129     /// IdomI - Determines whether one Instruction dominates another.
1130     bool IdomI(Instruction *I1, Instruction *I2) const {
1131       BasicBlock *BB1 = I1->getParent(),
1132                  *BB2 = I2->getParent();
1133       if (BB1 == BB2) {
1134         if (isa<TerminatorInst>(I1)) return false;
1135         if (isa<TerminatorInst>(I2)) return true;
1136         if (isa<PHINode>(I1) && !isa<PHINode>(I2)) return true;
1137         if (!isa<PHINode>(I1) && isa<PHINode>(I2)) return false;
1138
1139         for (BasicBlock::const_iterator I = BB1->begin(), E = BB1->end();
1140              I != E; ++I) {
1141           if (&*I == I1) return true;
1142           if (&*I == I2) return false;
1143         }
1144         assert(!"Instructions not found in parent BasicBlock?");
1145       } else {
1146         return Forest->properlyDominates(BB1, BB2);
1147       }
1148       return false;
1149     }
1150
1151     /// Returns true if V1 is a better canonical value than V2.
1152     bool compare(Value *V1, Value *V2) const {
1153       if (isa<Constant>(V1))
1154         return !isa<Constant>(V2);
1155       else if (isa<Constant>(V2))
1156         return false;
1157       else if (isa<Argument>(V1))
1158         return !isa<Argument>(V2);
1159       else if (isa<Argument>(V2))
1160         return false;
1161
1162       Instruction *I1 = dyn_cast<Instruction>(V1);
1163       Instruction *I2 = dyn_cast<Instruction>(V2);
1164
1165       if (!I1 || !I2)
1166         return V1->getNumUses() < V2->getNumUses();
1167
1168       return IdomI(I1, I2);
1169     }
1170
1171     // below - true if the Instruction is dominated by the current context
1172     // block or instruction
1173     bool below(Instruction *I) {
1174       if (TopInst)
1175         return IdomI(TopInst, I);
1176       else {
1177         ETNode *Node = Forest->getNodeForBlock(I->getParent());
1178         return Node->DominatedBy(Top);
1179       }
1180     }
1181
1182     bool makeEqual(Value *V1, Value *V2) {
1183       DOUT << "makeEqual(" << *V1 << ", " << *V2 << ")\n";
1184
1185       assert(V1->getType() == V2->getType() &&
1186              "Can't make two values with different types equal.");
1187
1188       if (V1 == V2) return true;
1189
1190       if (isa<Constant>(V1) && isa<Constant>(V2))
1191         return false;
1192
1193       unsigned n1 = IG.getNode(V1, Top), n2 = IG.getNode(V2, Top);
1194
1195       if (n1 && n2) {
1196         if (n1 == n2) return true;
1197         if (IG.isRelatedBy(n1, n2, Top, NE)) return false;
1198       }
1199
1200       if (n1) assert(V1 == IG.node(n1)->getValue() && "Value isn't canonical.");
1201       if (n2) assert(V2 == IG.node(n2)->getValue() && "Value isn't canonical.");
1202
1203       assert(!compare(V2, V1) && "Please order parameters to makeEqual.");
1204
1205       assert(!isa<Constant>(V2) && "Tried to remove a constant.");
1206
1207       SetVector<unsigned> Remove;
1208       if (n2) Remove.insert(n2);
1209
1210       if (n1 && n2) {
1211         // Suppose we're being told that %x == %y, and %x <= %z and %y >= %z.
1212         // We can't just merge %x and %y because the relationship with %z would
1213         // be EQ and that's invalid. What we're doing is looking for any nodes
1214         // %z such that %x <= %z and %y >= %z, and vice versa.
1215
1216         Node *N1 = IG.node(n1);
1217         Node *N2 = IG.node(n2);
1218         Node::iterator end = N2->end();
1219
1220         // Find the intersection between N1 and N2 which is dominated by
1221         // Top. If we find %x where N1 <= %x <= N2 (or >=) then add %x to
1222         // Remove.
1223         for (Node::iterator I = N1->begin(), E = N1->end(); I != E; ++I) {
1224           if (!(I->LV & EQ_BIT) || !Top->DominatedBy(I->Subtree)) continue;
1225
1226           unsigned ILV_s = I->LV & (SLT_BIT|SGT_BIT);
1227           unsigned ILV_u = I->LV & (ULT_BIT|UGT_BIT);
1228           Node::iterator NI = N2->find(I->To, Top);
1229           if (NI != end) {
1230             LatticeVal NILV = reversePredicate(NI->LV);
1231             unsigned NILV_s = NILV & (SLT_BIT|SGT_BIT);
1232             unsigned NILV_u = NILV & (ULT_BIT|UGT_BIT);
1233
1234             if ((ILV_s != (SLT_BIT|SGT_BIT) && ILV_s == NILV_s) ||
1235                 (ILV_u != (ULT_BIT|UGT_BIT) && ILV_u == NILV_u))
1236               Remove.insert(I->To);
1237           }
1238         }
1239
1240         // See if one of the nodes about to be removed is actually a better
1241         // canonical choice than n1.
1242         unsigned orig_n1 = n1;
1243         SetVector<unsigned>::iterator DontRemove = Remove.end();
1244         for (SetVector<unsigned>::iterator I = Remove.begin()+1 /* skip n2 */,
1245              E = Remove.end(); I != E; ++I) {
1246           unsigned n = *I;
1247           Value *V = IG.node(n)->getValue();
1248           if (compare(V, V1)) {
1249             V1 = V;
1250             n1 = n;
1251             DontRemove = I;
1252           }
1253         }
1254         if (DontRemove != Remove.end()) {
1255           unsigned n = *DontRemove;
1256           Remove.remove(n);
1257           Remove.insert(orig_n1);
1258         }
1259       }
1260
1261       // We'd like to allow makeEqual on two values to perform a simple
1262       // substitution without every creating nodes in the IG whenever possible.
1263       //
1264       // The first iteration through this loop operates on V2 before going
1265       // through the Remove list and operating on those too. If all of the
1266       // iterations performed simple replacements then we exit early.
1267       bool mergeIGNode = false;
1268       unsigned i = 0;
1269       for (Value *R = V2; i == 0 || i < Remove.size(); ++i) {
1270         if (i) R = IG.node(Remove[i])->getValue(); // skip n2.
1271
1272         // Try to replace the whole instruction. If we can, we're done.
1273         Instruction *I2 = dyn_cast<Instruction>(R);
1274         if (I2 && below(I2)) {
1275           std::vector<Instruction *> ToNotify;
1276           for (Value::use_iterator UI = R->use_begin(), UE = R->use_end();
1277                UI != UE;) {
1278             Use &TheUse = UI.getUse();
1279             ++UI;
1280             if (Instruction *I = dyn_cast<Instruction>(TheUse.getUser()))
1281               ToNotify.push_back(I);
1282           }
1283
1284           DOUT << "Simply removing " << *I2
1285                << ", replacing with " << *V1 << "\n";
1286           I2->replaceAllUsesWith(V1);
1287           // leave it dead; it'll get erased later.
1288           ++NumInstruction;
1289           modified = true;
1290
1291           for (std::vector<Instruction *>::iterator II = ToNotify.begin(),
1292                IE = ToNotify.end(); II != IE; ++II) {
1293             opsToDef(*II);
1294           }
1295
1296           continue;
1297         }
1298
1299         // Otherwise, replace all dominated uses.
1300         for (Value::use_iterator UI = R->use_begin(), UE = R->use_end();
1301              UI != UE;) {
1302           Use &TheUse = UI.getUse();
1303           ++UI;
1304           if (Instruction *I = dyn_cast<Instruction>(TheUse.getUser())) {
1305             if (below(I)) {
1306               TheUse.set(V1);
1307               modified = true;
1308               ++NumVarsReplaced;
1309               opsToDef(I);
1310             }
1311           }
1312         }
1313
1314         // If that killed the instruction, stop here.
1315         if (I2 && isInstructionTriviallyDead(I2)) {
1316           DOUT << "Killed all uses of " << *I2
1317                << ", replacing with " << *V1 << "\n";
1318           continue;
1319         }
1320
1321         // If we make it to here, then we will need to create a node for N1.
1322         // Otherwise, we can skip out early!
1323         mergeIGNode = true;
1324       }
1325
1326       if (!isa<Constant>(V1)) {
1327         if (Remove.empty()) {
1328           VR.mergeInto(&V2, 1, V1, Top, this);
1329         } else {
1330           std::vector<Value*> RemoveVals;
1331           RemoveVals.reserve(Remove.size());
1332
1333           for (SetVector<unsigned>::iterator I = Remove.begin(),
1334                E = Remove.end(); I != E; ++I) {
1335             Value *V = IG.node(*I)->getValue();
1336             if (!V->use_empty())
1337               RemoveVals.push_back(V);
1338           }
1339           VR.mergeInto(&RemoveVals[0], RemoveVals.size(), V1, Top, this);
1340         }
1341       }
1342
1343       if (mergeIGNode) {
1344         // Create N1.
1345         if (!n1) n1 = IG.newNode(V1);
1346
1347         // Migrate relationships from removed nodes to N1.
1348         Node *N1 = IG.node(n1);
1349         for (SetVector<unsigned>::iterator I = Remove.begin(), E = Remove.end();
1350              I != E; ++I) {
1351           unsigned n = *I;
1352           Node *N = IG.node(n);
1353           for (Node::iterator NI = N->begin(), NE = N->end(); NI != NE; ++NI) {
1354             if (NI->Subtree->DominatedBy(Top)) {
1355               if (NI->To == n1) {
1356                 assert((NI->LV & EQ_BIT) && "Node inequal to itself.");
1357                 continue;
1358               }
1359               if (Remove.count(NI->To))
1360                 continue;
1361
1362               IG.node(NI->To)->update(n1, reversePredicate(NI->LV), Top);
1363               N1->update(NI->To, NI->LV, Top);
1364             }
1365           }
1366         }
1367
1368         // Point V2 (and all items in Remove) to N1.
1369         if (!n2)
1370           IG.addEquality(n1, V2, Top);
1371         else {
1372           for (SetVector<unsigned>::iterator I = Remove.begin(),
1373                E = Remove.end(); I != E; ++I) {
1374             IG.addEquality(n1, IG.node(*I)->getValue(), Top);
1375           }
1376         }
1377
1378         // If !Remove.empty() then V2 = Remove[0]->getValue().
1379         // Even when Remove is empty, we still want to process V2.
1380         i = 0;
1381         for (Value *R = V2; i == 0 || i < Remove.size(); ++i) {
1382           if (i) R = IG.node(Remove[i])->getValue(); // skip n2.
1383
1384           if (Instruction *I2 = dyn_cast<Instruction>(R)) {
1385             if (below(I2) ||
1386                 Top->DominatedBy(Forest->getNodeForBlock(I2->getParent())))
1387             defToOps(I2);
1388           }
1389           for (Value::use_iterator UI = V2->use_begin(), UE = V2->use_end();
1390                UI != UE;) {
1391             Use &TheUse = UI.getUse();
1392             ++UI;
1393             if (Instruction *I = dyn_cast<Instruction>(TheUse.getUser())) {
1394               if (below(I) ||
1395                   Top->DominatedBy(Forest->getNodeForBlock(I->getParent())))
1396                 opsToDef(I);
1397             }
1398           }
1399         }
1400       }
1401
1402       // re-opsToDef all dominated users of V1.
1403       if (Instruction *I = dyn_cast<Instruction>(V1)) {
1404         for (Value::use_iterator UI = I->use_begin(), UE = I->use_end();
1405              UI != UE;) {
1406           Use &TheUse = UI.getUse();
1407           ++UI;
1408           Value *V = TheUse.getUser();
1409           if (!V->use_empty()) {
1410             if (Instruction *Inst = dyn_cast<Instruction>(V)) {
1411               if (below(Inst) ||
1412                   Top->DominatedBy(Forest->getNodeForBlock(Inst->getParent())))
1413                 opsToDef(Inst);
1414             }
1415           }
1416         }
1417       }
1418
1419       return true;
1420     }
1421
1422     /// cmpInstToLattice - converts an CmpInst::Predicate to lattice value
1423     /// Requires that the lattice value be valid; does not accept ICMP_EQ.
1424     static LatticeVal cmpInstToLattice(ICmpInst::Predicate Pred) {
1425       switch (Pred) {
1426         case ICmpInst::ICMP_EQ:
1427           assert(!"No matching lattice value.");
1428           return static_cast<LatticeVal>(EQ_BIT);
1429         default:
1430           assert(!"Invalid 'icmp' predicate.");
1431         case ICmpInst::ICMP_NE:
1432           return NE;
1433         case ICmpInst::ICMP_UGT:
1434           return UGT;
1435         case ICmpInst::ICMP_UGE:
1436           return UGE;
1437         case ICmpInst::ICMP_ULT:
1438           return ULT;
1439         case ICmpInst::ICMP_ULE:
1440           return ULE;
1441         case ICmpInst::ICMP_SGT:
1442           return SGT;
1443         case ICmpInst::ICMP_SGE:
1444           return SGE;
1445         case ICmpInst::ICMP_SLT:
1446           return SLT;
1447         case ICmpInst::ICMP_SLE:
1448           return SLE;
1449       }
1450     }
1451
1452   public:
1453     VRPSolver(InequalityGraph &IG, UnreachableBlocks &UB, ValueRanges &VR,
1454               ETForest *Forest, bool &modified, BasicBlock *TopBB)
1455       : IG(IG),
1456         UB(UB),
1457         VR(VR),
1458         Forest(Forest),
1459         Top(Forest->getNodeForBlock(TopBB)),
1460         TopBB(TopBB),
1461         TopInst(NULL),
1462         modified(modified) {}
1463
1464     VRPSolver(InequalityGraph &IG, UnreachableBlocks &UB, ValueRanges &VR,
1465               ETForest *Forest, bool &modified, Instruction *TopInst)
1466       : IG(IG),
1467         UB(UB),
1468         VR(VR),
1469         Forest(Forest),
1470         TopInst(TopInst),
1471         modified(modified)
1472     {
1473       TopBB = TopInst->getParent();
1474       Top = Forest->getNodeForBlock(TopBB);
1475     }
1476
1477     bool isRelatedBy(Value *V1, Value *V2, ICmpInst::Predicate Pred) const {
1478       if (Constant *C1 = dyn_cast<Constant>(V1))
1479         if (Constant *C2 = dyn_cast<Constant>(V2))
1480           return ConstantExpr::getCompare(Pred, C1, C2) ==
1481                  ConstantInt::getTrue();
1482
1483       if (unsigned n1 = IG.getNode(V1, Top))
1484         if (unsigned n2 = IG.getNode(V2, Top)) {
1485           if (n1 == n2) return Pred == ICmpInst::ICMP_EQ ||
1486                                Pred == ICmpInst::ICMP_ULE ||
1487                                Pred == ICmpInst::ICMP_UGE ||
1488                                Pred == ICmpInst::ICMP_SLE ||
1489                                Pred == ICmpInst::ICMP_SGE;
1490           if (Pred == ICmpInst::ICMP_EQ) return false;
1491           if (IG.isRelatedBy(n1, n2, Top, cmpInstToLattice(Pred))) return true;
1492         }
1493
1494       if (Pred == ICmpInst::ICMP_EQ) return V1 == V2;
1495       return VR.isRelatedBy(V1, V2, Top, cmpInstToLattice(Pred));
1496     }
1497
1498     /// add - adds a new property to the work queue
1499     void add(Value *V1, Value *V2, ICmpInst::Predicate Pred,
1500              Instruction *I = NULL) {
1501       DOUT << "adding " << *V1 << " " << Pred << " " << *V2;
1502       if (I) DOUT << " context: " << *I;
1503       else DOUT << " default context";
1504       DOUT << "\n";
1505
1506       assert(V1->getType() == V2->getType() &&
1507              "Can't relate two values with different types.");
1508
1509       WorkList.push_back(Operation());
1510       Operation &O = WorkList.back();
1511       O.LHS = V1, O.RHS = V2, O.Op = Pred, O.ContextInst = I;
1512       O.ContextBB = I ? I->getParent() : TopBB;
1513     }
1514
1515     /// defToOps - Given an instruction definition that we've learned something
1516     /// new about, find any new relationships between its operands.
1517     void defToOps(Instruction *I) {
1518       Instruction *NewContext = below(I) ? I : TopInst;
1519       Value *Canonical = IG.canonicalize(I, Top);
1520
1521       if (BinaryOperator *BO = dyn_cast<BinaryOperator>(I)) {
1522         const Type *Ty = BO->getType();
1523         assert(!Ty->isFPOrFPVector() && "Float in work queue!");
1524
1525         Value *Op0 = IG.canonicalize(BO->getOperand(0), Top);
1526         Value *Op1 = IG.canonicalize(BO->getOperand(1), Top);
1527
1528         // TODO: "and i32 -1, %x" EQ %y then %x EQ %y.
1529
1530         switch (BO->getOpcode()) {
1531           case Instruction::And: {
1532             // "and i32 %a, %b" EQ -1 then %a EQ -1 and %b EQ -1
1533             ConstantInt *CI = ConstantInt::getAllOnesValue(Ty);
1534             if (Canonical == CI) {
1535               add(CI, Op0, ICmpInst::ICMP_EQ, NewContext);
1536               add(CI, Op1, ICmpInst::ICMP_EQ, NewContext);
1537             }
1538           } break;
1539           case Instruction::Or: {
1540             // "or i32 %a, %b" EQ 0 then %a EQ 0 and %b EQ 0
1541             Constant *Zero = Constant::getNullValue(Ty);
1542             if (Canonical == Zero) {
1543               add(Zero, Op0, ICmpInst::ICMP_EQ, NewContext);
1544               add(Zero, Op1, ICmpInst::ICMP_EQ, NewContext);
1545             }
1546           } break;
1547           case Instruction::Xor: {
1548             // "xor i32 %c, %a" EQ %b then %a EQ %c ^ %b
1549             // "xor i32 %c, %a" EQ %c then %a EQ 0
1550             // "xor i32 %c, %a" NE %c then %a NE 0
1551             // Repeat the above, with order of operands reversed.
1552             Value *LHS = Op0;
1553             Value *RHS = Op1;
1554             if (!isa<Constant>(LHS)) std::swap(LHS, RHS);
1555
1556             if (ConstantInt *CI = dyn_cast<ConstantInt>(Canonical)) {
1557               if (ConstantInt *Arg = dyn_cast<ConstantInt>(LHS)) {
1558                 add(RHS, ConstantInt::get(CI->getValue() ^ Arg->getValue()),
1559                     ICmpInst::ICMP_EQ, NewContext);
1560               }
1561             }
1562             if (Canonical == LHS) {
1563               if (isa<ConstantInt>(Canonical))
1564                 add(RHS, Constant::getNullValue(Ty), ICmpInst::ICMP_EQ,
1565                     NewContext);
1566             } else if (isRelatedBy(LHS, Canonical, ICmpInst::ICMP_NE)) {
1567               add(RHS, Constant::getNullValue(Ty), ICmpInst::ICMP_NE,
1568                   NewContext);
1569             }
1570           } break;
1571           default:
1572             break;
1573         }
1574       } else if (ICmpInst *IC = dyn_cast<ICmpInst>(I)) {
1575         // "icmp ult i32 %a, %y" EQ true then %a u< y
1576         // etc.
1577
1578         if (Canonical == ConstantInt::getTrue()) {
1579           add(IC->getOperand(0), IC->getOperand(1), IC->getPredicate(),
1580               NewContext);
1581         } else if (Canonical == ConstantInt::getFalse()) {
1582           add(IC->getOperand(0), IC->getOperand(1),
1583               ICmpInst::getInversePredicate(IC->getPredicate()), NewContext);
1584         }
1585       } else if (SelectInst *SI = dyn_cast<SelectInst>(I)) {
1586         if (I->getType()->isFPOrFPVector()) return;
1587
1588         // Given: "%a = select i1 %x, i32 %b, i32 %c"
1589         // %a EQ %b and %b NE %c then %x EQ true
1590         // %a EQ %c and %b NE %c then %x EQ false
1591
1592         Value *True  = SI->getTrueValue();
1593         Value *False = SI->getFalseValue();
1594         if (isRelatedBy(True, False, ICmpInst::ICMP_NE)) {
1595           if (Canonical == IG.canonicalize(True, Top) ||
1596               isRelatedBy(Canonical, False, ICmpInst::ICMP_NE))
1597             add(SI->getCondition(), ConstantInt::getTrue(),
1598                 ICmpInst::ICMP_EQ, NewContext);
1599           else if (Canonical == IG.canonicalize(False, Top) ||
1600                    isRelatedBy(Canonical, True, ICmpInst::ICMP_NE))
1601             add(SI->getCondition(), ConstantInt::getFalse(),
1602                 ICmpInst::ICMP_EQ, NewContext);
1603         }
1604       } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
1605         for (GetElementPtrInst::op_iterator OI = GEPI->idx_begin(),
1606              OE = GEPI->idx_end(); OI != OE; ++OI) {
1607           ConstantInt *Op = dyn_cast<ConstantInt>(IG.canonicalize(*OI, Top));
1608           if (!Op || !Op->isZero()) return;
1609         }
1610         // TODO: The GEPI indices are all zero. Copy from definition to operand,
1611         // jumping the type plane as needed.
1612         if (isRelatedBy(GEPI, Constant::getNullValue(GEPI->getType()),
1613                         ICmpInst::ICMP_NE)) {
1614           Value *Ptr = GEPI->getPointerOperand();
1615           add(Ptr, Constant::getNullValue(Ptr->getType()), ICmpInst::ICMP_NE,
1616               NewContext);
1617         }
1618       } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
1619         const Type *SrcTy = CI->getSrcTy();
1620
1621         Value *TheCI = IG.canonicalize(CI, Top);
1622         uint32_t W = VR.typeToWidth(SrcTy);
1623         if (!W) return;
1624         ConstantRange CR = VR.rangeFromValue(TheCI, Top, W);
1625
1626         if (CR.isFullSet()) return;
1627
1628         switch (CI->getOpcode()) {
1629           default: break;
1630           case Instruction::ZExt:
1631           case Instruction::SExt:
1632             VR.applyRange(IG.canonicalize(CI->getOperand(0), Top),
1633                           CR.truncate(W), Top, this);
1634             break;
1635           case Instruction::BitCast:
1636             VR.applyRange(IG.canonicalize(CI->getOperand(0), Top),
1637                           CR, Top, this);
1638             break;
1639         }
1640       }
1641     }
1642
1643     /// opsToDef - A new relationship was discovered involving one of this
1644     /// instruction's operands. Find any new relationship involving the
1645     /// definition, or another operand.
1646     void opsToDef(Instruction *I) {
1647       Instruction *NewContext = below(I) ? I : TopInst;
1648
1649       if (BinaryOperator *BO = dyn_cast<BinaryOperator>(I)) {
1650         Value *Op0 = IG.canonicalize(BO->getOperand(0), Top);
1651         Value *Op1 = IG.canonicalize(BO->getOperand(1), Top);
1652
1653         if (ConstantInt *CI0 = dyn_cast<ConstantInt>(Op0))
1654           if (ConstantInt *CI1 = dyn_cast<ConstantInt>(Op1)) {
1655             add(BO, ConstantExpr::get(BO->getOpcode(), CI0, CI1),
1656                 ICmpInst::ICMP_EQ, NewContext);
1657             return;
1658           }
1659
1660         // "%y = and i1 true, %x" then %x EQ %y
1661         // "%y = or i1 false, %x" then %x EQ %y
1662         // "%x = add i32 %y, 0" then %x EQ %y
1663         // "%x = mul i32 %y, 0" then %x EQ 0
1664
1665         Instruction::BinaryOps Opcode = BO->getOpcode();
1666         const Type *Ty = BO->getType();
1667         assert(!Ty->isFPOrFPVector() && "Float in work queue!");
1668
1669         Constant *Zero = Constant::getNullValue(Ty);
1670         ConstantInt *AllOnes = ConstantInt::getAllOnesValue(Ty);
1671
1672         switch (Opcode) {
1673           default: break;
1674           case Instruction::LShr:
1675           case Instruction::AShr:
1676           case Instruction::Shl:
1677           case Instruction::Sub:
1678             if (Op1 == Zero) {
1679               add(BO, Op0, ICmpInst::ICMP_EQ, NewContext);
1680               return;
1681             }
1682             break;
1683           case Instruction::Or:
1684             if (Op0 == AllOnes || Op1 == AllOnes) {
1685               add(BO, AllOnes, ICmpInst::ICMP_EQ, NewContext);
1686               return;
1687             } // fall-through
1688           case Instruction::Xor:
1689           case Instruction::Add:
1690             if (Op0 == Zero) {
1691               add(BO, Op1, ICmpInst::ICMP_EQ, NewContext);
1692               return;
1693             } else if (Op1 == Zero) {
1694               add(BO, Op0, ICmpInst::ICMP_EQ, NewContext);
1695               return;
1696             }
1697             break;
1698           case Instruction::And:
1699             if (Op0 == AllOnes) {
1700               add(BO, Op1, ICmpInst::ICMP_EQ, NewContext);
1701               return;
1702             } else if (Op1 == AllOnes) {
1703               add(BO, Op0, ICmpInst::ICMP_EQ, NewContext);
1704               return;
1705             }
1706             // fall-through
1707           case Instruction::Mul:
1708             if (Op0 == Zero || Op1 == Zero) {
1709               add(BO, Zero, ICmpInst::ICMP_EQ, NewContext);
1710               return;
1711             }
1712             break;
1713         }
1714
1715         // "%x = add i32 %y, %z" and %x EQ %y then %z EQ 0
1716         // "%x = add i32 %y, %z" and %x EQ %z then %y EQ 0
1717         // "%x = shl i32 %y, %z" and %x EQ %y and %y NE 0 then %z EQ 0
1718         // "%x = udiv i32 %y, %z" and %x EQ %y then %z EQ 1
1719
1720         Value *Known = Op0, *Unknown = Op1,
1721               *TheBO = IG.canonicalize(BO, Top);
1722         if (Known != TheBO) std::swap(Known, Unknown);
1723         if (Known == TheBO) {
1724           switch (Opcode) {
1725             default: break;
1726             case Instruction::LShr:
1727             case Instruction::AShr:
1728             case Instruction::Shl:
1729               if (!isRelatedBy(Known, Zero, ICmpInst::ICMP_NE)) break;
1730               // otherwise, fall-through.
1731             case Instruction::Sub:
1732               if (Unknown == Op1) break;
1733               // otherwise, fall-through.
1734             case Instruction::Xor:
1735             case Instruction::Add:
1736               add(Unknown, Zero, ICmpInst::ICMP_EQ, NewContext);
1737               break;
1738             case Instruction::UDiv:
1739             case Instruction::SDiv:
1740               if (Unknown == Op1) break;
1741               if (isRelatedBy(Known, Zero, ICmpInst::ICMP_NE)) {
1742                 Constant *One = ConstantInt::get(Ty, 1);
1743                 add(Unknown, One, ICmpInst::ICMP_EQ, NewContext);
1744               }
1745               break;
1746           }
1747         }
1748
1749         // TODO: "%a = add i32 %b, 1" and %b > %z then %a >= %z.
1750
1751       } else if (ICmpInst *IC = dyn_cast<ICmpInst>(I)) {
1752         // "%a = icmp ult i32 %b, %c" and %b u<  %c then %a EQ true
1753         // "%a = icmp ult i32 %b, %c" and %b u>= %c then %a EQ false
1754         // etc.
1755
1756         Value *Op0 = IG.canonicalize(IC->getOperand(0), Top);
1757         Value *Op1 = IG.canonicalize(IC->getOperand(1), Top);
1758
1759         ICmpInst::Predicate Pred = IC->getPredicate();
1760         if (isRelatedBy(Op0, Op1, Pred)) {
1761           add(IC, ConstantInt::getTrue(), ICmpInst::ICMP_EQ, NewContext);
1762         } else if (isRelatedBy(Op0, Op1, ICmpInst::getInversePredicate(Pred))) {
1763           add(IC, ConstantInt::getFalse(), ICmpInst::ICMP_EQ, NewContext);
1764         }
1765
1766       } else if (SelectInst *SI = dyn_cast<SelectInst>(I)) {
1767         if (I->getType()->isFPOrFPVector()) return;
1768
1769         // Given: "%a = select i1 %x, i32 %b, i32 %c"
1770         // %x EQ true  then %a EQ %b
1771         // %x EQ false then %a EQ %c
1772         // %b EQ %c then %a EQ %b
1773
1774         Value *Canonical = IG.canonicalize(SI->getCondition(), Top);
1775         if (Canonical == ConstantInt::getTrue()) {
1776           add(SI, SI->getTrueValue(), ICmpInst::ICMP_EQ, NewContext);
1777         } else if (Canonical == ConstantInt::getFalse()) {
1778           add(SI, SI->getFalseValue(), ICmpInst::ICMP_EQ, NewContext);
1779         } else if (IG.canonicalize(SI->getTrueValue(), Top) ==
1780                    IG.canonicalize(SI->getFalseValue(), Top)) {
1781           add(SI, SI->getTrueValue(), ICmpInst::ICMP_EQ, NewContext);
1782         }
1783       } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
1784         const Type *DestTy = CI->getDestTy();
1785         if (DestTy->isFPOrFPVector()) return;
1786
1787         Value *Op = IG.canonicalize(CI->getOperand(0), Top);
1788         Instruction::CastOps Opcode = CI->getOpcode();
1789
1790         if (Constant *C = dyn_cast<Constant>(Op)) {
1791           add(CI, ConstantExpr::getCast(Opcode, C, DestTy),
1792               ICmpInst::ICMP_EQ, NewContext);
1793         }
1794
1795         uint32_t W = VR.typeToWidth(DestTy);
1796         Value *TheCI = IG.canonicalize(CI, Top);
1797         ConstantRange CR = VR.rangeFromValue(Op, Top, W);
1798
1799         if (!CR.isFullSet()) {
1800           switch (Opcode) {
1801             default: break;
1802             case Instruction::ZExt:
1803               VR.applyRange(TheCI, CR.zeroExtend(W), Top, this);
1804               break;
1805             case Instruction::SExt:
1806               VR.applyRange(TheCI, CR.signExtend(W), Top, this);
1807               break;
1808             case Instruction::Trunc: {
1809               ConstantRange Result = CR.truncate(W);
1810               if (!Result.isFullSet())
1811                 VR.applyRange(TheCI, Result, Top, this);
1812             } break;
1813             case Instruction::BitCast:
1814               VR.applyRange(TheCI, CR, Top, this);
1815               break;
1816             // TODO: other casts?
1817           }
1818         }
1819       } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
1820         for (GetElementPtrInst::op_iterator OI = GEPI->idx_begin(),
1821              OE = GEPI->idx_end(); OI != OE; ++OI) {
1822           ConstantInt *Op = dyn_cast<ConstantInt>(IG.canonicalize(*OI, Top));
1823           if (!Op || !Op->isZero()) return;
1824         }
1825         // TODO: The GEPI indices are all zero. Copy from operand to definition,
1826         // jumping the type plane as needed.
1827         Value *Ptr = GEPI->getPointerOperand();
1828         if (isRelatedBy(Ptr, Constant::getNullValue(Ptr->getType()),
1829                         ICmpInst::ICMP_NE)) {
1830           add(GEPI, Constant::getNullValue(GEPI->getType()), ICmpInst::ICMP_NE,
1831               NewContext);
1832         }
1833       }
1834     }
1835
1836     /// solve - process the work queue
1837     void solve() {
1838       //DOUT << "WorkList entry, size: " << WorkList.size() << "\n";
1839       while (!WorkList.empty()) {
1840         //DOUT << "WorkList size: " << WorkList.size() << "\n";
1841
1842         Operation &O = WorkList.front();
1843         TopInst = O.ContextInst;
1844         TopBB = O.ContextBB;
1845         Top = Forest->getNodeForBlock(TopBB);
1846
1847         O.LHS = IG.canonicalize(O.LHS, Top);
1848         O.RHS = IG.canonicalize(O.RHS, Top);
1849
1850         assert(O.LHS == IG.canonicalize(O.LHS, Top) && "Canonicalize isn't.");
1851         assert(O.RHS == IG.canonicalize(O.RHS, Top) && "Canonicalize isn't.");
1852
1853         DOUT << "solving " << *O.LHS << " " << O.Op << " " << *O.RHS;
1854         if (O.ContextInst) DOUT << " context inst: " << *O.ContextInst;
1855         else DOUT << " context block: " << O.ContextBB->getName();
1856         DOUT << "\n";
1857
1858         DEBUG(IG.dump());
1859
1860         // If they're both Constant, skip it. Check for contradiction and mark
1861         // the BB as unreachable if so.
1862         if (Constant *CI_L = dyn_cast<Constant>(O.LHS)) {
1863           if (Constant *CI_R = dyn_cast<Constant>(O.RHS)) {
1864             if (ConstantExpr::getCompare(O.Op, CI_L, CI_R) ==
1865                 ConstantInt::getFalse())
1866               UB.mark(TopBB);
1867
1868             WorkList.pop_front();
1869             continue;
1870           }
1871         }
1872
1873         if (compare(O.LHS, O.RHS)) {
1874           std::swap(O.LHS, O.RHS);
1875           O.Op = ICmpInst::getSwappedPredicate(O.Op);
1876         }
1877
1878         if (O.Op == ICmpInst::ICMP_EQ) {
1879           if (!makeEqual(O.RHS, O.LHS))
1880             UB.mark(TopBB);
1881         } else {
1882           LatticeVal LV = cmpInstToLattice(O.Op);
1883
1884           if ((LV & EQ_BIT) &&
1885               isRelatedBy(O.LHS, O.RHS, ICmpInst::getSwappedPredicate(O.Op))) {
1886             if (!makeEqual(O.RHS, O.LHS))
1887               UB.mark(TopBB);
1888           } else {
1889             if (isRelatedBy(O.LHS, O.RHS, ICmpInst::getInversePredicate(O.Op))){
1890               UB.mark(TopBB);
1891               WorkList.pop_front();
1892               continue;
1893             }
1894
1895             unsigned n1 = IG.getNode(O.LHS, Top);
1896             unsigned n2 = IG.getNode(O.RHS, Top);
1897
1898             if (n1 && n1 == n2) {
1899               if (O.Op != ICmpInst::ICMP_UGE && O.Op != ICmpInst::ICMP_ULE &&
1900                   O.Op != ICmpInst::ICMP_SGE && O.Op != ICmpInst::ICMP_SLE)
1901                 UB.mark(TopBB);
1902
1903               WorkList.pop_front();
1904               continue;
1905             }
1906
1907             if (VR.isRelatedBy(O.LHS, O.RHS, Top, LV) ||
1908                 (n1 && n2 && IG.isRelatedBy(n1, n2, Top, LV))) {
1909               WorkList.pop_front();
1910               continue;
1911             }
1912
1913             VR.addInequality(O.LHS, O.RHS, Top, LV, this);
1914             if ((!isa<ConstantInt>(O.RHS) && !isa<ConstantInt>(O.LHS)) ||
1915                 LV == NE) {
1916               if (!n1) n1 = IG.newNode(O.LHS);
1917               if (!n2) n2 = IG.newNode(O.RHS);
1918               IG.addInequality(n1, n2, Top, LV);
1919             }
1920
1921             if (Instruction *I1 = dyn_cast<Instruction>(O.LHS)) {
1922               if (below(I1) ||
1923                   Top->DominatedBy(Forest->getNodeForBlock(I1->getParent())))
1924                 defToOps(I1);
1925             }
1926             if (isa<Instruction>(O.LHS) || isa<Argument>(O.LHS)) {
1927               for (Value::use_iterator UI = O.LHS->use_begin(),
1928                    UE = O.LHS->use_end(); UI != UE;) {
1929                 Use &TheUse = UI.getUse();
1930                 ++UI;
1931                 if (Instruction *I = dyn_cast<Instruction>(TheUse.getUser())) {
1932                   if (below(I) ||
1933                       Top->DominatedBy(Forest->getNodeForBlock(I->getParent())))
1934                     opsToDef(I);
1935                 }
1936               }
1937             }
1938             if (Instruction *I2 = dyn_cast<Instruction>(O.RHS)) {
1939               if (below(I2) ||
1940                   Top->DominatedBy(Forest->getNodeForBlock(I2->getParent())))
1941               defToOps(I2);
1942             }
1943             if (isa<Instruction>(O.RHS) || isa<Argument>(O.RHS)) {
1944               for (Value::use_iterator UI = O.RHS->use_begin(),
1945                    UE = O.RHS->use_end(); UI != UE;) {
1946                 Use &TheUse = UI.getUse();
1947                 ++UI;
1948                 if (Instruction *I = dyn_cast<Instruction>(TheUse.getUser())) {
1949                   if (below(I) ||
1950                       Top->DominatedBy(Forest->getNodeForBlock(I->getParent())))
1951
1952                     opsToDef(I);
1953                 }
1954               }
1955             }
1956           }
1957         }
1958         WorkList.pop_front();
1959       }
1960     }
1961   };
1962
1963   void ValueRanges::addToWorklist(Value *V, Constant *C,
1964                                   ICmpInst::Predicate Pred, VRPSolver *VRP) {
1965     VRP->add(V, C, Pred, VRP->TopInst);
1966   }
1967
1968   void ValueRanges::markBlock(VRPSolver *VRP) {
1969     VRP->UB.mark(VRP->TopBB);
1970   }
1971
1972 #ifndef NDEBUG
1973   bool ValueRanges::isCanonical(Value *V, ETNode *Subtree, VRPSolver *VRP) {
1974     return V == VRP->IG.canonicalize(V, Subtree);
1975   }
1976 #endif
1977
1978   /// PredicateSimplifier - This class is a simplifier that replaces
1979   /// one equivalent variable with another. It also tracks what
1980   /// can't be equal and will solve setcc instructions when possible.
1981   /// @brief Root of the predicate simplifier optimization.
1982   class VISIBILITY_HIDDEN PredicateSimplifier : public FunctionPass {
1983     ETForest *Forest;
1984     bool modified;
1985     InequalityGraph *IG;
1986     UnreachableBlocks UB;
1987     ValueRanges *VR;
1988
1989     std::vector<BasicBlock *> WorkList;
1990
1991   public:
1992     bool runOnFunction(Function &F);
1993
1994     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
1995       AU.addRequiredID(BreakCriticalEdgesID);
1996       AU.addRequired<ETForest>();
1997       AU.addRequired<TargetData>();
1998       AU.addPreserved<TargetData>();
1999     }
2000
2001   private:
2002     /// Forwards - Adds new properties into PropertySet and uses them to
2003     /// simplify instructions. Because new properties sometimes apply to
2004     /// a transition from one BasicBlock to another, this will use the
2005     /// PredicateSimplifier::proceedToSuccessor(s) interface to enter the
2006     /// basic block with the new PropertySet.
2007     /// @brief Performs abstract execution of the program.
2008     class VISIBILITY_HIDDEN Forwards : public InstVisitor<Forwards> {
2009       friend class InstVisitor<Forwards>;
2010       PredicateSimplifier *PS;
2011       BasicBlock *Node;
2012
2013     public:
2014       InequalityGraph &IG;
2015       UnreachableBlocks &UB;
2016       ValueRanges &VR;
2017
2018       Forwards(PredicateSimplifier *PS, BasicBlock* node)
2019         : PS(PS), Node(node), IG(*PS->IG), UB(PS->UB), VR(*PS->VR) {}
2020
2021       void visitTerminatorInst(TerminatorInst &TI);
2022       void visitBranchInst(BranchInst &BI);
2023       void visitSwitchInst(SwitchInst &SI);
2024
2025       void visitAllocaInst(AllocaInst &AI);
2026       void visitLoadInst(LoadInst &LI);
2027       void visitStoreInst(StoreInst &SI);
2028
2029       void visitSExtInst(SExtInst &SI);
2030       void visitZExtInst(ZExtInst &ZI);
2031
2032       void visitBinaryOperator(BinaryOperator &BO);
2033       void visitICmpInst(ICmpInst &IC);
2034     };
2035   
2036     // Used by terminator instructions to proceed from the current basic
2037     // block to the next. Verifies that "current" dominates "next",
2038     // then calls visitBasicBlock.
2039     void proceedToSuccessors(BasicBlock *Current) {
2040       std::vector<BasicBlock*> Children;
2041       Forest->getChildren(Current, Children);
2042       for (std::vector<BasicBlock*>::iterator I = Children.begin(),
2043            E = Children.end(); I != E; ++I) {
2044         WorkList.push_back(*I);
2045       }
2046     }
2047
2048     void proceedToSuccessor(BasicBlock *Next) {
2049       WorkList.push_back(Next);
2050     }
2051
2052     // Visits each instruction in the basic block.
2053     void visitBasicBlock(BasicBlock *BB) {
2054       ETNode *ET = Forest->getNodeForBlock(BB);
2055       DOUT << "Entering Basic Block: " << BB->getName()
2056            << " (" << ET->getDFSNumIn() << ")\n";
2057       for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E;) {
2058         visitInstruction(I++, BB, ET);
2059       }
2060     }
2061
2062     // Tries to simplify each Instruction and add new properties to
2063     // the PropertySet.
2064     void visitInstruction(Instruction *I, BasicBlock *node, ETNode *ET) {
2065       DOUT << "Considering instruction " << *I << "\n";
2066       DEBUG(IG->dump());
2067
2068       // Sometimes instructions are killed in earlier analysis.
2069       if (isInstructionTriviallyDead(I)) {
2070         ++NumSimple;
2071         modified = true;
2072         IG->remove(I);
2073         I->eraseFromParent();
2074         return;
2075       }
2076
2077 #ifndef NDEBUG
2078       // Try to replace the whole instruction.
2079       Value *V = IG->canonicalize(I, ET);
2080       assert(V == I && "Late instruction canonicalization.");
2081       if (V != I) {
2082         modified = true;
2083         ++NumInstruction;
2084         DOUT << "Removing " << *I << ", replacing with " << *V << "\n";
2085         IG->remove(I);
2086         I->replaceAllUsesWith(V);
2087         I->eraseFromParent();
2088         return;
2089       }
2090
2091       // Try to substitute operands.
2092       for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
2093         Value *Oper = I->getOperand(i);
2094         Value *V = IG->canonicalize(Oper, ET);
2095         assert(V == Oper && "Late operand canonicalization.");
2096         if (V != Oper) {
2097           modified = true;
2098           ++NumVarsReplaced;
2099           DOUT << "Resolving " << *I;
2100           I->setOperand(i, V);
2101           DOUT << " into " << *I;
2102         }
2103       }
2104 #endif
2105
2106       std::string name = I->getParent()->getName();
2107       DOUT << "push (%" << name << ")\n";
2108       Forwards visit(this, node);
2109       visit.visit(*I);
2110       DOUT << "pop (%" << name << ")\n";
2111     }
2112   };
2113
2114   bool PredicateSimplifier::runOnFunction(Function &F) {
2115     Forest = &getAnalysis<ETForest>();
2116
2117     TargetData *TD = &getAnalysis<TargetData>();
2118
2119     // XXX: should only act when numbers are out of date
2120     Forest->updateDFSNumbers();
2121
2122     DOUT << "Entering Function: " << F.getName() << "\n";
2123
2124     modified = false;
2125     BasicBlock *RootBlock = &F.getEntryBlock();
2126     IG = new InequalityGraph(Forest->getNodeForBlock(RootBlock));
2127     VR = new ValueRanges(TD);
2128     WorkList.push_back(Forest->getRoot());
2129
2130     do {
2131       BasicBlock *node = WorkList.back();
2132       WorkList.pop_back();
2133       if (!UB.isDead(node)) visitBasicBlock(node);
2134     } while (!WorkList.empty());
2135
2136     delete VR;
2137     delete IG;
2138
2139     modified |= UB.kill();
2140
2141     return modified;
2142   }
2143
2144   void PredicateSimplifier::Forwards::visitTerminatorInst(TerminatorInst &TI) {
2145     PS->proceedToSuccessors(Node);
2146   }
2147
2148   void PredicateSimplifier::Forwards::visitBranchInst(BranchInst &BI) {
2149     if (BI.isUnconditional()) {
2150       PS->proceedToSuccessors(Node);
2151       return;
2152     }
2153
2154     Value *Condition = BI.getCondition();
2155     BasicBlock *TrueDest  = BI.getSuccessor(0);
2156     BasicBlock *FalseDest = BI.getSuccessor(1);
2157
2158     if (isa<Constant>(Condition) || TrueDest == FalseDest) {
2159       PS->proceedToSuccessors(Node);
2160       return;
2161     }
2162
2163     std::vector<BasicBlock*> Children;
2164     PS->Forest->getChildren(Node, Children);
2165     for (std::vector<BasicBlock*>::iterator I = Children.begin(),
2166          E = Children.end(); I != E; ++I) {
2167       BasicBlock *Dest = *I;
2168       DOUT << "Branch thinking about %" << Dest->getName()
2169            << "(" << PS->Forest->getNodeForBlock(Dest)->getDFSNumIn() << ")\n";
2170
2171       if (Dest == TrueDest) {
2172         DOUT << "(" << Node->getName() << ") true set:\n";
2173         VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, Dest);
2174         VRP.add(ConstantInt::getTrue(), Condition, ICmpInst::ICMP_EQ);
2175         VRP.solve();
2176         DEBUG(IG.dump());
2177       } else if (Dest == FalseDest) {
2178         DOUT << "(" << Node->getName() << ") false set:\n";
2179         VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, Dest);
2180         VRP.add(ConstantInt::getFalse(), Condition, ICmpInst::ICMP_EQ);
2181         VRP.solve();
2182         DEBUG(IG.dump());
2183       }
2184
2185       PS->proceedToSuccessor(*I);
2186     }
2187   }
2188
2189   void PredicateSimplifier::Forwards::visitSwitchInst(SwitchInst &SI) {
2190     Value *Condition = SI.getCondition();
2191
2192     // Set the EQProperty in each of the cases BBs, and the NEProperties
2193     // in the default BB.
2194     std::vector<BasicBlock*> Children;
2195     PS->Forest->getChildren(Node, Children);
2196     for (std::vector<BasicBlock*>::iterator I = Children.begin(),
2197          E = Children.end(); I != E; ++I) {
2198       BasicBlock *BB = *I;
2199       DOUT << "Switch thinking about BB %" << BB->getName()
2200            << "(" << PS->Forest->getNodeForBlock(BB)->getDFSNumIn() << ")\n";
2201
2202       VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, BB);
2203       if (BB == SI.getDefaultDest()) {
2204         for (unsigned i = 1, e = SI.getNumCases(); i < e; ++i)
2205           if (SI.getSuccessor(i) != BB)
2206             VRP.add(Condition, SI.getCaseValue(i), ICmpInst::ICMP_NE);
2207         VRP.solve();
2208       } else if (ConstantInt *CI = SI.findCaseDest(BB)) {
2209         VRP.add(Condition, CI, ICmpInst::ICMP_EQ);
2210         VRP.solve();
2211       }
2212       PS->proceedToSuccessor(*I);
2213     }
2214   }
2215
2216   void PredicateSimplifier::Forwards::visitAllocaInst(AllocaInst &AI) {
2217     VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &AI);
2218     VRP.add(Constant::getNullValue(AI.getType()), &AI, ICmpInst::ICMP_NE);
2219     VRP.solve();
2220   }
2221
2222   void PredicateSimplifier::Forwards::visitLoadInst(LoadInst &LI) {
2223     Value *Ptr = LI.getPointerOperand();
2224     // avoid "load uint* null" -> null NE null.
2225     if (isa<Constant>(Ptr)) return;
2226
2227     VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &LI);
2228     VRP.add(Constant::getNullValue(Ptr->getType()), Ptr, ICmpInst::ICMP_NE);
2229     VRP.solve();
2230   }
2231
2232   void PredicateSimplifier::Forwards::visitStoreInst(StoreInst &SI) {
2233     Value *Ptr = SI.getPointerOperand();
2234     if (isa<Constant>(Ptr)) return;
2235
2236     VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &SI);
2237     VRP.add(Constant::getNullValue(Ptr->getType()), Ptr, ICmpInst::ICMP_NE);
2238     VRP.solve();
2239   }
2240
2241   void PredicateSimplifier::Forwards::visitSExtInst(SExtInst &SI) {
2242     VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &SI);
2243     uint32_t SrcBitWidth = cast<IntegerType>(SI.getSrcTy())->getBitWidth();
2244     uint32_t DstBitWidth = cast<IntegerType>(SI.getDestTy())->getBitWidth();
2245     APInt Min(APInt::getHighBitsSet(DstBitWidth, DstBitWidth-SrcBitWidth+1));
2246     APInt Max(APInt::getLowBitsSet(DstBitWidth, SrcBitWidth-1));
2247     VRP.add(ConstantInt::get(Min), &SI, ICmpInst::ICMP_SLE);
2248     VRP.add(ConstantInt::get(Max), &SI, ICmpInst::ICMP_SGE);
2249     VRP.solve();
2250   }
2251
2252   void PredicateSimplifier::Forwards::visitZExtInst(ZExtInst &ZI) {
2253     VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &ZI);
2254     uint32_t SrcBitWidth = cast<IntegerType>(ZI.getSrcTy())->getBitWidth();
2255     uint32_t DstBitWidth = cast<IntegerType>(ZI.getDestTy())->getBitWidth();
2256     APInt Max(APInt::getLowBitsSet(DstBitWidth, SrcBitWidth));
2257     VRP.add(ConstantInt::get(Max), &ZI, ICmpInst::ICMP_UGE);
2258     VRP.solve();
2259   }
2260
2261   void PredicateSimplifier::Forwards::visitBinaryOperator(BinaryOperator &BO) {
2262     Instruction::BinaryOps ops = BO.getOpcode();
2263
2264     switch (ops) {
2265     default: break;
2266       case Instruction::URem:
2267       case Instruction::SRem:
2268       case Instruction::UDiv:
2269       case Instruction::SDiv: {
2270         Value *Divisor = BO.getOperand(1);
2271         VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &BO);
2272         VRP.add(Constant::getNullValue(Divisor->getType()), Divisor,
2273                 ICmpInst::ICMP_NE);
2274         VRP.solve();
2275         break;
2276       }
2277     }
2278
2279     switch (ops) {
2280       default: break;
2281       case Instruction::Shl: {
2282         VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &BO);
2283         VRP.add(&BO, BO.getOperand(0), ICmpInst::ICMP_UGE);
2284         VRP.solve();
2285       } break;
2286       case Instruction::AShr: {
2287         VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &BO);
2288         VRP.add(&BO, BO.getOperand(0), ICmpInst::ICMP_SLE);
2289         VRP.solve();
2290       } break;
2291       case Instruction::LShr:
2292       case Instruction::UDiv: {
2293         VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &BO);
2294         VRP.add(&BO, BO.getOperand(0), ICmpInst::ICMP_ULE);
2295         VRP.solve();
2296       } break;
2297       case Instruction::URem: {
2298         VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &BO);
2299         VRP.add(&BO, BO.getOperand(1), ICmpInst::ICMP_ULE);
2300         VRP.solve();
2301       } break;
2302       case Instruction::And: {
2303         VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &BO);
2304         VRP.add(&BO, BO.getOperand(0), ICmpInst::ICMP_ULE);
2305         VRP.add(&BO, BO.getOperand(1), ICmpInst::ICMP_ULE);
2306         VRP.solve();
2307       } break;
2308       case Instruction::Or: {
2309         VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &BO);
2310         VRP.add(&BO, BO.getOperand(0), ICmpInst::ICMP_UGE);
2311         VRP.add(&BO, BO.getOperand(1), ICmpInst::ICMP_UGE);
2312         VRP.solve();
2313       } break;
2314     }
2315   }
2316
2317   void PredicateSimplifier::Forwards::visitICmpInst(ICmpInst &IC) {
2318     // If possible, squeeze the ICmp predicate into something simpler.
2319     // Eg., if x = [0, 4) and we're being asked icmp uge %x, 3 then change
2320     // the predicate to eq.
2321
2322     // XXX: once we do full PHI handling, modifying the instruction in the
2323     // Forwards visitor will cause missed optimizations.
2324
2325     ICmpInst::Predicate Pred = IC.getPredicate();
2326
2327     switch (Pred) {
2328       default: break;
2329       case ICmpInst::ICMP_ULE: Pred = ICmpInst::ICMP_ULT; break;
2330       case ICmpInst::ICMP_UGE: Pred = ICmpInst::ICMP_UGT; break;
2331       case ICmpInst::ICMP_SLE: Pred = ICmpInst::ICMP_SLT; break;
2332       case ICmpInst::ICMP_SGE: Pred = ICmpInst::ICMP_SGT; break;
2333     }
2334     if (Pred != IC.getPredicate()) {
2335       VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &IC);
2336       if (VRP.isRelatedBy(IC.getOperand(1), IC.getOperand(0),
2337                           ICmpInst::ICMP_NE)) {
2338         ++NumSnuggle;
2339         PS->modified = true;
2340         IC.setPredicate(Pred);
2341       }
2342     }
2343
2344     Pred = IC.getPredicate();
2345
2346     if (ConstantInt *Op1 = dyn_cast<ConstantInt>(IC.getOperand(1))) {
2347       ConstantInt *NextVal = 0;
2348       switch (Pred) {
2349         default: break;
2350         case ICmpInst::ICMP_SLT:
2351         case ICmpInst::ICMP_ULT:
2352           if (Op1->getValue() != 0)
2353             NextVal = ConstantInt::get(Op1->getValue()-1);
2354          break;
2355         case ICmpInst::ICMP_SGT:
2356         case ICmpInst::ICMP_UGT:
2357           if (!Op1->getValue().isAllOnesValue())
2358             NextVal = ConstantInt::get(Op1->getValue()+1);
2359          break;
2360
2361       }
2362       if (NextVal) {
2363         VRPSolver VRP(IG, UB, VR, PS->Forest, PS->modified, &IC);
2364         if (VRP.isRelatedBy(IC.getOperand(0), NextVal,
2365                             ICmpInst::getInversePredicate(Pred))) {
2366           ICmpInst *NewIC = new ICmpInst(ICmpInst::ICMP_EQ, IC.getOperand(0),
2367                                          NextVal, "", &IC);
2368           NewIC->takeName(&IC);
2369           IC.replaceAllUsesWith(NewIC);
2370           IG.remove(&IC); // XXX: prove this isn't necessary
2371           IC.eraseFromParent();
2372           ++NumSnuggle;
2373           PS->modified = true;
2374         }
2375       }
2376     }
2377   }
2378
2379   RegisterPass<PredicateSimplifier> X("predsimplify",
2380                                       "Predicate Simplifier");
2381 }
2382
2383 FunctionPass *llvm::createPredicateSimplifierPass() {
2384   return new PredicateSimplifier();
2385 }