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