1 //===-- Constants.cpp - Implement Constant nodes --------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Constant* classes...
12 //===----------------------------------------------------------------------===//
14 #include "LLVMContextImpl.h"
15 #include "llvm/Constants.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/System/Mutex.h"
31 #include "llvm/System/RWMutex.h"
32 #include "llvm/System/Threading.h"
33 #include "llvm/ADT/DenseMap.h"
34 #include "llvm/ADT/SmallVector.h"
39 //===----------------------------------------------------------------------===//
41 //===----------------------------------------------------------------------===//
43 // Becomes a no-op when multithreading is disabled.
44 ManagedStatic<sys::SmartRWMutex<true> > ConstantsLock;
46 void Constant::destroyConstantImpl() {
47 // When a Constant is destroyed, there may be lingering
48 // references to the constant by other constants in the constant pool. These
49 // constants are implicitly dependent on the module that is being deleted,
50 // but they don't know that. Because we only find out when the CPV is
51 // deleted, we must now notify all of our users (that should only be
52 // Constants) that they are, in fact, invalid now and should be deleted.
54 while (!use_empty()) {
55 Value *V = use_back();
56 #ifndef NDEBUG // Only in -g mode...
57 if (!isa<Constant>(V))
58 DOUT << "While deleting: " << *this
59 << "\n\nUse still stuck around after Def is destroyed: "
62 assert(isa<Constant>(V) && "References remain to Constant being destroyed");
63 Constant *CV = cast<Constant>(V);
64 CV->destroyConstant();
66 // The constant should remove itself from our use list...
67 assert((use_empty() || use_back() != V) && "Constant not removed!");
70 // Value has no outstanding references it is safe to delete it now...
74 /// canTrap - Return true if evaluation of this constant could trap. This is
75 /// true for things like constant expressions that could divide by zero.
76 bool Constant::canTrap() const {
77 assert(getType()->isFirstClassType() && "Cannot evaluate aggregate vals!");
78 // The only thing that could possibly trap are constant exprs.
79 const ConstantExpr *CE = dyn_cast<ConstantExpr>(this);
80 if (!CE) return false;
82 // ConstantExpr traps if any operands can trap.
83 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
84 if (getOperand(i)->canTrap())
87 // Otherwise, only specific operations can trap.
88 switch (CE->getOpcode()) {
91 case Instruction::UDiv:
92 case Instruction::SDiv:
93 case Instruction::FDiv:
94 case Instruction::URem:
95 case Instruction::SRem:
96 case Instruction::FRem:
97 // Div and rem can trap if the RHS is not known to be non-zero.
98 if (!isa<ConstantInt>(getOperand(1)) || getOperand(1)->isNullValue())
105 /// getRelocationInfo - This method classifies the entry according to
106 /// whether or not it may generate a relocation entry. This must be
107 /// conservative, so if it might codegen to a relocatable entry, it should say
108 /// so. The return values are:
110 /// NoRelocation: This constant pool entry is guaranteed to never have a
111 /// relocation applied to it (because it holds a simple constant like
113 /// LocalRelocation: This entry has relocations, but the entries are
114 /// guaranteed to be resolvable by the static linker, so the dynamic
115 /// linker will never see them.
116 /// GlobalRelocations: This entry may have arbitrary relocations.
118 /// FIXME: This really should not be in VMCore.
119 Constant::PossibleRelocationsTy Constant::getRelocationInfo() const {
120 if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
121 if (GV->hasLocalLinkage() || GV->hasHiddenVisibility())
122 return LocalRelocation; // Local to this file/library.
123 return GlobalRelocations; // Global reference.
126 PossibleRelocationsTy Result = NoRelocation;
127 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
128 Result = std::max(Result, getOperand(i)->getRelocationInfo());
134 /// getVectorElements - This method, which is only valid on constant of vector
135 /// type, returns the elements of the vector in the specified smallvector.
136 /// This handles breaking down a vector undef into undef elements, etc. For
137 /// constant exprs and other cases we can't handle, we return an empty vector.
138 void Constant::getVectorElements(LLVMContext &Context,
139 SmallVectorImpl<Constant*> &Elts) const {
140 assert(isa<VectorType>(getType()) && "Not a vector constant!");
142 if (const ConstantVector *CV = dyn_cast<ConstantVector>(this)) {
143 for (unsigned i = 0, e = CV->getNumOperands(); i != e; ++i)
144 Elts.push_back(CV->getOperand(i));
148 const VectorType *VT = cast<VectorType>(getType());
149 if (isa<ConstantAggregateZero>(this)) {
150 Elts.assign(VT->getNumElements(),
151 Context.getNullValue(VT->getElementType()));
155 if (isa<UndefValue>(this)) {
156 Elts.assign(VT->getNumElements(), Context.getUndef(VT->getElementType()));
160 // Unknown type, must be constant expr etc.
165 //===----------------------------------------------------------------------===//
167 //===----------------------------------------------------------------------===//
169 ConstantInt::ConstantInt(const IntegerType *Ty, const APInt& V)
170 : Constant(Ty, ConstantIntVal, 0, 0), Val(V) {
171 assert(V.getBitWidth() == Ty->getBitWidth() && "Invalid constant for type");
174 // Get a ConstantInt from an APInt. Note that the value stored in the DenseMap
175 // as the key, is a DenseMapAPIntKeyInfo::KeyTy which has provided the
176 // operator== and operator!= to ensure that the DenseMap doesn't attempt to
177 // compare APInt's of different widths, which would violate an APInt class
178 // invariant which generates an assertion.
179 ConstantInt *ConstantInt::get(LLVMContext &Context, const APInt& V) {
180 // Get the corresponding integer type for the bit width of the value.
181 const IntegerType *ITy = Context.getIntegerType(V.getBitWidth());
182 // get an existing value or the insertion position
183 DenseMapAPIntKeyInfo::KeyTy Key(V, ITy);
185 Context.pImpl->ConstantsLock.reader_acquire();
186 ConstantInt *&Slot = Context.pImpl->IntConstants[Key];
187 Context.pImpl->ConstantsLock.reader_release();
190 sys::SmartScopedWriter<true> Writer(Context.pImpl->ConstantsLock);
191 ConstantInt *&NewSlot = Context.pImpl->IntConstants[Key];
193 NewSlot = new ConstantInt(ITy, V);
202 Constant* ConstantInt::get(const Type* Ty, uint64_t V, bool isSigned) {
203 Constant *C = get(cast<IntegerType>(Ty->getScalarType()),
206 // For vectors, broadcast the value.
207 if (const VectorType *VTy = dyn_cast<VectorType>(Ty))
208 return ConstantVector::get(
209 std::vector<Constant *>(VTy->getNumElements(), C));
214 ConstantInt* ConstantInt::get(const IntegerType* Ty, uint64_t V,
216 return get(Ty->getContext(), APInt(Ty->getBitWidth(), V, isSigned));
219 ConstantInt* ConstantInt::getSigned(const IntegerType* Ty, int64_t V) {
220 return get(Ty, V, true);
223 Constant *ConstantInt::getSigned(const Type *Ty, int64_t V) {
224 return get(Ty, V, true);
227 Constant* ConstantInt::get(const Type* Ty, const APInt& V) {
228 ConstantInt *C = get(Ty->getContext(), V);
229 assert(C->getType() == Ty->getScalarType() &&
230 "ConstantInt type doesn't match the type implied by its value!");
232 // For vectors, broadcast the value.
233 if (const VectorType *VTy = dyn_cast<VectorType>(Ty))
234 return ConstantVector::get(
235 std::vector<Constant *>(VTy->getNumElements(), C));
240 //===----------------------------------------------------------------------===//
242 //===----------------------------------------------------------------------===//
244 static const fltSemantics *TypeToFloatSemantics(const Type *Ty) {
245 if (Ty == Type::FloatTy)
246 return &APFloat::IEEEsingle;
247 if (Ty == Type::DoubleTy)
248 return &APFloat::IEEEdouble;
249 if (Ty == Type::X86_FP80Ty)
250 return &APFloat::x87DoubleExtended;
251 else if (Ty == Type::FP128Ty)
252 return &APFloat::IEEEquad;
254 assert(Ty == Type::PPC_FP128Ty && "Unknown FP format");
255 return &APFloat::PPCDoubleDouble;
258 /// get() - This returns a constant fp for the specified value in the
259 /// specified type. This should only be used for simple constant values like
260 /// 2.0/1.0 etc, that are known-valid both as double and as the target format.
261 Constant* ConstantFP::get(const Type* Ty, double V) {
262 LLVMContext &Context = Ty->getContext();
266 FV.convert(*TypeToFloatSemantics(Ty->getScalarType()),
267 APFloat::rmNearestTiesToEven, &ignored);
268 Constant *C = get(Context, FV);
270 // For vectors, broadcast the value.
271 if (const VectorType *VTy = dyn_cast<VectorType>(Ty))
272 return ConstantVector::get(
273 std::vector<Constant *>(VTy->getNumElements(), C));
278 ConstantFP* ConstantFP::getNegativeZero(const Type* Ty) {
279 LLVMContext &Context = Ty->getContext();
280 APFloat apf = cast <ConstantFP>(Context.getNullValue(Ty))->getValueAPF();
282 return get(Context, apf);
286 Constant* ConstantFP::getZeroValueForNegation(const Type* Ty) {
287 LLVMContext &Context = Ty->getContext();
288 if (const VectorType *PTy = dyn_cast<VectorType>(Ty))
289 if (PTy->getElementType()->isFloatingPoint()) {
290 std::vector<Constant*> zeros(PTy->getNumElements(),
291 getNegativeZero(PTy->getElementType()));
292 return ConstantVector::get(PTy, zeros);
295 if (Ty->isFloatingPoint())
296 return getNegativeZero(Ty);
298 return Context.getNullValue(Ty);
302 // ConstantFP accessors.
303 ConstantFP* ConstantFP::get(LLVMContext &Context, const APFloat& V) {
304 DenseMapAPFloatKeyInfo::KeyTy Key(V);
306 LLVMContextImpl* pImpl = Context.pImpl;
308 pImpl->ConstantsLock.reader_acquire();
309 ConstantFP *&Slot = pImpl->FPConstants[Key];
310 pImpl->ConstantsLock.reader_release();
313 sys::SmartScopedWriter<true> Writer(pImpl->ConstantsLock);
314 ConstantFP *&NewSlot = pImpl->FPConstants[Key];
317 if (&V.getSemantics() == &APFloat::IEEEsingle)
319 else if (&V.getSemantics() == &APFloat::IEEEdouble)
321 else if (&V.getSemantics() == &APFloat::x87DoubleExtended)
322 Ty = Type::X86_FP80Ty;
323 else if (&V.getSemantics() == &APFloat::IEEEquad)
326 assert(&V.getSemantics() == &APFloat::PPCDoubleDouble &&
327 "Unknown FP format");
328 Ty = Type::PPC_FP128Ty;
330 NewSlot = new ConstantFP(Ty, V);
339 ConstantFP::ConstantFP(const Type *Ty, const APFloat& V)
340 : Constant(Ty, ConstantFPVal, 0, 0), Val(V) {
341 assert(&V.getSemantics() == TypeToFloatSemantics(Ty) &&
345 bool ConstantFP::isNullValue() const {
346 return Val.isZero() && !Val.isNegative();
349 bool ConstantFP::isExactlyValue(const APFloat& V) const {
350 return Val.bitwiseIsEqual(V);
353 //===----------------------------------------------------------------------===//
354 // ConstantXXX Classes
355 //===----------------------------------------------------------------------===//
358 ConstantArray::ConstantArray(const ArrayType *T,
359 const std::vector<Constant*> &V)
360 : Constant(T, ConstantArrayVal,
361 OperandTraits<ConstantArray>::op_end(this) - V.size(),
363 assert(V.size() == T->getNumElements() &&
364 "Invalid initializer vector for constant array");
365 Use *OL = OperandList;
366 for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
369 assert((C->getType() == T->getElementType() ||
371 C->getType()->getTypeID() == T->getElementType()->getTypeID())) &&
372 "Initializer for array element doesn't match array element type!");
377 Constant *ConstantArray::get(const ArrayType *Ty,
378 const std::vector<Constant*> &V) {
379 LLVMContextImpl *pImpl = Ty->getContext().pImpl;
380 // If this is an all-zero array, return a ConstantAggregateZero object
383 if (!C->isNullValue()) {
384 // Implicitly locked.
385 return pImpl->ArrayConstants.getOrCreate(Ty, V);
387 for (unsigned i = 1, e = V.size(); i != e; ++i)
389 // Implicitly locked.
390 return pImpl->ArrayConstants.getOrCreate(Ty, V);
394 return Ty->getContext().getConstantAggregateZero(Ty);
398 Constant* ConstantArray::get(const ArrayType* T, Constant* const* Vals,
400 // FIXME: make this the primary ctor method.
401 return get(T, std::vector<Constant*>(Vals, Vals+NumVals));
404 /// ConstantArray::get(const string&) - Return an array that is initialized to
405 /// contain the specified string. If length is zero then a null terminator is
406 /// added to the specified string so that it may be used in a natural way.
407 /// Otherwise, the length parameter specifies how much of the string to use
408 /// and it won't be null terminated.
410 Constant* ConstantArray::get(const StringRef &Str, bool AddNull) {
411 std::vector<Constant*> ElementVals;
412 for (unsigned i = 0; i < Str.size(); ++i)
413 ElementVals.push_back(ConstantInt::get(Type::Int8Ty, Str[i]));
415 // Add a null terminator to the string...
417 ElementVals.push_back(ConstantInt::get(Type::Int8Ty, 0));
420 ArrayType *ATy = ArrayType::get(Type::Int8Ty, ElementVals.size());
421 return get(ATy, ElementVals);
426 ConstantStruct::ConstantStruct(const StructType *T,
427 const std::vector<Constant*> &V)
428 : Constant(T, ConstantStructVal,
429 OperandTraits<ConstantStruct>::op_end(this) - V.size(),
431 assert(V.size() == T->getNumElements() &&
432 "Invalid initializer vector for constant structure");
433 Use *OL = OperandList;
434 for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
437 assert((C->getType() == T->getElementType(I-V.begin()) ||
438 ((T->getElementType(I-V.begin())->isAbstract() ||
439 C->getType()->isAbstract()) &&
440 T->getElementType(I-V.begin())->getTypeID() ==
441 C->getType()->getTypeID())) &&
442 "Initializer for struct element doesn't match struct element type!");
447 // ConstantStruct accessors.
448 Constant* ConstantStruct::get(const StructType* T,
449 const std::vector<Constant*>& V) {
450 LLVMContextImpl* pImpl = T->getContext().pImpl;
452 // Create a ConstantAggregateZero value if all elements are zeros...
453 for (unsigned i = 0, e = V.size(); i != e; ++i)
454 if (!V[i]->isNullValue())
455 // Implicitly locked.
456 return pImpl->StructConstants.getOrCreate(T, V);
458 return T->getContext().getConstantAggregateZero(T);
461 Constant* ConstantStruct::get(const std::vector<Constant*>& V, bool packed) {
462 std::vector<const Type*> StructEls;
463 StructEls.reserve(V.size());
464 for (unsigned i = 0, e = V.size(); i != e; ++i)
465 StructEls.push_back(V[i]->getType());
466 return get(StructType::get(StructEls, packed), V);
469 Constant* ConstantStruct::get(Constant* const *Vals, unsigned NumVals,
471 // FIXME: make this the primary ctor method.
472 return get(std::vector<Constant*>(Vals, Vals+NumVals), Packed);
475 ConstantVector::ConstantVector(const VectorType *T,
476 const std::vector<Constant*> &V)
477 : Constant(T, ConstantVectorVal,
478 OperandTraits<ConstantVector>::op_end(this) - V.size(),
480 Use *OL = OperandList;
481 for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
484 assert((C->getType() == T->getElementType() ||
486 C->getType()->getTypeID() == T->getElementType()->getTypeID())) &&
487 "Initializer for vector element doesn't match vector element type!");
492 // ConstantVector accessors.
493 Constant* ConstantVector::get(const VectorType* T,
494 const std::vector<Constant*>& V) {
495 assert(!V.empty() && "Vectors can't be empty");
496 LLVMContext &Context = T->getContext();
497 LLVMContextImpl *pImpl = Context.pImpl;
499 // If this is an all-undef or alll-zero vector, return a
500 // ConstantAggregateZero or UndefValue.
502 bool isZero = C->isNullValue();
503 bool isUndef = isa<UndefValue>(C);
505 if (isZero || isUndef) {
506 for (unsigned i = 1, e = V.size(); i != e; ++i)
508 isZero = isUndef = false;
514 return Context.getConstantAggregateZero(T);
516 return Context.getUndef(T);
518 // Implicitly locked.
519 return pImpl->VectorConstants.getOrCreate(T, V);
522 Constant* ConstantVector::get(const std::vector<Constant*>& V) {
523 assert(!V.empty() && "Cannot infer type if V is empty");
524 return get(VectorType::get(V.front()->getType(),V.size()), V);
527 Constant* ConstantVector::get(Constant* const* Vals, unsigned NumVals) {
528 // FIXME: make this the primary ctor method.
529 return get(std::vector<Constant*>(Vals, Vals+NumVals));
534 // We declare several classes private to this file, so use an anonymous
538 /// UnaryConstantExpr - This class is private to Constants.cpp, and is used
539 /// behind the scenes to implement unary constant exprs.
540 class VISIBILITY_HIDDEN UnaryConstantExpr : public ConstantExpr {
541 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
543 // allocate space for exactly one operand
544 void *operator new(size_t s) {
545 return User::operator new(s, 1);
547 UnaryConstantExpr(unsigned Opcode, Constant *C, const Type *Ty)
548 : ConstantExpr(Ty, Opcode, &Op<0>(), 1) {
551 /// Transparently provide more efficient getOperand methods.
552 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
555 /// BinaryConstantExpr - This class is private to Constants.cpp, and is used
556 /// behind the scenes to implement binary constant exprs.
557 class VISIBILITY_HIDDEN BinaryConstantExpr : public ConstantExpr {
558 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
560 // allocate space for exactly two operands
561 void *operator new(size_t s) {
562 return User::operator new(s, 2);
564 BinaryConstantExpr(unsigned Opcode, Constant *C1, Constant *C2)
565 : ConstantExpr(C1->getType(), Opcode, &Op<0>(), 2) {
569 /// Transparently provide more efficient getOperand methods.
570 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
573 /// SelectConstantExpr - This class is private to Constants.cpp, and is used
574 /// behind the scenes to implement select constant exprs.
575 class VISIBILITY_HIDDEN SelectConstantExpr : public ConstantExpr {
576 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
578 // allocate space for exactly three operands
579 void *operator new(size_t s) {
580 return User::operator new(s, 3);
582 SelectConstantExpr(Constant *C1, Constant *C2, Constant *C3)
583 : ConstantExpr(C2->getType(), Instruction::Select, &Op<0>(), 3) {
588 /// Transparently provide more efficient getOperand methods.
589 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
592 /// ExtractElementConstantExpr - This class is private to
593 /// Constants.cpp, and is used behind the scenes to implement
594 /// extractelement constant exprs.
595 class VISIBILITY_HIDDEN ExtractElementConstantExpr : public ConstantExpr {
596 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
598 // allocate space for exactly two operands
599 void *operator new(size_t s) {
600 return User::operator new(s, 2);
602 ExtractElementConstantExpr(Constant *C1, Constant *C2)
603 : ConstantExpr(cast<VectorType>(C1->getType())->getElementType(),
604 Instruction::ExtractElement, &Op<0>(), 2) {
608 /// Transparently provide more efficient getOperand methods.
609 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
612 /// InsertElementConstantExpr - This class is private to
613 /// Constants.cpp, and is used behind the scenes to implement
614 /// insertelement constant exprs.
615 class VISIBILITY_HIDDEN InsertElementConstantExpr : public ConstantExpr {
616 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
618 // allocate space for exactly three operands
619 void *operator new(size_t s) {
620 return User::operator new(s, 3);
622 InsertElementConstantExpr(Constant *C1, Constant *C2, Constant *C3)
623 : ConstantExpr(C1->getType(), Instruction::InsertElement,
629 /// Transparently provide more efficient getOperand methods.
630 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
633 /// ShuffleVectorConstantExpr - This class is private to
634 /// Constants.cpp, and is used behind the scenes to implement
635 /// shufflevector constant exprs.
636 class VISIBILITY_HIDDEN ShuffleVectorConstantExpr : public ConstantExpr {
637 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
639 // allocate space for exactly three operands
640 void *operator new(size_t s) {
641 return User::operator new(s, 3);
643 ShuffleVectorConstantExpr(Constant *C1, Constant *C2, Constant *C3)
644 : ConstantExpr(VectorType::get(
645 cast<VectorType>(C1->getType())->getElementType(),
646 cast<VectorType>(C3->getType())->getNumElements()),
647 Instruction::ShuffleVector,
653 /// Transparently provide more efficient getOperand methods.
654 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
657 /// ExtractValueConstantExpr - This class is private to
658 /// Constants.cpp, and is used behind the scenes to implement
659 /// extractvalue constant exprs.
660 class VISIBILITY_HIDDEN ExtractValueConstantExpr : public ConstantExpr {
661 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
663 // allocate space for exactly one operand
664 void *operator new(size_t s) {
665 return User::operator new(s, 1);
667 ExtractValueConstantExpr(Constant *Agg,
668 const SmallVector<unsigned, 4> &IdxList,
670 : ConstantExpr(DestTy, Instruction::ExtractValue, &Op<0>(), 1),
675 /// Indices - These identify which value to extract.
676 const SmallVector<unsigned, 4> Indices;
678 /// Transparently provide more efficient getOperand methods.
679 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
682 /// InsertValueConstantExpr - This class is private to
683 /// Constants.cpp, and is used behind the scenes to implement
684 /// insertvalue constant exprs.
685 class VISIBILITY_HIDDEN InsertValueConstantExpr : public ConstantExpr {
686 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
688 // allocate space for exactly one operand
689 void *operator new(size_t s) {
690 return User::operator new(s, 2);
692 InsertValueConstantExpr(Constant *Agg, Constant *Val,
693 const SmallVector<unsigned, 4> &IdxList,
695 : ConstantExpr(DestTy, Instruction::InsertValue, &Op<0>(), 2),
701 /// Indices - These identify the position for the insertion.
702 const SmallVector<unsigned, 4> Indices;
704 /// Transparently provide more efficient getOperand methods.
705 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
709 /// GetElementPtrConstantExpr - This class is private to Constants.cpp, and is
710 /// used behind the scenes to implement getelementpr constant exprs.
711 class VISIBILITY_HIDDEN GetElementPtrConstantExpr : public ConstantExpr {
712 GetElementPtrConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
715 static GetElementPtrConstantExpr *Create(Constant *C,
716 const std::vector<Constant*>&IdxList,
717 const Type *DestTy) {
719 new(IdxList.size() + 1) GetElementPtrConstantExpr(C, IdxList, DestTy);
721 /// Transparently provide more efficient getOperand methods.
722 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
725 // CompareConstantExpr - This class is private to Constants.cpp, and is used
726 // behind the scenes to implement ICmp and FCmp constant expressions. This is
727 // needed in order to store the predicate value for these instructions.
728 struct VISIBILITY_HIDDEN CompareConstantExpr : public ConstantExpr {
729 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
730 // allocate space for exactly two operands
731 void *operator new(size_t s) {
732 return User::operator new(s, 2);
734 unsigned short predicate;
735 CompareConstantExpr(const Type *ty, Instruction::OtherOps opc,
736 unsigned short pred, Constant* LHS, Constant* RHS)
737 : ConstantExpr(ty, opc, &Op<0>(), 2), predicate(pred) {
741 /// Transparently provide more efficient getOperand methods.
742 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
745 } // end anonymous namespace
748 struct OperandTraits<UnaryConstantExpr> : FixedNumOperandTraits<1> {
750 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(UnaryConstantExpr, Value)
753 struct OperandTraits<BinaryConstantExpr> : FixedNumOperandTraits<2> {
755 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BinaryConstantExpr, Value)
758 struct OperandTraits<SelectConstantExpr> : FixedNumOperandTraits<3> {
760 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectConstantExpr, Value)
763 struct OperandTraits<ExtractElementConstantExpr> : FixedNumOperandTraits<2> {
765 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementConstantExpr, Value)
768 struct OperandTraits<InsertElementConstantExpr> : FixedNumOperandTraits<3> {
770 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementConstantExpr, Value)
773 struct OperandTraits<ShuffleVectorConstantExpr> : FixedNumOperandTraits<3> {
775 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorConstantExpr, Value)
778 struct OperandTraits<ExtractValueConstantExpr> : FixedNumOperandTraits<1> {
780 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractValueConstantExpr, Value)
783 struct OperandTraits<InsertValueConstantExpr> : FixedNumOperandTraits<2> {
785 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueConstantExpr, Value)
788 struct OperandTraits<GetElementPtrConstantExpr> : VariadicOperandTraits<1> {
791 GetElementPtrConstantExpr::GetElementPtrConstantExpr
793 const std::vector<Constant*> &IdxList,
795 : ConstantExpr(DestTy, Instruction::GetElementPtr,
796 OperandTraits<GetElementPtrConstantExpr>::op_end(this)
797 - (IdxList.size()+1),
800 for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
801 OperandList[i+1] = IdxList[i];
804 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrConstantExpr, Value)
808 struct OperandTraits<CompareConstantExpr> : FixedNumOperandTraits<2> {
810 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CompareConstantExpr, Value)
813 } // End llvm namespace
816 // Utility function for determining if a ConstantExpr is a CastOp or not. This
817 // can't be inline because we don't want to #include Instruction.h into
819 bool ConstantExpr::isCast() const {
820 return Instruction::isCast(getOpcode());
823 bool ConstantExpr::isCompare() const {
824 return getOpcode() == Instruction::ICmp || getOpcode() == Instruction::FCmp;
827 bool ConstantExpr::hasIndices() const {
828 return getOpcode() == Instruction::ExtractValue ||
829 getOpcode() == Instruction::InsertValue;
832 const SmallVector<unsigned, 4> &ConstantExpr::getIndices() const {
833 if (const ExtractValueConstantExpr *EVCE =
834 dyn_cast<ExtractValueConstantExpr>(this))
835 return EVCE->Indices;
837 return cast<InsertValueConstantExpr>(this)->Indices;
840 unsigned ConstantExpr::getPredicate() const {
841 assert(getOpcode() == Instruction::FCmp ||
842 getOpcode() == Instruction::ICmp);
843 return ((const CompareConstantExpr*)this)->predicate;
846 /// getWithOperandReplaced - Return a constant expression identical to this
847 /// one, but with the specified operand set to the specified value.
849 ConstantExpr::getWithOperandReplaced(unsigned OpNo, Constant *Op) const {
850 assert(OpNo < getNumOperands() && "Operand num is out of range!");
851 assert(Op->getType() == getOperand(OpNo)->getType() &&
852 "Replacing operand with value of different type!");
853 if (getOperand(OpNo) == Op)
854 return const_cast<ConstantExpr*>(this);
856 Constant *Op0, *Op1, *Op2;
857 switch (getOpcode()) {
858 case Instruction::Trunc:
859 case Instruction::ZExt:
860 case Instruction::SExt:
861 case Instruction::FPTrunc:
862 case Instruction::FPExt:
863 case Instruction::UIToFP:
864 case Instruction::SIToFP:
865 case Instruction::FPToUI:
866 case Instruction::FPToSI:
867 case Instruction::PtrToInt:
868 case Instruction::IntToPtr:
869 case Instruction::BitCast:
870 return ConstantExpr::getCast(getOpcode(), Op, getType());
871 case Instruction::Select:
872 Op0 = (OpNo == 0) ? Op : getOperand(0);
873 Op1 = (OpNo == 1) ? Op : getOperand(1);
874 Op2 = (OpNo == 2) ? Op : getOperand(2);
875 return ConstantExpr::getSelect(Op0, Op1, Op2);
876 case Instruction::InsertElement:
877 Op0 = (OpNo == 0) ? Op : getOperand(0);
878 Op1 = (OpNo == 1) ? Op : getOperand(1);
879 Op2 = (OpNo == 2) ? Op : getOperand(2);
880 return ConstantExpr::getInsertElement(Op0, Op1, Op2);
881 case Instruction::ExtractElement:
882 Op0 = (OpNo == 0) ? Op : getOperand(0);
883 Op1 = (OpNo == 1) ? Op : getOperand(1);
884 return ConstantExpr::getExtractElement(Op0, Op1);
885 case Instruction::ShuffleVector:
886 Op0 = (OpNo == 0) ? Op : getOperand(0);
887 Op1 = (OpNo == 1) ? Op : getOperand(1);
888 Op2 = (OpNo == 2) ? Op : getOperand(2);
889 return ConstantExpr::getShuffleVector(Op0, Op1, Op2);
890 case Instruction::GetElementPtr: {
891 SmallVector<Constant*, 8> Ops;
892 Ops.resize(getNumOperands()-1);
893 for (unsigned i = 1, e = getNumOperands(); i != e; ++i)
894 Ops[i-1] = getOperand(i);
896 return ConstantExpr::getGetElementPtr(Op, &Ops[0], Ops.size());
898 return ConstantExpr::getGetElementPtr(getOperand(0), &Ops[0], Ops.size());
901 assert(getNumOperands() == 2 && "Must be binary operator?");
902 Op0 = (OpNo == 0) ? Op : getOperand(0);
903 Op1 = (OpNo == 1) ? Op : getOperand(1);
904 return ConstantExpr::get(getOpcode(), Op0, Op1);
908 /// getWithOperands - This returns the current constant expression with the
909 /// operands replaced with the specified values. The specified operands must
910 /// match count and type with the existing ones.
911 Constant *ConstantExpr::
912 getWithOperands(Constant* const *Ops, unsigned NumOps) const {
913 assert(NumOps == getNumOperands() && "Operand count mismatch!");
914 bool AnyChange = false;
915 for (unsigned i = 0; i != NumOps; ++i) {
916 assert(Ops[i]->getType() == getOperand(i)->getType() &&
917 "Operand type mismatch!");
918 AnyChange |= Ops[i] != getOperand(i);
920 if (!AnyChange) // No operands changed, return self.
921 return const_cast<ConstantExpr*>(this);
923 switch (getOpcode()) {
924 case Instruction::Trunc:
925 case Instruction::ZExt:
926 case Instruction::SExt:
927 case Instruction::FPTrunc:
928 case Instruction::FPExt:
929 case Instruction::UIToFP:
930 case Instruction::SIToFP:
931 case Instruction::FPToUI:
932 case Instruction::FPToSI:
933 case Instruction::PtrToInt:
934 case Instruction::IntToPtr:
935 case Instruction::BitCast:
936 return ConstantExpr::getCast(getOpcode(), Ops[0], getType());
937 case Instruction::Select:
938 return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
939 case Instruction::InsertElement:
940 return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
941 case Instruction::ExtractElement:
942 return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
943 case Instruction::ShuffleVector:
944 return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
945 case Instruction::GetElementPtr:
946 return ConstantExpr::getGetElementPtr(Ops[0], &Ops[1], NumOps-1);
947 case Instruction::ICmp:
948 case Instruction::FCmp:
949 return ConstantExpr::getCompare(getPredicate(), Ops[0], Ops[1]);
951 assert(getNumOperands() == 2 && "Must be binary operator?");
952 return ConstantExpr::get(getOpcode(), Ops[0], Ops[1]);
957 //===----------------------------------------------------------------------===//
958 // isValueValidForType implementations
960 bool ConstantInt::isValueValidForType(const Type *Ty, uint64_t Val) {
961 unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
962 if (Ty == Type::Int1Ty)
963 return Val == 0 || Val == 1;
965 return true; // always true, has to fit in largest type
966 uint64_t Max = (1ll << NumBits) - 1;
970 bool ConstantInt::isValueValidForType(const Type *Ty, int64_t Val) {
971 unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
972 if (Ty == Type::Int1Ty)
973 return Val == 0 || Val == 1 || Val == -1;
975 return true; // always true, has to fit in largest type
976 int64_t Min = -(1ll << (NumBits-1));
977 int64_t Max = (1ll << (NumBits-1)) - 1;
978 return (Val >= Min && Val <= Max);
981 bool ConstantFP::isValueValidForType(const Type *Ty, const APFloat& Val) {
982 // convert modifies in place, so make a copy.
983 APFloat Val2 = APFloat(Val);
985 switch (Ty->getTypeID()) {
987 return false; // These can't be represented as floating point!
989 // FIXME rounding mode needs to be more flexible
990 case Type::FloatTyID: {
991 if (&Val2.getSemantics() == &APFloat::IEEEsingle)
993 Val2.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &losesInfo);
996 case Type::DoubleTyID: {
997 if (&Val2.getSemantics() == &APFloat::IEEEsingle ||
998 &Val2.getSemantics() == &APFloat::IEEEdouble)
1000 Val2.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, &losesInfo);
1003 case Type::X86_FP80TyID:
1004 return &Val2.getSemantics() == &APFloat::IEEEsingle ||
1005 &Val2.getSemantics() == &APFloat::IEEEdouble ||
1006 &Val2.getSemantics() == &APFloat::x87DoubleExtended;
1007 case Type::FP128TyID:
1008 return &Val2.getSemantics() == &APFloat::IEEEsingle ||
1009 &Val2.getSemantics() == &APFloat::IEEEdouble ||
1010 &Val2.getSemantics() == &APFloat::IEEEquad;
1011 case Type::PPC_FP128TyID:
1012 return &Val2.getSemantics() == &APFloat::IEEEsingle ||
1013 &Val2.getSemantics() == &APFloat::IEEEdouble ||
1014 &Val2.getSemantics() == &APFloat::PPCDoubleDouble;
1018 //===----------------------------------------------------------------------===//
1019 // Factory Function Implementation
1021 /// destroyConstant - Remove the constant from the constant table...
1023 void ConstantAggregateZero::destroyConstant() {
1024 // Implicitly locked.
1025 getType()->getContext().erase(this);
1026 destroyConstantImpl();
1029 /// destroyConstant - Remove the constant from the constant table...
1031 void ConstantArray::destroyConstant() {
1032 // Implicitly locked.
1033 getType()->getContext().pImpl->ArrayConstants.remove(this);
1034 destroyConstantImpl();
1037 /// isString - This method returns true if the array is an array of i8, and
1038 /// if the elements of the array are all ConstantInt's.
1039 bool ConstantArray::isString() const {
1040 // Check the element type for i8...
1041 if (getType()->getElementType() != Type::Int8Ty)
1043 // Check the elements to make sure they are all integers, not constant
1045 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1046 if (!isa<ConstantInt>(getOperand(i)))
1051 /// isCString - This method returns true if the array is a string (see
1052 /// isString) and it ends in a null byte \\0 and does not contains any other
1053 /// null bytes except its terminator.
1054 bool ConstantArray::isCString() const {
1055 // Check the element type for i8...
1056 if (getType()->getElementType() != Type::Int8Ty)
1059 // Last element must be a null.
1060 if (!getOperand(getNumOperands()-1)->isNullValue())
1062 // Other elements must be non-null integers.
1063 for (unsigned i = 0, e = getNumOperands()-1; i != e; ++i) {
1064 if (!isa<ConstantInt>(getOperand(i)))
1066 if (getOperand(i)->isNullValue())
1073 /// getAsString - If the sub-element type of this array is i8
1074 /// then this method converts the array to an std::string and returns it.
1075 /// Otherwise, it asserts out.
1077 std::string ConstantArray::getAsString() const {
1078 assert(isString() && "Not a string!");
1080 Result.reserve(getNumOperands());
1081 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1082 Result.push_back((char)cast<ConstantInt>(getOperand(i))->getZExtValue());
1087 //---- ConstantStruct::get() implementation...
1094 // destroyConstant - Remove the constant from the constant table...
1096 void ConstantStruct::destroyConstant() {
1097 // Implicitly locked.
1098 getType()->getContext().pImpl->StructConstants.remove(this);
1099 destroyConstantImpl();
1102 // destroyConstant - Remove the constant from the constant table...
1104 void ConstantVector::destroyConstant() {
1105 // Implicitly locked.
1106 getType()->getContext().pImpl->VectorConstants.remove(this);
1107 destroyConstantImpl();
1110 /// This function will return true iff every element in this vector constant
1111 /// is set to all ones.
1112 /// @returns true iff this constant's emements are all set to all ones.
1113 /// @brief Determine if the value is all ones.
1114 bool ConstantVector::isAllOnesValue() const {
1115 // Check out first element.
1116 const Constant *Elt = getOperand(0);
1117 const ConstantInt *CI = dyn_cast<ConstantInt>(Elt);
1118 if (!CI || !CI->isAllOnesValue()) return false;
1119 // Then make sure all remaining elements point to the same value.
1120 for (unsigned I = 1, E = getNumOperands(); I < E; ++I) {
1121 if (getOperand(I) != Elt) return false;
1126 /// getSplatValue - If this is a splat constant, where all of the
1127 /// elements have the same value, return that value. Otherwise return null.
1128 Constant *ConstantVector::getSplatValue() {
1129 // Check out first element.
1130 Constant *Elt = getOperand(0);
1131 // Then make sure all remaining elements point to the same value.
1132 for (unsigned I = 1, E = getNumOperands(); I < E; ++I)
1133 if (getOperand(I) != Elt) return 0;
1137 //---- ConstantPointerNull::get() implementation...
1141 // ConstantPointerNull does not take extra "value" argument...
1142 template<class ValType>
1143 struct ConstantCreator<ConstantPointerNull, PointerType, ValType> {
1144 static ConstantPointerNull *create(const PointerType *Ty, const ValType &V){
1145 return new ConstantPointerNull(Ty);
1150 struct ConvertConstantType<ConstantPointerNull, PointerType> {
1151 static void convert(ConstantPointerNull *OldC, const PointerType *NewTy) {
1152 // Make everyone now use a constant of the new type...
1153 Constant *New = ConstantPointerNull::get(NewTy);
1154 assert(New != OldC && "Didn't replace constant??");
1155 OldC->uncheckedReplaceAllUsesWith(New);
1156 OldC->destroyConstant(); // This constant is now dead, destroy it.
1161 static ManagedStatic<ValueMap<char, PointerType,
1162 ConstantPointerNull> > NullPtrConstants;
1164 static char getValType(ConstantPointerNull *) {
1169 ConstantPointerNull *ConstantPointerNull::get(const PointerType *Ty) {
1170 // Implicitly locked.
1171 return NullPtrConstants->getOrCreate(Ty, 0);
1174 // destroyConstant - Remove the constant from the constant table...
1176 void ConstantPointerNull::destroyConstant() {
1177 // Implicitly locked.
1178 NullPtrConstants->remove(this);
1179 destroyConstantImpl();
1183 //---- UndefValue::get() implementation...
1187 // UndefValue does not take extra "value" argument...
1188 template<class ValType>
1189 struct ConstantCreator<UndefValue, Type, ValType> {
1190 static UndefValue *create(const Type *Ty, const ValType &V) {
1191 return new UndefValue(Ty);
1196 struct ConvertConstantType<UndefValue, Type> {
1197 static void convert(UndefValue *OldC, const Type *NewTy) {
1198 // Make everyone now use a constant of the new type.
1199 Constant *New = UndefValue::get(NewTy);
1200 assert(New != OldC && "Didn't replace constant??");
1201 OldC->uncheckedReplaceAllUsesWith(New);
1202 OldC->destroyConstant(); // This constant is now dead, destroy it.
1207 static ManagedStatic<ValueMap<char, Type, UndefValue> > UndefValueConstants;
1209 static char getValType(UndefValue *) {
1214 UndefValue *UndefValue::get(const Type *Ty) {
1215 // Implicitly locked.
1216 return UndefValueConstants->getOrCreate(Ty, 0);
1219 // destroyConstant - Remove the constant from the constant table.
1221 void UndefValue::destroyConstant() {
1222 // Implicitly locked.
1223 UndefValueConstants->remove(this);
1224 destroyConstantImpl();
1227 //---- ConstantExpr::get() implementations...
1232 struct ExprMapKeyType {
1233 typedef SmallVector<unsigned, 4> IndexList;
1235 ExprMapKeyType(unsigned opc,
1236 const std::vector<Constant*> &ops,
1237 unsigned short pred = 0,
1238 const IndexList &inds = IndexList())
1239 : opcode(opc), predicate(pred), operands(ops), indices(inds) {}
1242 std::vector<Constant*> operands;
1244 bool operator==(const ExprMapKeyType& that) const {
1245 return this->opcode == that.opcode &&
1246 this->predicate == that.predicate &&
1247 this->operands == that.operands &&
1248 this->indices == that.indices;
1250 bool operator<(const ExprMapKeyType & that) const {
1251 return this->opcode < that.opcode ||
1252 (this->opcode == that.opcode && this->predicate < that.predicate) ||
1253 (this->opcode == that.opcode && this->predicate == that.predicate &&
1254 this->operands < that.operands) ||
1255 (this->opcode == that.opcode && this->predicate == that.predicate &&
1256 this->operands == that.operands && this->indices < that.indices);
1259 bool operator!=(const ExprMapKeyType& that) const {
1260 return !(*this == that);
1268 struct ConstantCreator<ConstantExpr, Type, ExprMapKeyType> {
1269 static ConstantExpr *create(const Type *Ty, const ExprMapKeyType &V,
1270 unsigned short pred = 0) {
1271 if (Instruction::isCast(V.opcode))
1272 return new UnaryConstantExpr(V.opcode, V.operands[0], Ty);
1273 if ((V.opcode >= Instruction::BinaryOpsBegin &&
1274 V.opcode < Instruction::BinaryOpsEnd))
1275 return new BinaryConstantExpr(V.opcode, V.operands[0], V.operands[1]);
1276 if (V.opcode == Instruction::Select)
1277 return new SelectConstantExpr(V.operands[0], V.operands[1],
1279 if (V.opcode == Instruction::ExtractElement)
1280 return new ExtractElementConstantExpr(V.operands[0], V.operands[1]);
1281 if (V.opcode == Instruction::InsertElement)
1282 return new InsertElementConstantExpr(V.operands[0], V.operands[1],
1284 if (V.opcode == Instruction::ShuffleVector)
1285 return new ShuffleVectorConstantExpr(V.operands[0], V.operands[1],
1287 if (V.opcode == Instruction::InsertValue)
1288 return new InsertValueConstantExpr(V.operands[0], V.operands[1],
1290 if (V.opcode == Instruction::ExtractValue)
1291 return new ExtractValueConstantExpr(V.operands[0], V.indices, Ty);
1292 if (V.opcode == Instruction::GetElementPtr) {
1293 std::vector<Constant*> IdxList(V.operands.begin()+1, V.operands.end());
1294 return GetElementPtrConstantExpr::Create(V.operands[0], IdxList, Ty);
1297 // The compare instructions are weird. We have to encode the predicate
1298 // value and it is combined with the instruction opcode by multiplying
1299 // the opcode by one hundred. We must decode this to get the predicate.
1300 if (V.opcode == Instruction::ICmp)
1301 return new CompareConstantExpr(Ty, Instruction::ICmp, V.predicate,
1302 V.operands[0], V.operands[1]);
1303 if (V.opcode == Instruction::FCmp)
1304 return new CompareConstantExpr(Ty, Instruction::FCmp, V.predicate,
1305 V.operands[0], V.operands[1]);
1306 llvm_unreachable("Invalid ConstantExpr!");
1312 struct ConvertConstantType<ConstantExpr, Type> {
1313 static void convert(ConstantExpr *OldC, const Type *NewTy) {
1315 switch (OldC->getOpcode()) {
1316 case Instruction::Trunc:
1317 case Instruction::ZExt:
1318 case Instruction::SExt:
1319 case Instruction::FPTrunc:
1320 case Instruction::FPExt:
1321 case Instruction::UIToFP:
1322 case Instruction::SIToFP:
1323 case Instruction::FPToUI:
1324 case Instruction::FPToSI:
1325 case Instruction::PtrToInt:
1326 case Instruction::IntToPtr:
1327 case Instruction::BitCast:
1328 New = ConstantExpr::getCast(OldC->getOpcode(), OldC->getOperand(0),
1331 case Instruction::Select:
1332 New = ConstantExpr::getSelectTy(NewTy, OldC->getOperand(0),
1333 OldC->getOperand(1),
1334 OldC->getOperand(2));
1337 assert(OldC->getOpcode() >= Instruction::BinaryOpsBegin &&
1338 OldC->getOpcode() < Instruction::BinaryOpsEnd);
1339 New = ConstantExpr::getTy(NewTy, OldC->getOpcode(), OldC->getOperand(0),
1340 OldC->getOperand(1));
1342 case Instruction::GetElementPtr:
1343 // Make everyone now use a constant of the new type...
1344 std::vector<Value*> Idx(OldC->op_begin()+1, OldC->op_end());
1345 New = ConstantExpr::getGetElementPtrTy(NewTy, OldC->getOperand(0),
1346 &Idx[0], Idx.size());
1350 assert(New != OldC && "Didn't replace constant??");
1351 OldC->uncheckedReplaceAllUsesWith(New);
1352 OldC->destroyConstant(); // This constant is now dead, destroy it.
1355 } // end namespace llvm
1358 static ExprMapKeyType getValType(ConstantExpr *CE) {
1359 std::vector<Constant*> Operands;
1360 Operands.reserve(CE->getNumOperands());
1361 for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i)
1362 Operands.push_back(cast<Constant>(CE->getOperand(i)));
1363 return ExprMapKeyType(CE->getOpcode(), Operands,
1364 CE->isCompare() ? CE->getPredicate() : 0,
1366 CE->getIndices() : SmallVector<unsigned, 4>());
1369 static ManagedStatic<ValueMap<ExprMapKeyType, Type,
1370 ConstantExpr> > ExprConstants;
1372 /// This is a utility function to handle folding of casts and lookup of the
1373 /// cast in the ExprConstants map. It is used by the various get* methods below.
1374 static inline Constant *getFoldedCast(
1375 Instruction::CastOps opc, Constant *C, const Type *Ty) {
1376 assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1377 // Fold a few common cases
1379 ConstantFoldCastInstruction(getGlobalContext(), opc, C, Ty))
1382 // Look up the constant in the table first to ensure uniqueness
1383 std::vector<Constant*> argVec(1, C);
1384 ExprMapKeyType Key(opc, argVec);
1386 // Implicitly locked.
1387 return ExprConstants->getOrCreate(Ty, Key);
1390 Constant *ConstantExpr::getCast(unsigned oc, Constant *C, const Type *Ty) {
1391 Instruction::CastOps opc = Instruction::CastOps(oc);
1392 assert(Instruction::isCast(opc) && "opcode out of range");
1393 assert(C && Ty && "Null arguments to getCast");
1394 assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1398 llvm_unreachable("Invalid cast opcode");
1400 case Instruction::Trunc: return getTrunc(C, Ty);
1401 case Instruction::ZExt: return getZExt(C, Ty);
1402 case Instruction::SExt: return getSExt(C, Ty);
1403 case Instruction::FPTrunc: return getFPTrunc(C, Ty);
1404 case Instruction::FPExt: return getFPExtend(C, Ty);
1405 case Instruction::UIToFP: return getUIToFP(C, Ty);
1406 case Instruction::SIToFP: return getSIToFP(C, Ty);
1407 case Instruction::FPToUI: return getFPToUI(C, Ty);
1408 case Instruction::FPToSI: return getFPToSI(C, Ty);
1409 case Instruction::PtrToInt: return getPtrToInt(C, Ty);
1410 case Instruction::IntToPtr: return getIntToPtr(C, Ty);
1411 case Instruction::BitCast: return getBitCast(C, Ty);
1416 Constant *ConstantExpr::getZExtOrBitCast(Constant *C, const Type *Ty) {
1417 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1418 return getCast(Instruction::BitCast, C, Ty);
1419 return getCast(Instruction::ZExt, C, Ty);
1422 Constant *ConstantExpr::getSExtOrBitCast(Constant *C, const Type *Ty) {
1423 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1424 return getCast(Instruction::BitCast, C, Ty);
1425 return getCast(Instruction::SExt, C, Ty);
1428 Constant *ConstantExpr::getTruncOrBitCast(Constant *C, const Type *Ty) {
1429 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1430 return getCast(Instruction::BitCast, C, Ty);
1431 return getCast(Instruction::Trunc, C, Ty);
1434 Constant *ConstantExpr::getPointerCast(Constant *S, const Type *Ty) {
1435 assert(isa<PointerType>(S->getType()) && "Invalid cast");
1436 assert((Ty->isInteger() || isa<PointerType>(Ty)) && "Invalid cast");
1438 if (Ty->isInteger())
1439 return getCast(Instruction::PtrToInt, S, Ty);
1440 return getCast(Instruction::BitCast, S, Ty);
1443 Constant *ConstantExpr::getIntegerCast(Constant *C, const Type *Ty,
1445 assert(C->getType()->isIntOrIntVector() &&
1446 Ty->isIntOrIntVector() && "Invalid cast");
1447 unsigned SrcBits = C->getType()->getScalarSizeInBits();
1448 unsigned DstBits = Ty->getScalarSizeInBits();
1449 Instruction::CastOps opcode =
1450 (SrcBits == DstBits ? Instruction::BitCast :
1451 (SrcBits > DstBits ? Instruction::Trunc :
1452 (isSigned ? Instruction::SExt : Instruction::ZExt)));
1453 return getCast(opcode, C, Ty);
1456 Constant *ConstantExpr::getFPCast(Constant *C, const Type *Ty) {
1457 assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
1459 unsigned SrcBits = C->getType()->getScalarSizeInBits();
1460 unsigned DstBits = Ty->getScalarSizeInBits();
1461 if (SrcBits == DstBits)
1462 return C; // Avoid a useless cast
1463 Instruction::CastOps opcode =
1464 (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt);
1465 return getCast(opcode, C, Ty);
1468 Constant *ConstantExpr::getTrunc(Constant *C, const Type *Ty) {
1470 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1471 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1473 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1474 assert(C->getType()->isIntOrIntVector() && "Trunc operand must be integer");
1475 assert(Ty->isIntOrIntVector() && "Trunc produces only integral");
1476 assert(C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1477 "SrcTy must be larger than DestTy for Trunc!");
1479 return getFoldedCast(Instruction::Trunc, C, Ty);
1482 Constant *ConstantExpr::getSExt(Constant *C, const Type *Ty) {
1484 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1485 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1487 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1488 assert(C->getType()->isIntOrIntVector() && "SExt operand must be integral");
1489 assert(Ty->isIntOrIntVector() && "SExt produces only integer");
1490 assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1491 "SrcTy must be smaller than DestTy for SExt!");
1493 return getFoldedCast(Instruction::SExt, C, Ty);
1496 Constant *ConstantExpr::getZExt(Constant *C, const Type *Ty) {
1498 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1499 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1501 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1502 assert(C->getType()->isIntOrIntVector() && "ZEXt operand must be integral");
1503 assert(Ty->isIntOrIntVector() && "ZExt produces only integer");
1504 assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1505 "SrcTy must be smaller than DestTy for ZExt!");
1507 return getFoldedCast(Instruction::ZExt, C, Ty);
1510 Constant *ConstantExpr::getFPTrunc(Constant *C, const Type *Ty) {
1512 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1513 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1515 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1516 assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
1517 C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1518 "This is an illegal floating point truncation!");
1519 return getFoldedCast(Instruction::FPTrunc, C, Ty);
1522 Constant *ConstantExpr::getFPExtend(Constant *C, const Type *Ty) {
1524 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1525 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1527 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1528 assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
1529 C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1530 "This is an illegal floating point extension!");
1531 return getFoldedCast(Instruction::FPExt, C, Ty);
1534 Constant *ConstantExpr::getUIToFP(Constant *C, const Type *Ty) {
1536 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1537 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1539 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1540 assert(C->getType()->isIntOrIntVector() && Ty->isFPOrFPVector() &&
1541 "This is an illegal uint to floating point cast!");
1542 return getFoldedCast(Instruction::UIToFP, C, Ty);
1545 Constant *ConstantExpr::getSIToFP(Constant *C, const Type *Ty) {
1547 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1548 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1550 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1551 assert(C->getType()->isIntOrIntVector() && Ty->isFPOrFPVector() &&
1552 "This is an illegal sint to floating point cast!");
1553 return getFoldedCast(Instruction::SIToFP, C, Ty);
1556 Constant *ConstantExpr::getFPToUI(Constant *C, const Type *Ty) {
1558 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1559 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1561 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1562 assert(C->getType()->isFPOrFPVector() && Ty->isIntOrIntVector() &&
1563 "This is an illegal floating point to uint cast!");
1564 return getFoldedCast(Instruction::FPToUI, C, Ty);
1567 Constant *ConstantExpr::getFPToSI(Constant *C, const Type *Ty) {
1569 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1570 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1572 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1573 assert(C->getType()->isFPOrFPVector() && Ty->isIntOrIntVector() &&
1574 "This is an illegal floating point to sint cast!");
1575 return getFoldedCast(Instruction::FPToSI, C, Ty);
1578 Constant *ConstantExpr::getPtrToInt(Constant *C, const Type *DstTy) {
1579 assert(isa<PointerType>(C->getType()) && "PtrToInt source must be pointer");
1580 assert(DstTy->isInteger() && "PtrToInt destination must be integral");
1581 return getFoldedCast(Instruction::PtrToInt, C, DstTy);
1584 Constant *ConstantExpr::getIntToPtr(Constant *C, const Type *DstTy) {
1585 assert(C->getType()->isInteger() && "IntToPtr source must be integral");
1586 assert(isa<PointerType>(DstTy) && "IntToPtr destination must be a pointer");
1587 return getFoldedCast(Instruction::IntToPtr, C, DstTy);
1590 Constant *ConstantExpr::getBitCast(Constant *C, const Type *DstTy) {
1591 // BitCast implies a no-op cast of type only. No bits change. However, you
1592 // can't cast pointers to anything but pointers.
1594 const Type *SrcTy = C->getType();
1595 assert((isa<PointerType>(SrcTy) == isa<PointerType>(DstTy)) &&
1596 "BitCast cannot cast pointer to non-pointer and vice versa");
1598 // Now we know we're not dealing with mismatched pointer casts (ptr->nonptr
1599 // or nonptr->ptr). For all the other types, the cast is okay if source and
1600 // destination bit widths are identical.
1601 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
1602 unsigned DstBitSize = DstTy->getPrimitiveSizeInBits();
1604 assert(SrcBitSize == DstBitSize && "BitCast requires types of same width");
1606 // It is common to ask for a bitcast of a value to its own type, handle this
1608 if (C->getType() == DstTy) return C;
1610 return getFoldedCast(Instruction::BitCast, C, DstTy);
1613 Constant *ConstantExpr::getTy(const Type *ReqTy, unsigned Opcode,
1614 Constant *C1, Constant *C2) {
1615 // Check the operands for consistency first
1616 assert(Opcode >= Instruction::BinaryOpsBegin &&
1617 Opcode < Instruction::BinaryOpsEnd &&
1618 "Invalid opcode in binary constant expression");
1619 assert(C1->getType() == C2->getType() &&
1620 "Operand types in binary constant expression should match");
1622 if (ReqTy == C1->getType() || ReqTy == Type::Int1Ty)
1623 if (Constant *FC = ConstantFoldBinaryInstruction(
1624 getGlobalContext(), Opcode, C1, C2))
1625 return FC; // Fold a few common cases...
1627 std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1628 ExprMapKeyType Key(Opcode, argVec);
1630 // Implicitly locked.
1631 return ExprConstants->getOrCreate(ReqTy, Key);
1634 Constant *ConstantExpr::getCompareTy(unsigned short predicate,
1635 Constant *C1, Constant *C2) {
1636 switch (predicate) {
1637 default: llvm_unreachable("Invalid CmpInst predicate");
1638 case CmpInst::FCMP_FALSE: case CmpInst::FCMP_OEQ: case CmpInst::FCMP_OGT:
1639 case CmpInst::FCMP_OGE: case CmpInst::FCMP_OLT: case CmpInst::FCMP_OLE:
1640 case CmpInst::FCMP_ONE: case CmpInst::FCMP_ORD: case CmpInst::FCMP_UNO:
1641 case CmpInst::FCMP_UEQ: case CmpInst::FCMP_UGT: case CmpInst::FCMP_UGE:
1642 case CmpInst::FCMP_ULT: case CmpInst::FCMP_ULE: case CmpInst::FCMP_UNE:
1643 case CmpInst::FCMP_TRUE:
1644 return getFCmp(predicate, C1, C2);
1646 case CmpInst::ICMP_EQ: case CmpInst::ICMP_NE: case CmpInst::ICMP_UGT:
1647 case CmpInst::ICMP_UGE: case CmpInst::ICMP_ULT: case CmpInst::ICMP_ULE:
1648 case CmpInst::ICMP_SGT: case CmpInst::ICMP_SGE: case CmpInst::ICMP_SLT:
1649 case CmpInst::ICMP_SLE:
1650 return getICmp(predicate, C1, C2);
1654 Constant *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2) {
1655 // API compatibility: Adjust integer opcodes to floating-point opcodes.
1656 if (C1->getType()->isFPOrFPVector()) {
1657 if (Opcode == Instruction::Add) Opcode = Instruction::FAdd;
1658 else if (Opcode == Instruction::Sub) Opcode = Instruction::FSub;
1659 else if (Opcode == Instruction::Mul) Opcode = Instruction::FMul;
1663 case Instruction::Add:
1664 case Instruction::Sub:
1665 case Instruction::Mul:
1666 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1667 assert(C1->getType()->isIntOrIntVector() &&
1668 "Tried to create an integer operation on a non-integer type!");
1670 case Instruction::FAdd:
1671 case Instruction::FSub:
1672 case Instruction::FMul:
1673 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1674 assert(C1->getType()->isFPOrFPVector() &&
1675 "Tried to create a floating-point operation on a "
1676 "non-floating-point type!");
1678 case Instruction::UDiv:
1679 case Instruction::SDiv:
1680 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1681 assert(C1->getType()->isIntOrIntVector() &&
1682 "Tried to create an arithmetic operation on a non-arithmetic type!");
1684 case Instruction::FDiv:
1685 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1686 assert(C1->getType()->isFPOrFPVector() &&
1687 "Tried to create an arithmetic operation on a non-arithmetic type!");
1689 case Instruction::URem:
1690 case Instruction::SRem:
1691 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1692 assert(C1->getType()->isIntOrIntVector() &&
1693 "Tried to create an arithmetic operation on a non-arithmetic type!");
1695 case Instruction::FRem:
1696 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1697 assert(C1->getType()->isFPOrFPVector() &&
1698 "Tried to create an arithmetic operation on a non-arithmetic type!");
1700 case Instruction::And:
1701 case Instruction::Or:
1702 case Instruction::Xor:
1703 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1704 assert(C1->getType()->isIntOrIntVector() &&
1705 "Tried to create a logical operation on a non-integral type!");
1707 case Instruction::Shl:
1708 case Instruction::LShr:
1709 case Instruction::AShr:
1710 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1711 assert(C1->getType()->isIntOrIntVector() &&
1712 "Tried to create a shift operation on a non-integer type!");
1719 return getTy(C1->getType(), Opcode, C1, C2);
1722 Constant* ConstantExpr::getSizeOf(const Type* Ty) {
1723 // sizeof is implemented as: (i64) gep (Ty*)null, 1
1724 // Note that a non-inbounds gep is used, as null isn't within any object.
1725 LLVMContext &Context = Ty->getContext();
1726 Constant *GEPIdx = ConstantInt::get(Type::Int32Ty, 1);
1727 Constant *GEP = getGetElementPtr(
1728 Context.getNullValue(PointerType::getUnqual(Ty)), &GEPIdx, 1);
1729 return getCast(Instruction::PtrToInt, GEP, Type::Int64Ty);
1732 Constant* ConstantExpr::getAlignOf(const Type* Ty) {
1733 LLVMContext &Context = Ty->getContext();
1734 // alignof is implemented as: (i64) gep ({i8,Ty}*)null, 0, 1
1735 const Type *AligningTy = StructType::get(Type::Int8Ty, Ty, NULL);
1736 Constant *NullPtr = Context.getNullValue(AligningTy->getPointerTo());
1737 Constant *Zero = ConstantInt::get(Type::Int32Ty, 0);
1738 Constant *One = ConstantInt::get(Type::Int32Ty, 1);
1739 Constant *Indices[2] = { Zero, One };
1740 Constant *GEP = getGetElementPtr(NullPtr, Indices, 2);
1741 return getCast(Instruction::PtrToInt, GEP, Type::Int32Ty);
1745 Constant *ConstantExpr::getCompare(unsigned short pred,
1746 Constant *C1, Constant *C2) {
1747 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1748 return getCompareTy(pred, C1, C2);
1751 Constant *ConstantExpr::getSelectTy(const Type *ReqTy, Constant *C,
1752 Constant *V1, Constant *V2) {
1753 assert(!SelectInst::areInvalidOperands(C, V1, V2)&&"Invalid select operands");
1755 if (ReqTy == V1->getType())
1756 if (Constant *SC = ConstantFoldSelectInstruction(
1757 getGlobalContext(), C, V1, V2))
1758 return SC; // Fold common cases
1760 std::vector<Constant*> argVec(3, C);
1763 ExprMapKeyType Key(Instruction::Select, argVec);
1765 // Implicitly locked.
1766 return ExprConstants->getOrCreate(ReqTy, Key);
1769 Constant *ConstantExpr::getGetElementPtrTy(const Type *ReqTy, Constant *C,
1772 assert(GetElementPtrInst::getIndexedType(C->getType(), Idxs,
1774 cast<PointerType>(ReqTy)->getElementType() &&
1775 "GEP indices invalid!");
1777 if (Constant *FC = ConstantFoldGetElementPtr(
1778 getGlobalContext(), C, (Constant**)Idxs, NumIdx))
1779 return FC; // Fold a few common cases...
1781 assert(isa<PointerType>(C->getType()) &&
1782 "Non-pointer type for constant GetElementPtr expression");
1783 // Look up the constant in the table first to ensure uniqueness
1784 std::vector<Constant*> ArgVec;
1785 ArgVec.reserve(NumIdx+1);
1786 ArgVec.push_back(C);
1787 for (unsigned i = 0; i != NumIdx; ++i)
1788 ArgVec.push_back(cast<Constant>(Idxs[i]));
1789 const ExprMapKeyType Key(Instruction::GetElementPtr, ArgVec);
1791 // Implicitly locked.
1792 return ExprConstants->getOrCreate(ReqTy, Key);
1795 Constant *ConstantExpr::getGetElementPtr(Constant *C, Value* const *Idxs,
1797 // Get the result type of the getelementptr!
1799 GetElementPtrInst::getIndexedType(C->getType(), Idxs, Idxs+NumIdx);
1800 assert(Ty && "GEP indices invalid!");
1801 unsigned As = cast<PointerType>(C->getType())->getAddressSpace();
1802 return getGetElementPtrTy(PointerType::get(Ty, As), C, Idxs, NumIdx);
1805 Constant *ConstantExpr::getGetElementPtr(Constant *C, Constant* const *Idxs,
1807 return getGetElementPtr(C, (Value* const *)Idxs, NumIdx);
1812 ConstantExpr::getICmp(unsigned short pred, Constant* LHS, Constant* RHS) {
1813 assert(LHS->getType() == RHS->getType());
1814 assert(pred >= ICmpInst::FIRST_ICMP_PREDICATE &&
1815 pred <= ICmpInst::LAST_ICMP_PREDICATE && "Invalid ICmp Predicate");
1817 if (Constant *FC = ConstantFoldCompareInstruction(
1818 getGlobalContext(),pred, LHS, RHS))
1819 return FC; // Fold a few common cases...
1821 // Look up the constant in the table first to ensure uniqueness
1822 std::vector<Constant*> ArgVec;
1823 ArgVec.push_back(LHS);
1824 ArgVec.push_back(RHS);
1825 // Get the key type with both the opcode and predicate
1826 const ExprMapKeyType Key(Instruction::ICmp, ArgVec, pred);
1828 // Implicitly locked.
1829 return ExprConstants->getOrCreate(Type::Int1Ty, Key);
1833 ConstantExpr::getFCmp(unsigned short pred, Constant* LHS, Constant* RHS) {
1834 assert(LHS->getType() == RHS->getType());
1835 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE && "Invalid FCmp Predicate");
1837 if (Constant *FC = ConstantFoldCompareInstruction(
1838 getGlobalContext(), pred, LHS, RHS))
1839 return FC; // Fold a few common cases...
1841 // Look up the constant in the table first to ensure uniqueness
1842 std::vector<Constant*> ArgVec;
1843 ArgVec.push_back(LHS);
1844 ArgVec.push_back(RHS);
1845 // Get the key type with both the opcode and predicate
1846 const ExprMapKeyType Key(Instruction::FCmp, ArgVec, pred);
1848 // Implicitly locked.
1849 return ExprConstants->getOrCreate(Type::Int1Ty, Key);
1852 Constant *ConstantExpr::getExtractElementTy(const Type *ReqTy, Constant *Val,
1854 if (Constant *FC = ConstantFoldExtractElementInstruction(
1855 getGlobalContext(), Val, Idx))
1856 return FC; // Fold a few common cases...
1857 // Look up the constant in the table first to ensure uniqueness
1858 std::vector<Constant*> ArgVec(1, Val);
1859 ArgVec.push_back(Idx);
1860 const ExprMapKeyType Key(Instruction::ExtractElement,ArgVec);
1862 // Implicitly locked.
1863 return ExprConstants->getOrCreate(ReqTy, Key);
1866 Constant *ConstantExpr::getExtractElement(Constant *Val, Constant *Idx) {
1867 assert(isa<VectorType>(Val->getType()) &&
1868 "Tried to create extractelement operation on non-vector type!");
1869 assert(Idx->getType() == Type::Int32Ty &&
1870 "Extractelement index must be i32 type!");
1871 return getExtractElementTy(cast<VectorType>(Val->getType())->getElementType(),
1875 Constant *ConstantExpr::getInsertElementTy(const Type *ReqTy, Constant *Val,
1876 Constant *Elt, Constant *Idx) {
1877 if (Constant *FC = ConstantFoldInsertElementInstruction(
1878 getGlobalContext(), Val, Elt, Idx))
1879 return FC; // Fold a few common cases...
1880 // Look up the constant in the table first to ensure uniqueness
1881 std::vector<Constant*> ArgVec(1, Val);
1882 ArgVec.push_back(Elt);
1883 ArgVec.push_back(Idx);
1884 const ExprMapKeyType Key(Instruction::InsertElement,ArgVec);
1886 // Implicitly locked.
1887 return ExprConstants->getOrCreate(ReqTy, Key);
1890 Constant *ConstantExpr::getInsertElement(Constant *Val, Constant *Elt,
1892 assert(isa<VectorType>(Val->getType()) &&
1893 "Tried to create insertelement operation on non-vector type!");
1894 assert(Elt->getType() == cast<VectorType>(Val->getType())->getElementType()
1895 && "Insertelement types must match!");
1896 assert(Idx->getType() == Type::Int32Ty &&
1897 "Insertelement index must be i32 type!");
1898 return getInsertElementTy(Val->getType(), Val, Elt, Idx);
1901 Constant *ConstantExpr::getShuffleVectorTy(const Type *ReqTy, Constant *V1,
1902 Constant *V2, Constant *Mask) {
1903 if (Constant *FC = ConstantFoldShuffleVectorInstruction(
1904 getGlobalContext(), V1, V2, Mask))
1905 return FC; // Fold a few common cases...
1906 // Look up the constant in the table first to ensure uniqueness
1907 std::vector<Constant*> ArgVec(1, V1);
1908 ArgVec.push_back(V2);
1909 ArgVec.push_back(Mask);
1910 const ExprMapKeyType Key(Instruction::ShuffleVector,ArgVec);
1912 // Implicitly locked.
1913 return ExprConstants->getOrCreate(ReqTy, Key);
1916 Constant *ConstantExpr::getShuffleVector(Constant *V1, Constant *V2,
1918 assert(ShuffleVectorInst::isValidOperands(V1, V2, Mask) &&
1919 "Invalid shuffle vector constant expr operands!");
1921 unsigned NElts = cast<VectorType>(Mask->getType())->getNumElements();
1922 const Type *EltTy = cast<VectorType>(V1->getType())->getElementType();
1923 const Type *ShufTy = VectorType::get(EltTy, NElts);
1924 return getShuffleVectorTy(ShufTy, V1, V2, Mask);
1927 Constant *ConstantExpr::getInsertValueTy(const Type *ReqTy, Constant *Agg,
1929 const unsigned *Idxs, unsigned NumIdx) {
1930 assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs,
1931 Idxs+NumIdx) == Val->getType() &&
1932 "insertvalue indices invalid!");
1933 assert(Agg->getType() == ReqTy &&
1934 "insertvalue type invalid!");
1935 assert(Agg->getType()->isFirstClassType() &&
1936 "Non-first-class type for constant InsertValue expression");
1937 Constant *FC = ConstantFoldInsertValueInstruction(
1938 getGlobalContext(), Agg, Val, Idxs, NumIdx);
1939 assert(FC && "InsertValue constant expr couldn't be folded!");
1943 Constant *ConstantExpr::getInsertValue(Constant *Agg, Constant *Val,
1944 const unsigned *IdxList, unsigned NumIdx) {
1945 assert(Agg->getType()->isFirstClassType() &&
1946 "Tried to create insertelement operation on non-first-class type!");
1948 const Type *ReqTy = Agg->getType();
1951 ExtractValueInst::getIndexedType(Agg->getType(), IdxList, IdxList+NumIdx);
1953 assert(ValTy == Val->getType() && "insertvalue indices invalid!");
1954 return getInsertValueTy(ReqTy, Agg, Val, IdxList, NumIdx);
1957 Constant *ConstantExpr::getExtractValueTy(const Type *ReqTy, Constant *Agg,
1958 const unsigned *Idxs, unsigned NumIdx) {
1959 assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs,
1960 Idxs+NumIdx) == ReqTy &&
1961 "extractvalue indices invalid!");
1962 assert(Agg->getType()->isFirstClassType() &&
1963 "Non-first-class type for constant extractvalue expression");
1964 Constant *FC = ConstantFoldExtractValueInstruction(
1965 getGlobalContext(), Agg, Idxs, NumIdx);
1966 assert(FC && "ExtractValue constant expr couldn't be folded!");
1970 Constant *ConstantExpr::getExtractValue(Constant *Agg,
1971 const unsigned *IdxList, unsigned NumIdx) {
1972 assert(Agg->getType()->isFirstClassType() &&
1973 "Tried to create extractelement operation on non-first-class type!");
1976 ExtractValueInst::getIndexedType(Agg->getType(), IdxList, IdxList+NumIdx);
1977 assert(ReqTy && "extractvalue indices invalid!");
1978 return getExtractValueTy(ReqTy, Agg, IdxList, NumIdx);
1981 Constant* ConstantExpr::getNeg(Constant* C) {
1982 // API compatibility: Adjust integer opcodes to floating-point opcodes.
1983 if (C->getType()->isFPOrFPVector())
1985 assert(C->getType()->isIntOrIntVector() &&
1986 "Cannot NEG a nonintegral value!");
1987 return get(Instruction::Sub,
1988 ConstantFP::getZeroValueForNegation(C->getType()),
1992 Constant* ConstantExpr::getFNeg(Constant* C) {
1993 assert(C->getType()->isFPOrFPVector() &&
1994 "Cannot FNEG a non-floating-point value!");
1995 return get(Instruction::FSub,
1996 ConstantFP::getZeroValueForNegation(C->getType()),
2000 Constant* ConstantExpr::getNot(Constant* C) {
2001 assert(C->getType()->isIntOrIntVector() &&
2002 "Cannot NOT a nonintegral value!");
2003 LLVMContext &Context = C->getType()->getContext();
2004 return get(Instruction::Xor, C, Context.getAllOnesValue(C->getType()));
2007 Constant* ConstantExpr::getAdd(Constant* C1, Constant* C2) {
2008 return get(Instruction::Add, C1, C2);
2011 Constant* ConstantExpr::getFAdd(Constant* C1, Constant* C2) {
2012 return get(Instruction::FAdd, C1, C2);
2015 Constant* ConstantExpr::getSub(Constant* C1, Constant* C2) {
2016 return get(Instruction::Sub, C1, C2);
2019 Constant* ConstantExpr::getFSub(Constant* C1, Constant* C2) {
2020 return get(Instruction::FSub, C1, C2);
2023 Constant* ConstantExpr::getMul(Constant* C1, Constant* C2) {
2024 return get(Instruction::Mul, C1, C2);
2027 Constant* ConstantExpr::getFMul(Constant* C1, Constant* C2) {
2028 return get(Instruction::FMul, C1, C2);
2031 Constant* ConstantExpr::getUDiv(Constant* C1, Constant* C2) {
2032 return get(Instruction::UDiv, C1, C2);
2035 Constant* ConstantExpr::getSDiv(Constant* C1, Constant* C2) {
2036 return get(Instruction::SDiv, C1, C2);
2039 Constant* ConstantExpr::getFDiv(Constant* C1, Constant* C2) {
2040 return get(Instruction::FDiv, C1, C2);
2043 Constant* ConstantExpr::getURem(Constant* C1, Constant* C2) {
2044 return get(Instruction::URem, C1, C2);
2047 Constant* ConstantExpr::getSRem(Constant* C1, Constant* C2) {
2048 return get(Instruction::SRem, C1, C2);
2051 Constant* ConstantExpr::getFRem(Constant* C1, Constant* C2) {
2052 return get(Instruction::FRem, C1, C2);
2055 Constant* ConstantExpr::getAnd(Constant* C1, Constant* C2) {
2056 return get(Instruction::And, C1, C2);
2059 Constant* ConstantExpr::getOr(Constant* C1, Constant* C2) {
2060 return get(Instruction::Or, C1, C2);
2063 Constant* ConstantExpr::getXor(Constant* C1, Constant* C2) {
2064 return get(Instruction::Xor, C1, C2);
2067 Constant* ConstantExpr::getShl(Constant* C1, Constant* C2) {
2068 return get(Instruction::Shl, C1, C2);
2071 Constant* ConstantExpr::getLShr(Constant* C1, Constant* C2) {
2072 return get(Instruction::LShr, C1, C2);
2075 Constant* ConstantExpr::getAShr(Constant* C1, Constant* C2) {
2076 return get(Instruction::AShr, C1, C2);
2079 // destroyConstant - Remove the constant from the constant table...
2081 void ConstantExpr::destroyConstant() {
2082 // Implicitly locked.
2083 ExprConstants->remove(this);
2084 destroyConstantImpl();
2087 const char *ConstantExpr::getOpcodeName() const {
2088 return Instruction::getOpcodeName(getOpcode());
2091 //===----------------------------------------------------------------------===//
2092 // replaceUsesOfWithOnConstant implementations
2094 /// replaceUsesOfWithOnConstant - Update this constant array to change uses of
2095 /// 'From' to be uses of 'To'. This must update the uniquing data structures
2098 /// Note that we intentionally replace all uses of From with To here. Consider
2099 /// a large array that uses 'From' 1000 times. By handling this case all here,
2100 /// ConstantArray::replaceUsesOfWithOnConstant is only invoked once, and that
2101 /// single invocation handles all 1000 uses. Handling them one at a time would
2102 /// work, but would be really slow because it would have to unique each updated
2105 static std::vector<Constant*> getValType(ConstantArray *CA) {
2106 std::vector<Constant*> Elements;
2107 Elements.reserve(CA->getNumOperands());
2108 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
2109 Elements.push_back(cast<Constant>(CA->getOperand(i)));
2114 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
2116 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2117 Constant *ToC = cast<Constant>(To);
2119 LLVMContext &Context = getType()->getContext();
2120 LLVMContextImpl *pImpl = Context.pImpl;
2122 std::pair<LLVMContextImpl::ArrayConstantsTy::MapKey, Constant*> Lookup;
2123 Lookup.first.first = getType();
2124 Lookup.second = this;
2126 std::vector<Constant*> &Values = Lookup.first.second;
2127 Values.reserve(getNumOperands()); // Build replacement array.
2129 // Fill values with the modified operands of the constant array. Also,
2130 // compute whether this turns into an all-zeros array.
2131 bool isAllZeros = false;
2132 unsigned NumUpdated = 0;
2133 if (!ToC->isNullValue()) {
2134 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2135 Constant *Val = cast<Constant>(O->get());
2140 Values.push_back(Val);
2144 for (Use *O = OperandList, *E = OperandList+getNumOperands();O != E; ++O) {
2145 Constant *Val = cast<Constant>(O->get());
2150 Values.push_back(Val);
2151 if (isAllZeros) isAllZeros = Val->isNullValue();
2155 Constant *Replacement = 0;
2157 Replacement = Context.getConstantAggregateZero(getType());
2159 // Check to see if we have this array type already.
2160 sys::SmartScopedWriter<true> Writer(pImpl->ConstantsLock);
2162 LLVMContextImpl::ArrayConstantsTy::MapTy::iterator I =
2163 pImpl->ArrayConstants.InsertOrGetItem(Lookup, Exists);
2166 Replacement = I->second;
2168 // Okay, the new shape doesn't exist in the system yet. Instead of
2169 // creating a new constant array, inserting it, replaceallusesof'ing the
2170 // old with the new, then deleting the old... just update the current one
2172 pImpl->ArrayConstants.MoveConstantToNewSlot(this, I);
2174 // Update to the new value. Optimize for the case when we have a single
2175 // operand that we're changing, but handle bulk updates efficiently.
2176 if (NumUpdated == 1) {
2177 unsigned OperandToUpdate = U - OperandList;
2178 assert(getOperand(OperandToUpdate) == From &&
2179 "ReplaceAllUsesWith broken!");
2180 setOperand(OperandToUpdate, ToC);
2182 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2183 if (getOperand(i) == From)
2190 // Otherwise, I do need to replace this with an existing value.
2191 assert(Replacement != this && "I didn't contain From!");
2193 // Everyone using this now uses the replacement.
2194 uncheckedReplaceAllUsesWith(Replacement);
2196 // Delete the old constant!
2200 static std::vector<Constant*> getValType(ConstantStruct *CS) {
2201 std::vector<Constant*> Elements;
2202 Elements.reserve(CS->getNumOperands());
2203 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i)
2204 Elements.push_back(cast<Constant>(CS->getOperand(i)));
2208 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
2210 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2211 Constant *ToC = cast<Constant>(To);
2213 unsigned OperandToUpdate = U-OperandList;
2214 assert(getOperand(OperandToUpdate) == From && "ReplaceAllUsesWith broken!");
2216 std::pair<LLVMContextImpl::StructConstantsTy::MapKey, Constant*> Lookup;
2217 Lookup.first.first = getType();
2218 Lookup.second = this;
2219 std::vector<Constant*> &Values = Lookup.first.second;
2220 Values.reserve(getNumOperands()); // Build replacement struct.
2223 // Fill values with the modified operands of the constant struct. Also,
2224 // compute whether this turns into an all-zeros struct.
2225 bool isAllZeros = false;
2226 if (!ToC->isNullValue()) {
2227 for (Use *O = OperandList, *E = OperandList + getNumOperands(); O != E; ++O)
2228 Values.push_back(cast<Constant>(O->get()));
2231 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2232 Constant *Val = cast<Constant>(O->get());
2233 Values.push_back(Val);
2234 if (isAllZeros) isAllZeros = Val->isNullValue();
2237 Values[OperandToUpdate] = ToC;
2239 LLVMContext &Context = getType()->getContext();
2240 LLVMContextImpl *pImpl = Context.pImpl;
2242 Constant *Replacement = 0;
2244 Replacement = Context.getConstantAggregateZero(getType());
2246 // Check to see if we have this array type already.
2247 sys::SmartScopedWriter<true> Writer(pImpl->ConstantsLock);
2249 LLVMContextImpl::StructConstantsTy::MapTy::iterator I =
2250 pImpl->StructConstants.InsertOrGetItem(Lookup, Exists);
2253 Replacement = I->second;
2255 // Okay, the new shape doesn't exist in the system yet. Instead of
2256 // creating a new constant struct, inserting it, replaceallusesof'ing the
2257 // old with the new, then deleting the old... just update the current one
2259 pImpl->StructConstants.MoveConstantToNewSlot(this, I);
2261 // Update to the new value.
2262 setOperand(OperandToUpdate, ToC);
2267 assert(Replacement != this && "I didn't contain From!");
2269 // Everyone using this now uses the replacement.
2270 uncheckedReplaceAllUsesWith(Replacement);
2272 // Delete the old constant!
2276 static std::vector<Constant*> getValType(ConstantVector *CP) {
2277 std::vector<Constant*> Elements;
2278 Elements.reserve(CP->getNumOperands());
2279 for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
2280 Elements.push_back(CP->getOperand(i));
2284 void ConstantVector::replaceUsesOfWithOnConstant(Value *From, Value *To,
2286 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2288 std::vector<Constant*> Values;
2289 Values.reserve(getNumOperands()); // Build replacement array...
2290 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
2291 Constant *Val = getOperand(i);
2292 if (Val == From) Val = cast<Constant>(To);
2293 Values.push_back(Val);
2296 Constant *Replacement = get(getType(), Values);
2297 assert(Replacement != this && "I didn't contain From!");
2299 // Everyone using this now uses the replacement.
2300 uncheckedReplaceAllUsesWith(Replacement);
2302 // Delete the old constant!
2306 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
2308 assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
2309 Constant *To = cast<Constant>(ToV);
2311 Constant *Replacement = 0;
2312 if (getOpcode() == Instruction::GetElementPtr) {
2313 SmallVector<Constant*, 8> Indices;
2314 Constant *Pointer = getOperand(0);
2315 Indices.reserve(getNumOperands()-1);
2316 if (Pointer == From) Pointer = To;
2318 for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
2319 Constant *Val = getOperand(i);
2320 if (Val == From) Val = To;
2321 Indices.push_back(Val);
2323 Replacement = ConstantExpr::getGetElementPtr(Pointer,
2324 &Indices[0], Indices.size());
2325 } else if (getOpcode() == Instruction::ExtractValue) {
2326 Constant *Agg = getOperand(0);
2327 if (Agg == From) Agg = To;
2329 const SmallVector<unsigned, 4> &Indices = getIndices();
2330 Replacement = ConstantExpr::getExtractValue(Agg,
2331 &Indices[0], Indices.size());
2332 } else if (getOpcode() == Instruction::InsertValue) {
2333 Constant *Agg = getOperand(0);
2334 Constant *Val = getOperand(1);
2335 if (Agg == From) Agg = To;
2336 if (Val == From) Val = To;
2338 const SmallVector<unsigned, 4> &Indices = getIndices();
2339 Replacement = ConstantExpr::getInsertValue(Agg, Val,
2340 &Indices[0], Indices.size());
2341 } else if (isCast()) {
2342 assert(getOperand(0) == From && "Cast only has one use!");
2343 Replacement = ConstantExpr::getCast(getOpcode(), To, getType());
2344 } else if (getOpcode() == Instruction::Select) {
2345 Constant *C1 = getOperand(0);
2346 Constant *C2 = getOperand(1);
2347 Constant *C3 = getOperand(2);
2348 if (C1 == From) C1 = To;
2349 if (C2 == From) C2 = To;
2350 if (C3 == From) C3 = To;
2351 Replacement = ConstantExpr::getSelect(C1, C2, C3);
2352 } else if (getOpcode() == Instruction::ExtractElement) {
2353 Constant *C1 = getOperand(0);
2354 Constant *C2 = getOperand(1);
2355 if (C1 == From) C1 = To;
2356 if (C2 == From) C2 = To;
2357 Replacement = ConstantExpr::getExtractElement(C1, C2);
2358 } else if (getOpcode() == Instruction::InsertElement) {
2359 Constant *C1 = getOperand(0);
2360 Constant *C2 = getOperand(1);
2361 Constant *C3 = getOperand(1);
2362 if (C1 == From) C1 = To;
2363 if (C2 == From) C2 = To;
2364 if (C3 == From) C3 = To;
2365 Replacement = ConstantExpr::getInsertElement(C1, C2, C3);
2366 } else if (getOpcode() == Instruction::ShuffleVector) {
2367 Constant *C1 = getOperand(0);
2368 Constant *C2 = getOperand(1);
2369 Constant *C3 = getOperand(2);
2370 if (C1 == From) C1 = To;
2371 if (C2 == From) C2 = To;
2372 if (C3 == From) C3 = To;
2373 Replacement = ConstantExpr::getShuffleVector(C1, C2, C3);
2374 } else if (isCompare()) {
2375 Constant *C1 = getOperand(0);
2376 Constant *C2 = getOperand(1);
2377 if (C1 == From) C1 = To;
2378 if (C2 == From) C2 = To;
2379 if (getOpcode() == Instruction::ICmp)
2380 Replacement = ConstantExpr::getICmp(getPredicate(), C1, C2);
2382 assert(getOpcode() == Instruction::FCmp);
2383 Replacement = ConstantExpr::getFCmp(getPredicate(), C1, C2);
2385 } else if (getNumOperands() == 2) {
2386 Constant *C1 = getOperand(0);
2387 Constant *C2 = getOperand(1);
2388 if (C1 == From) C1 = To;
2389 if (C2 == From) C2 = To;
2390 Replacement = ConstantExpr::get(getOpcode(), C1, C2);
2392 llvm_unreachable("Unknown ConstantExpr type!");
2396 assert(Replacement != this && "I didn't contain From!");
2398 // Everyone using this now uses the replacement.
2399 uncheckedReplaceAllUsesWith(Replacement);
2401 // Delete the old constant!