Remove a bunch more now-unnecessary Context arguments.
[oota-llvm.git] / lib / Transforms / Scalar / GVNPRE.cpp
1 //===- GVNPRE.cpp - Eliminate redundant values and expressions ------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This pass performs a hybrid of global value numbering and partial redundancy
11 // elimination, known as GVN-PRE.  It performs partial redundancy elimination on
12 // values, rather than lexical expressions, allowing a more comprehensive view 
13 // the optimization.  It replaces redundant values with uses of earlier 
14 // occurences of the same value.  While this is beneficial in that it eliminates
15 // unneeded computation, it also increases register pressure by creating large
16 // live ranges, and should be used with caution on platforms that are very 
17 // sensitive to register pressure.
18 //
19 // Note that this pass does the value numbering itself, it does not use the
20 // ValueNumbering analysis passes.
21 //
22 //===----------------------------------------------------------------------===//
23
24 #define DEBUG_TYPE "gvnpre"
25 #include "llvm/Value.h"
26 #include "llvm/Transforms/Scalar.h"
27 #include "llvm/Instructions.h"
28 #include "llvm/Function.h"
29 #include "llvm/DerivedTypes.h"
30 #include "llvm/Analysis/Dominators.h"
31 #include "llvm/ADT/BitVector.h"
32 #include "llvm/ADT/DenseMap.h"
33 #include "llvm/ADT/DepthFirstIterator.h"
34 #include "llvm/ADT/PostOrderIterator.h"
35 #include "llvm/ADT/SmallPtrSet.h"
36 #include "llvm/ADT/SmallVector.h"
37 #include "llvm/ADT/Statistic.h"
38 #include "llvm/Transforms/Utils/UnifyFunctionExitNodes.h"
39 #include "llvm/Support/CFG.h"
40 #include "llvm/Support/Compiler.h"
41 #include "llvm/Support/Debug.h"
42 #include "llvm/Support/ErrorHandling.h"
43 #include <algorithm>
44 #include <deque>
45 #include <map>
46 using namespace llvm;
47
48 //===----------------------------------------------------------------------===//
49 //                         ValueTable Class
50 //===----------------------------------------------------------------------===//
51
52 namespace {
53
54 /// This class holds the mapping between values and value numbers.  It is used
55 /// as an efficient mechanism to determine the expression-wise equivalence of
56 /// two values.
57
58 struct Expression {
59   enum ExpressionOpcode { ADD, FADD, SUB, FSUB, MUL, FMUL,
60                           UDIV, SDIV, FDIV, UREM, SREM,
61                           FREM, SHL, LSHR, ASHR, AND, OR, XOR, ICMPEQ, 
62                           ICMPNE, ICMPUGT, ICMPUGE, ICMPULT, ICMPULE, 
63                           ICMPSGT, ICMPSGE, ICMPSLT, ICMPSLE, FCMPOEQ, 
64                           FCMPOGT, FCMPOGE, FCMPOLT, FCMPOLE, FCMPONE, 
65                           FCMPORD, FCMPUNO, FCMPUEQ, FCMPUGT, FCMPUGE, 
66                           FCMPULT, FCMPULE, FCMPUNE, EXTRACT, INSERT,
67                           SHUFFLE, SELECT, TRUNC, ZEXT, SEXT, FPTOUI,
68                           FPTOSI, UITOFP, SITOFP, FPTRUNC, FPEXT, 
69                           PTRTOINT, INTTOPTR, BITCAST, GEP, EMPTY,
70                           TOMBSTONE };
71
72   ExpressionOpcode opcode;
73   const Type* type;
74   uint32_t firstVN;
75   uint32_t secondVN;
76   uint32_t thirdVN;
77   SmallVector<uint32_t, 4> varargs;
78   
79   Expression() { }
80   explicit Expression(ExpressionOpcode o) : opcode(o) { }
81   
82   bool operator==(const Expression &other) const {
83     if (opcode != other.opcode)
84       return false;
85     else if (opcode == EMPTY || opcode == TOMBSTONE)
86       return true;
87     else if (type != other.type)
88       return false;
89     else if (firstVN != other.firstVN)
90       return false;
91     else if (secondVN != other.secondVN)
92       return false;
93     else if (thirdVN != other.thirdVN)
94       return false;
95     else {
96       if (varargs.size() != other.varargs.size())
97         return false;
98       
99       for (size_t i = 0; i < varargs.size(); ++i)
100         if (varargs[i] != other.varargs[i])
101           return false;
102     
103       return true;
104     }
105   }
106   
107   bool operator!=(const Expression &other) const {
108     if (opcode != other.opcode)
109       return true;
110     else if (opcode == EMPTY || opcode == TOMBSTONE)
111       return false;
112     else if (type != other.type)
113       return true;
114     else if (firstVN != other.firstVN)
115       return true;
116     else if (secondVN != other.secondVN)
117       return true;
118     else if (thirdVN != other.thirdVN)
119       return true;
120     else {
121       if (varargs.size() != other.varargs.size())
122         return true;
123       
124       for (size_t i = 0; i < varargs.size(); ++i)
125         if (varargs[i] != other.varargs[i])
126           return true;
127     
128       return false;
129     }
130   }
131 };
132
133 }
134
135 namespace {
136   class VISIBILITY_HIDDEN ValueTable {
137     private:
138       DenseMap<Value*, uint32_t> valueNumbering;
139       DenseMap<Expression, uint32_t> expressionNumbering;
140   
141       uint32_t nextValueNumber;
142     
143       Expression::ExpressionOpcode getOpcode(BinaryOperator* BO);
144       Expression::ExpressionOpcode getOpcode(CmpInst* C);
145       Expression::ExpressionOpcode getOpcode(CastInst* C);
146       Expression create_expression(BinaryOperator* BO);
147       Expression create_expression(CmpInst* C);
148       Expression create_expression(ShuffleVectorInst* V);
149       Expression create_expression(ExtractElementInst* C);
150       Expression create_expression(InsertElementInst* V);
151       Expression create_expression(SelectInst* V);
152       Expression create_expression(CastInst* C);
153       Expression create_expression(GetElementPtrInst* G);
154     public:
155       ValueTable() { nextValueNumber = 1; }
156       uint32_t lookup_or_add(Value* V);
157       uint32_t lookup(Value* V) const;
158       void add(Value* V, uint32_t num);
159       void clear();
160       void erase(Value* v);
161       unsigned size();
162   };
163 }
164
165 namespace llvm {
166 template <> struct DenseMapInfo<Expression> {
167   static inline Expression getEmptyKey() {
168     return Expression(Expression::EMPTY);
169   }
170   
171   static inline Expression getTombstoneKey() {
172     return Expression(Expression::TOMBSTONE);
173   }
174   
175   static unsigned getHashValue(const Expression e) {
176     unsigned hash = e.opcode;
177     
178     hash = e.firstVN + hash * 37;
179     hash = e.secondVN + hash * 37;
180     hash = e.thirdVN + hash * 37;
181     
182     hash = ((unsigned)((uintptr_t)e.type >> 4) ^
183             (unsigned)((uintptr_t)e.type >> 9)) +
184            hash * 37;
185     
186     for (SmallVector<uint32_t, 4>::const_iterator I = e.varargs.begin(),
187          E = e.varargs.end(); I != E; ++I)
188       hash = *I + hash * 37;
189     
190     return hash;
191   }
192   static bool isEqual(const Expression &LHS, const Expression &RHS) {
193     return LHS == RHS;
194   }
195   static bool isPod() { return true; }
196 };
197 }
198
199 //===----------------------------------------------------------------------===//
200 //                     ValueTable Internal Functions
201 //===----------------------------------------------------------------------===//
202 Expression::ExpressionOpcode 
203                              ValueTable::getOpcode(BinaryOperator* BO) {
204   switch(BO->getOpcode()) {
205     case Instruction::Add:
206       return Expression::ADD;
207     case Instruction::FAdd:
208       return Expression::FADD;
209     case Instruction::Sub:
210       return Expression::SUB;
211     case Instruction::FSub:
212       return Expression::FSUB;
213     case Instruction::Mul:
214       return Expression::MUL;
215     case Instruction::FMul:
216       return Expression::FMUL;
217     case Instruction::UDiv:
218       return Expression::UDIV;
219     case Instruction::SDiv:
220       return Expression::SDIV;
221     case Instruction::FDiv:
222       return Expression::FDIV;
223     case Instruction::URem:
224       return Expression::UREM;
225     case Instruction::SRem:
226       return Expression::SREM;
227     case Instruction::FRem:
228       return Expression::FREM;
229     case Instruction::Shl:
230       return Expression::SHL;
231     case Instruction::LShr:
232       return Expression::LSHR;
233     case Instruction::AShr:
234       return Expression::ASHR;
235     case Instruction::And:
236       return Expression::AND;
237     case Instruction::Or:
238       return Expression::OR;
239     case Instruction::Xor:
240       return Expression::XOR;
241     
242     // THIS SHOULD NEVER HAPPEN
243     default:
244       llvm_unreachable("Binary operator with unknown opcode?");
245       return Expression::ADD;
246   }
247 }
248
249 Expression::ExpressionOpcode ValueTable::getOpcode(CmpInst* C) {
250   if (C->getOpcode() == Instruction::ICmp) {
251     switch (C->getPredicate()) {
252       case ICmpInst::ICMP_EQ:
253         return Expression::ICMPEQ;
254       case ICmpInst::ICMP_NE:
255         return Expression::ICMPNE;
256       case ICmpInst::ICMP_UGT:
257         return Expression::ICMPUGT;
258       case ICmpInst::ICMP_UGE:
259         return Expression::ICMPUGE;
260       case ICmpInst::ICMP_ULT:
261         return Expression::ICMPULT;
262       case ICmpInst::ICMP_ULE:
263         return Expression::ICMPULE;
264       case ICmpInst::ICMP_SGT:
265         return Expression::ICMPSGT;
266       case ICmpInst::ICMP_SGE:
267         return Expression::ICMPSGE;
268       case ICmpInst::ICMP_SLT:
269         return Expression::ICMPSLT;
270       case ICmpInst::ICMP_SLE:
271         return Expression::ICMPSLE;
272       
273       // THIS SHOULD NEVER HAPPEN
274       default:
275         llvm_unreachable("Comparison with unknown predicate?");
276         return Expression::ICMPEQ;
277     }
278   } else {
279     switch (C->getPredicate()) {
280       case FCmpInst::FCMP_OEQ:
281         return Expression::FCMPOEQ;
282       case FCmpInst::FCMP_OGT:
283         return Expression::FCMPOGT;
284       case FCmpInst::FCMP_OGE:
285         return Expression::FCMPOGE;
286       case FCmpInst::FCMP_OLT:
287         return Expression::FCMPOLT;
288       case FCmpInst::FCMP_OLE:
289         return Expression::FCMPOLE;
290       case FCmpInst::FCMP_ONE:
291         return Expression::FCMPONE;
292       case FCmpInst::FCMP_ORD:
293         return Expression::FCMPORD;
294       case FCmpInst::FCMP_UNO:
295         return Expression::FCMPUNO;
296       case FCmpInst::FCMP_UEQ:
297         return Expression::FCMPUEQ;
298       case FCmpInst::FCMP_UGT:
299         return Expression::FCMPUGT;
300       case FCmpInst::FCMP_UGE:
301         return Expression::FCMPUGE;
302       case FCmpInst::FCMP_ULT:
303         return Expression::FCMPULT;
304       case FCmpInst::FCMP_ULE:
305         return Expression::FCMPULE;
306       case FCmpInst::FCMP_UNE:
307         return Expression::FCMPUNE;
308       
309       // THIS SHOULD NEVER HAPPEN
310       default:
311         llvm_unreachable("Comparison with unknown predicate?");
312         return Expression::FCMPOEQ;
313     }
314   }
315 }
316
317 Expression::ExpressionOpcode 
318                              ValueTable::getOpcode(CastInst* C) {
319   switch(C->getOpcode()) {
320     case Instruction::Trunc:
321       return Expression::TRUNC;
322     case Instruction::ZExt:
323       return Expression::ZEXT;
324     case Instruction::SExt:
325       return Expression::SEXT;
326     case Instruction::FPToUI:
327       return Expression::FPTOUI;
328     case Instruction::FPToSI:
329       return Expression::FPTOSI;
330     case Instruction::UIToFP:
331       return Expression::UITOFP;
332     case Instruction::SIToFP:
333       return Expression::SITOFP;
334     case Instruction::FPTrunc:
335       return Expression::FPTRUNC;
336     case Instruction::FPExt:
337       return Expression::FPEXT;
338     case Instruction::PtrToInt:
339       return Expression::PTRTOINT;
340     case Instruction::IntToPtr:
341       return Expression::INTTOPTR;
342     case Instruction::BitCast:
343       return Expression::BITCAST;
344     
345     // THIS SHOULD NEVER HAPPEN
346     default:
347       llvm_unreachable("Cast operator with unknown opcode?");
348       return Expression::BITCAST;
349   }
350 }
351
352 Expression ValueTable::create_expression(BinaryOperator* BO) {
353   Expression e;
354     
355   e.firstVN = lookup_or_add(BO->getOperand(0));
356   e.secondVN = lookup_or_add(BO->getOperand(1));
357   e.thirdVN = 0;
358   e.type = BO->getType();
359   e.opcode = getOpcode(BO);
360   
361   return e;
362 }
363
364 Expression ValueTable::create_expression(CmpInst* C) {
365   Expression e;
366     
367   e.firstVN = lookup_or_add(C->getOperand(0));
368   e.secondVN = lookup_or_add(C->getOperand(1));
369   e.thirdVN = 0;
370   e.type = C->getType();
371   e.opcode = getOpcode(C);
372   
373   return e;
374 }
375
376 Expression ValueTable::create_expression(CastInst* C) {
377   Expression e;
378     
379   e.firstVN = lookup_or_add(C->getOperand(0));
380   e.secondVN = 0;
381   e.thirdVN = 0;
382   e.type = C->getType();
383   e.opcode = getOpcode(C);
384   
385   return e;
386 }
387
388 Expression ValueTable::create_expression(ShuffleVectorInst* S) {
389   Expression e;
390     
391   e.firstVN = lookup_or_add(S->getOperand(0));
392   e.secondVN = lookup_or_add(S->getOperand(1));
393   e.thirdVN = lookup_or_add(S->getOperand(2));
394   e.type = S->getType();
395   e.opcode = Expression::SHUFFLE;
396   
397   return e;
398 }
399
400 Expression ValueTable::create_expression(ExtractElementInst* E) {
401   Expression e;
402     
403   e.firstVN = lookup_or_add(E->getOperand(0));
404   e.secondVN = lookup_or_add(E->getOperand(1));
405   e.thirdVN = 0;
406   e.type = E->getType();
407   e.opcode = Expression::EXTRACT;
408   
409   return e;
410 }
411
412 Expression ValueTable::create_expression(InsertElementInst* I) {
413   Expression e;
414     
415   e.firstVN = lookup_or_add(I->getOperand(0));
416   e.secondVN = lookup_or_add(I->getOperand(1));
417   e.thirdVN = lookup_or_add(I->getOperand(2));
418   e.type = I->getType();
419   e.opcode = Expression::INSERT;
420   
421   return e;
422 }
423
424 Expression ValueTable::create_expression(SelectInst* I) {
425   Expression e;
426     
427   e.firstVN = lookup_or_add(I->getCondition());
428   e.secondVN = lookup_or_add(I->getTrueValue());
429   e.thirdVN = lookup_or_add(I->getFalseValue());
430   e.type = I->getType();
431   e.opcode = Expression::SELECT;
432   
433   return e;
434 }
435
436 Expression ValueTable::create_expression(GetElementPtrInst* G) {
437   Expression e;
438     
439   e.firstVN = lookup_or_add(G->getPointerOperand());
440   e.secondVN = 0;
441   e.thirdVN = 0;
442   e.type = G->getType();
443   e.opcode = Expression::GEP;
444   
445   for (GetElementPtrInst::op_iterator I = G->idx_begin(), E = G->idx_end();
446        I != E; ++I)
447     e.varargs.push_back(lookup_or_add(*I));
448   
449   return e;
450 }
451
452 //===----------------------------------------------------------------------===//
453 //                     ValueTable External Functions
454 //===----------------------------------------------------------------------===//
455
456 /// lookup_or_add - Returns the value number for the specified value, assigning
457 /// it a new number if it did not have one before.
458 uint32_t ValueTable::lookup_or_add(Value* V) {
459   DenseMap<Value*, uint32_t>::iterator VI = valueNumbering.find(V);
460   if (VI != valueNumbering.end())
461     return VI->second;
462   
463   
464   if (BinaryOperator* BO = dyn_cast<BinaryOperator>(V)) {
465     Expression e = create_expression(BO);
466     
467     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
468     if (EI != expressionNumbering.end()) {
469       valueNumbering.insert(std::make_pair(V, EI->second));
470       return EI->second;
471     } else {
472       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
473       valueNumbering.insert(std::make_pair(V, nextValueNumber));
474       
475       return nextValueNumber++;
476     }
477   } else if (CmpInst* C = dyn_cast<CmpInst>(V)) {
478     Expression e = create_expression(C);
479     
480     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
481     if (EI != expressionNumbering.end()) {
482       valueNumbering.insert(std::make_pair(V, EI->second));
483       return EI->second;
484     } else {
485       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
486       valueNumbering.insert(std::make_pair(V, nextValueNumber));
487       
488       return nextValueNumber++;
489     }
490   } else if (ShuffleVectorInst* U = dyn_cast<ShuffleVectorInst>(V)) {
491     Expression e = create_expression(U);
492     
493     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
494     if (EI != expressionNumbering.end()) {
495       valueNumbering.insert(std::make_pair(V, EI->second));
496       return EI->second;
497     } else {
498       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
499       valueNumbering.insert(std::make_pair(V, nextValueNumber));
500       
501       return nextValueNumber++;
502     }
503   } else if (ExtractElementInst* U = dyn_cast<ExtractElementInst>(V)) {
504     Expression e = create_expression(U);
505     
506     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
507     if (EI != expressionNumbering.end()) {
508       valueNumbering.insert(std::make_pair(V, EI->second));
509       return EI->second;
510     } else {
511       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
512       valueNumbering.insert(std::make_pair(V, nextValueNumber));
513       
514       return nextValueNumber++;
515     }
516   } else if (InsertElementInst* U = dyn_cast<InsertElementInst>(V)) {
517     Expression e = create_expression(U);
518     
519     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
520     if (EI != expressionNumbering.end()) {
521       valueNumbering.insert(std::make_pair(V, EI->second));
522       return EI->second;
523     } else {
524       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
525       valueNumbering.insert(std::make_pair(V, nextValueNumber));
526       
527       return nextValueNumber++;
528     }
529   } else if (SelectInst* U = dyn_cast<SelectInst>(V)) {
530     Expression e = create_expression(U);
531     
532     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
533     if (EI != expressionNumbering.end()) {
534       valueNumbering.insert(std::make_pair(V, EI->second));
535       return EI->second;
536     } else {
537       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
538       valueNumbering.insert(std::make_pair(V, nextValueNumber));
539       
540       return nextValueNumber++;
541     }
542   } else if (CastInst* U = dyn_cast<CastInst>(V)) {
543     Expression e = create_expression(U);
544     
545     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
546     if (EI != expressionNumbering.end()) {
547       valueNumbering.insert(std::make_pair(V, EI->second));
548       return EI->second;
549     } else {
550       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
551       valueNumbering.insert(std::make_pair(V, nextValueNumber));
552       
553       return nextValueNumber++;
554     }
555   } else if (GetElementPtrInst* U = dyn_cast<GetElementPtrInst>(V)) {
556     Expression e = create_expression(U);
557     
558     DenseMap<Expression, uint32_t>::iterator EI = expressionNumbering.find(e);
559     if (EI != expressionNumbering.end()) {
560       valueNumbering.insert(std::make_pair(V, EI->second));
561       return EI->second;
562     } else {
563       expressionNumbering.insert(std::make_pair(e, nextValueNumber));
564       valueNumbering.insert(std::make_pair(V, nextValueNumber));
565       
566       return nextValueNumber++;
567     }
568   } else {
569     valueNumbering.insert(std::make_pair(V, nextValueNumber));
570     return nextValueNumber++;
571   }
572 }
573
574 /// lookup - Returns the value number of the specified value. Fails if
575 /// the value has not yet been numbered.
576 uint32_t ValueTable::lookup(Value* V) const {
577   DenseMap<Value*, uint32_t>::iterator VI = valueNumbering.find(V);
578   if (VI != valueNumbering.end())
579     return VI->second;
580   else
581     llvm_unreachable("Value not numbered?");
582   
583   return 0;
584 }
585
586 /// add - Add the specified value with the given value number, removing
587 /// its old number, if any
588 void ValueTable::add(Value* V, uint32_t num) {
589   DenseMap<Value*, uint32_t>::iterator VI = valueNumbering.find(V);
590   if (VI != valueNumbering.end())
591     valueNumbering.erase(VI);
592   valueNumbering.insert(std::make_pair(V, num));
593 }
594
595 /// clear - Remove all entries from the ValueTable
596 void ValueTable::clear() {
597   valueNumbering.clear();
598   expressionNumbering.clear();
599   nextValueNumber = 1;
600 }
601
602 /// erase - Remove a value from the value numbering
603 void ValueTable::erase(Value* V) {
604   valueNumbering.erase(V);
605 }
606
607 /// size - Return the number of assigned value numbers
608 unsigned ValueTable::size() {
609   // NOTE: zero is never assigned
610   return nextValueNumber;
611 }
612
613 namespace {
614
615 //===----------------------------------------------------------------------===//
616 //                       ValueNumberedSet Class
617 //===----------------------------------------------------------------------===//
618
619 class ValueNumberedSet {
620   private:
621     SmallPtrSet<Value*, 8> contents;
622     BitVector numbers;
623   public:
624     ValueNumberedSet() { numbers.resize(1); }
625     ValueNumberedSet(const ValueNumberedSet& other) {
626       numbers = other.numbers;
627       contents = other.contents;
628     }
629     
630     typedef SmallPtrSet<Value*, 8>::iterator iterator;
631     
632     iterator begin() { return contents.begin(); }
633     iterator end() { return contents.end(); }
634     
635     bool insert(Value* v) { return contents.insert(v); }
636     void insert(iterator I, iterator E) { contents.insert(I, E); }
637     void erase(Value* v) { contents.erase(v); }
638     unsigned count(Value* v) { return contents.count(v); }
639     size_t size() { return contents.size(); }
640     
641     void set(unsigned i)  {
642       if (i >= numbers.size())
643         numbers.resize(i+1);
644       
645       numbers.set(i);
646     }
647     
648     void operator=(const ValueNumberedSet& other) {
649       contents = other.contents;
650       numbers = other.numbers;
651     }
652     
653     void reset(unsigned i)  {
654       if (i < numbers.size())
655         numbers.reset(i);
656     }
657     
658     bool test(unsigned i)  {
659       if (i >= numbers.size())
660         return false;
661       
662       return numbers.test(i);
663     }
664     
665     void clear() {
666       contents.clear();
667       numbers.clear();
668     }
669 };
670
671 }
672
673 //===----------------------------------------------------------------------===//
674 //                         GVNPRE Pass
675 //===----------------------------------------------------------------------===//
676
677 namespace {
678
679   class VISIBILITY_HIDDEN GVNPRE : public FunctionPass {
680     bool runOnFunction(Function &F);
681   public:
682     static char ID; // Pass identification, replacement for typeid
683     GVNPRE() : FunctionPass(&ID) {}
684
685   private:
686     ValueTable VN;
687     SmallVector<Instruction*, 8> createdExpressions;
688     
689     DenseMap<BasicBlock*, ValueNumberedSet> availableOut;
690     DenseMap<BasicBlock*, ValueNumberedSet> anticipatedIn;
691     DenseMap<BasicBlock*, ValueNumberedSet> generatedPhis;
692     
693     // This transformation requires dominator postdominator info
694     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
695       AU.setPreservesCFG();
696       AU.addRequiredID(BreakCriticalEdgesID);
697       AU.addRequired<UnifyFunctionExitNodes>();
698       AU.addRequired<DominatorTree>();
699     }
700   
701     // Helper fuctions
702     // FIXME: eliminate or document these better
703     void dump(ValueNumberedSet& s) const ;
704     void clean(ValueNumberedSet& set) ;
705     Value* find_leader(ValueNumberedSet& vals, uint32_t v) ;
706     Value* phi_translate(Value* V, BasicBlock* pred, BasicBlock* succ) ;
707     void phi_translate_set(ValueNumberedSet& anticIn, BasicBlock* pred,
708                            BasicBlock* succ, ValueNumberedSet& out) ;
709     
710     void topo_sort(ValueNumberedSet& set,
711                    SmallVector<Value*, 8>& vec) ;
712     
713     void cleanup() ;
714     bool elimination() ;
715     
716     void val_insert(ValueNumberedSet& s, Value* v) ;
717     void val_replace(ValueNumberedSet& s, Value* v) ;
718     bool dependsOnInvoke(Value* V) ;
719     void buildsets_availout(BasicBlock::iterator I,
720                             ValueNumberedSet& currAvail,
721                             ValueNumberedSet& currPhis,
722                             ValueNumberedSet& currExps,
723                             SmallPtrSet<Value*, 16>& currTemps);
724     bool buildsets_anticout(BasicBlock* BB,
725                             ValueNumberedSet& anticOut,
726                             SmallPtrSet<BasicBlock*, 8>& visited);
727     unsigned buildsets_anticin(BasicBlock* BB,
728                            ValueNumberedSet& anticOut,
729                            ValueNumberedSet& currExps,
730                            SmallPtrSet<Value*, 16>& currTemps,
731                            SmallPtrSet<BasicBlock*, 8>& visited);
732     void buildsets(Function& F) ;
733     
734     void insertion_pre(Value* e, BasicBlock* BB,
735                        DenseMap<BasicBlock*, Value*>& avail,
736                        std::map<BasicBlock*,ValueNumberedSet>& new_set);
737     unsigned insertion_mergepoint(SmallVector<Value*, 8>& workList,
738                                   df_iterator<DomTreeNode*>& D,
739                       std::map<BasicBlock*, ValueNumberedSet>& new_set);
740     bool insertion(Function& F) ;
741   
742   };
743   
744   char GVNPRE::ID = 0;
745   
746 }
747
748 // createGVNPREPass - The public interface to this file...
749 FunctionPass *llvm::createGVNPREPass() { return new GVNPRE(); }
750
751 static RegisterPass<GVNPRE> X("gvnpre",
752                       "Global Value Numbering/Partial Redundancy Elimination");
753
754
755 STATISTIC(NumInsertedVals, "Number of values inserted");
756 STATISTIC(NumInsertedPhis, "Number of PHI nodes inserted");
757 STATISTIC(NumEliminated, "Number of redundant instructions eliminated");
758
759 /// find_leader - Given a set and a value number, return the first
760 /// element of the set with that value number, or 0 if no such element
761 /// is present
762 Value* GVNPRE::find_leader(ValueNumberedSet& vals, uint32_t v) {
763   if (!vals.test(v))
764     return 0;
765   
766   for (ValueNumberedSet::iterator I = vals.begin(), E = vals.end();
767        I != E; ++I)
768     if (v == VN.lookup(*I))
769       return *I;
770   
771   llvm_unreachable("No leader found, but present bit is set?");
772   return 0;
773 }
774
775 /// val_insert - Insert a value into a set only if there is not a value
776 /// with the same value number already in the set
777 void GVNPRE::val_insert(ValueNumberedSet& s, Value* v) {
778   uint32_t num = VN.lookup(v);
779   if (!s.test(num))
780     s.insert(v);
781 }
782
783 /// val_replace - Insert a value into a set, replacing any values already in
784 /// the set that have the same value number
785 void GVNPRE::val_replace(ValueNumberedSet& s, Value* v) {
786   if (s.count(v)) return;
787   
788   uint32_t num = VN.lookup(v);
789   Value* leader = find_leader(s, num);
790   if (leader != 0)
791     s.erase(leader);
792   s.insert(v);
793   s.set(num);
794 }
795
796 /// phi_translate - Given a value, its parent block, and a predecessor of its
797 /// parent, translate the value into legal for the predecessor block.  This 
798 /// means translating its operands (and recursively, their operands) through
799 /// any phi nodes in the parent into values available in the predecessor
800 Value* GVNPRE::phi_translate(Value* V, BasicBlock* pred, BasicBlock* succ) {
801   if (V == 0)
802     return 0;
803     
804   LLVMContext &Context = V->getContext();
805   
806   // Unary Operations
807   if (CastInst* U = dyn_cast<CastInst>(V)) {
808     Value* newOp1 = 0;
809     if (isa<Instruction>(U->getOperand(0)))
810       newOp1 = phi_translate(U->getOperand(0), pred, succ);
811     else
812       newOp1 = U->getOperand(0);
813     
814     if (newOp1 == 0)
815       return 0;
816     
817     if (newOp1 != U->getOperand(0)) {
818       Instruction* newVal = 0;
819       if (CastInst* C = dyn_cast<CastInst>(U))
820         newVal = CastInst::Create(C->getOpcode(),
821                                   newOp1, C->getType(),
822                                   C->getName()+".expr");
823       
824       uint32_t v = VN.lookup_or_add(newVal);
825       
826       Value* leader = find_leader(availableOut[pred], v);
827       if (leader == 0) {
828         createdExpressions.push_back(newVal);
829         return newVal;
830       } else {
831         VN.erase(newVal);
832         delete newVal;
833         return leader;
834       }
835     }
836   
837   // Binary Operations
838   } if (isa<BinaryOperator>(V) || isa<CmpInst>(V) || 
839       isa<ExtractElementInst>(V)) {
840     User* U = cast<User>(V);
841     
842     Value* newOp1 = 0;
843     if (isa<Instruction>(U->getOperand(0)))
844       newOp1 = phi_translate(U->getOperand(0), pred, succ);
845     else
846       newOp1 = U->getOperand(0);
847     
848     if (newOp1 == 0)
849       return 0;
850     
851     Value* newOp2 = 0;
852     if (isa<Instruction>(U->getOperand(1)))
853       newOp2 = phi_translate(U->getOperand(1), pred, succ);
854     else
855       newOp2 = U->getOperand(1);
856     
857     if (newOp2 == 0)
858       return 0;
859     
860     if (newOp1 != U->getOperand(0) || newOp2 != U->getOperand(1)) {
861       Instruction* newVal = 0;
862       if (BinaryOperator* BO = dyn_cast<BinaryOperator>(U))
863         newVal = BinaryOperator::Create(BO->getOpcode(),
864                                         newOp1, newOp2,
865                                         BO->getName()+".expr");
866       else if (CmpInst* C = dyn_cast<CmpInst>(U))
867         newVal = CmpInst::Create(Context, C->getOpcode(),
868                                  C->getPredicate(),
869                                  newOp1, newOp2,
870                                  C->getName()+".expr");
871       else if (ExtractElementInst* E = dyn_cast<ExtractElementInst>(U))
872         newVal = ExtractElementInst::Create(newOp1, newOp2, 
873                                             E->getName()+".expr");
874       
875       uint32_t v = VN.lookup_or_add(newVal);
876       
877       Value* leader = find_leader(availableOut[pred], v);
878       if (leader == 0) {
879         createdExpressions.push_back(newVal);
880         return newVal;
881       } else {
882         VN.erase(newVal);
883         delete newVal;
884         return leader;
885       }
886     }
887   
888   // Ternary Operations
889   } else if (isa<ShuffleVectorInst>(V) || isa<InsertElementInst>(V) ||
890              isa<SelectInst>(V)) {
891     User* U = cast<User>(V);
892     
893     Value* newOp1 = 0;
894     if (isa<Instruction>(U->getOperand(0)))
895       newOp1 = phi_translate(U->getOperand(0), pred, succ);
896     else
897       newOp1 = U->getOperand(0);
898     
899     if (newOp1 == 0)
900       return 0;
901     
902     Value* newOp2 = 0;
903     if (isa<Instruction>(U->getOperand(1)))
904       newOp2 = phi_translate(U->getOperand(1), pred, succ);
905     else
906       newOp2 = U->getOperand(1);
907     
908     if (newOp2 == 0)
909       return 0;
910     
911     Value* newOp3 = 0;
912     if (isa<Instruction>(U->getOperand(2)))
913       newOp3 = phi_translate(U->getOperand(2), pred, succ);
914     else
915       newOp3 = U->getOperand(2);
916     
917     if (newOp3 == 0)
918       return 0;
919     
920     if (newOp1 != U->getOperand(0) ||
921         newOp2 != U->getOperand(1) ||
922         newOp3 != U->getOperand(2)) {
923       Instruction* newVal = 0;
924       if (ShuffleVectorInst* S = dyn_cast<ShuffleVectorInst>(U))
925         newVal = new ShuffleVectorInst(newOp1, newOp2, newOp3,
926                                        S->getName() + ".expr");
927       else if (InsertElementInst* I = dyn_cast<InsertElementInst>(U))
928         newVal = InsertElementInst::Create(newOp1, newOp2, newOp3,
929                                            I->getName() + ".expr");
930       else if (SelectInst* I = dyn_cast<SelectInst>(U))
931         newVal = SelectInst::Create(newOp1, newOp2, newOp3,
932                                     I->getName() + ".expr");
933       
934       uint32_t v = VN.lookup_or_add(newVal);
935       
936       Value* leader = find_leader(availableOut[pred], v);
937       if (leader == 0) {
938         createdExpressions.push_back(newVal);
939         return newVal;
940       } else {
941         VN.erase(newVal);
942         delete newVal;
943         return leader;
944       }
945     }
946   
947   // Varargs operators
948   } else if (GetElementPtrInst* U = dyn_cast<GetElementPtrInst>(V)) {
949     Value* newOp1 = 0;
950     if (isa<Instruction>(U->getPointerOperand()))
951       newOp1 = phi_translate(U->getPointerOperand(), pred, succ);
952     else
953       newOp1 = U->getPointerOperand();
954     
955     if (newOp1 == 0)
956       return 0;
957     
958     bool changed_idx = false;
959     SmallVector<Value*, 4> newIdx;
960     for (GetElementPtrInst::op_iterator I = U->idx_begin(), E = U->idx_end();
961          I != E; ++I)
962       if (isa<Instruction>(*I)) {
963         Value* newVal = phi_translate(*I, pred, succ);
964         newIdx.push_back(newVal);
965         if (newVal != *I)
966           changed_idx = true;
967       } else {
968         newIdx.push_back(*I);
969       }
970     
971     if (newOp1 != U->getPointerOperand() || changed_idx) {
972       Instruction* newVal =
973           GetElementPtrInst::Create(newOp1,
974                                     newIdx.begin(), newIdx.end(),
975                                     U->getName()+".expr");
976       
977       uint32_t v = VN.lookup_or_add(newVal);
978       
979       Value* leader = find_leader(availableOut[pred], v);
980       if (leader == 0) {
981         createdExpressions.push_back(newVal);
982         return newVal;
983       } else {
984         VN.erase(newVal);
985         delete newVal;
986         return leader;
987       }
988     }
989   
990   // PHI Nodes
991   } else if (PHINode* P = dyn_cast<PHINode>(V)) {
992     if (P->getParent() == succ)
993       return P->getIncomingValueForBlock(pred);
994   }
995   
996   return V;
997 }
998
999 /// phi_translate_set - Perform phi translation on every element of a set
1000 void GVNPRE::phi_translate_set(ValueNumberedSet& anticIn,
1001                               BasicBlock* pred, BasicBlock* succ,
1002                               ValueNumberedSet& out) {
1003   for (ValueNumberedSet::iterator I = anticIn.begin(),
1004        E = anticIn.end(); I != E; ++I) {
1005     Value* V = phi_translate(*I, pred, succ);
1006     if (V != 0 && !out.test(VN.lookup_or_add(V))) {
1007       out.insert(V);
1008       out.set(VN.lookup(V));
1009     }
1010   }
1011 }
1012
1013 /// dependsOnInvoke - Test if a value has an phi node as an operand, any of 
1014 /// whose inputs is an invoke instruction.  If this is true, we cannot safely
1015 /// PRE the instruction or anything that depends on it.
1016 bool GVNPRE::dependsOnInvoke(Value* V) {
1017   if (PHINode* p = dyn_cast<PHINode>(V)) {
1018     for (PHINode::op_iterator I = p->op_begin(), E = p->op_end(); I != E; ++I)
1019       if (isa<InvokeInst>(*I))
1020         return true;
1021     return false;
1022   } else {
1023     return false;
1024   }
1025 }
1026
1027 /// clean - Remove all non-opaque values from the set whose operands are not
1028 /// themselves in the set, as well as all values that depend on invokes (see 
1029 /// above)
1030 void GVNPRE::clean(ValueNumberedSet& set) {
1031   SmallVector<Value*, 8> worklist;
1032   worklist.reserve(set.size());
1033   topo_sort(set, worklist);
1034   
1035   for (unsigned i = 0; i < worklist.size(); ++i) {
1036     Value* v = worklist[i];
1037     
1038     // Handle unary ops
1039     if (CastInst* U = dyn_cast<CastInst>(v)) {
1040       bool lhsValid = !isa<Instruction>(U->getOperand(0));
1041       lhsValid |= set.test(VN.lookup(U->getOperand(0)));
1042       if (lhsValid)
1043         lhsValid = !dependsOnInvoke(U->getOperand(0));
1044       
1045       if (!lhsValid) {
1046         set.erase(U);
1047         set.reset(VN.lookup(U));
1048       }
1049     
1050     // Handle binary ops
1051     } else if (isa<BinaryOperator>(v) || isa<CmpInst>(v) ||
1052         isa<ExtractElementInst>(v)) {
1053       User* U = cast<User>(v);
1054       
1055       bool lhsValid = !isa<Instruction>(U->getOperand(0));
1056       lhsValid |= set.test(VN.lookup(U->getOperand(0)));
1057       if (lhsValid)
1058         lhsValid = !dependsOnInvoke(U->getOperand(0));
1059     
1060       bool rhsValid = !isa<Instruction>(U->getOperand(1));
1061       rhsValid |= set.test(VN.lookup(U->getOperand(1)));
1062       if (rhsValid)
1063         rhsValid = !dependsOnInvoke(U->getOperand(1));
1064       
1065       if (!lhsValid || !rhsValid) {
1066         set.erase(U);
1067         set.reset(VN.lookup(U));
1068       }
1069     
1070     // Handle ternary ops
1071     } else if (isa<ShuffleVectorInst>(v) || isa<InsertElementInst>(v) ||
1072                isa<SelectInst>(v)) {
1073       User* U = cast<User>(v);
1074     
1075       bool lhsValid = !isa<Instruction>(U->getOperand(0));
1076       lhsValid |= set.test(VN.lookup(U->getOperand(0)));
1077       if (lhsValid)
1078         lhsValid = !dependsOnInvoke(U->getOperand(0));
1079       
1080       bool rhsValid = !isa<Instruction>(U->getOperand(1));
1081       rhsValid |= set.test(VN.lookup(U->getOperand(1)));
1082       if (rhsValid)
1083         rhsValid = !dependsOnInvoke(U->getOperand(1));
1084       
1085       bool thirdValid = !isa<Instruction>(U->getOperand(2));
1086       thirdValid |= set.test(VN.lookup(U->getOperand(2)));
1087       if (thirdValid)
1088         thirdValid = !dependsOnInvoke(U->getOperand(2));
1089     
1090       if (!lhsValid || !rhsValid || !thirdValid) {
1091         set.erase(U);
1092         set.reset(VN.lookup(U));
1093       }
1094     
1095     // Handle varargs ops
1096     } else if (GetElementPtrInst* U = dyn_cast<GetElementPtrInst>(v)) {
1097       bool ptrValid = !isa<Instruction>(U->getPointerOperand());
1098       ptrValid |= set.test(VN.lookup(U->getPointerOperand()));
1099       if (ptrValid)
1100         ptrValid = !dependsOnInvoke(U->getPointerOperand());
1101       
1102       bool varValid = true;
1103       for (GetElementPtrInst::op_iterator I = U->idx_begin(), E = U->idx_end();
1104            I != E; ++I)
1105         if (varValid) {
1106           varValid &= !isa<Instruction>(*I) || set.test(VN.lookup(*I));
1107           varValid &= !dependsOnInvoke(*I);
1108         }
1109     
1110       if (!ptrValid || !varValid) {
1111         set.erase(U);
1112         set.reset(VN.lookup(U));
1113       }
1114     }
1115   }
1116 }
1117
1118 /// topo_sort - Given a set of values, sort them by topological
1119 /// order into the provided vector.
1120 void GVNPRE::topo_sort(ValueNumberedSet& set, SmallVector<Value*, 8>& vec) {
1121   SmallPtrSet<Value*, 16> visited;
1122   SmallVector<Value*, 8> stack;
1123   for (ValueNumberedSet::iterator I = set.begin(), E = set.end();
1124        I != E; ++I) {
1125     if (visited.count(*I) == 0)
1126       stack.push_back(*I);
1127     
1128     while (!stack.empty()) {
1129       Value* e = stack.back();
1130       
1131       // Handle unary ops
1132       if (CastInst* U = dyn_cast<CastInst>(e)) {
1133         Value* l = find_leader(set, VN.lookup(U->getOperand(0)));
1134     
1135         if (l != 0 && isa<Instruction>(l) &&
1136             visited.count(l) == 0)
1137           stack.push_back(l);
1138         else {
1139           vec.push_back(e);
1140           visited.insert(e);
1141           stack.pop_back();
1142         }
1143       
1144       // Handle binary ops
1145       } else if (isa<BinaryOperator>(e) || isa<CmpInst>(e) ||
1146           isa<ExtractElementInst>(e)) {
1147         User* U = cast<User>(e);
1148         Value* l = find_leader(set, VN.lookup(U->getOperand(0)));
1149         Value* r = find_leader(set, VN.lookup(U->getOperand(1)));
1150     
1151         if (l != 0 && isa<Instruction>(l) &&
1152             visited.count(l) == 0)
1153           stack.push_back(l);
1154         else if (r != 0 && isa<Instruction>(r) &&
1155                  visited.count(r) == 0)
1156           stack.push_back(r);
1157         else {
1158           vec.push_back(e);
1159           visited.insert(e);
1160           stack.pop_back();
1161         }
1162       
1163       // Handle ternary ops
1164       } else if (isa<InsertElementInst>(e) || isa<ShuffleVectorInst>(e) ||
1165                  isa<SelectInst>(e)) {
1166         User* U = cast<User>(e);
1167         Value* l = find_leader(set, VN.lookup(U->getOperand(0)));
1168         Value* r = find_leader(set, VN.lookup(U->getOperand(1)));
1169         Value* m = find_leader(set, VN.lookup(U->getOperand(2)));
1170       
1171         if (l != 0 && isa<Instruction>(l) &&
1172             visited.count(l) == 0)
1173           stack.push_back(l);
1174         else if (r != 0 && isa<Instruction>(r) &&
1175                  visited.count(r) == 0)
1176           stack.push_back(r);
1177         else if (m != 0 && isa<Instruction>(m) &&
1178                  visited.count(m) == 0)
1179           stack.push_back(m);
1180         else {
1181           vec.push_back(e);
1182           visited.insert(e);
1183           stack.pop_back();
1184         }
1185       
1186       // Handle vararg ops
1187       } else if (GetElementPtrInst* U = dyn_cast<GetElementPtrInst>(e)) {
1188         Value* p = find_leader(set, VN.lookup(U->getPointerOperand()));
1189         
1190         if (p != 0 && isa<Instruction>(p) &&
1191             visited.count(p) == 0)
1192           stack.push_back(p);
1193         else {
1194           bool push_va = false;
1195           for (GetElementPtrInst::op_iterator I = U->idx_begin(),
1196                E = U->idx_end(); I != E; ++I) {
1197             Value * v = find_leader(set, VN.lookup(*I));
1198             if (v != 0 && isa<Instruction>(v) && visited.count(v) == 0) {
1199               stack.push_back(v);
1200               push_va = true;
1201             }
1202           }
1203           
1204           if (!push_va) {
1205             vec.push_back(e);
1206             visited.insert(e);
1207             stack.pop_back();
1208           }
1209         }
1210       
1211       // Handle opaque ops
1212       } else {
1213         visited.insert(e);
1214         vec.push_back(e);
1215         stack.pop_back();
1216       }
1217     }
1218     
1219     stack.clear();
1220   }
1221 }
1222
1223 /// dump - Dump a set of values to standard error
1224 void GVNPRE::dump(ValueNumberedSet& s) const {
1225   DOUT << "{ ";
1226   for (ValueNumberedSet::iterator I = s.begin(), E = s.end();
1227        I != E; ++I) {
1228     DOUT << "" << VN.lookup(*I) << ": ";
1229     DEBUG((*I)->dump());
1230   }
1231   DOUT << "}\n\n";
1232 }
1233
1234 /// elimination - Phase 3 of the main algorithm.  Perform full redundancy 
1235 /// elimination by walking the dominator tree and removing any instruction that 
1236 /// is dominated by another instruction with the same value number.
1237 bool GVNPRE::elimination() {
1238   bool changed_function = false;
1239   
1240   SmallVector<std::pair<Instruction*, Value*>, 8> replace;
1241   SmallVector<Instruction*, 8> erase;
1242   
1243   DominatorTree& DT = getAnalysis<DominatorTree>();
1244   
1245   for (df_iterator<DomTreeNode*> DI = df_begin(DT.getRootNode()),
1246          E = df_end(DT.getRootNode()); DI != E; ++DI) {
1247     BasicBlock* BB = DI->getBlock();
1248     
1249     for (BasicBlock::iterator BI = BB->begin(), BE = BB->end();
1250          BI != BE; ++BI) {
1251
1252       if (isa<BinaryOperator>(BI) || isa<CmpInst>(BI) ||
1253           isa<ShuffleVectorInst>(BI) || isa<InsertElementInst>(BI) ||
1254           isa<ExtractElementInst>(BI) || isa<SelectInst>(BI) ||
1255           isa<CastInst>(BI) || isa<GetElementPtrInst>(BI)) {
1256         
1257         if (availableOut[BB].test(VN.lookup(BI)) &&
1258             !availableOut[BB].count(BI)) {
1259           Value *leader = find_leader(availableOut[BB], VN.lookup(BI));
1260           if (Instruction* Instr = dyn_cast<Instruction>(leader))
1261             if (Instr->getParent() != 0 && Instr != BI) {
1262               replace.push_back(std::make_pair(BI, leader));
1263               erase.push_back(BI);
1264               ++NumEliminated;
1265             }
1266         }
1267       }
1268     }
1269   }
1270   
1271   while (!replace.empty()) {
1272     std::pair<Instruction*, Value*> rep = replace.back();
1273     replace.pop_back();
1274     rep.first->replaceAllUsesWith(rep.second);
1275     changed_function = true;
1276   }
1277     
1278   for (SmallVector<Instruction*, 8>::iterator I = erase.begin(),
1279        E = erase.end(); I != E; ++I)
1280      (*I)->eraseFromParent();
1281   
1282   return changed_function;
1283 }
1284
1285 /// cleanup - Delete any extraneous values that were created to represent
1286 /// expressions without leaders.
1287 void GVNPRE::cleanup() {
1288   while (!createdExpressions.empty()) {
1289     Instruction* I = createdExpressions.back();
1290     createdExpressions.pop_back();
1291     
1292     delete I;
1293   }
1294 }
1295
1296 /// buildsets_availout - When calculating availability, handle an instruction
1297 /// by inserting it into the appropriate sets
1298 void GVNPRE::buildsets_availout(BasicBlock::iterator I,
1299                                 ValueNumberedSet& currAvail,
1300                                 ValueNumberedSet& currPhis,
1301                                 ValueNumberedSet& currExps,
1302                                 SmallPtrSet<Value*, 16>& currTemps) {
1303   // Handle PHI nodes
1304   if (PHINode* p = dyn_cast<PHINode>(I)) {
1305     unsigned num = VN.lookup_or_add(p);
1306     
1307     currPhis.insert(p);
1308     currPhis.set(num);
1309   
1310   // Handle unary ops
1311   } else if (CastInst* U = dyn_cast<CastInst>(I)) {
1312     Value* leftValue = U->getOperand(0);
1313     
1314     unsigned num = VN.lookup_or_add(U);
1315       
1316     if (isa<Instruction>(leftValue))
1317       if (!currExps.test(VN.lookup(leftValue))) {
1318         currExps.insert(leftValue);
1319         currExps.set(VN.lookup(leftValue));
1320       }
1321     
1322     if (!currExps.test(num)) {
1323       currExps.insert(U);
1324       currExps.set(num);
1325     }
1326   
1327   // Handle binary ops
1328   } else if (isa<BinaryOperator>(I) || isa<CmpInst>(I) ||
1329              isa<ExtractElementInst>(I)) {
1330     User* U = cast<User>(I);
1331     Value* leftValue = U->getOperand(0);
1332     Value* rightValue = U->getOperand(1);
1333     
1334     unsigned num = VN.lookup_or_add(U);
1335       
1336     if (isa<Instruction>(leftValue))
1337       if (!currExps.test(VN.lookup(leftValue))) {
1338         currExps.insert(leftValue);
1339         currExps.set(VN.lookup(leftValue));
1340       }
1341     
1342     if (isa<Instruction>(rightValue))
1343       if (!currExps.test(VN.lookup(rightValue))) {
1344         currExps.insert(rightValue);
1345         currExps.set(VN.lookup(rightValue));
1346       }
1347     
1348     if (!currExps.test(num)) {
1349       currExps.insert(U);
1350       currExps.set(num);
1351     }
1352     
1353   // Handle ternary ops
1354   } else if (isa<InsertElementInst>(I) || isa<ShuffleVectorInst>(I) ||
1355              isa<SelectInst>(I)) {
1356     User* U = cast<User>(I);
1357     Value* leftValue = U->getOperand(0);
1358     Value* rightValue = U->getOperand(1);
1359     Value* thirdValue = U->getOperand(2);
1360       
1361     VN.lookup_or_add(U);
1362     
1363     unsigned num = VN.lookup_or_add(U);
1364     
1365     if (isa<Instruction>(leftValue))
1366       if (!currExps.test(VN.lookup(leftValue))) {
1367         currExps.insert(leftValue);
1368         currExps.set(VN.lookup(leftValue));
1369       }
1370     if (isa<Instruction>(rightValue))
1371       if (!currExps.test(VN.lookup(rightValue))) {
1372         currExps.insert(rightValue);
1373         currExps.set(VN.lookup(rightValue));
1374       }
1375     if (isa<Instruction>(thirdValue))
1376       if (!currExps.test(VN.lookup(thirdValue))) {
1377         currExps.insert(thirdValue);
1378         currExps.set(VN.lookup(thirdValue));
1379       }
1380     
1381     if (!currExps.test(num)) {
1382       currExps.insert(U);
1383       currExps.set(num);
1384     }
1385     
1386   // Handle vararg ops
1387   } else if (GetElementPtrInst* U = dyn_cast<GetElementPtrInst>(I)) {
1388     Value* ptrValue = U->getPointerOperand();
1389       
1390     VN.lookup_or_add(U);
1391     
1392     unsigned num = VN.lookup_or_add(U);
1393     
1394     if (isa<Instruction>(ptrValue))
1395       if (!currExps.test(VN.lookup(ptrValue))) {
1396         currExps.insert(ptrValue);
1397         currExps.set(VN.lookup(ptrValue));
1398       }
1399     
1400     for (GetElementPtrInst::op_iterator OI = U->idx_begin(), OE = U->idx_end();
1401          OI != OE; ++OI)
1402       if (isa<Instruction>(*OI) && !currExps.test(VN.lookup(*OI))) {
1403         currExps.insert(*OI);
1404         currExps.set(VN.lookup(*OI));
1405       }
1406     
1407     if (!currExps.test(VN.lookup(U))) {
1408       currExps.insert(U);
1409       currExps.set(num);
1410     }
1411     
1412   // Handle opaque ops
1413   } else if (!I->isTerminator()){
1414     VN.lookup_or_add(I);
1415     
1416     currTemps.insert(I);
1417   }
1418     
1419   if (!I->isTerminator())
1420     if (!currAvail.test(VN.lookup(I))) {
1421       currAvail.insert(I);
1422       currAvail.set(VN.lookup(I));
1423     }
1424 }
1425
1426 /// buildsets_anticout - When walking the postdom tree, calculate the ANTIC_OUT
1427 /// set as a function of the ANTIC_IN set of the block's predecessors
1428 bool GVNPRE::buildsets_anticout(BasicBlock* BB,
1429                                 ValueNumberedSet& anticOut,
1430                                 SmallPtrSet<BasicBlock*, 8>& visited) {
1431   if (BB->getTerminator()->getNumSuccessors() == 1) {
1432     if (BB->getTerminator()->getSuccessor(0) != BB &&
1433         visited.count(BB->getTerminator()->getSuccessor(0)) == 0) {
1434       return true;
1435     }
1436     else {
1437       phi_translate_set(anticipatedIn[BB->getTerminator()->getSuccessor(0)],
1438                         BB,  BB->getTerminator()->getSuccessor(0), anticOut);
1439     }
1440   } else if (BB->getTerminator()->getNumSuccessors() > 1) {
1441     BasicBlock* first = BB->getTerminator()->getSuccessor(0);
1442     for (ValueNumberedSet::iterator I = anticipatedIn[first].begin(),
1443          E = anticipatedIn[first].end(); I != E; ++I) {
1444       anticOut.insert(*I);
1445       anticOut.set(VN.lookup(*I));
1446     }
1447     
1448     for (unsigned i = 1; i < BB->getTerminator()->getNumSuccessors(); ++i) {
1449       BasicBlock* currSucc = BB->getTerminator()->getSuccessor(i);
1450       ValueNumberedSet& succAnticIn = anticipatedIn[currSucc];
1451       
1452       SmallVector<Value*, 16> temp;
1453       
1454       for (ValueNumberedSet::iterator I = anticOut.begin(),
1455            E = anticOut.end(); I != E; ++I)
1456         if (!succAnticIn.test(VN.lookup(*I)))
1457           temp.push_back(*I);
1458
1459       for (SmallVector<Value*, 16>::iterator I = temp.begin(), E = temp.end();
1460            I != E; ++I) {
1461         anticOut.erase(*I);
1462         anticOut.reset(VN.lookup(*I));
1463       }
1464     }
1465   }
1466   
1467   return false;
1468 }
1469
1470 /// buildsets_anticin - Walk the postdom tree, calculating ANTIC_OUT for
1471 /// each block.  ANTIC_IN is then a function of ANTIC_OUT and the GEN
1472 /// sets populated in buildsets_availout
1473 unsigned GVNPRE::buildsets_anticin(BasicBlock* BB,
1474                                ValueNumberedSet& anticOut,
1475                                ValueNumberedSet& currExps,
1476                                SmallPtrSet<Value*, 16>& currTemps,
1477                                SmallPtrSet<BasicBlock*, 8>& visited) {
1478   ValueNumberedSet& anticIn = anticipatedIn[BB];
1479   unsigned old = anticIn.size();
1480       
1481   bool defer = buildsets_anticout(BB, anticOut, visited);
1482   if (defer)
1483     return 0;
1484   
1485   anticIn.clear();
1486   
1487   for (ValueNumberedSet::iterator I = anticOut.begin(),
1488        E = anticOut.end(); I != E; ++I) {
1489     anticIn.insert(*I);
1490     anticIn.set(VN.lookup(*I));
1491   }
1492   for (ValueNumberedSet::iterator I = currExps.begin(),
1493        E = currExps.end(); I != E; ++I) {
1494     if (!anticIn.test(VN.lookup(*I))) {
1495       anticIn.insert(*I);
1496       anticIn.set(VN.lookup(*I));
1497     }
1498   } 
1499   
1500   for (SmallPtrSet<Value*, 16>::iterator I = currTemps.begin(),
1501        E = currTemps.end(); I != E; ++I) {
1502     anticIn.erase(*I);
1503     anticIn.reset(VN.lookup(*I));
1504   }
1505   
1506   clean(anticIn);
1507   anticOut.clear();
1508   
1509   if (old != anticIn.size())
1510     return 2;
1511   else
1512     return 1;
1513 }
1514
1515 /// buildsets - Phase 1 of the main algorithm.  Construct the AVAIL_OUT
1516 /// and the ANTIC_IN sets.
1517 void GVNPRE::buildsets(Function& F) {
1518   DenseMap<BasicBlock*, ValueNumberedSet> generatedExpressions;
1519   DenseMap<BasicBlock*, SmallPtrSet<Value*, 16> > generatedTemporaries;
1520
1521   DominatorTree &DT = getAnalysis<DominatorTree>();   
1522   
1523   // Phase 1, Part 1: calculate AVAIL_OUT
1524   
1525   // Top-down walk of the dominator tree
1526   for (df_iterator<DomTreeNode*> DI = df_begin(DT.getRootNode()),
1527          E = df_end(DT.getRootNode()); DI != E; ++DI) {
1528     
1529     // Get the sets to update for this block
1530     ValueNumberedSet& currExps = generatedExpressions[DI->getBlock()];
1531     ValueNumberedSet& currPhis = generatedPhis[DI->getBlock()];
1532     SmallPtrSet<Value*, 16>& currTemps = generatedTemporaries[DI->getBlock()];
1533     ValueNumberedSet& currAvail = availableOut[DI->getBlock()];     
1534     
1535     BasicBlock* BB = DI->getBlock();
1536   
1537     // A block inherits AVAIL_OUT from its dominator
1538     if (DI->getIDom() != 0)
1539       currAvail = availableOut[DI->getIDom()->getBlock()];
1540
1541     for (BasicBlock::iterator BI = BB->begin(), BE = BB->end();
1542          BI != BE; ++BI)
1543       buildsets_availout(BI, currAvail, currPhis, currExps,
1544                          currTemps);
1545       
1546   }
1547
1548   // Phase 1, Part 2: calculate ANTIC_IN
1549   
1550   SmallPtrSet<BasicBlock*, 8> visited;
1551   SmallPtrSet<BasicBlock*, 4> block_changed;
1552   for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI)
1553     block_changed.insert(FI);
1554   
1555   bool changed = true;
1556   unsigned iterations = 0;
1557   
1558   while (changed) {
1559     changed = false;
1560     ValueNumberedSet anticOut;
1561     
1562     // Postorder walk of the CFG
1563     for (po_iterator<BasicBlock*> BBI = po_begin(&F.getEntryBlock()),
1564          BBE = po_end(&F.getEntryBlock()); BBI != BBE; ++BBI) {
1565       BasicBlock* BB = *BBI;
1566       
1567       if (block_changed.count(BB) != 0) {
1568         unsigned ret = buildsets_anticin(BB, anticOut,generatedExpressions[BB],
1569                                          generatedTemporaries[BB], visited);
1570       
1571         if (ret == 0) {
1572           changed = true;
1573           continue;
1574         } else {
1575           visited.insert(BB);
1576         
1577           if (ret == 2)
1578            for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
1579                  PI != PE; ++PI) {
1580               block_changed.insert(*PI);
1581            }
1582           else
1583             block_changed.erase(BB);
1584         
1585           changed |= (ret == 2);
1586         }
1587       }
1588     }
1589     
1590     iterations++;
1591   }
1592 }
1593
1594 /// insertion_pre - When a partial redundancy has been identified, eliminate it
1595 /// by inserting appropriate values into the predecessors and a phi node in
1596 /// the main block
1597 void GVNPRE::insertion_pre(Value* e, BasicBlock* BB,
1598                            DenseMap<BasicBlock*, Value*>& avail,
1599                     std::map<BasicBlock*, ValueNumberedSet>& new_sets) {
1600   LLVMContext &Context = e->getContext();
1601   for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE; ++PI) {
1602     Value* e2 = avail[*PI];
1603     if (!availableOut[*PI].test(VN.lookup(e2))) {
1604       User* U = cast<User>(e2);
1605       
1606       Value* s1 = 0;
1607       if (isa<BinaryOperator>(U->getOperand(0)) || 
1608           isa<CmpInst>(U->getOperand(0)) ||
1609           isa<ShuffleVectorInst>(U->getOperand(0)) ||
1610           isa<ExtractElementInst>(U->getOperand(0)) ||
1611           isa<InsertElementInst>(U->getOperand(0)) ||
1612           isa<SelectInst>(U->getOperand(0)) ||
1613           isa<CastInst>(U->getOperand(0)) ||
1614           isa<GetElementPtrInst>(U->getOperand(0)))
1615         s1 = find_leader(availableOut[*PI], VN.lookup(U->getOperand(0)));
1616       else
1617         s1 = U->getOperand(0);
1618       
1619       Value* s2 = 0;
1620       
1621       if (isa<BinaryOperator>(U) || 
1622           isa<CmpInst>(U) ||
1623           isa<ShuffleVectorInst>(U) ||
1624           isa<ExtractElementInst>(U) ||
1625           isa<InsertElementInst>(U) ||
1626           isa<SelectInst>(U)) {
1627         if (isa<BinaryOperator>(U->getOperand(1)) || 
1628             isa<CmpInst>(U->getOperand(1)) ||
1629             isa<ShuffleVectorInst>(U->getOperand(1)) ||
1630             isa<ExtractElementInst>(U->getOperand(1)) ||
1631             isa<InsertElementInst>(U->getOperand(1)) ||
1632             isa<SelectInst>(U->getOperand(1)) ||
1633             isa<CastInst>(U->getOperand(1)) ||
1634             isa<GetElementPtrInst>(U->getOperand(1))) {
1635           s2 = find_leader(availableOut[*PI], VN.lookup(U->getOperand(1)));
1636         } else {
1637           s2 = U->getOperand(1);
1638         }
1639       }
1640       
1641       // Ternary Operators
1642       Value* s3 = 0;
1643       if (isa<ShuffleVectorInst>(U) ||
1644           isa<InsertElementInst>(U) ||
1645           isa<SelectInst>(U)) {
1646         if (isa<BinaryOperator>(U->getOperand(2)) || 
1647             isa<CmpInst>(U->getOperand(2)) ||
1648             isa<ShuffleVectorInst>(U->getOperand(2)) ||
1649             isa<ExtractElementInst>(U->getOperand(2)) ||
1650             isa<InsertElementInst>(U->getOperand(2)) ||
1651             isa<SelectInst>(U->getOperand(2)) ||
1652             isa<CastInst>(U->getOperand(2)) ||
1653             isa<GetElementPtrInst>(U->getOperand(2))) {
1654           s3 = find_leader(availableOut[*PI], VN.lookup(U->getOperand(2)));
1655         } else {
1656           s3 = U->getOperand(2);
1657         }
1658       }
1659       
1660       // Vararg operators
1661       SmallVector<Value*, 4> sVarargs;
1662       if (GetElementPtrInst* G = dyn_cast<GetElementPtrInst>(U)) {
1663         for (GetElementPtrInst::op_iterator OI = G->idx_begin(),
1664              OE = G->idx_end(); OI != OE; ++OI) {
1665           if (isa<BinaryOperator>(*OI) || 
1666               isa<CmpInst>(*OI) ||
1667               isa<ShuffleVectorInst>(*OI) ||
1668               isa<ExtractElementInst>(*OI) ||
1669               isa<InsertElementInst>(*OI) ||
1670               isa<SelectInst>(*OI) ||
1671               isa<CastInst>(*OI) ||
1672               isa<GetElementPtrInst>(*OI)) {
1673             sVarargs.push_back(find_leader(availableOut[*PI], 
1674                                VN.lookup(*OI)));
1675           } else {
1676             sVarargs.push_back(*OI);
1677           }
1678         }
1679       }
1680       
1681       Value* newVal = 0;
1682       if (BinaryOperator* BO = dyn_cast<BinaryOperator>(U))
1683         newVal = BinaryOperator::Create(BO->getOpcode(), s1, s2,
1684                                         BO->getName()+".gvnpre",
1685                                         (*PI)->getTerminator());
1686       else if (CmpInst* C = dyn_cast<CmpInst>(U))
1687         newVal = CmpInst::Create(Context, C->getOpcode(),
1688                                  C->getPredicate(), s1, s2,
1689                                  C->getName()+".gvnpre", 
1690                                  (*PI)->getTerminator());
1691       else if (ShuffleVectorInst* S = dyn_cast<ShuffleVectorInst>(U))
1692         newVal = new ShuffleVectorInst(s1, s2, s3, S->getName()+".gvnpre",
1693                                        (*PI)->getTerminator());
1694       else if (InsertElementInst* S = dyn_cast<InsertElementInst>(U))
1695         newVal = InsertElementInst::Create(s1, s2, s3, S->getName()+".gvnpre",
1696                                            (*PI)->getTerminator());
1697       else if (ExtractElementInst* S = dyn_cast<ExtractElementInst>(U))
1698         newVal = ExtractElementInst::Create(s1, s2, S->getName()+".gvnpre",
1699                                         (*PI)->getTerminator());
1700       else if (SelectInst* S = dyn_cast<SelectInst>(U))
1701         newVal = SelectInst::Create(s1, s2, s3, S->getName()+".gvnpre",
1702                                     (*PI)->getTerminator());
1703       else if (CastInst* C = dyn_cast<CastInst>(U))
1704         newVal = CastInst::Create(C->getOpcode(), s1, C->getType(),
1705                                   C->getName()+".gvnpre", 
1706                                   (*PI)->getTerminator());
1707       else if (GetElementPtrInst* G = dyn_cast<GetElementPtrInst>(U))
1708         newVal = GetElementPtrInst::Create(s1, sVarargs.begin(), sVarargs.end(),
1709                                            G->getName()+".gvnpre", 
1710                                            (*PI)->getTerminator());
1711
1712       VN.add(newVal, VN.lookup(U));
1713                   
1714       ValueNumberedSet& predAvail = availableOut[*PI];
1715       val_replace(predAvail, newVal);
1716       val_replace(new_sets[*PI], newVal);
1717       predAvail.set(VN.lookup(newVal));
1718             
1719       DenseMap<BasicBlock*, Value*>::iterator av = avail.find(*PI);
1720       if (av != avail.end())
1721         avail.erase(av);
1722       avail.insert(std::make_pair(*PI, newVal));
1723                   
1724       ++NumInsertedVals;
1725     }
1726   }
1727               
1728   PHINode* p = 0;
1729               
1730   for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE; ++PI) {
1731     if (p == 0)
1732       p = PHINode::Create(avail[*PI]->getType(), "gvnpre-join", BB->begin());
1733     
1734     p->addIncoming(avail[*PI], *PI);
1735   }
1736
1737   VN.add(p, VN.lookup(e));
1738   val_replace(availableOut[BB], p);
1739   availableOut[BB].set(VN.lookup(e));
1740   generatedPhis[BB].insert(p);
1741   generatedPhis[BB].set(VN.lookup(e));
1742   new_sets[BB].insert(p);
1743   new_sets[BB].set(VN.lookup(e));
1744               
1745   ++NumInsertedPhis;
1746 }
1747
1748 /// insertion_mergepoint - When walking the dom tree, check at each merge
1749 /// block for the possibility of a partial redundancy.  If present, eliminate it
1750 unsigned GVNPRE::insertion_mergepoint(SmallVector<Value*, 8>& workList,
1751                                       df_iterator<DomTreeNode*>& D,
1752                     std::map<BasicBlock*, ValueNumberedSet >& new_sets) {
1753   bool changed_function = false;
1754   bool new_stuff = false;
1755   
1756   BasicBlock* BB = D->getBlock();
1757   for (unsigned i = 0; i < workList.size(); ++i) {
1758     Value* e = workList[i];
1759           
1760     if (isa<BinaryOperator>(e) || isa<CmpInst>(e) ||
1761         isa<ExtractElementInst>(e) || isa<InsertElementInst>(e) ||
1762         isa<ShuffleVectorInst>(e) || isa<SelectInst>(e) || isa<CastInst>(e) ||
1763         isa<GetElementPtrInst>(e)) {
1764       if (availableOut[D->getIDom()->getBlock()].test(VN.lookup(e)))
1765         continue;
1766             
1767       DenseMap<BasicBlock*, Value*> avail;
1768       bool by_some = false;
1769       bool all_same = true;
1770       Value * first_s = 0;
1771             
1772       for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE;
1773            ++PI) {
1774         Value *e2 = phi_translate(e, *PI, BB);
1775         Value *e3 = find_leader(availableOut[*PI], VN.lookup(e2));
1776               
1777         if (e3 == 0) {
1778           DenseMap<BasicBlock*, Value*>::iterator av = avail.find(*PI);
1779           if (av != avail.end())
1780             avail.erase(av);
1781           avail.insert(std::make_pair(*PI, e2));
1782           all_same = false;
1783         } else {
1784           DenseMap<BasicBlock*, Value*>::iterator av = avail.find(*PI);
1785           if (av != avail.end())
1786             avail.erase(av);
1787           avail.insert(std::make_pair(*PI, e3));
1788                 
1789           by_some = true;
1790           if (first_s == 0)
1791             first_s = e3;
1792           else if (first_s != e3)
1793             all_same = false;
1794         }
1795       }
1796             
1797       if (by_some && !all_same &&
1798           !generatedPhis[BB].test(VN.lookup(e))) {
1799         insertion_pre(e, BB, avail, new_sets);
1800               
1801         changed_function = true;
1802         new_stuff = true;
1803       }
1804     }
1805   }
1806   
1807   unsigned retval = 0;
1808   if (changed_function)
1809     retval += 1;
1810   if (new_stuff)
1811     retval += 2;
1812   
1813   return retval;
1814 }
1815
1816 /// insert - Phase 2 of the main algorithm.  Walk the dominator tree looking for
1817 /// merge points.  When one is found, check for a partial redundancy.  If one is
1818 /// present, eliminate it.  Repeat this walk until no changes are made.
1819 bool GVNPRE::insertion(Function& F) {
1820   bool changed_function = false;
1821
1822   DominatorTree &DT = getAnalysis<DominatorTree>();  
1823   
1824   std::map<BasicBlock*, ValueNumberedSet> new_sets;
1825   bool new_stuff = true;
1826   while (new_stuff) {
1827     new_stuff = false;
1828     for (df_iterator<DomTreeNode*> DI = df_begin(DT.getRootNode()),
1829          E = df_end(DT.getRootNode()); DI != E; ++DI) {
1830       BasicBlock* BB = DI->getBlock();
1831       
1832       if (BB == 0)
1833         continue;
1834       
1835       ValueNumberedSet& availOut = availableOut[BB];
1836       ValueNumberedSet& anticIn = anticipatedIn[BB];
1837       
1838       // Replace leaders with leaders inherited from dominator
1839       if (DI->getIDom() != 0) {
1840         ValueNumberedSet& dom_set = new_sets[DI->getIDom()->getBlock()];
1841         for (ValueNumberedSet::iterator I = dom_set.begin(),
1842              E = dom_set.end(); I != E; ++I) {
1843           val_replace(new_sets[BB], *I);
1844           val_replace(availOut, *I);
1845         }
1846       }
1847       
1848       // If there is more than one predecessor...
1849       if (pred_begin(BB) != pred_end(BB) && ++pred_begin(BB) != pred_end(BB)) {
1850         SmallVector<Value*, 8> workList;
1851         workList.reserve(anticIn.size());
1852         topo_sort(anticIn, workList);
1853         
1854         unsigned result = insertion_mergepoint(workList, DI, new_sets);
1855         if (result & 1)
1856           changed_function = true;
1857         if (result & 2)
1858           new_stuff = true;
1859       }
1860     }
1861   }
1862   
1863   return changed_function;
1864 }
1865
1866 // GVNPRE::runOnFunction - This is the main transformation entry point for a
1867 // function.
1868 //
1869 bool GVNPRE::runOnFunction(Function &F) {
1870   // Clean out global sets from any previous functions
1871   VN.clear();
1872   createdExpressions.clear();
1873   availableOut.clear();
1874   anticipatedIn.clear();
1875   generatedPhis.clear();
1876  
1877   bool changed_function = false;
1878   
1879   // Phase 1: BuildSets
1880   // This phase calculates the AVAIL_OUT and ANTIC_IN sets
1881   buildsets(F);
1882   
1883   // Phase 2: Insert
1884   // This phase inserts values to make partially redundant values
1885   // fully redundant
1886   changed_function |= insertion(F);
1887   
1888   // Phase 3: Eliminate
1889   // This phase performs trivial full redundancy elimination
1890   changed_function |= elimination();
1891   
1892   // Phase 4: Cleanup
1893   // This phase cleans up values that were created solely
1894   // as leaders for expressions
1895   cleanup();
1896   
1897   return changed_function;
1898 }