Add some accessor methods to CAZ and UndefValue that help simplify clients.
[oota-llvm.git] / lib / VMCore / Constants.cpp
1 //===-- Constants.cpp - Implement Constant nodes --------------------------===//
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 file implements the Constant* classes.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "llvm/Constants.h"
15 #include "LLVMContextImpl.h"
16 #include "ConstantFold.h"
17 #include "llvm/DerivedTypes.h"
18 #include "llvm/GlobalValue.h"
19 #include "llvm/Instructions.h"
20 #include "llvm/Module.h"
21 #include "llvm/Operator.h"
22 #include "llvm/ADT/FoldingSet.h"
23 #include "llvm/ADT/StringExtras.h"
24 #include "llvm/ADT/StringMap.h"
25 #include "llvm/Support/Compiler.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/Support/ErrorHandling.h"
28 #include "llvm/Support/ManagedStatic.h"
29 #include "llvm/Support/MathExtras.h"
30 #include "llvm/Support/raw_ostream.h"
31 #include "llvm/Support/GetElementPtrTypeIterator.h"
32 #include "llvm/ADT/DenseMap.h"
33 #include "llvm/ADT/SmallVector.h"
34 #include "llvm/ADT/STLExtras.h"
35 #include <algorithm>
36 #include <cstdarg>
37 using namespace llvm;
38
39 //===----------------------------------------------------------------------===//
40 //                              Constant Class
41 //===----------------------------------------------------------------------===//
42
43 void Constant::anchor() { }
44
45 bool Constant::isNegativeZeroValue() const {
46   // Floating point values have an explicit -0.0 value.
47   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(this))
48     return CFP->isZero() && CFP->isNegative();
49   
50   // Otherwise, just use +0.0.
51   return isNullValue();
52 }
53
54 bool Constant::isNullValue() const {
55   // 0 is null.
56   if (const ConstantInt *CI = dyn_cast<ConstantInt>(this))
57     return CI->isZero();
58   
59   // +0.0 is null.
60   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(this))
61     return CFP->isZero() && !CFP->isNegative();
62
63   // constant zero is zero for aggregates and cpnull is null for pointers.
64   return isa<ConstantAggregateZero>(this) || isa<ConstantPointerNull>(this);
65 }
66
67 bool Constant::isAllOnesValue() const {
68   // Check for -1 integers
69   if (const ConstantInt *CI = dyn_cast<ConstantInt>(this))
70     return CI->isMinusOne();
71
72   // Check for FP which are bitcasted from -1 integers
73   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(this))
74     return CFP->getValueAPF().bitcastToAPInt().isAllOnesValue();
75
76   // Check for constant vectors which are splats of -1 values.
77   if (const ConstantVector *CV = dyn_cast<ConstantVector>(this))
78     if (Constant *Splat = CV->getSplatValue())
79       return Splat->isAllOnesValue();
80
81   return false;
82 }
83
84 // Constructor to create a '0' constant of arbitrary type...
85 Constant *Constant::getNullValue(Type *Ty) {
86   switch (Ty->getTypeID()) {
87   case Type::IntegerTyID:
88     return ConstantInt::get(Ty, 0);
89   case Type::HalfTyID:
90     return ConstantFP::get(Ty->getContext(),
91                            APFloat::getZero(APFloat::IEEEhalf));
92   case Type::FloatTyID:
93     return ConstantFP::get(Ty->getContext(),
94                            APFloat::getZero(APFloat::IEEEsingle));
95   case Type::DoubleTyID:
96     return ConstantFP::get(Ty->getContext(),
97                            APFloat::getZero(APFloat::IEEEdouble));
98   case Type::X86_FP80TyID:
99     return ConstantFP::get(Ty->getContext(),
100                            APFloat::getZero(APFloat::x87DoubleExtended));
101   case Type::FP128TyID:
102     return ConstantFP::get(Ty->getContext(),
103                            APFloat::getZero(APFloat::IEEEquad));
104   case Type::PPC_FP128TyID:
105     return ConstantFP::get(Ty->getContext(),
106                            APFloat(APInt::getNullValue(128)));
107   case Type::PointerTyID:
108     return ConstantPointerNull::get(cast<PointerType>(Ty));
109   case Type::StructTyID:
110   case Type::ArrayTyID:
111   case Type::VectorTyID:
112     return ConstantAggregateZero::get(Ty);
113   default:
114     // Function, Label, or Opaque type?
115     assert(0 && "Cannot create a null constant of that type!");
116     return 0;
117   }
118 }
119
120 Constant *Constant::getIntegerValue(Type *Ty, const APInt &V) {
121   Type *ScalarTy = Ty->getScalarType();
122
123   // Create the base integer constant.
124   Constant *C = ConstantInt::get(Ty->getContext(), V);
125
126   // Convert an integer to a pointer, if necessary.
127   if (PointerType *PTy = dyn_cast<PointerType>(ScalarTy))
128     C = ConstantExpr::getIntToPtr(C, PTy);
129
130   // Broadcast a scalar to a vector, if necessary.
131   if (VectorType *VTy = dyn_cast<VectorType>(Ty))
132     C = ConstantVector::get(std::vector<Constant *>(VTy->getNumElements(), C));
133
134   return C;
135 }
136
137 Constant *Constant::getAllOnesValue(Type *Ty) {
138   if (IntegerType *ITy = dyn_cast<IntegerType>(Ty))
139     return ConstantInt::get(Ty->getContext(),
140                             APInt::getAllOnesValue(ITy->getBitWidth()));
141
142   if (Ty->isFloatingPointTy()) {
143     APFloat FL = APFloat::getAllOnesValue(Ty->getPrimitiveSizeInBits(),
144                                           !Ty->isPPC_FP128Ty());
145     return ConstantFP::get(Ty->getContext(), FL);
146   }
147
148   SmallVector<Constant*, 16> Elts;
149   VectorType *VTy = cast<VectorType>(Ty);
150   Elts.resize(VTy->getNumElements(), getAllOnesValue(VTy->getElementType()));
151   assert(Elts[0] && "Invalid AllOnes value!");
152   return cast<ConstantVector>(ConstantVector::get(Elts));
153 }
154
155 void Constant::destroyConstantImpl() {
156   // When a Constant is destroyed, there may be lingering
157   // references to the constant by other constants in the constant pool.  These
158   // constants are implicitly dependent on the module that is being deleted,
159   // but they don't know that.  Because we only find out when the CPV is
160   // deleted, we must now notify all of our users (that should only be
161   // Constants) that they are, in fact, invalid now and should be deleted.
162   //
163   while (!use_empty()) {
164     Value *V = use_back();
165 #ifndef NDEBUG      // Only in -g mode...
166     if (!isa<Constant>(V)) {
167       dbgs() << "While deleting: " << *this
168              << "\n\nUse still stuck around after Def is destroyed: "
169              << *V << "\n\n";
170     }
171 #endif
172     assert(isa<Constant>(V) && "References remain to Constant being destroyed");
173     Constant *CV = cast<Constant>(V);
174     CV->destroyConstant();
175
176     // The constant should remove itself from our use list...
177     assert((use_empty() || use_back() != V) && "Constant not removed!");
178   }
179
180   // Value has no outstanding references it is safe to delete it now...
181   delete this;
182 }
183
184 /// canTrap - Return true if evaluation of this constant could trap.  This is
185 /// true for things like constant expressions that could divide by zero.
186 bool Constant::canTrap() const {
187   assert(getType()->isFirstClassType() && "Cannot evaluate aggregate vals!");
188   // The only thing that could possibly trap are constant exprs.
189   const ConstantExpr *CE = dyn_cast<ConstantExpr>(this);
190   if (!CE) return false;
191   
192   // ConstantExpr traps if any operands can trap. 
193   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
194     if (CE->getOperand(i)->canTrap()) 
195       return true;
196
197   // Otherwise, only specific operations can trap.
198   switch (CE->getOpcode()) {
199   default:
200     return false;
201   case Instruction::UDiv:
202   case Instruction::SDiv:
203   case Instruction::FDiv:
204   case Instruction::URem:
205   case Instruction::SRem:
206   case Instruction::FRem:
207     // Div and rem can trap if the RHS is not known to be non-zero.
208     if (!isa<ConstantInt>(CE->getOperand(1)) ||CE->getOperand(1)->isNullValue())
209       return true;
210     return false;
211   }
212 }
213
214 /// isConstantUsed - Return true if the constant has users other than constant
215 /// exprs and other dangling things.
216 bool Constant::isConstantUsed() const {
217   for (const_use_iterator UI = use_begin(), E = use_end(); UI != E; ++UI) {
218     const Constant *UC = dyn_cast<Constant>(*UI);
219     if (UC == 0 || isa<GlobalValue>(UC))
220       return true;
221     
222     if (UC->isConstantUsed())
223       return true;
224   }
225   return false;
226 }
227
228
229
230 /// getRelocationInfo - This method classifies the entry according to
231 /// whether or not it may generate a relocation entry.  This must be
232 /// conservative, so if it might codegen to a relocatable entry, it should say
233 /// so.  The return values are:
234 /// 
235 ///  NoRelocation: This constant pool entry is guaranteed to never have a
236 ///     relocation applied to it (because it holds a simple constant like
237 ///     '4').
238 ///  LocalRelocation: This entry has relocations, but the entries are
239 ///     guaranteed to be resolvable by the static linker, so the dynamic
240 ///     linker will never see them.
241 ///  GlobalRelocations: This entry may have arbitrary relocations.
242 ///
243 /// FIXME: This really should not be in VMCore.
244 Constant::PossibleRelocationsTy Constant::getRelocationInfo() const {
245   if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
246     if (GV->hasLocalLinkage() || GV->hasHiddenVisibility())
247       return LocalRelocation;  // Local to this file/library.
248     return GlobalRelocations;    // Global reference.
249   }
250   
251   if (const BlockAddress *BA = dyn_cast<BlockAddress>(this))
252     return BA->getFunction()->getRelocationInfo();
253   
254   // While raw uses of blockaddress need to be relocated, differences between
255   // two of them don't when they are for labels in the same function.  This is a
256   // common idiom when creating a table for the indirect goto extension, so we
257   // handle it efficiently here.
258   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(this))
259     if (CE->getOpcode() == Instruction::Sub) {
260       ConstantExpr *LHS = dyn_cast<ConstantExpr>(CE->getOperand(0));
261       ConstantExpr *RHS = dyn_cast<ConstantExpr>(CE->getOperand(1));
262       if (LHS && RHS &&
263           LHS->getOpcode() == Instruction::PtrToInt &&
264           RHS->getOpcode() == Instruction::PtrToInt &&
265           isa<BlockAddress>(LHS->getOperand(0)) &&
266           isa<BlockAddress>(RHS->getOperand(0)) &&
267           cast<BlockAddress>(LHS->getOperand(0))->getFunction() ==
268             cast<BlockAddress>(RHS->getOperand(0))->getFunction())
269         return NoRelocation;
270     }
271   
272   PossibleRelocationsTy Result = NoRelocation;
273   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
274     Result = std::max(Result,
275                       cast<Constant>(getOperand(i))->getRelocationInfo());
276   
277   return Result;
278 }
279
280
281 /// getVectorElements - This method, which is only valid on constant of vector
282 /// type, returns the elements of the vector in the specified smallvector.
283 /// This handles breaking down a vector undef into undef elements, etc.  For
284 /// constant exprs and other cases we can't handle, we return an empty vector.
285 void Constant::getVectorElements(SmallVectorImpl<Constant*> &Elts) const {
286   assert(getType()->isVectorTy() && "Not a vector constant!");
287   
288   if (const ConstantVector *CV = dyn_cast<ConstantVector>(this)) {
289     for (unsigned i = 0, e = CV->getNumOperands(); i != e; ++i)
290       Elts.push_back(CV->getOperand(i));
291     return;
292   }
293   
294   VectorType *VT = cast<VectorType>(getType());
295   if (isa<ConstantAggregateZero>(this)) {
296     Elts.assign(VT->getNumElements(), 
297                 Constant::getNullValue(VT->getElementType()));
298     return;
299   }
300   
301   if (isa<UndefValue>(this)) {
302     Elts.assign(VT->getNumElements(), UndefValue::get(VT->getElementType()));
303     return;
304   }
305   
306   // Unknown type, must be constant expr etc.
307 }
308
309
310 /// removeDeadUsersOfConstant - If the specified constantexpr is dead, remove
311 /// it.  This involves recursively eliminating any dead users of the
312 /// constantexpr.
313 static bool removeDeadUsersOfConstant(const Constant *C) {
314   if (isa<GlobalValue>(C)) return false; // Cannot remove this
315   
316   while (!C->use_empty()) {
317     const Constant *User = dyn_cast<Constant>(C->use_back());
318     if (!User) return false; // Non-constant usage;
319     if (!removeDeadUsersOfConstant(User))
320       return false; // Constant wasn't dead
321   }
322   
323   const_cast<Constant*>(C)->destroyConstant();
324   return true;
325 }
326
327
328 /// removeDeadConstantUsers - If there are any dead constant users dangling
329 /// off of this constant, remove them.  This method is useful for clients
330 /// that want to check to see if a global is unused, but don't want to deal
331 /// with potentially dead constants hanging off of the globals.
332 void Constant::removeDeadConstantUsers() const {
333   Value::const_use_iterator I = use_begin(), E = use_end();
334   Value::const_use_iterator LastNonDeadUser = E;
335   while (I != E) {
336     const Constant *User = dyn_cast<Constant>(*I);
337     if (User == 0) {
338       LastNonDeadUser = I;
339       ++I;
340       continue;
341     }
342     
343     if (!removeDeadUsersOfConstant(User)) {
344       // If the constant wasn't dead, remember that this was the last live use
345       // and move on to the next constant.
346       LastNonDeadUser = I;
347       ++I;
348       continue;
349     }
350     
351     // If the constant was dead, then the iterator is invalidated.
352     if (LastNonDeadUser == E) {
353       I = use_begin();
354       if (I == E) break;
355     } else {
356       I = LastNonDeadUser;
357       ++I;
358     }
359   }
360 }
361
362
363
364 //===----------------------------------------------------------------------===//
365 //                                ConstantInt
366 //===----------------------------------------------------------------------===//
367
368 void ConstantInt::anchor() { }
369
370 ConstantInt::ConstantInt(IntegerType *Ty, const APInt& V)
371   : Constant(Ty, ConstantIntVal, 0, 0), Val(V) {
372   assert(V.getBitWidth() == Ty->getBitWidth() && "Invalid constant for type");
373 }
374
375 ConstantInt *ConstantInt::getTrue(LLVMContext &Context) {
376   LLVMContextImpl *pImpl = Context.pImpl;
377   if (!pImpl->TheTrueVal)
378     pImpl->TheTrueVal = ConstantInt::get(Type::getInt1Ty(Context), 1);
379   return pImpl->TheTrueVal;
380 }
381
382 ConstantInt *ConstantInt::getFalse(LLVMContext &Context) {
383   LLVMContextImpl *pImpl = Context.pImpl;
384   if (!pImpl->TheFalseVal)
385     pImpl->TheFalseVal = ConstantInt::get(Type::getInt1Ty(Context), 0);
386   return pImpl->TheFalseVal;
387 }
388
389 Constant *ConstantInt::getTrue(Type *Ty) {
390   VectorType *VTy = dyn_cast<VectorType>(Ty);
391   if (!VTy) {
392     assert(Ty->isIntegerTy(1) && "True must be i1 or vector of i1.");
393     return ConstantInt::getTrue(Ty->getContext());
394   }
395   assert(VTy->getElementType()->isIntegerTy(1) &&
396          "True must be vector of i1 or i1.");
397   SmallVector<Constant*, 16> Splat(VTy->getNumElements(),
398                                    ConstantInt::getTrue(Ty->getContext()));
399   return ConstantVector::get(Splat);
400 }
401
402 Constant *ConstantInt::getFalse(Type *Ty) {
403   VectorType *VTy = dyn_cast<VectorType>(Ty);
404   if (!VTy) {
405     assert(Ty->isIntegerTy(1) && "False must be i1 or vector of i1.");
406     return ConstantInt::getFalse(Ty->getContext());
407   }
408   assert(VTy->getElementType()->isIntegerTy(1) &&
409          "False must be vector of i1 or i1.");
410   SmallVector<Constant*, 16> Splat(VTy->getNumElements(),
411                                    ConstantInt::getFalse(Ty->getContext()));
412   return ConstantVector::get(Splat);
413 }
414
415
416 // Get a ConstantInt from an APInt. Note that the value stored in the DenseMap 
417 // as the key, is a DenseMapAPIntKeyInfo::KeyTy which has provided the
418 // operator== and operator!= to ensure that the DenseMap doesn't attempt to
419 // compare APInt's of different widths, which would violate an APInt class
420 // invariant which generates an assertion.
421 ConstantInt *ConstantInt::get(LLVMContext &Context, const APInt &V) {
422   // Get the corresponding integer type for the bit width of the value.
423   IntegerType *ITy = IntegerType::get(Context, V.getBitWidth());
424   // get an existing value or the insertion position
425   DenseMapAPIntKeyInfo::KeyTy Key(V, ITy);
426   ConstantInt *&Slot = Context.pImpl->IntConstants[Key]; 
427   if (!Slot) Slot = new ConstantInt(ITy, V);
428   return Slot;
429 }
430
431 Constant *ConstantInt::get(Type *Ty, uint64_t V, bool isSigned) {
432   Constant *C = get(cast<IntegerType>(Ty->getScalarType()), V, isSigned);
433
434   // For vectors, broadcast the value.
435   if (VectorType *VTy = dyn_cast<VectorType>(Ty))
436     return ConstantVector::get(SmallVector<Constant*,
437                                            16>(VTy->getNumElements(), C));
438
439   return C;
440 }
441
442 ConstantInt* ConstantInt::get(IntegerType* Ty, uint64_t V, 
443                               bool isSigned) {
444   return get(Ty->getContext(), APInt(Ty->getBitWidth(), V, isSigned));
445 }
446
447 ConstantInt* ConstantInt::getSigned(IntegerType* Ty, int64_t V) {
448   return get(Ty, V, true);
449 }
450
451 Constant *ConstantInt::getSigned(Type *Ty, int64_t V) {
452   return get(Ty, V, true);
453 }
454
455 Constant *ConstantInt::get(Type* Ty, const APInt& V) {
456   ConstantInt *C = get(Ty->getContext(), V);
457   assert(C->getType() == Ty->getScalarType() &&
458          "ConstantInt type doesn't match the type implied by its value!");
459
460   // For vectors, broadcast the value.
461   if (VectorType *VTy = dyn_cast<VectorType>(Ty))
462     return ConstantVector::get(
463       SmallVector<Constant *, 16>(VTy->getNumElements(), C));
464
465   return C;
466 }
467
468 ConstantInt* ConstantInt::get(IntegerType* Ty, StringRef Str,
469                               uint8_t radix) {
470   return get(Ty->getContext(), APInt(Ty->getBitWidth(), Str, radix));
471 }
472
473 //===----------------------------------------------------------------------===//
474 //                                ConstantFP
475 //===----------------------------------------------------------------------===//
476
477 static const fltSemantics *TypeToFloatSemantics(Type *Ty) {
478   if (Ty->isHalfTy())
479     return &APFloat::IEEEhalf;
480   if (Ty->isFloatTy())
481     return &APFloat::IEEEsingle;
482   if (Ty->isDoubleTy())
483     return &APFloat::IEEEdouble;
484   if (Ty->isX86_FP80Ty())
485     return &APFloat::x87DoubleExtended;
486   else if (Ty->isFP128Ty())
487     return &APFloat::IEEEquad;
488   
489   assert(Ty->isPPC_FP128Ty() && "Unknown FP format");
490   return &APFloat::PPCDoubleDouble;
491 }
492
493 void ConstantFP::anchor() { }
494
495 /// get() - This returns a constant fp for the specified value in the
496 /// specified type.  This should only be used for simple constant values like
497 /// 2.0/1.0 etc, that are known-valid both as double and as the target format.
498 Constant *ConstantFP::get(Type* Ty, double V) {
499   LLVMContext &Context = Ty->getContext();
500   
501   APFloat FV(V);
502   bool ignored;
503   FV.convert(*TypeToFloatSemantics(Ty->getScalarType()),
504              APFloat::rmNearestTiesToEven, &ignored);
505   Constant *C = get(Context, FV);
506
507   // For vectors, broadcast the value.
508   if (VectorType *VTy = dyn_cast<VectorType>(Ty))
509     return ConstantVector::get(
510       SmallVector<Constant *, 16>(VTy->getNumElements(), C));
511
512   return C;
513 }
514
515
516 Constant *ConstantFP::get(Type* Ty, StringRef Str) {
517   LLVMContext &Context = Ty->getContext();
518
519   APFloat FV(*TypeToFloatSemantics(Ty->getScalarType()), Str);
520   Constant *C = get(Context, FV);
521
522   // For vectors, broadcast the value.
523   if (VectorType *VTy = dyn_cast<VectorType>(Ty))
524     return ConstantVector::get(
525       SmallVector<Constant *, 16>(VTy->getNumElements(), C));
526
527   return C; 
528 }
529
530
531 ConstantFP* ConstantFP::getNegativeZero(Type* Ty) {
532   LLVMContext &Context = Ty->getContext();
533   APFloat apf = cast <ConstantFP>(Constant::getNullValue(Ty))->getValueAPF();
534   apf.changeSign();
535   return get(Context, apf);
536 }
537
538
539 Constant *ConstantFP::getZeroValueForNegation(Type* Ty) {
540   if (VectorType *PTy = dyn_cast<VectorType>(Ty))
541     if (PTy->getElementType()->isFloatingPointTy()) {
542       SmallVector<Constant*, 16> zeros(PTy->getNumElements(),
543                            getNegativeZero(PTy->getElementType()));
544       return ConstantVector::get(zeros);
545     }
546
547   if (Ty->isFloatingPointTy()) 
548     return getNegativeZero(Ty);
549
550   return Constant::getNullValue(Ty);
551 }
552
553
554 // ConstantFP accessors.
555 ConstantFP* ConstantFP::get(LLVMContext &Context, const APFloat& V) {
556   DenseMapAPFloatKeyInfo::KeyTy Key(V);
557   
558   LLVMContextImpl* pImpl = Context.pImpl;
559   
560   ConstantFP *&Slot = pImpl->FPConstants[Key];
561     
562   if (!Slot) {
563     Type *Ty;
564     if (&V.getSemantics() == &APFloat::IEEEhalf)
565       Ty = Type::getHalfTy(Context);
566     else if (&V.getSemantics() == &APFloat::IEEEsingle)
567       Ty = Type::getFloatTy(Context);
568     else if (&V.getSemantics() == &APFloat::IEEEdouble)
569       Ty = Type::getDoubleTy(Context);
570     else if (&V.getSemantics() == &APFloat::x87DoubleExtended)
571       Ty = Type::getX86_FP80Ty(Context);
572     else if (&V.getSemantics() == &APFloat::IEEEquad)
573       Ty = Type::getFP128Ty(Context);
574     else {
575       assert(&V.getSemantics() == &APFloat::PPCDoubleDouble && 
576              "Unknown FP format");
577       Ty = Type::getPPC_FP128Ty(Context);
578     }
579     Slot = new ConstantFP(Ty, V);
580   }
581   
582   return Slot;
583 }
584
585 ConstantFP *ConstantFP::getInfinity(Type *Ty, bool Negative) {
586   const fltSemantics &Semantics = *TypeToFloatSemantics(Ty);
587   return ConstantFP::get(Ty->getContext(),
588                          APFloat::getInf(Semantics, Negative));
589 }
590
591 ConstantFP::ConstantFP(Type *Ty, const APFloat& V)
592   : Constant(Ty, ConstantFPVal, 0, 0), Val(V) {
593   assert(&V.getSemantics() == TypeToFloatSemantics(Ty) &&
594          "FP type Mismatch");
595 }
596
597 bool ConstantFP::isExactlyValue(const APFloat &V) const {
598   return Val.bitwiseIsEqual(V);
599 }
600
601 //===----------------------------------------------------------------------===//
602 //                   ConstantAggregateZero Implementation
603 //===----------------------------------------------------------------------===//
604
605 /// getSequentialElement - If this CAZ has array or vector type, return a zero
606 /// with the right element type.
607 Constant *ConstantAggregateZero::getSequentialElement() {
608   return Constant::getNullValue(
609                             cast<SequentialType>(getType())->getElementType());
610 }
611
612 /// getStructElement - If this CAZ has struct type, return a zero with the
613 /// right element type for the specified element.
614 Constant *ConstantAggregateZero::getStructElement(unsigned Elt) {
615   return Constant::getNullValue(
616                               cast<StructType>(getType())->getElementType(Elt));
617 }
618
619 /// getElementValue - Return a zero of the right value for the specified GEP
620 /// index if we can, otherwise return null (e.g. if C is a ConstantExpr).
621 Constant *ConstantAggregateZero::getElementValue(Constant *C) {
622   if (isa<SequentialType>(getType()))
623     return getSequentialElement();
624   return getStructElement(cast<ConstantInt>(C)->getZExtValue());
625 }
626
627 //===----------------------------------------------------------------------===//
628 //                         UndefValue Implementation
629 //===----------------------------------------------------------------------===//
630
631 /// getSequentialElement - If this undef has array or vector type, return an
632 /// undef with the right element type.
633 UndefValue *UndefValue::getSequentialElement() {
634   return UndefValue::get(cast<SequentialType>(getType())->getElementType());
635 }
636
637 /// getStructElement - If this undef has struct type, return a zero with the
638 /// right element type for the specified element.
639 UndefValue *UndefValue::getStructElement(unsigned Elt) {
640   return UndefValue::get(cast<StructType>(getType())->getElementType(Elt));
641 }
642
643 /// getElementValue - Return an undef of the right value for the specified GEP
644 /// index if we can, otherwise return null (e.g. if C is a ConstantExpr).
645 UndefValue *UndefValue::getElementValue(Constant *C) {
646   if (isa<SequentialType>(getType()))
647     return getSequentialElement();
648   return getStructElement(cast<ConstantInt>(C)->getZExtValue());
649 }
650
651
652 //===----------------------------------------------------------------------===//
653 //                            ConstantXXX Classes
654 //===----------------------------------------------------------------------===//
655
656
657 ConstantArray::ConstantArray(ArrayType *T, ArrayRef<Constant *> V)
658   : Constant(T, ConstantArrayVal,
659              OperandTraits<ConstantArray>::op_end(this) - V.size(),
660              V.size()) {
661   assert(V.size() == T->getNumElements() &&
662          "Invalid initializer vector for constant array");
663   for (unsigned i = 0, e = V.size(); i != e; ++i)
664     assert(V[i]->getType() == T->getElementType() &&
665            "Initializer for array element doesn't match array element type!");
666   std::copy(V.begin(), V.end(), op_begin());
667 }
668
669 Constant *ConstantArray::get(ArrayType *Ty, ArrayRef<Constant*> V) {
670   for (unsigned i = 0, e = V.size(); i != e; ++i) {
671     assert(V[i]->getType() == Ty->getElementType() &&
672            "Wrong type in array element initializer");
673   }
674   LLVMContextImpl *pImpl = Ty->getContext().pImpl;
675   // If this is an all-zero array, return a ConstantAggregateZero object
676   if (!V.empty()) {
677     Constant *C = V[0];
678     if (!C->isNullValue())
679       return pImpl->ArrayConstants.getOrCreate(Ty, V);
680     
681     for (unsigned i = 1, e = V.size(); i != e; ++i)
682       if (V[i] != C)
683         return pImpl->ArrayConstants.getOrCreate(Ty, V);
684   }
685   
686   return ConstantAggregateZero::get(Ty);
687 }
688
689 /// ConstantArray::get(const string&) - Return an array that is initialized to
690 /// contain the specified string.  If length is zero then a null terminator is 
691 /// added to the specified string so that it may be used in a natural way. 
692 /// Otherwise, the length parameter specifies how much of the string to use 
693 /// and it won't be null terminated.
694 ///
695 Constant *ConstantArray::get(LLVMContext &Context, StringRef Str,
696                              bool AddNull) {
697   std::vector<Constant*> ElementVals;
698   ElementVals.reserve(Str.size() + size_t(AddNull));
699   for (unsigned i = 0; i < Str.size(); ++i)
700     ElementVals.push_back(ConstantInt::get(Type::getInt8Ty(Context), Str[i]));
701
702   // Add a null terminator to the string...
703   if (AddNull) {
704     ElementVals.push_back(ConstantInt::get(Type::getInt8Ty(Context), 0));
705   }
706
707   ArrayType *ATy = ArrayType::get(Type::getInt8Ty(Context), ElementVals.size());
708   return get(ATy, ElementVals);
709 }
710
711 /// getTypeForElements - Return an anonymous struct type to use for a constant
712 /// with the specified set of elements.  The list must not be empty.
713 StructType *ConstantStruct::getTypeForElements(LLVMContext &Context,
714                                                ArrayRef<Constant*> V,
715                                                bool Packed) {
716   SmallVector<Type*, 16> EltTypes;
717   for (unsigned i = 0, e = V.size(); i != e; ++i)
718     EltTypes.push_back(V[i]->getType());
719   
720   return StructType::get(Context, EltTypes, Packed);
721 }
722
723
724 StructType *ConstantStruct::getTypeForElements(ArrayRef<Constant*> V,
725                                                bool Packed) {
726   assert(!V.empty() &&
727          "ConstantStruct::getTypeForElements cannot be called on empty list");
728   return getTypeForElements(V[0]->getContext(), V, Packed);
729 }
730
731
732 ConstantStruct::ConstantStruct(StructType *T, ArrayRef<Constant *> V)
733   : Constant(T, ConstantStructVal,
734              OperandTraits<ConstantStruct>::op_end(this) - V.size(),
735              V.size()) {
736   assert(V.size() == T->getNumElements() &&
737          "Invalid initializer vector for constant structure");
738   for (unsigned i = 0, e = V.size(); i != e; ++i)
739     assert((T->isOpaque() || V[i]->getType() == T->getElementType(i)) &&
740            "Initializer for struct element doesn't match struct element type!");
741   std::copy(V.begin(), V.end(), op_begin());
742 }
743
744 // ConstantStruct accessors.
745 Constant *ConstantStruct::get(StructType *ST, ArrayRef<Constant*> V) {
746   // Create a ConstantAggregateZero value if all elements are zeros.
747   for (unsigned i = 0, e = V.size(); i != e; ++i)
748     if (!V[i]->isNullValue())
749       return ST->getContext().pImpl->StructConstants.getOrCreate(ST, V);
750
751   assert((ST->isOpaque() || ST->getNumElements() == V.size()) &&
752          "Incorrect # elements specified to ConstantStruct::get");
753   return ConstantAggregateZero::get(ST);
754 }
755
756 Constant *ConstantStruct::get(StructType *T, ...) {
757   va_list ap;
758   SmallVector<Constant*, 8> Values;
759   va_start(ap, T);
760   while (Constant *Val = va_arg(ap, llvm::Constant*))
761     Values.push_back(Val);
762   va_end(ap);
763   return get(T, Values);
764 }
765
766 ConstantVector::ConstantVector(VectorType *T, ArrayRef<Constant *> V)
767   : Constant(T, ConstantVectorVal,
768              OperandTraits<ConstantVector>::op_end(this) - V.size(),
769              V.size()) {
770   for (size_t i = 0, e = V.size(); i != e; i++)
771     assert(V[i]->getType() == T->getElementType() &&
772            "Initializer for vector element doesn't match vector element type!");
773   std::copy(V.begin(), V.end(), op_begin());
774 }
775
776 // ConstantVector accessors.
777 Constant *ConstantVector::get(ArrayRef<Constant*> V) {
778   assert(!V.empty() && "Vectors can't be empty");
779   VectorType *T = VectorType::get(V.front()->getType(), V.size());
780   LLVMContextImpl *pImpl = T->getContext().pImpl;
781
782   // If this is an all-undef or all-zero vector, return a
783   // ConstantAggregateZero or UndefValue.
784   Constant *C = V[0];
785   bool isZero = C->isNullValue();
786   bool isUndef = isa<UndefValue>(C);
787
788   if (isZero || isUndef) {
789     for (unsigned i = 1, e = V.size(); i != e; ++i)
790       if (V[i] != C) {
791         isZero = isUndef = false;
792         break;
793       }
794   }
795   
796   if (isZero)
797     return ConstantAggregateZero::get(T);
798   if (isUndef)
799     return UndefValue::get(T);
800     
801   return pImpl->VectorConstants.getOrCreate(T, V);
802 }
803
804 // Utility function for determining if a ConstantExpr is a CastOp or not. This
805 // can't be inline because we don't want to #include Instruction.h into
806 // Constant.h
807 bool ConstantExpr::isCast() const {
808   return Instruction::isCast(getOpcode());
809 }
810
811 bool ConstantExpr::isCompare() const {
812   return getOpcode() == Instruction::ICmp || getOpcode() == Instruction::FCmp;
813 }
814
815 bool ConstantExpr::isGEPWithNoNotionalOverIndexing() const {
816   if (getOpcode() != Instruction::GetElementPtr) return false;
817
818   gep_type_iterator GEPI = gep_type_begin(this), E = gep_type_end(this);
819   User::const_op_iterator OI = llvm::next(this->op_begin());
820
821   // Skip the first index, as it has no static limit.
822   ++GEPI;
823   ++OI;
824
825   // The remaining indices must be compile-time known integers within the
826   // bounds of the corresponding notional static array types.
827   for (; GEPI != E; ++GEPI, ++OI) {
828     ConstantInt *CI = dyn_cast<ConstantInt>(*OI);
829     if (!CI) return false;
830     if (ArrayType *ATy = dyn_cast<ArrayType>(*GEPI))
831       if (CI->getValue().getActiveBits() > 64 ||
832           CI->getZExtValue() >= ATy->getNumElements())
833         return false;
834   }
835
836   // All the indices checked out.
837   return true;
838 }
839
840 bool ConstantExpr::hasIndices() const {
841   return getOpcode() == Instruction::ExtractValue ||
842          getOpcode() == Instruction::InsertValue;
843 }
844
845 ArrayRef<unsigned> ConstantExpr::getIndices() const {
846   if (const ExtractValueConstantExpr *EVCE =
847         dyn_cast<ExtractValueConstantExpr>(this))
848     return EVCE->Indices;
849
850   return cast<InsertValueConstantExpr>(this)->Indices;
851 }
852
853 unsigned ConstantExpr::getPredicate() const {
854   assert(isCompare());
855   return ((const CompareConstantExpr*)this)->predicate;
856 }
857
858 /// getWithOperandReplaced - Return a constant expression identical to this
859 /// one, but with the specified operand set to the specified value.
860 Constant *
861 ConstantExpr::getWithOperandReplaced(unsigned OpNo, Constant *Op) const {
862   assert(OpNo < getNumOperands() && "Operand num is out of range!");
863   assert(Op->getType() == getOperand(OpNo)->getType() &&
864          "Replacing operand with value of different type!");
865   if (getOperand(OpNo) == Op)
866     return const_cast<ConstantExpr*>(this);
867   
868   Constant *Op0, *Op1, *Op2;
869   switch (getOpcode()) {
870   case Instruction::Trunc:
871   case Instruction::ZExt:
872   case Instruction::SExt:
873   case Instruction::FPTrunc:
874   case Instruction::FPExt:
875   case Instruction::UIToFP:
876   case Instruction::SIToFP:
877   case Instruction::FPToUI:
878   case Instruction::FPToSI:
879   case Instruction::PtrToInt:
880   case Instruction::IntToPtr:
881   case Instruction::BitCast:
882     return ConstantExpr::getCast(getOpcode(), Op, getType());
883   case Instruction::Select:
884     Op0 = (OpNo == 0) ? Op : getOperand(0);
885     Op1 = (OpNo == 1) ? Op : getOperand(1);
886     Op2 = (OpNo == 2) ? Op : getOperand(2);
887     return ConstantExpr::getSelect(Op0, Op1, Op2);
888   case Instruction::InsertElement:
889     Op0 = (OpNo == 0) ? Op : getOperand(0);
890     Op1 = (OpNo == 1) ? Op : getOperand(1);
891     Op2 = (OpNo == 2) ? Op : getOperand(2);
892     return ConstantExpr::getInsertElement(Op0, Op1, Op2);
893   case Instruction::ExtractElement:
894     Op0 = (OpNo == 0) ? Op : getOperand(0);
895     Op1 = (OpNo == 1) ? Op : getOperand(1);
896     return ConstantExpr::getExtractElement(Op0, Op1);
897   case Instruction::ShuffleVector:
898     Op0 = (OpNo == 0) ? Op : getOperand(0);
899     Op1 = (OpNo == 1) ? Op : getOperand(1);
900     Op2 = (OpNo == 2) ? Op : getOperand(2);
901     return ConstantExpr::getShuffleVector(Op0, Op1, Op2);
902   case Instruction::GetElementPtr: {
903     SmallVector<Constant*, 8> Ops;
904     Ops.resize(getNumOperands()-1);
905     for (unsigned i = 1, e = getNumOperands(); i != e; ++i)
906       Ops[i-1] = getOperand(i);
907     if (OpNo == 0)
908       return
909         ConstantExpr::getGetElementPtr(Op, Ops,
910                                        cast<GEPOperator>(this)->isInBounds());
911     Ops[OpNo-1] = Op;
912     return
913       ConstantExpr::getGetElementPtr(getOperand(0), Ops,
914                                      cast<GEPOperator>(this)->isInBounds());
915   }
916   default:
917     assert(getNumOperands() == 2 && "Must be binary operator?");
918     Op0 = (OpNo == 0) ? Op : getOperand(0);
919     Op1 = (OpNo == 1) ? Op : getOperand(1);
920     return ConstantExpr::get(getOpcode(), Op0, Op1, SubclassOptionalData);
921   }
922 }
923
924 /// getWithOperands - This returns the current constant expression with the
925 /// operands replaced with the specified values.  The specified array must
926 /// have the same number of operands as our current one.
927 Constant *ConstantExpr::
928 getWithOperands(ArrayRef<Constant*> Ops, Type *Ty) const {
929   assert(Ops.size() == getNumOperands() && "Operand count mismatch!");
930   bool AnyChange = Ty != getType();
931   for (unsigned i = 0; i != Ops.size(); ++i)
932     AnyChange |= Ops[i] != getOperand(i);
933   
934   if (!AnyChange)  // No operands changed, return self.
935     return const_cast<ConstantExpr*>(this);
936
937   switch (getOpcode()) {
938   case Instruction::Trunc:
939   case Instruction::ZExt:
940   case Instruction::SExt:
941   case Instruction::FPTrunc:
942   case Instruction::FPExt:
943   case Instruction::UIToFP:
944   case Instruction::SIToFP:
945   case Instruction::FPToUI:
946   case Instruction::FPToSI:
947   case Instruction::PtrToInt:
948   case Instruction::IntToPtr:
949   case Instruction::BitCast:
950     return ConstantExpr::getCast(getOpcode(), Ops[0], Ty);
951   case Instruction::Select:
952     return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
953   case Instruction::InsertElement:
954     return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
955   case Instruction::ExtractElement:
956     return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
957   case Instruction::ShuffleVector:
958     return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
959   case Instruction::GetElementPtr:
960     return
961       ConstantExpr::getGetElementPtr(Ops[0], Ops.slice(1),
962                                      cast<GEPOperator>(this)->isInBounds());
963   case Instruction::ICmp:
964   case Instruction::FCmp:
965     return ConstantExpr::getCompare(getPredicate(), Ops[0], Ops[1]);
966   default:
967     assert(getNumOperands() == 2 && "Must be binary operator?");
968     return ConstantExpr::get(getOpcode(), Ops[0], Ops[1], SubclassOptionalData);
969   }
970 }
971
972
973 //===----------------------------------------------------------------------===//
974 //                      isValueValidForType implementations
975
976 bool ConstantInt::isValueValidForType(Type *Ty, uint64_t Val) {
977   unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
978   if (Ty == Type::getInt1Ty(Ty->getContext()))
979     return Val == 0 || Val == 1;
980   if (NumBits >= 64)
981     return true; // always true, has to fit in largest type
982   uint64_t Max = (1ll << NumBits) - 1;
983   return Val <= Max;
984 }
985
986 bool ConstantInt::isValueValidForType(Type *Ty, int64_t Val) {
987   unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
988   if (Ty == Type::getInt1Ty(Ty->getContext()))
989     return Val == 0 || Val == 1 || Val == -1;
990   if (NumBits >= 64)
991     return true; // always true, has to fit in largest type
992   int64_t Min = -(1ll << (NumBits-1));
993   int64_t Max = (1ll << (NumBits-1)) - 1;
994   return (Val >= Min && Val <= Max);
995 }
996
997 bool ConstantFP::isValueValidForType(Type *Ty, const APFloat& Val) {
998   // convert modifies in place, so make a copy.
999   APFloat Val2 = APFloat(Val);
1000   bool losesInfo;
1001   switch (Ty->getTypeID()) {
1002   default:
1003     return false;         // These can't be represented as floating point!
1004
1005   // FIXME rounding mode needs to be more flexible
1006   case Type::HalfTyID: {
1007     if (&Val2.getSemantics() == &APFloat::IEEEhalf)
1008       return true;
1009     Val2.convert(APFloat::IEEEhalf, APFloat::rmNearestTiesToEven, &losesInfo);
1010     return !losesInfo;
1011   }
1012   case Type::FloatTyID: {
1013     if (&Val2.getSemantics() == &APFloat::IEEEsingle)
1014       return true;
1015     Val2.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &losesInfo);
1016     return !losesInfo;
1017   }
1018   case Type::DoubleTyID: {
1019     if (&Val2.getSemantics() == &APFloat::IEEEhalf ||
1020         &Val2.getSemantics() == &APFloat::IEEEsingle ||
1021         &Val2.getSemantics() == &APFloat::IEEEdouble)
1022       return true;
1023     Val2.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, &losesInfo);
1024     return !losesInfo;
1025   }
1026   case Type::X86_FP80TyID:
1027     return &Val2.getSemantics() == &APFloat::IEEEhalf ||
1028            &Val2.getSemantics() == &APFloat::IEEEsingle || 
1029            &Val2.getSemantics() == &APFloat::IEEEdouble ||
1030            &Val2.getSemantics() == &APFloat::x87DoubleExtended;
1031   case Type::FP128TyID:
1032     return &Val2.getSemantics() == &APFloat::IEEEhalf ||
1033            &Val2.getSemantics() == &APFloat::IEEEsingle || 
1034            &Val2.getSemantics() == &APFloat::IEEEdouble ||
1035            &Val2.getSemantics() == &APFloat::IEEEquad;
1036   case Type::PPC_FP128TyID:
1037     return &Val2.getSemantics() == &APFloat::IEEEhalf ||
1038            &Val2.getSemantics() == &APFloat::IEEEsingle || 
1039            &Val2.getSemantics() == &APFloat::IEEEdouble ||
1040            &Val2.getSemantics() == &APFloat::PPCDoubleDouble;
1041   }
1042 }
1043
1044
1045 //===----------------------------------------------------------------------===//
1046 //                      Factory Function Implementation
1047
1048 ConstantAggregateZero *ConstantAggregateZero::get(Type *Ty) {
1049   assert((Ty->isStructTy() || Ty->isArrayTy() || Ty->isVectorTy()) &&
1050          "Cannot create an aggregate zero of non-aggregate type!");
1051   
1052   ConstantAggregateZero *&Entry = Ty->getContext().pImpl->CAZConstants[Ty];
1053   if (Entry == 0)
1054     Entry = new ConstantAggregateZero(Ty);
1055   
1056   return Entry;
1057 }
1058
1059 /// destroyConstant - Remove the constant from the constant table.
1060 ///
1061 void ConstantAggregateZero::destroyConstant() {
1062   getContext().pImpl->CAZConstants.erase(getType());
1063   destroyConstantImpl();
1064 }
1065
1066 /// destroyConstant - Remove the constant from the constant table...
1067 ///
1068 void ConstantArray::destroyConstant() {
1069   getType()->getContext().pImpl->ArrayConstants.remove(this);
1070   destroyConstantImpl();
1071 }
1072
1073 /// isString - This method returns true if the array is an array of i8, and 
1074 /// if the elements of the array are all ConstantInt's.
1075 bool ConstantArray::isString() const {
1076   // Check the element type for i8...
1077   if (!getType()->getElementType()->isIntegerTy(8))
1078     return false;
1079   // Check the elements to make sure they are all integers, not constant
1080   // expressions.
1081   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1082     if (!isa<ConstantInt>(getOperand(i)))
1083       return false;
1084   return true;
1085 }
1086
1087 /// isCString - This method returns true if the array is a string (see
1088 /// isString) and it ends in a null byte \\0 and does not contains any other
1089 /// null bytes except its terminator.
1090 bool ConstantArray::isCString() const {
1091   // Check the element type for i8...
1092   if (!getType()->getElementType()->isIntegerTy(8))
1093     return false;
1094
1095   // Last element must be a null.
1096   if (!getOperand(getNumOperands()-1)->isNullValue())
1097     return false;
1098   // Other elements must be non-null integers.
1099   for (unsigned i = 0, e = getNumOperands()-1; i != e; ++i) {
1100     if (!isa<ConstantInt>(getOperand(i)))
1101       return false;
1102     if (getOperand(i)->isNullValue())
1103       return false;
1104   }
1105   return true;
1106 }
1107
1108
1109 /// convertToString - Helper function for getAsString() and getAsCString().
1110 static std::string convertToString(const User *U, unsigned len) {
1111   std::string Result;
1112   Result.reserve(len);
1113   for (unsigned i = 0; i != len; ++i)
1114     Result.push_back((char)cast<ConstantInt>(U->getOperand(i))->getZExtValue());
1115   return Result;
1116 }
1117
1118 /// getAsString - If this array is isString(), then this method converts the
1119 /// array to an std::string and returns it.  Otherwise, it asserts out.
1120 ///
1121 std::string ConstantArray::getAsString() const {
1122   assert(isString() && "Not a string!");
1123   return convertToString(this, getNumOperands());
1124 }
1125
1126
1127 /// getAsCString - If this array is isCString(), then this method converts the
1128 /// array (without the trailing null byte) to an std::string and returns it.
1129 /// Otherwise, it asserts out.
1130 ///
1131 std::string ConstantArray::getAsCString() const {
1132   assert(isCString() && "Not a string!");
1133   return convertToString(this, getNumOperands() - 1);
1134 }
1135
1136
1137 //---- ConstantStruct::get() implementation...
1138 //
1139
1140 // destroyConstant - Remove the constant from the constant table...
1141 //
1142 void ConstantStruct::destroyConstant() {
1143   getType()->getContext().pImpl->StructConstants.remove(this);
1144   destroyConstantImpl();
1145 }
1146
1147 // destroyConstant - Remove the constant from the constant table...
1148 //
1149 void ConstantVector::destroyConstant() {
1150   getType()->getContext().pImpl->VectorConstants.remove(this);
1151   destroyConstantImpl();
1152 }
1153
1154 /// getSplatValue - If this is a splat constant, where all of the
1155 /// elements have the same value, return that value. Otherwise return null.
1156 Constant *ConstantVector::getSplatValue() const {
1157   // Check out first element.
1158   Constant *Elt = getOperand(0);
1159   // Then make sure all remaining elements point to the same value.
1160   for (unsigned I = 1, E = getNumOperands(); I < E; ++I)
1161     if (getOperand(I) != Elt)
1162       return 0;
1163   return Elt;
1164 }
1165
1166 //---- ConstantPointerNull::get() implementation.
1167 //
1168
1169 ConstantPointerNull *ConstantPointerNull::get(PointerType *Ty) {
1170   ConstantPointerNull *&Entry = Ty->getContext().pImpl->CPNConstants[Ty];
1171   if (Entry == 0)
1172     Entry = new ConstantPointerNull(Ty);
1173   
1174   return Entry;
1175 }
1176
1177 // destroyConstant - Remove the constant from the constant table...
1178 //
1179 void ConstantPointerNull::destroyConstant() {
1180   getContext().pImpl->CPNConstants.erase(getType());
1181   // Free the constant and any dangling references to it.
1182   destroyConstantImpl();
1183 }
1184
1185
1186 //---- UndefValue::get() implementation.
1187 //
1188
1189 UndefValue *UndefValue::get(Type *Ty) {
1190   UndefValue *&Entry = Ty->getContext().pImpl->UVConstants[Ty];
1191   if (Entry == 0)
1192     Entry = new UndefValue(Ty);
1193   
1194   return Entry;
1195 }
1196
1197 // destroyConstant - Remove the constant from the constant table.
1198 //
1199 void UndefValue::destroyConstant() {
1200   // Free the constant and any dangling references to it.
1201   getContext().pImpl->UVConstants.erase(getType());
1202   destroyConstantImpl();
1203 }
1204
1205 //---- BlockAddress::get() implementation.
1206 //
1207
1208 BlockAddress *BlockAddress::get(BasicBlock *BB) {
1209   assert(BB->getParent() != 0 && "Block must have a parent");
1210   return get(BB->getParent(), BB);
1211 }
1212
1213 BlockAddress *BlockAddress::get(Function *F, BasicBlock *BB) {
1214   BlockAddress *&BA =
1215     F->getContext().pImpl->BlockAddresses[std::make_pair(F, BB)];
1216   if (BA == 0)
1217     BA = new BlockAddress(F, BB);
1218   
1219   assert(BA->getFunction() == F && "Basic block moved between functions");
1220   return BA;
1221 }
1222
1223 BlockAddress::BlockAddress(Function *F, BasicBlock *BB)
1224 : Constant(Type::getInt8PtrTy(F->getContext()), Value::BlockAddressVal,
1225            &Op<0>(), 2) {
1226   setOperand(0, F);
1227   setOperand(1, BB);
1228   BB->AdjustBlockAddressRefCount(1);
1229 }
1230
1231
1232 // destroyConstant - Remove the constant from the constant table.
1233 //
1234 void BlockAddress::destroyConstant() {
1235   getFunction()->getType()->getContext().pImpl
1236     ->BlockAddresses.erase(std::make_pair(getFunction(), getBasicBlock()));
1237   getBasicBlock()->AdjustBlockAddressRefCount(-1);
1238   destroyConstantImpl();
1239 }
1240
1241 void BlockAddress::replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U) {
1242   // This could be replacing either the Basic Block or the Function.  In either
1243   // case, we have to remove the map entry.
1244   Function *NewF = getFunction();
1245   BasicBlock *NewBB = getBasicBlock();
1246   
1247   if (U == &Op<0>())
1248     NewF = cast<Function>(To);
1249   else
1250     NewBB = cast<BasicBlock>(To);
1251   
1252   // See if the 'new' entry already exists, if not, just update this in place
1253   // and return early.
1254   BlockAddress *&NewBA =
1255     getContext().pImpl->BlockAddresses[std::make_pair(NewF, NewBB)];
1256   if (NewBA == 0) {
1257     getBasicBlock()->AdjustBlockAddressRefCount(-1);
1258     
1259     // Remove the old entry, this can't cause the map to rehash (just a
1260     // tombstone will get added).
1261     getContext().pImpl->BlockAddresses.erase(std::make_pair(getFunction(),
1262                                                             getBasicBlock()));
1263     NewBA = this;
1264     setOperand(0, NewF);
1265     setOperand(1, NewBB);
1266     getBasicBlock()->AdjustBlockAddressRefCount(1);
1267     return;
1268   }
1269
1270   // Otherwise, I do need to replace this with an existing value.
1271   assert(NewBA != this && "I didn't contain From!");
1272   
1273   // Everyone using this now uses the replacement.
1274   replaceAllUsesWith(NewBA);
1275   
1276   destroyConstant();
1277 }
1278
1279 //---- ConstantExpr::get() implementations.
1280 //
1281
1282 /// This is a utility function to handle folding of casts and lookup of the
1283 /// cast in the ExprConstants map. It is used by the various get* methods below.
1284 static inline Constant *getFoldedCast(
1285   Instruction::CastOps opc, Constant *C, Type *Ty) {
1286   assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1287   // Fold a few common cases
1288   if (Constant *FC = ConstantFoldCastInstruction(opc, C, Ty))
1289     return FC;
1290
1291   LLVMContextImpl *pImpl = Ty->getContext().pImpl;
1292
1293   // Look up the constant in the table first to ensure uniqueness
1294   std::vector<Constant*> argVec(1, C);
1295   ExprMapKeyType Key(opc, argVec);
1296   
1297   return pImpl->ExprConstants.getOrCreate(Ty, Key);
1298 }
1299  
1300 Constant *ConstantExpr::getCast(unsigned oc, Constant *C, Type *Ty) {
1301   Instruction::CastOps opc = Instruction::CastOps(oc);
1302   assert(Instruction::isCast(opc) && "opcode out of range");
1303   assert(C && Ty && "Null arguments to getCast");
1304   assert(CastInst::castIsValid(opc, C, Ty) && "Invalid constantexpr cast!");
1305
1306   switch (opc) {
1307   default:
1308     llvm_unreachable("Invalid cast opcode");
1309   case Instruction::Trunc:    return getTrunc(C, Ty);
1310   case Instruction::ZExt:     return getZExt(C, Ty);
1311   case Instruction::SExt:     return getSExt(C, Ty);
1312   case Instruction::FPTrunc:  return getFPTrunc(C, Ty);
1313   case Instruction::FPExt:    return getFPExtend(C, Ty);
1314   case Instruction::UIToFP:   return getUIToFP(C, Ty);
1315   case Instruction::SIToFP:   return getSIToFP(C, Ty);
1316   case Instruction::FPToUI:   return getFPToUI(C, Ty);
1317   case Instruction::FPToSI:   return getFPToSI(C, Ty);
1318   case Instruction::PtrToInt: return getPtrToInt(C, Ty);
1319   case Instruction::IntToPtr: return getIntToPtr(C, Ty);
1320   case Instruction::BitCast:  return getBitCast(C, Ty);
1321   }
1322
1323
1324 Constant *ConstantExpr::getZExtOrBitCast(Constant *C, Type *Ty) {
1325   if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1326     return getBitCast(C, Ty);
1327   return getZExt(C, Ty);
1328 }
1329
1330 Constant *ConstantExpr::getSExtOrBitCast(Constant *C, Type *Ty) {
1331   if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1332     return getBitCast(C, Ty);
1333   return getSExt(C, Ty);
1334 }
1335
1336 Constant *ConstantExpr::getTruncOrBitCast(Constant *C, Type *Ty) {
1337   if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1338     return getBitCast(C, Ty);
1339   return getTrunc(C, Ty);
1340 }
1341
1342 Constant *ConstantExpr::getPointerCast(Constant *S, Type *Ty) {
1343   assert(S->getType()->isPointerTy() && "Invalid cast");
1344   assert((Ty->isIntegerTy() || Ty->isPointerTy()) && "Invalid cast");
1345
1346   if (Ty->isIntegerTy())
1347     return getPtrToInt(S, Ty);
1348   return getBitCast(S, Ty);
1349 }
1350
1351 Constant *ConstantExpr::getIntegerCast(Constant *C, Type *Ty, 
1352                                        bool isSigned) {
1353   assert(C->getType()->isIntOrIntVectorTy() &&
1354          Ty->isIntOrIntVectorTy() && "Invalid cast");
1355   unsigned SrcBits = C->getType()->getScalarSizeInBits();
1356   unsigned DstBits = Ty->getScalarSizeInBits();
1357   Instruction::CastOps opcode =
1358     (SrcBits == DstBits ? Instruction::BitCast :
1359      (SrcBits > DstBits ? Instruction::Trunc :
1360       (isSigned ? Instruction::SExt : Instruction::ZExt)));
1361   return getCast(opcode, C, Ty);
1362 }
1363
1364 Constant *ConstantExpr::getFPCast(Constant *C, Type *Ty) {
1365   assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
1366          "Invalid cast");
1367   unsigned SrcBits = C->getType()->getScalarSizeInBits();
1368   unsigned DstBits = Ty->getScalarSizeInBits();
1369   if (SrcBits == DstBits)
1370     return C; // Avoid a useless cast
1371   Instruction::CastOps opcode =
1372     (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt);
1373   return getCast(opcode, C, Ty);
1374 }
1375
1376 Constant *ConstantExpr::getTrunc(Constant *C, Type *Ty) {
1377 #ifndef NDEBUG
1378   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1379   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1380 #endif
1381   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1382   assert(C->getType()->isIntOrIntVectorTy() && "Trunc operand must be integer");
1383   assert(Ty->isIntOrIntVectorTy() && "Trunc produces only integral");
1384   assert(C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1385          "SrcTy must be larger than DestTy for Trunc!");
1386
1387   return getFoldedCast(Instruction::Trunc, C, Ty);
1388 }
1389
1390 Constant *ConstantExpr::getSExt(Constant *C, Type *Ty) {
1391 #ifndef NDEBUG
1392   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1393   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1394 #endif
1395   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1396   assert(C->getType()->isIntOrIntVectorTy() && "SExt operand must be integral");
1397   assert(Ty->isIntOrIntVectorTy() && "SExt produces only integer");
1398   assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1399          "SrcTy must be smaller than DestTy for SExt!");
1400
1401   return getFoldedCast(Instruction::SExt, C, Ty);
1402 }
1403
1404 Constant *ConstantExpr::getZExt(Constant *C, Type *Ty) {
1405 #ifndef NDEBUG
1406   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1407   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1408 #endif
1409   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1410   assert(C->getType()->isIntOrIntVectorTy() && "ZEXt operand must be integral");
1411   assert(Ty->isIntOrIntVectorTy() && "ZExt produces only integer");
1412   assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1413          "SrcTy must be smaller than DestTy for ZExt!");
1414
1415   return getFoldedCast(Instruction::ZExt, C, Ty);
1416 }
1417
1418 Constant *ConstantExpr::getFPTrunc(Constant *C, Type *Ty) {
1419 #ifndef NDEBUG
1420   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1421   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1422 #endif
1423   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1424   assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
1425          C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1426          "This is an illegal floating point truncation!");
1427   return getFoldedCast(Instruction::FPTrunc, C, Ty);
1428 }
1429
1430 Constant *ConstantExpr::getFPExtend(Constant *C, Type *Ty) {
1431 #ifndef NDEBUG
1432   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1433   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1434 #endif
1435   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1436   assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
1437          C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1438          "This is an illegal floating point extension!");
1439   return getFoldedCast(Instruction::FPExt, C, Ty);
1440 }
1441
1442 Constant *ConstantExpr::getUIToFP(Constant *C, Type *Ty) {
1443 #ifndef NDEBUG
1444   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1445   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1446 #endif
1447   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1448   assert(C->getType()->isIntOrIntVectorTy() && Ty->isFPOrFPVectorTy() &&
1449          "This is an illegal uint to floating point cast!");
1450   return getFoldedCast(Instruction::UIToFP, C, Ty);
1451 }
1452
1453 Constant *ConstantExpr::getSIToFP(Constant *C, Type *Ty) {
1454 #ifndef NDEBUG
1455   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1456   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1457 #endif
1458   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1459   assert(C->getType()->isIntOrIntVectorTy() && Ty->isFPOrFPVectorTy() &&
1460          "This is an illegal sint to floating point cast!");
1461   return getFoldedCast(Instruction::SIToFP, C, Ty);
1462 }
1463
1464 Constant *ConstantExpr::getFPToUI(Constant *C, Type *Ty) {
1465 #ifndef NDEBUG
1466   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1467   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1468 #endif
1469   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1470   assert(C->getType()->isFPOrFPVectorTy() && Ty->isIntOrIntVectorTy() &&
1471          "This is an illegal floating point to uint cast!");
1472   return getFoldedCast(Instruction::FPToUI, C, Ty);
1473 }
1474
1475 Constant *ConstantExpr::getFPToSI(Constant *C, Type *Ty) {
1476 #ifndef NDEBUG
1477   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1478   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1479 #endif
1480   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1481   assert(C->getType()->isFPOrFPVectorTy() && Ty->isIntOrIntVectorTy() &&
1482          "This is an illegal floating point to sint cast!");
1483   return getFoldedCast(Instruction::FPToSI, C, Ty);
1484 }
1485
1486 Constant *ConstantExpr::getPtrToInt(Constant *C, Type *DstTy) {
1487   assert(C->getType()->getScalarType()->isPointerTy() &&
1488          "PtrToInt source must be pointer or pointer vector");
1489   assert(DstTy->getScalarType()->isIntegerTy() && 
1490          "PtrToInt destination must be integer or integer vector");
1491   assert(C->getType()->getNumElements() == DstTy->getNumElements() &&
1492     "Invalid cast between a different number of vector elements");
1493   return getFoldedCast(Instruction::PtrToInt, C, DstTy);
1494 }
1495
1496 Constant *ConstantExpr::getIntToPtr(Constant *C, Type *DstTy) {
1497   assert(C->getType()->getScalarType()->isIntegerTy() &&
1498          "IntToPtr source must be integer or integer vector");
1499   assert(DstTy->getScalarType()->isPointerTy() &&
1500          "IntToPtr destination must be a pointer or pointer vector");
1501   assert(C->getType()->getNumElements() == DstTy->getNumElements() &&
1502     "Invalid cast between a different number of vector elements");
1503   return getFoldedCast(Instruction::IntToPtr, C, DstTy);
1504 }
1505
1506 Constant *ConstantExpr::getBitCast(Constant *C, Type *DstTy) {
1507   assert(CastInst::castIsValid(Instruction::BitCast, C, DstTy) &&
1508          "Invalid constantexpr bitcast!");
1509   
1510   // It is common to ask for a bitcast of a value to its own type, handle this
1511   // speedily.
1512   if (C->getType() == DstTy) return C;
1513   
1514   return getFoldedCast(Instruction::BitCast, C, DstTy);
1515 }
1516
1517 Constant *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2,
1518                             unsigned Flags) {
1519   // Check the operands for consistency first.
1520   assert(Opcode >= Instruction::BinaryOpsBegin &&
1521          Opcode <  Instruction::BinaryOpsEnd   &&
1522          "Invalid opcode in binary constant expression");
1523   assert(C1->getType() == C2->getType() &&
1524          "Operand types in binary constant expression should match");
1525   
1526 #ifndef NDEBUG
1527   switch (Opcode) {
1528   case Instruction::Add:
1529   case Instruction::Sub:
1530   case Instruction::Mul:
1531     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1532     assert(C1->getType()->isIntOrIntVectorTy() &&
1533            "Tried to create an integer operation on a non-integer type!");
1534     break;
1535   case Instruction::FAdd:
1536   case Instruction::FSub:
1537   case Instruction::FMul:
1538     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1539     assert(C1->getType()->isFPOrFPVectorTy() &&
1540            "Tried to create a floating-point operation on a "
1541            "non-floating-point type!");
1542     break;
1543   case Instruction::UDiv: 
1544   case Instruction::SDiv: 
1545     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1546     assert(C1->getType()->isIntOrIntVectorTy() &&
1547            "Tried to create an arithmetic operation on a non-arithmetic type!");
1548     break;
1549   case Instruction::FDiv:
1550     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1551     assert(C1->getType()->isFPOrFPVectorTy() &&
1552            "Tried to create an arithmetic operation on a non-arithmetic type!");
1553     break;
1554   case Instruction::URem: 
1555   case Instruction::SRem: 
1556     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1557     assert(C1->getType()->isIntOrIntVectorTy() &&
1558            "Tried to create an arithmetic operation on a non-arithmetic type!");
1559     break;
1560   case Instruction::FRem:
1561     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1562     assert(C1->getType()->isFPOrFPVectorTy() &&
1563            "Tried to create an arithmetic operation on a non-arithmetic type!");
1564     break;
1565   case Instruction::And:
1566   case Instruction::Or:
1567   case Instruction::Xor:
1568     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1569     assert(C1->getType()->isIntOrIntVectorTy() &&
1570            "Tried to create a logical operation on a non-integral type!");
1571     break;
1572   case Instruction::Shl:
1573   case Instruction::LShr:
1574   case Instruction::AShr:
1575     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1576     assert(C1->getType()->isIntOrIntVectorTy() &&
1577            "Tried to create a shift operation on a non-integer type!");
1578     break;
1579   default:
1580     break;
1581   }
1582 #endif
1583
1584   if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1585     return FC;          // Fold a few common cases.
1586   
1587   std::vector<Constant*> argVec(1, C1);
1588   argVec.push_back(C2);
1589   ExprMapKeyType Key(Opcode, argVec, 0, Flags);
1590   
1591   LLVMContextImpl *pImpl = C1->getContext().pImpl;
1592   return pImpl->ExprConstants.getOrCreate(C1->getType(), Key);
1593 }
1594
1595 Constant *ConstantExpr::getSizeOf(Type* Ty) {
1596   // sizeof is implemented as: (i64) gep (Ty*)null, 1
1597   // Note that a non-inbounds gep is used, as null isn't within any object.
1598   Constant *GEPIdx = ConstantInt::get(Type::getInt32Ty(Ty->getContext()), 1);
1599   Constant *GEP = getGetElementPtr(
1600                  Constant::getNullValue(PointerType::getUnqual(Ty)), GEPIdx);
1601   return getPtrToInt(GEP, 
1602                      Type::getInt64Ty(Ty->getContext()));
1603 }
1604
1605 Constant *ConstantExpr::getAlignOf(Type* Ty) {
1606   // alignof is implemented as: (i64) gep ({i1,Ty}*)null, 0, 1
1607   // Note that a non-inbounds gep is used, as null isn't within any object.
1608   Type *AligningTy = 
1609     StructType::get(Type::getInt1Ty(Ty->getContext()), Ty, NULL);
1610   Constant *NullPtr = Constant::getNullValue(AligningTy->getPointerTo());
1611   Constant *Zero = ConstantInt::get(Type::getInt64Ty(Ty->getContext()), 0);
1612   Constant *One = ConstantInt::get(Type::getInt32Ty(Ty->getContext()), 1);
1613   Constant *Indices[2] = { Zero, One };
1614   Constant *GEP = getGetElementPtr(NullPtr, Indices);
1615   return getPtrToInt(GEP,
1616                      Type::getInt64Ty(Ty->getContext()));
1617 }
1618
1619 Constant *ConstantExpr::getOffsetOf(StructType* STy, unsigned FieldNo) {
1620   return getOffsetOf(STy, ConstantInt::get(Type::getInt32Ty(STy->getContext()),
1621                                            FieldNo));
1622 }
1623
1624 Constant *ConstantExpr::getOffsetOf(Type* Ty, Constant *FieldNo) {
1625   // offsetof is implemented as: (i64) gep (Ty*)null, 0, FieldNo
1626   // Note that a non-inbounds gep is used, as null isn't within any object.
1627   Constant *GEPIdx[] = {
1628     ConstantInt::get(Type::getInt64Ty(Ty->getContext()), 0),
1629     FieldNo
1630   };
1631   Constant *GEP = getGetElementPtr(
1632                 Constant::getNullValue(PointerType::getUnqual(Ty)), GEPIdx);
1633   return getPtrToInt(GEP,
1634                      Type::getInt64Ty(Ty->getContext()));
1635 }
1636
1637 Constant *ConstantExpr::getCompare(unsigned short Predicate, 
1638                                    Constant *C1, Constant *C2) {
1639   assert(C1->getType() == C2->getType() && "Op types should be identical!");
1640   
1641   switch (Predicate) {
1642   default: llvm_unreachable("Invalid CmpInst predicate");
1643   case CmpInst::FCMP_FALSE: case CmpInst::FCMP_OEQ: case CmpInst::FCMP_OGT:
1644   case CmpInst::FCMP_OGE:   case CmpInst::FCMP_OLT: case CmpInst::FCMP_OLE:
1645   case CmpInst::FCMP_ONE:   case CmpInst::FCMP_ORD: case CmpInst::FCMP_UNO:
1646   case CmpInst::FCMP_UEQ:   case CmpInst::FCMP_UGT: case CmpInst::FCMP_UGE:
1647   case CmpInst::FCMP_ULT:   case CmpInst::FCMP_ULE: case CmpInst::FCMP_UNE:
1648   case CmpInst::FCMP_TRUE:
1649     return getFCmp(Predicate, C1, C2);
1650     
1651   case CmpInst::ICMP_EQ:  case CmpInst::ICMP_NE:  case CmpInst::ICMP_UGT:
1652   case CmpInst::ICMP_UGE: case CmpInst::ICMP_ULT: case CmpInst::ICMP_ULE:
1653   case CmpInst::ICMP_SGT: case CmpInst::ICMP_SGE: case CmpInst::ICMP_SLT:
1654   case CmpInst::ICMP_SLE:
1655     return getICmp(Predicate, C1, C2);
1656   }
1657 }
1658
1659 Constant *ConstantExpr::getSelect(Constant *C, Constant *V1, Constant *V2) {
1660   assert(!SelectInst::areInvalidOperands(C, V1, V2)&&"Invalid select operands");
1661
1662   if (Constant *SC = ConstantFoldSelectInstruction(C, V1, V2))
1663     return SC;        // Fold common cases
1664
1665   std::vector<Constant*> argVec(3, C);
1666   argVec[1] = V1;
1667   argVec[2] = V2;
1668   ExprMapKeyType Key(Instruction::Select, argVec);
1669   
1670   LLVMContextImpl *pImpl = C->getContext().pImpl;
1671   return pImpl->ExprConstants.getOrCreate(V1->getType(), Key);
1672 }
1673
1674 Constant *ConstantExpr::getGetElementPtr(Constant *C, ArrayRef<Value *> Idxs,
1675                                          bool InBounds) {
1676   if (Constant *FC = ConstantFoldGetElementPtr(C, InBounds, Idxs))
1677     return FC;          // Fold a few common cases.
1678
1679   // Get the result type of the getelementptr!
1680   Type *Ty = GetElementPtrInst::getIndexedType(C->getType(), Idxs);
1681   assert(Ty && "GEP indices invalid!");
1682   unsigned AS = cast<PointerType>(C->getType())->getAddressSpace();
1683   Type *ReqTy = Ty->getPointerTo(AS);
1684   
1685   assert(C->getType()->isPointerTy() &&
1686          "Non-pointer type for constant GetElementPtr expression");
1687   // Look up the constant in the table first to ensure uniqueness
1688   std::vector<Constant*> ArgVec;
1689   ArgVec.reserve(1 + Idxs.size());
1690   ArgVec.push_back(C);
1691   for (unsigned i = 0, e = Idxs.size(); i != e; ++i)
1692     ArgVec.push_back(cast<Constant>(Idxs[i]));
1693   const ExprMapKeyType Key(Instruction::GetElementPtr, ArgVec, 0,
1694                            InBounds ? GEPOperator::IsInBounds : 0);
1695   
1696   LLVMContextImpl *pImpl = C->getContext().pImpl;
1697   return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
1698 }
1699
1700 Constant *
1701 ConstantExpr::getICmp(unsigned short pred, Constant *LHS, Constant *RHS) {
1702   assert(LHS->getType() == RHS->getType());
1703   assert(pred >= ICmpInst::FIRST_ICMP_PREDICATE && 
1704          pred <= ICmpInst::LAST_ICMP_PREDICATE && "Invalid ICmp Predicate");
1705
1706   if (Constant *FC = ConstantFoldCompareInstruction(pred, LHS, RHS))
1707     return FC;          // Fold a few common cases...
1708
1709   // Look up the constant in the table first to ensure uniqueness
1710   std::vector<Constant*> ArgVec;
1711   ArgVec.push_back(LHS);
1712   ArgVec.push_back(RHS);
1713   // Get the key type with both the opcode and predicate
1714   const ExprMapKeyType Key(Instruction::ICmp, ArgVec, pred);
1715
1716   Type *ResultTy = Type::getInt1Ty(LHS->getContext());
1717   if (VectorType *VT = dyn_cast<VectorType>(LHS->getType()))
1718     ResultTy = VectorType::get(ResultTy, VT->getNumElements());
1719
1720   LLVMContextImpl *pImpl = LHS->getType()->getContext().pImpl;
1721   return pImpl->ExprConstants.getOrCreate(ResultTy, Key);
1722 }
1723
1724 Constant *
1725 ConstantExpr::getFCmp(unsigned short pred, Constant *LHS, Constant *RHS) {
1726   assert(LHS->getType() == RHS->getType());
1727   assert(pred <= FCmpInst::LAST_FCMP_PREDICATE && "Invalid FCmp Predicate");
1728
1729   if (Constant *FC = ConstantFoldCompareInstruction(pred, LHS, RHS))
1730     return FC;          // Fold a few common cases...
1731
1732   // Look up the constant in the table first to ensure uniqueness
1733   std::vector<Constant*> ArgVec;
1734   ArgVec.push_back(LHS);
1735   ArgVec.push_back(RHS);
1736   // Get the key type with both the opcode and predicate
1737   const ExprMapKeyType Key(Instruction::FCmp, ArgVec, pred);
1738
1739   Type *ResultTy = Type::getInt1Ty(LHS->getContext());
1740   if (VectorType *VT = dyn_cast<VectorType>(LHS->getType()))
1741     ResultTy = VectorType::get(ResultTy, VT->getNumElements());
1742
1743   LLVMContextImpl *pImpl = LHS->getType()->getContext().pImpl;
1744   return pImpl->ExprConstants.getOrCreate(ResultTy, Key);
1745 }
1746
1747 Constant *ConstantExpr::getExtractElement(Constant *Val, Constant *Idx) {
1748   assert(Val->getType()->isVectorTy() &&
1749          "Tried to create extractelement operation on non-vector type!");
1750   assert(Idx->getType()->isIntegerTy(32) &&
1751          "Extractelement index must be i32 type!");
1752   
1753   if (Constant *FC = ConstantFoldExtractElementInstruction(Val, Idx))
1754     return FC;          // Fold a few common cases.
1755   
1756   // Look up the constant in the table first to ensure uniqueness
1757   std::vector<Constant*> ArgVec(1, Val);
1758   ArgVec.push_back(Idx);
1759   const ExprMapKeyType Key(Instruction::ExtractElement,ArgVec);
1760   
1761   LLVMContextImpl *pImpl = Val->getContext().pImpl;
1762   Type *ReqTy = cast<VectorType>(Val->getType())->getElementType();
1763   return pImpl->ExprConstants.getOrCreate(ReqTy, Key);
1764 }
1765
1766 Constant *ConstantExpr::getInsertElement(Constant *Val, Constant *Elt, 
1767                                          Constant *Idx) {
1768   assert(Val->getType()->isVectorTy() &&
1769          "Tried to create insertelement operation on non-vector type!");
1770   assert(Elt->getType() == cast<VectorType>(Val->getType())->getElementType()
1771          && "Insertelement types must match!");
1772   assert(Idx->getType()->isIntegerTy(32) &&
1773          "Insertelement index must be i32 type!");
1774
1775   if (Constant *FC = ConstantFoldInsertElementInstruction(Val, Elt, Idx))
1776     return FC;          // Fold a few common cases.
1777   // Look up the constant in the table first to ensure uniqueness
1778   std::vector<Constant*> ArgVec(1, Val);
1779   ArgVec.push_back(Elt);
1780   ArgVec.push_back(Idx);
1781   const ExprMapKeyType Key(Instruction::InsertElement,ArgVec);
1782   
1783   LLVMContextImpl *pImpl = Val->getContext().pImpl;
1784   return pImpl->ExprConstants.getOrCreate(Val->getType(), Key);
1785 }
1786
1787 Constant *ConstantExpr::getShuffleVector(Constant *V1, Constant *V2, 
1788                                          Constant *Mask) {
1789   assert(ShuffleVectorInst::isValidOperands(V1, V2, Mask) &&
1790          "Invalid shuffle vector constant expr operands!");
1791
1792   if (Constant *FC = ConstantFoldShuffleVectorInstruction(V1, V2, Mask))
1793     return FC;          // Fold a few common cases.
1794
1795   unsigned NElts = cast<VectorType>(Mask->getType())->getNumElements();
1796   Type *EltTy = cast<VectorType>(V1->getType())->getElementType();
1797   Type *ShufTy = VectorType::get(EltTy, NElts);
1798
1799   // Look up the constant in the table first to ensure uniqueness
1800   std::vector<Constant*> ArgVec(1, V1);
1801   ArgVec.push_back(V2);
1802   ArgVec.push_back(Mask);
1803   const ExprMapKeyType Key(Instruction::ShuffleVector,ArgVec);
1804   
1805   LLVMContextImpl *pImpl = ShufTy->getContext().pImpl;
1806   return pImpl->ExprConstants.getOrCreate(ShufTy, Key);
1807 }
1808
1809 Constant *ConstantExpr::getInsertValue(Constant *Agg, Constant *Val,
1810                                        ArrayRef<unsigned> Idxs) {
1811   assert(ExtractValueInst::getIndexedType(Agg->getType(),
1812                                           Idxs) == Val->getType() &&
1813          "insertvalue indices invalid!");
1814   assert(Agg->getType()->isFirstClassType() &&
1815          "Non-first-class type for constant insertvalue expression");
1816   Constant *FC = ConstantFoldInsertValueInstruction(Agg, Val, Idxs);
1817   assert(FC && "insertvalue constant expr couldn't be folded!");
1818   return FC;
1819 }
1820
1821 Constant *ConstantExpr::getExtractValue(Constant *Agg,
1822                                         ArrayRef<unsigned> Idxs) {
1823   assert(Agg->getType()->isFirstClassType() &&
1824          "Tried to create extractelement operation on non-first-class type!");
1825
1826   Type *ReqTy = ExtractValueInst::getIndexedType(Agg->getType(), Idxs);
1827   (void)ReqTy;
1828   assert(ReqTy && "extractvalue indices invalid!");
1829   
1830   assert(Agg->getType()->isFirstClassType() &&
1831          "Non-first-class type for constant extractvalue expression");
1832   Constant *FC = ConstantFoldExtractValueInstruction(Agg, Idxs);
1833   assert(FC && "ExtractValue constant expr couldn't be folded!");
1834   return FC;
1835 }
1836
1837 Constant *ConstantExpr::getNeg(Constant *C, bool HasNUW, bool HasNSW) {
1838   assert(C->getType()->isIntOrIntVectorTy() &&
1839          "Cannot NEG a nonintegral value!");
1840   return getSub(ConstantFP::getZeroValueForNegation(C->getType()),
1841                 C, HasNUW, HasNSW);
1842 }
1843
1844 Constant *ConstantExpr::getFNeg(Constant *C) {
1845   assert(C->getType()->isFPOrFPVectorTy() &&
1846          "Cannot FNEG a non-floating-point value!");
1847   return getFSub(ConstantFP::getZeroValueForNegation(C->getType()), C);
1848 }
1849
1850 Constant *ConstantExpr::getNot(Constant *C) {
1851   assert(C->getType()->isIntOrIntVectorTy() &&
1852          "Cannot NOT a nonintegral value!");
1853   return get(Instruction::Xor, C, Constant::getAllOnesValue(C->getType()));
1854 }
1855
1856 Constant *ConstantExpr::getAdd(Constant *C1, Constant *C2,
1857                                bool HasNUW, bool HasNSW) {
1858   unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
1859                    (HasNSW ? OverflowingBinaryOperator::NoSignedWrap   : 0);
1860   return get(Instruction::Add, C1, C2, Flags);
1861 }
1862
1863 Constant *ConstantExpr::getFAdd(Constant *C1, Constant *C2) {
1864   return get(Instruction::FAdd, C1, C2);
1865 }
1866
1867 Constant *ConstantExpr::getSub(Constant *C1, Constant *C2,
1868                                bool HasNUW, bool HasNSW) {
1869   unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
1870                    (HasNSW ? OverflowingBinaryOperator::NoSignedWrap   : 0);
1871   return get(Instruction::Sub, C1, C2, Flags);
1872 }
1873
1874 Constant *ConstantExpr::getFSub(Constant *C1, Constant *C2) {
1875   return get(Instruction::FSub, C1, C2);
1876 }
1877
1878 Constant *ConstantExpr::getMul(Constant *C1, Constant *C2,
1879                                bool HasNUW, bool HasNSW) {
1880   unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
1881                    (HasNSW ? OverflowingBinaryOperator::NoSignedWrap   : 0);
1882   return get(Instruction::Mul, C1, C2, Flags);
1883 }
1884
1885 Constant *ConstantExpr::getFMul(Constant *C1, Constant *C2) {
1886   return get(Instruction::FMul, C1, C2);
1887 }
1888
1889 Constant *ConstantExpr::getUDiv(Constant *C1, Constant *C2, bool isExact) {
1890   return get(Instruction::UDiv, C1, C2,
1891              isExact ? PossiblyExactOperator::IsExact : 0);
1892 }
1893
1894 Constant *ConstantExpr::getSDiv(Constant *C1, Constant *C2, bool isExact) {
1895   return get(Instruction::SDiv, C1, C2,
1896              isExact ? PossiblyExactOperator::IsExact : 0);
1897 }
1898
1899 Constant *ConstantExpr::getFDiv(Constant *C1, Constant *C2) {
1900   return get(Instruction::FDiv, C1, C2);
1901 }
1902
1903 Constant *ConstantExpr::getURem(Constant *C1, Constant *C2) {
1904   return get(Instruction::URem, C1, C2);
1905 }
1906
1907 Constant *ConstantExpr::getSRem(Constant *C1, Constant *C2) {
1908   return get(Instruction::SRem, C1, C2);
1909 }
1910
1911 Constant *ConstantExpr::getFRem(Constant *C1, Constant *C2) {
1912   return get(Instruction::FRem, C1, C2);
1913 }
1914
1915 Constant *ConstantExpr::getAnd(Constant *C1, Constant *C2) {
1916   return get(Instruction::And, C1, C2);
1917 }
1918
1919 Constant *ConstantExpr::getOr(Constant *C1, Constant *C2) {
1920   return get(Instruction::Or, C1, C2);
1921 }
1922
1923 Constant *ConstantExpr::getXor(Constant *C1, Constant *C2) {
1924   return get(Instruction::Xor, C1, C2);
1925 }
1926
1927 Constant *ConstantExpr::getShl(Constant *C1, Constant *C2,
1928                                bool HasNUW, bool HasNSW) {
1929   unsigned Flags = (HasNUW ? OverflowingBinaryOperator::NoUnsignedWrap : 0) |
1930                    (HasNSW ? OverflowingBinaryOperator::NoSignedWrap   : 0);
1931   return get(Instruction::Shl, C1, C2, Flags);
1932 }
1933
1934 Constant *ConstantExpr::getLShr(Constant *C1, Constant *C2, bool isExact) {
1935   return get(Instruction::LShr, C1, C2,
1936              isExact ? PossiblyExactOperator::IsExact : 0);
1937 }
1938
1939 Constant *ConstantExpr::getAShr(Constant *C1, Constant *C2, bool isExact) {
1940   return get(Instruction::AShr, C1, C2,
1941              isExact ? PossiblyExactOperator::IsExact : 0);
1942 }
1943
1944 // destroyConstant - Remove the constant from the constant table...
1945 //
1946 void ConstantExpr::destroyConstant() {
1947   getType()->getContext().pImpl->ExprConstants.remove(this);
1948   destroyConstantImpl();
1949 }
1950
1951 const char *ConstantExpr::getOpcodeName() const {
1952   return Instruction::getOpcodeName(getOpcode());
1953 }
1954
1955
1956
1957 GetElementPtrConstantExpr::
1958 GetElementPtrConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
1959                           Type *DestTy)
1960   : ConstantExpr(DestTy, Instruction::GetElementPtr,
1961                  OperandTraits<GetElementPtrConstantExpr>::op_end(this)
1962                  - (IdxList.size()+1), IdxList.size()+1) {
1963   OperandList[0] = C;
1964   for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
1965     OperandList[i+1] = IdxList[i];
1966 }
1967
1968 //===----------------------------------------------------------------------===//
1969 //                       ConstantData* implementations
1970
1971 void ConstantDataArray::anchor() {}
1972 void ConstantDataVector::anchor() {}
1973
1974 /// getElementType - Return the element type of the array/vector.
1975 Type *ConstantDataSequential::getElementType() const {
1976   return getType()->getElementType();
1977 }
1978
1979 /// isElementTypeCompatible - Return true if a ConstantDataSequential can be
1980 /// formed with a vector or array of the specified element type.
1981 /// ConstantDataArray only works with normal float and int types that are
1982 /// stored densely in memory, not with things like i42 or x86_f80.
1983 bool ConstantDataSequential::isElementTypeCompatible(const Type *Ty) {
1984   if (Ty->isFloatTy() || Ty->isDoubleTy()) return true;
1985   if (const IntegerType *IT = dyn_cast<IntegerType>(Ty)) {
1986     switch (IT->getBitWidth()) {
1987     case 8:
1988     case 16:
1989     case 32:
1990     case 64:
1991       return true;
1992     default: break;
1993     }
1994   }
1995   return false;
1996 }
1997
1998 /// getElementByteSize - Return the size in bytes of the elements in the data.
1999 uint64_t ConstantDataSequential::getElementByteSize() const {
2000   return getElementType()->getPrimitiveSizeInBits()/8;
2001 }
2002
2003 /// getElementPointer - Return the start of the specified element.
2004 const char *ConstantDataSequential::getElementPointer(unsigned Elt) const {
2005   assert(Elt < getElementType()->getNumElements() && "Invalid Elt");
2006   return DataElements+Elt*getElementByteSize();
2007 }
2008
2009
2010 /// isAllZeros - return true if the array is empty or all zeros.
2011 static bool isAllZeros(StringRef Arr) {
2012   for (StringRef::iterator I = Arr.begin(), E = Arr.end(); I != E; ++I)
2013     if (*I != 0)
2014       return false;
2015   return true;
2016 }
2017
2018 /// getImpl - This is the underlying implementation of all of the
2019 /// ConstantDataSequential::get methods.  They all thunk down to here, providing
2020 /// the correct element type.  We take the bytes in as an StringRef because
2021 /// we *want* an underlying "char*" to avoid TBAA type punning violations.
2022 Constant *ConstantDataSequential::getImpl(StringRef Elements, Type *Ty) {
2023   assert(isElementTypeCompatible(cast<SequentialType>(Ty)->getElementType()));
2024   // If the elements are all zero, return a CAZ, which is more dense.
2025   if (isAllZeros(Elements))
2026     return ConstantAggregateZero::get(Ty);
2027
2028   // Do a lookup to see if we have already formed one of these.
2029   StringMap<ConstantDataSequential*>::MapEntryTy &Slot =
2030     Ty->getContext().pImpl->CDSConstants.GetOrCreateValue(Elements);
2031   
2032   // The bucket can point to a linked list of different CDS's that have the same
2033   // body but different types.  For example, 0,0,0,1 could be a 4 element array
2034   // of i8, or a 1-element array of i32.  They'll both end up in the same
2035   /// StringMap bucket, linked up by their Next pointers.  Walk the list.
2036   ConstantDataSequential **Entry = &Slot.getValue();
2037   for (ConstantDataSequential *Node = *Entry; Node != 0;
2038        Entry = &Node->Next, Node = *Entry)
2039     if (Node->getType() == Ty)
2040       return Node;
2041   
2042   // Okay, we didn't get a hit.  Create a node of the right class, link it in,
2043   // and return it.
2044   if (isa<ArrayType>(Ty))
2045     return *Entry = new ConstantDataArray(Ty, Slot.getKeyData());
2046
2047   assert(isa<VectorType>(Ty));
2048   return *Entry = new ConstantDataVector(Ty, Slot.getKeyData());
2049 }
2050
2051 void ConstantDataSequential::destroyConstant() {
2052   uint64_t ByteSize = getElementByteSize() * getElementType()->getNumElements();
2053   
2054   // Remove the constant from the StringMap.
2055   StringMap<ConstantDataSequential*> &CDSConstants = 
2056     getType()->getContext().pImpl->CDSConstants;
2057   
2058   StringMap<ConstantDataSequential*>::iterator Slot =
2059     CDSConstants.find(StringRef(DataElements, ByteSize));
2060
2061   assert(Slot != CDSConstants.end() && "CDS not found in uniquing table");
2062
2063   ConstantDataSequential **Entry = &Slot->getValue();
2064
2065   // Remove the entry from the hash table.
2066   if ((*Entry)->Next == 0) {
2067     // If there is only one value in the bucket (common case) it must be this
2068     // entry, and removing the entry should remove the bucket completely.
2069     assert((*Entry) == this && "Hash mismatch in ConstantDataSequential");
2070     getContext().pImpl->CDSConstants.erase(Slot);
2071   } else {
2072     // Otherwise, there are multiple entries linked off the bucket, unlink the 
2073     // node we care about but keep the bucket around.
2074     for (ConstantDataSequential *Node = *Entry; ;
2075          Entry = &Node->Next, Node = *Entry) {
2076       assert(Node && "Didn't find entry in its uniquing hash table!");
2077       // If we found our entry, unlink it from the list and we're done.
2078       if (Node == this) {
2079         *Entry = Node->Next;
2080         break;
2081       }
2082     }
2083   }
2084   
2085   // If we were part of a list, make sure that we don't delete the list that is
2086   // still owned by the uniquing map.
2087   Next = 0;
2088   
2089   // Finally, actually delete it.
2090   destroyConstantImpl();
2091 }
2092
2093 /// get() constructors - Return a constant with array type with an element
2094 /// count and element type matching the ArrayRef passed in.  Note that this
2095 /// can return a ConstantAggregateZero object.
2096 Constant *ConstantDataArray::get(ArrayRef<uint8_t> Elts, LLVMContext &Context) {
2097   Type *Ty = ArrayType::get(Type::getInt8Ty(Context), Elts.size());
2098   return getImpl(StringRef((char*)Elts.data(), Elts.size()*1), Ty);
2099 }
2100 Constant *ConstantDataArray::get(ArrayRef<uint16_t> Elts, LLVMContext &Context){
2101   Type *Ty = ArrayType::get(Type::getInt16Ty(Context), Elts.size());
2102   return getImpl(StringRef((char*)Elts.data(), Elts.size()*2), Ty);
2103 }
2104 Constant *ConstantDataArray::get(ArrayRef<uint32_t> Elts, LLVMContext &Context){
2105   Type *Ty = ArrayType::get(Type::getInt32Ty(Context), Elts.size());
2106   return getImpl(StringRef((char*)Elts.data(), Elts.size()*4), Ty);
2107 }
2108 Constant *ConstantDataArray::get(ArrayRef<uint64_t> Elts, LLVMContext &Context){
2109   Type *Ty = ArrayType::get(Type::getInt64Ty(Context), Elts.size());
2110   return getImpl(StringRef((char*)Elts.data(), Elts.size()*8), Ty);
2111 }
2112 Constant *ConstantDataArray::get(ArrayRef<float> Elts, LLVMContext &Context) {
2113   Type *Ty = ArrayType::get(Type::getFloatTy(Context), Elts.size());
2114   return getImpl(StringRef((char*)Elts.data(), Elts.size()*4), Ty);
2115 }
2116 Constant *ConstantDataArray::get(ArrayRef<double> Elts, LLVMContext &Context) {
2117   Type *Ty = ArrayType::get(Type::getDoubleTy(Context), Elts.size());
2118   return getImpl(StringRef((char*)Elts.data(), Elts.size()*8), Ty);
2119 }
2120
2121
2122 /// get() constructors - Return a constant with vector type with an element
2123 /// count and element type matching the ArrayRef passed in.  Note that this
2124 /// can return a ConstantAggregateZero object.
2125 Constant *ConstantDataVector::get(ArrayRef<uint8_t> Elts, LLVMContext &Context) {
2126   Type *Ty = VectorType::get(Type::getInt8Ty(Context), Elts.size());
2127   return getImpl(StringRef((char*)Elts.data(), Elts.size()*1), Ty);
2128 }
2129 Constant *ConstantDataVector::get(ArrayRef<uint16_t> Elts, LLVMContext &Context){
2130   Type *Ty = VectorType::get(Type::getInt16Ty(Context), Elts.size());
2131   return getImpl(StringRef((char*)Elts.data(), Elts.size()*2), Ty);
2132 }
2133 Constant *ConstantDataVector::get(ArrayRef<uint32_t> Elts, LLVMContext &Context){
2134   Type *Ty = VectorType::get(Type::getInt32Ty(Context), Elts.size());
2135   return getImpl(StringRef((char*)Elts.data(), Elts.size()*4), Ty);
2136 }
2137 Constant *ConstantDataVector::get(ArrayRef<uint64_t> Elts, LLVMContext &Context){
2138   Type *Ty = VectorType::get(Type::getInt64Ty(Context), Elts.size());
2139   return getImpl(StringRef((char*)Elts.data(), Elts.size()*8), Ty);
2140 }
2141 Constant *ConstantDataVector::get(ArrayRef<float> Elts, LLVMContext &Context) {
2142   Type *Ty = VectorType::get(Type::getFloatTy(Context), Elts.size());
2143   return getImpl(StringRef((char*)Elts.data(), Elts.size()*4), Ty);
2144 }
2145 Constant *ConstantDataVector::get(ArrayRef<double> Elts, LLVMContext &Context) {
2146   Type *Ty = VectorType::get(Type::getDoubleTy(Context), Elts.size());
2147   return getImpl(StringRef((char*)Elts.data(), Elts.size()*8), Ty);
2148 }
2149
2150 /// getElementAsInteger - If this is a sequential container of integers (of
2151 /// any size), return the specified element in the low bits of a uint64_t.
2152 uint64_t ConstantDataSequential::getElementAsInteger(unsigned Elt) const {
2153   assert(isa<IntegerType>(getElementType()) &&
2154          "Accessor can only be used when element is an integer");
2155   const char *EltPtr = getElementPointer(Elt);
2156   
2157   // The data is stored in host byte order, make sure to cast back to the right
2158   // type to load with the right endianness.
2159   switch (cast<IntegerType>(getElementType())->getBitWidth()) {
2160   default: assert(0 && "Invalid bitwidth for CDS");
2161   case 8:  return *(uint8_t*)EltPtr;
2162   case 16: return *(uint16_t*)EltPtr;
2163   case 32: return *(uint32_t*)EltPtr;
2164   case 64: return *(uint64_t*)EltPtr;
2165   }
2166 }
2167
2168 /// getElementAsAPFloat - If this is a sequential container of floating point
2169 /// type, return the specified element as an APFloat.
2170 APFloat ConstantDataSequential::getElementAsAPFloat(unsigned Elt) const {
2171   const char *EltPtr = getElementPointer(Elt);
2172
2173   switch (getElementType()->getTypeID()) {
2174   default: assert("Accessor can only be used when element is float/double!");
2175   case Type::FloatTyID: return APFloat(*(float*)EltPtr);
2176   case Type::DoubleTyID: return APFloat(*(double*)EltPtr);
2177   }
2178 }
2179
2180 /// getElementAsFloat - If this is an sequential container of floats, return
2181 /// the specified element as a float.
2182 float ConstantDataSequential::getElementAsFloat(unsigned Elt) const {
2183   assert(getElementType()->isFloatTy() &&
2184          "Accessor can only be used when element is a 'float'");
2185   return *(float*)getElementPointer(Elt);
2186 }
2187
2188 /// getElementAsDouble - If this is an sequential container of doubles, return
2189 /// the specified element as a float.
2190 double ConstantDataSequential::getElementAsDouble(unsigned Elt) const {
2191   assert(getElementType()->isDoubleTy() &&
2192          "Accessor can only be used when element is a 'float'");
2193   return *(double*)getElementPointer(Elt);
2194 }
2195
2196 /// getElementAsConstant - Return a Constant for a specified index's element.
2197 /// Note that this has to compute a new constant to return, so it isn't as
2198 /// efficient as getElementAsInteger/Float/Double.
2199 Constant *ConstantDataSequential::getElementAsConstant(unsigned Elt) const {
2200   if (getElementType()->isFloatTy() || getElementType()->isDoubleTy())
2201     return ConstantFP::get(getContext(), getElementAsAPFloat(Elt));
2202   
2203   return ConstantInt::get(getElementType(), getElementAsInteger(Elt));
2204 }
2205
2206
2207
2208
2209 //===----------------------------------------------------------------------===//
2210 //                replaceUsesOfWithOnConstant implementations
2211
2212 /// replaceUsesOfWithOnConstant - Update this constant array to change uses of
2213 /// 'From' to be uses of 'To'.  This must update the uniquing data structures
2214 /// etc.
2215 ///
2216 /// Note that we intentionally replace all uses of From with To here.  Consider
2217 /// a large array that uses 'From' 1000 times.  By handling this case all here,
2218 /// ConstantArray::replaceUsesOfWithOnConstant is only invoked once, and that
2219 /// single invocation handles all 1000 uses.  Handling them one at a time would
2220 /// work, but would be really slow because it would have to unique each updated
2221 /// array instance.
2222 ///
2223 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
2224                                                 Use *U) {
2225   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2226   Constant *ToC = cast<Constant>(To);
2227
2228   LLVMContextImpl *pImpl = getType()->getContext().pImpl;
2229
2230   std::pair<LLVMContextImpl::ArrayConstantsTy::MapKey, ConstantArray*> Lookup;
2231   Lookup.first.first = cast<ArrayType>(getType());
2232   Lookup.second = this;
2233
2234   std::vector<Constant*> &Values = Lookup.first.second;
2235   Values.reserve(getNumOperands());  // Build replacement array.
2236
2237   // Fill values with the modified operands of the constant array.  Also, 
2238   // compute whether this turns into an all-zeros array.
2239   bool isAllZeros = false;
2240   unsigned NumUpdated = 0;
2241   if (!ToC->isNullValue()) {
2242     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2243       Constant *Val = cast<Constant>(O->get());
2244       if (Val == From) {
2245         Val = ToC;
2246         ++NumUpdated;
2247       }
2248       Values.push_back(Val);
2249     }
2250   } else {
2251     isAllZeros = true;
2252     for (Use *O = OperandList, *E = OperandList+getNumOperands();O != E; ++O) {
2253       Constant *Val = cast<Constant>(O->get());
2254       if (Val == From) {
2255         Val = ToC;
2256         ++NumUpdated;
2257       }
2258       Values.push_back(Val);
2259       if (isAllZeros) isAllZeros = Val->isNullValue();
2260     }
2261   }
2262   
2263   Constant *Replacement = 0;
2264   if (isAllZeros) {
2265     Replacement = ConstantAggregateZero::get(getType());
2266   } else {
2267     // Check to see if we have this array type already.
2268     bool Exists;
2269     LLVMContextImpl::ArrayConstantsTy::MapTy::iterator I =
2270       pImpl->ArrayConstants.InsertOrGetItem(Lookup, Exists);
2271     
2272     if (Exists) {
2273       Replacement = I->second;
2274     } else {
2275       // Okay, the new shape doesn't exist in the system yet.  Instead of
2276       // creating a new constant array, inserting it, replaceallusesof'ing the
2277       // old with the new, then deleting the old... just update the current one
2278       // in place!
2279       pImpl->ArrayConstants.MoveConstantToNewSlot(this, I);
2280       
2281       // Update to the new value.  Optimize for the case when we have a single
2282       // operand that we're changing, but handle bulk updates efficiently.
2283       if (NumUpdated == 1) {
2284         unsigned OperandToUpdate = U - OperandList;
2285         assert(getOperand(OperandToUpdate) == From &&
2286                "ReplaceAllUsesWith broken!");
2287         setOperand(OperandToUpdate, ToC);
2288       } else {
2289         for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2290           if (getOperand(i) == From)
2291             setOperand(i, ToC);
2292       }
2293       return;
2294     }
2295   }
2296  
2297   // Otherwise, I do need to replace this with an existing value.
2298   assert(Replacement != this && "I didn't contain From!");
2299   
2300   // Everyone using this now uses the replacement.
2301   replaceAllUsesWith(Replacement);
2302   
2303   // Delete the old constant!
2304   destroyConstant();
2305 }
2306
2307 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
2308                                                  Use *U) {
2309   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2310   Constant *ToC = cast<Constant>(To);
2311
2312   unsigned OperandToUpdate = U-OperandList;
2313   assert(getOperand(OperandToUpdate) == From && "ReplaceAllUsesWith broken!");
2314
2315   std::pair<LLVMContextImpl::StructConstantsTy::MapKey, ConstantStruct*> Lookup;
2316   Lookup.first.first = cast<StructType>(getType());
2317   Lookup.second = this;
2318   std::vector<Constant*> &Values = Lookup.first.second;
2319   Values.reserve(getNumOperands());  // Build replacement struct.
2320   
2321   
2322   // Fill values with the modified operands of the constant struct.  Also, 
2323   // compute whether this turns into an all-zeros struct.
2324   bool isAllZeros = false;
2325   if (!ToC->isNullValue()) {
2326     for (Use *O = OperandList, *E = OperandList + getNumOperands(); O != E; ++O)
2327       Values.push_back(cast<Constant>(O->get()));
2328   } else {
2329     isAllZeros = true;
2330     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2331       Constant *Val = cast<Constant>(O->get());
2332       Values.push_back(Val);
2333       if (isAllZeros) isAllZeros = Val->isNullValue();
2334     }
2335   }
2336   Values[OperandToUpdate] = ToC;
2337   
2338   LLVMContextImpl *pImpl = getContext().pImpl;
2339   
2340   Constant *Replacement = 0;
2341   if (isAllZeros) {
2342     Replacement = ConstantAggregateZero::get(getType());
2343   } else {
2344     // Check to see if we have this struct type already.
2345     bool Exists;
2346     LLVMContextImpl::StructConstantsTy::MapTy::iterator I =
2347       pImpl->StructConstants.InsertOrGetItem(Lookup, Exists);
2348     
2349     if (Exists) {
2350       Replacement = I->second;
2351     } else {
2352       // Okay, the new shape doesn't exist in the system yet.  Instead of
2353       // creating a new constant struct, inserting it, replaceallusesof'ing the
2354       // old with the new, then deleting the old... just update the current one
2355       // in place!
2356       pImpl->StructConstants.MoveConstantToNewSlot(this, I);
2357       
2358       // Update to the new value.
2359       setOperand(OperandToUpdate, ToC);
2360       return;
2361     }
2362   }
2363   
2364   assert(Replacement != this && "I didn't contain From!");
2365   
2366   // Everyone using this now uses the replacement.
2367   replaceAllUsesWith(Replacement);
2368   
2369   // Delete the old constant!
2370   destroyConstant();
2371 }
2372
2373 void ConstantVector::replaceUsesOfWithOnConstant(Value *From, Value *To,
2374                                                  Use *U) {
2375   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2376   
2377   std::vector<Constant*> Values;
2378   Values.reserve(getNumOperands());  // Build replacement array...
2379   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
2380     Constant *Val = getOperand(i);
2381     if (Val == From) Val = cast<Constant>(To);
2382     Values.push_back(Val);
2383   }
2384   
2385   Constant *Replacement = get(Values);
2386   assert(Replacement != this && "I didn't contain From!");
2387   
2388   // Everyone using this now uses the replacement.
2389   replaceAllUsesWith(Replacement);
2390   
2391   // Delete the old constant!
2392   destroyConstant();
2393 }
2394
2395 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
2396                                                Use *U) {
2397   assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
2398   Constant *To = cast<Constant>(ToV);
2399   
2400   Constant *Replacement = 0;
2401   if (getOpcode() == Instruction::GetElementPtr) {
2402     SmallVector<Constant*, 8> Indices;
2403     Constant *Pointer = getOperand(0);
2404     Indices.reserve(getNumOperands()-1);
2405     if (Pointer == From) Pointer = To;
2406     
2407     for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
2408       Constant *Val = getOperand(i);
2409       if (Val == From) Val = To;
2410       Indices.push_back(Val);
2411     }
2412     Replacement = ConstantExpr::getGetElementPtr(Pointer, Indices,
2413                                          cast<GEPOperator>(this)->isInBounds());
2414   } else if (getOpcode() == Instruction::ExtractValue) {
2415     Constant *Agg = getOperand(0);
2416     if (Agg == From) Agg = To;
2417     
2418     ArrayRef<unsigned> Indices = getIndices();
2419     Replacement = ConstantExpr::getExtractValue(Agg, Indices);
2420   } else if (getOpcode() == Instruction::InsertValue) {
2421     Constant *Agg = getOperand(0);
2422     Constant *Val = getOperand(1);
2423     if (Agg == From) Agg = To;
2424     if (Val == From) Val = To;
2425     
2426     ArrayRef<unsigned> Indices = getIndices();
2427     Replacement = ConstantExpr::getInsertValue(Agg, Val, Indices);
2428   } else if (isCast()) {
2429     assert(getOperand(0) == From && "Cast only has one use!");
2430     Replacement = ConstantExpr::getCast(getOpcode(), To, getType());
2431   } else if (getOpcode() == Instruction::Select) {
2432     Constant *C1 = getOperand(0);
2433     Constant *C2 = getOperand(1);
2434     Constant *C3 = getOperand(2);
2435     if (C1 == From) C1 = To;
2436     if (C2 == From) C2 = To;
2437     if (C3 == From) C3 = To;
2438     Replacement = ConstantExpr::getSelect(C1, C2, C3);
2439   } else if (getOpcode() == Instruction::ExtractElement) {
2440     Constant *C1 = getOperand(0);
2441     Constant *C2 = getOperand(1);
2442     if (C1 == From) C1 = To;
2443     if (C2 == From) C2 = To;
2444     Replacement = ConstantExpr::getExtractElement(C1, C2);
2445   } else if (getOpcode() == Instruction::InsertElement) {
2446     Constant *C1 = getOperand(0);
2447     Constant *C2 = getOperand(1);
2448     Constant *C3 = getOperand(1);
2449     if (C1 == From) C1 = To;
2450     if (C2 == From) C2 = To;
2451     if (C3 == From) C3 = To;
2452     Replacement = ConstantExpr::getInsertElement(C1, C2, C3);
2453   } else if (getOpcode() == Instruction::ShuffleVector) {
2454     Constant *C1 = getOperand(0);
2455     Constant *C2 = getOperand(1);
2456     Constant *C3 = getOperand(2);
2457     if (C1 == From) C1 = To;
2458     if (C2 == From) C2 = To;
2459     if (C3 == From) C3 = To;
2460     Replacement = ConstantExpr::getShuffleVector(C1, C2, C3);
2461   } else if (isCompare()) {
2462     Constant *C1 = getOperand(0);
2463     Constant *C2 = getOperand(1);
2464     if (C1 == From) C1 = To;
2465     if (C2 == From) C2 = To;
2466     if (getOpcode() == Instruction::ICmp)
2467       Replacement = ConstantExpr::getICmp(getPredicate(), C1, C2);
2468     else {
2469       assert(getOpcode() == Instruction::FCmp);
2470       Replacement = ConstantExpr::getFCmp(getPredicate(), C1, C2);
2471     }
2472   } else if (getNumOperands() == 2) {
2473     Constant *C1 = getOperand(0);
2474     Constant *C2 = getOperand(1);
2475     if (C1 == From) C1 = To;
2476     if (C2 == From) C2 = To;
2477     Replacement = ConstantExpr::get(getOpcode(), C1, C2, SubclassOptionalData);
2478   } else {
2479     llvm_unreachable("Unknown ConstantExpr type!");
2480   }
2481   
2482   assert(Replacement != this && "I didn't contain From!");
2483   
2484   // Everyone using this now uses the replacement.
2485   replaceAllUsesWith(Replacement);
2486   
2487   // Delete the old constant!
2488   destroyConstant();
2489 }