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 "llvm/Constants.h"
15 #include "ConstantFold.h"
16 #include "llvm/DerivedTypes.h"
17 #include "llvm/GlobalValue.h"
18 #include "llvm/Instructions.h"
19 #include "llvm/MDNode.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())
104 /// ContainsRelocations - Return true if the constant value contains relocations
105 /// which cannot be resolved at compile time. Kind argument is used to filter
106 /// only 'interesting' sorts of relocations.
107 bool Constant::ContainsRelocations(unsigned Kind) const {
108 if (const GlobalValue* GV = dyn_cast<GlobalValue>(this)) {
109 bool isLocal = GV->hasLocalLinkage();
110 if ((Kind & Reloc::Local) && isLocal) {
111 // Global has local linkage and 'local' kind of relocations are
116 if ((Kind & Reloc::Global) && !isLocal) {
117 // Global has non-local linkage and 'global' kind of relocations are
125 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
126 if (getOperand(i)->ContainsRelocations(Kind))
132 /// getVectorElements - This method, which is only valid on constant of vector
133 /// type, returns the elements of the vector in the specified smallvector.
134 /// This handles breaking down a vector undef into undef elements, etc. For
135 /// constant exprs and other cases we can't handle, we return an empty vector.
136 void Constant::getVectorElements(LLVMContext &Context,
137 SmallVectorImpl<Constant*> &Elts) const {
138 assert(isa<VectorType>(getType()) && "Not a vector constant!");
140 if (const ConstantVector *CV = dyn_cast<ConstantVector>(this)) {
141 for (unsigned i = 0, e = CV->getNumOperands(); i != e; ++i)
142 Elts.push_back(CV->getOperand(i));
146 const VectorType *VT = cast<VectorType>(getType());
147 if (isa<ConstantAggregateZero>(this)) {
148 Elts.assign(VT->getNumElements(),
149 Context.getNullValue(VT->getElementType()));
153 if (isa<UndefValue>(this)) {
154 Elts.assign(VT->getNumElements(), Context.getUndef(VT->getElementType()));
158 // Unknown type, must be constant expr etc.
163 //===----------------------------------------------------------------------===//
165 //===----------------------------------------------------------------------===//
167 ConstantInt::ConstantInt(const IntegerType *Ty, const APInt& V)
168 : Constant(Ty, ConstantIntVal, 0, 0), Val(V) {
169 assert(V.getBitWidth() == Ty->getBitWidth() && "Invalid constant for type");
172 //===----------------------------------------------------------------------===//
174 //===----------------------------------------------------------------------===//
177 static const fltSemantics *TypeToFloatSemantics(const Type *Ty) {
178 if (Ty == Type::FloatTy)
179 return &APFloat::IEEEsingle;
180 if (Ty == Type::DoubleTy)
181 return &APFloat::IEEEdouble;
182 if (Ty == Type::X86_FP80Ty)
183 return &APFloat::x87DoubleExtended;
184 else if (Ty == Type::FP128Ty)
185 return &APFloat::IEEEquad;
187 assert(Ty == Type::PPC_FP128Ty && "Unknown FP format");
188 return &APFloat::PPCDoubleDouble;
192 ConstantFP::ConstantFP(const Type *Ty, const APFloat& V)
193 : Constant(Ty, ConstantFPVal, 0, 0), Val(V) {
194 assert(&V.getSemantics() == TypeToFloatSemantics(Ty) &&
198 bool ConstantFP::isNullValue() const {
199 return Val.isZero() && !Val.isNegative();
202 bool ConstantFP::isExactlyValue(const APFloat& V) const {
203 return Val.bitwiseIsEqual(V);
206 //===----------------------------------------------------------------------===//
207 // ConstantXXX Classes
208 //===----------------------------------------------------------------------===//
211 ConstantArray::ConstantArray(const ArrayType *T,
212 const std::vector<Constant*> &V)
213 : Constant(T, ConstantArrayVal,
214 OperandTraits<ConstantArray>::op_end(this) - V.size(),
216 assert(V.size() == T->getNumElements() &&
217 "Invalid initializer vector for constant array");
218 Use *OL = OperandList;
219 for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
222 assert((C->getType() == T->getElementType() ||
224 C->getType()->getTypeID() == T->getElementType()->getTypeID())) &&
225 "Initializer for array element doesn't match array element type!");
231 ConstantStruct::ConstantStruct(const StructType *T,
232 const std::vector<Constant*> &V)
233 : Constant(T, ConstantStructVal,
234 OperandTraits<ConstantStruct>::op_end(this) - V.size(),
236 assert(V.size() == T->getNumElements() &&
237 "Invalid initializer vector for constant structure");
238 Use *OL = OperandList;
239 for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
242 assert((C->getType() == T->getElementType(I-V.begin()) ||
243 ((T->getElementType(I-V.begin())->isAbstract() ||
244 C->getType()->isAbstract()) &&
245 T->getElementType(I-V.begin())->getTypeID() ==
246 C->getType()->getTypeID())) &&
247 "Initializer for struct element doesn't match struct element type!");
253 ConstantVector::ConstantVector(const VectorType *T,
254 const std::vector<Constant*> &V)
255 : Constant(T, ConstantVectorVal,
256 OperandTraits<ConstantVector>::op_end(this) - V.size(),
258 Use *OL = OperandList;
259 for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
262 assert((C->getType() == T->getElementType() ||
264 C->getType()->getTypeID() == T->getElementType()->getTypeID())) &&
265 "Initializer for vector element doesn't match vector element type!");
272 // We declare several classes private to this file, so use an anonymous
276 /// UnaryConstantExpr - This class is private to Constants.cpp, and is used
277 /// behind the scenes to implement unary constant exprs.
278 class VISIBILITY_HIDDEN UnaryConstantExpr : public ConstantExpr {
279 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
281 // allocate space for exactly one operand
282 void *operator new(size_t s) {
283 return User::operator new(s, 1);
285 UnaryConstantExpr(unsigned Opcode, Constant *C, const Type *Ty)
286 : ConstantExpr(Ty, Opcode, &Op<0>(), 1) {
289 /// Transparently provide more efficient getOperand methods.
290 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
293 /// BinaryConstantExpr - This class is private to Constants.cpp, and is used
294 /// behind the scenes to implement binary constant exprs.
295 class VISIBILITY_HIDDEN BinaryConstantExpr : public ConstantExpr {
296 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
298 // allocate space for exactly two operands
299 void *operator new(size_t s) {
300 return User::operator new(s, 2);
302 BinaryConstantExpr(unsigned Opcode, Constant *C1, Constant *C2)
303 : ConstantExpr(C1->getType(), Opcode, &Op<0>(), 2) {
307 /// Transparently provide more efficient getOperand methods.
308 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
311 /// SelectConstantExpr - This class is private to Constants.cpp, and is used
312 /// behind the scenes to implement select constant exprs.
313 class VISIBILITY_HIDDEN SelectConstantExpr : public ConstantExpr {
314 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
316 // allocate space for exactly three operands
317 void *operator new(size_t s) {
318 return User::operator new(s, 3);
320 SelectConstantExpr(Constant *C1, Constant *C2, Constant *C3)
321 : ConstantExpr(C2->getType(), Instruction::Select, &Op<0>(), 3) {
326 /// Transparently provide more efficient getOperand methods.
327 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
330 /// ExtractElementConstantExpr - This class is private to
331 /// Constants.cpp, and is used behind the scenes to implement
332 /// extractelement constant exprs.
333 class VISIBILITY_HIDDEN ExtractElementConstantExpr : public ConstantExpr {
334 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
336 // allocate space for exactly two operands
337 void *operator new(size_t s) {
338 return User::operator new(s, 2);
340 ExtractElementConstantExpr(Constant *C1, Constant *C2)
341 : ConstantExpr(cast<VectorType>(C1->getType())->getElementType(),
342 Instruction::ExtractElement, &Op<0>(), 2) {
346 /// Transparently provide more efficient getOperand methods.
347 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
350 /// InsertElementConstantExpr - This class is private to
351 /// Constants.cpp, and is used behind the scenes to implement
352 /// insertelement constant exprs.
353 class VISIBILITY_HIDDEN InsertElementConstantExpr : public ConstantExpr {
354 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
356 // allocate space for exactly three operands
357 void *operator new(size_t s) {
358 return User::operator new(s, 3);
360 InsertElementConstantExpr(Constant *C1, Constant *C2, Constant *C3)
361 : ConstantExpr(C1->getType(), Instruction::InsertElement,
367 /// Transparently provide more efficient getOperand methods.
368 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
371 /// ShuffleVectorConstantExpr - This class is private to
372 /// Constants.cpp, and is used behind the scenes to implement
373 /// shufflevector constant exprs.
374 class VISIBILITY_HIDDEN ShuffleVectorConstantExpr : public ConstantExpr {
375 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
377 // allocate space for exactly three operands
378 void *operator new(size_t s) {
379 return User::operator new(s, 3);
381 ShuffleVectorConstantExpr(Constant *C1, Constant *C2, Constant *C3)
382 : ConstantExpr(VectorType::get(
383 cast<VectorType>(C1->getType())->getElementType(),
384 cast<VectorType>(C3->getType())->getNumElements()),
385 Instruction::ShuffleVector,
391 /// Transparently provide more efficient getOperand methods.
392 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
395 /// ExtractValueConstantExpr - This class is private to
396 /// Constants.cpp, and is used behind the scenes to implement
397 /// extractvalue constant exprs.
398 class VISIBILITY_HIDDEN ExtractValueConstantExpr : public ConstantExpr {
399 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
401 // allocate space for exactly one operand
402 void *operator new(size_t s) {
403 return User::operator new(s, 1);
405 ExtractValueConstantExpr(Constant *Agg,
406 const SmallVector<unsigned, 4> &IdxList,
408 : ConstantExpr(DestTy, Instruction::ExtractValue, &Op<0>(), 1),
413 /// Indices - These identify which value to extract.
414 const SmallVector<unsigned, 4> Indices;
416 /// Transparently provide more efficient getOperand methods.
417 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
420 /// InsertValueConstantExpr - This class is private to
421 /// Constants.cpp, and is used behind the scenes to implement
422 /// insertvalue constant exprs.
423 class VISIBILITY_HIDDEN InsertValueConstantExpr : public ConstantExpr {
424 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
426 // allocate space for exactly one operand
427 void *operator new(size_t s) {
428 return User::operator new(s, 2);
430 InsertValueConstantExpr(Constant *Agg, Constant *Val,
431 const SmallVector<unsigned, 4> &IdxList,
433 : ConstantExpr(DestTy, Instruction::InsertValue, &Op<0>(), 2),
439 /// Indices - These identify the position for the insertion.
440 const SmallVector<unsigned, 4> Indices;
442 /// Transparently provide more efficient getOperand methods.
443 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
447 /// GetElementPtrConstantExpr - This class is private to Constants.cpp, and is
448 /// used behind the scenes to implement getelementpr constant exprs.
449 class VISIBILITY_HIDDEN GetElementPtrConstantExpr : public ConstantExpr {
450 GetElementPtrConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
453 static GetElementPtrConstantExpr *Create(Constant *C,
454 const std::vector<Constant*>&IdxList,
455 const Type *DestTy) {
457 new(IdxList.size() + 1) GetElementPtrConstantExpr(C, IdxList, DestTy);
459 /// Transparently provide more efficient getOperand methods.
460 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
463 // CompareConstantExpr - This class is private to Constants.cpp, and is used
464 // behind the scenes to implement ICmp and FCmp constant expressions. This is
465 // needed in order to store the predicate value for these instructions.
466 struct VISIBILITY_HIDDEN CompareConstantExpr : public ConstantExpr {
467 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
468 // allocate space for exactly two operands
469 void *operator new(size_t s) {
470 return User::operator new(s, 2);
472 unsigned short predicate;
473 CompareConstantExpr(const Type *ty, Instruction::OtherOps opc,
474 unsigned short pred, Constant* LHS, Constant* RHS)
475 : ConstantExpr(ty, opc, &Op<0>(), 2), predicate(pred) {
479 /// Transparently provide more efficient getOperand methods.
480 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
483 } // end anonymous namespace
486 struct OperandTraits<UnaryConstantExpr> : FixedNumOperandTraits<1> {
488 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(UnaryConstantExpr, Value)
491 struct OperandTraits<BinaryConstantExpr> : FixedNumOperandTraits<2> {
493 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BinaryConstantExpr, Value)
496 struct OperandTraits<SelectConstantExpr> : FixedNumOperandTraits<3> {
498 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectConstantExpr, Value)
501 struct OperandTraits<ExtractElementConstantExpr> : FixedNumOperandTraits<2> {
503 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementConstantExpr, Value)
506 struct OperandTraits<InsertElementConstantExpr> : FixedNumOperandTraits<3> {
508 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementConstantExpr, Value)
511 struct OperandTraits<ShuffleVectorConstantExpr> : FixedNumOperandTraits<3> {
513 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorConstantExpr, Value)
516 struct OperandTraits<ExtractValueConstantExpr> : FixedNumOperandTraits<1> {
518 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractValueConstantExpr, Value)
521 struct OperandTraits<InsertValueConstantExpr> : FixedNumOperandTraits<2> {
523 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueConstantExpr, Value)
526 struct OperandTraits<GetElementPtrConstantExpr> : VariadicOperandTraits<1> {
529 GetElementPtrConstantExpr::GetElementPtrConstantExpr
531 const std::vector<Constant*> &IdxList,
533 : ConstantExpr(DestTy, Instruction::GetElementPtr,
534 OperandTraits<GetElementPtrConstantExpr>::op_end(this)
535 - (IdxList.size()+1),
538 for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
539 OperandList[i+1] = IdxList[i];
542 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrConstantExpr, Value)
546 struct OperandTraits<CompareConstantExpr> : FixedNumOperandTraits<2> {
548 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CompareConstantExpr, Value)
551 } // End llvm namespace
554 // Utility function for determining if a ConstantExpr is a CastOp or not. This
555 // can't be inline because we don't want to #include Instruction.h into
557 bool ConstantExpr::isCast() const {
558 return Instruction::isCast(getOpcode());
561 bool ConstantExpr::isCompare() const {
562 return getOpcode() == Instruction::ICmp || getOpcode() == Instruction::FCmp;
565 bool ConstantExpr::hasIndices() const {
566 return getOpcode() == Instruction::ExtractValue ||
567 getOpcode() == Instruction::InsertValue;
570 const SmallVector<unsigned, 4> &ConstantExpr::getIndices() const {
571 if (const ExtractValueConstantExpr *EVCE =
572 dyn_cast<ExtractValueConstantExpr>(this))
573 return EVCE->Indices;
575 return cast<InsertValueConstantExpr>(this)->Indices;
578 unsigned ConstantExpr::getPredicate() const {
579 assert(getOpcode() == Instruction::FCmp ||
580 getOpcode() == Instruction::ICmp);
581 return ((const CompareConstantExpr*)this)->predicate;
584 /// getWithOperandReplaced - Return a constant expression identical to this
585 /// one, but with the specified operand set to the specified value.
587 ConstantExpr::getWithOperandReplaced(unsigned OpNo, Constant *Op) const {
588 assert(OpNo < getNumOperands() && "Operand num is out of range!");
589 assert(Op->getType() == getOperand(OpNo)->getType() &&
590 "Replacing operand with value of different type!");
591 if (getOperand(OpNo) == Op)
592 return const_cast<ConstantExpr*>(this);
594 Constant *Op0, *Op1, *Op2;
595 switch (getOpcode()) {
596 case Instruction::Trunc:
597 case Instruction::ZExt:
598 case Instruction::SExt:
599 case Instruction::FPTrunc:
600 case Instruction::FPExt:
601 case Instruction::UIToFP:
602 case Instruction::SIToFP:
603 case Instruction::FPToUI:
604 case Instruction::FPToSI:
605 case Instruction::PtrToInt:
606 case Instruction::IntToPtr:
607 case Instruction::BitCast:
608 return ConstantExpr::getCast(getOpcode(), Op, getType());
609 case Instruction::Select:
610 Op0 = (OpNo == 0) ? Op : getOperand(0);
611 Op1 = (OpNo == 1) ? Op : getOperand(1);
612 Op2 = (OpNo == 2) ? Op : getOperand(2);
613 return ConstantExpr::getSelect(Op0, Op1, Op2);
614 case Instruction::InsertElement:
615 Op0 = (OpNo == 0) ? Op : getOperand(0);
616 Op1 = (OpNo == 1) ? Op : getOperand(1);
617 Op2 = (OpNo == 2) ? Op : getOperand(2);
618 return ConstantExpr::getInsertElement(Op0, Op1, Op2);
619 case Instruction::ExtractElement:
620 Op0 = (OpNo == 0) ? Op : getOperand(0);
621 Op1 = (OpNo == 1) ? Op : getOperand(1);
622 return ConstantExpr::getExtractElement(Op0, Op1);
623 case Instruction::ShuffleVector:
624 Op0 = (OpNo == 0) ? Op : getOperand(0);
625 Op1 = (OpNo == 1) ? Op : getOperand(1);
626 Op2 = (OpNo == 2) ? Op : getOperand(2);
627 return ConstantExpr::getShuffleVector(Op0, Op1, Op2);
628 case Instruction::GetElementPtr: {
629 SmallVector<Constant*, 8> Ops;
630 Ops.resize(getNumOperands()-1);
631 for (unsigned i = 1, e = getNumOperands(); i != e; ++i)
632 Ops[i-1] = getOperand(i);
634 return ConstantExpr::getGetElementPtr(Op, &Ops[0], Ops.size());
636 return ConstantExpr::getGetElementPtr(getOperand(0), &Ops[0], Ops.size());
639 assert(getNumOperands() == 2 && "Must be binary operator?");
640 Op0 = (OpNo == 0) ? Op : getOperand(0);
641 Op1 = (OpNo == 1) ? Op : getOperand(1);
642 return ConstantExpr::get(getOpcode(), Op0, Op1);
646 /// getWithOperands - This returns the current constant expression with the
647 /// operands replaced with the specified values. The specified operands must
648 /// match count and type with the existing ones.
649 Constant *ConstantExpr::
650 getWithOperands(Constant* const *Ops, unsigned NumOps) const {
651 assert(NumOps == getNumOperands() && "Operand count mismatch!");
652 bool AnyChange = false;
653 for (unsigned i = 0; i != NumOps; ++i) {
654 assert(Ops[i]->getType() == getOperand(i)->getType() &&
655 "Operand type mismatch!");
656 AnyChange |= Ops[i] != getOperand(i);
658 if (!AnyChange) // No operands changed, return self.
659 return const_cast<ConstantExpr*>(this);
661 switch (getOpcode()) {
662 case Instruction::Trunc:
663 case Instruction::ZExt:
664 case Instruction::SExt:
665 case Instruction::FPTrunc:
666 case Instruction::FPExt:
667 case Instruction::UIToFP:
668 case Instruction::SIToFP:
669 case Instruction::FPToUI:
670 case Instruction::FPToSI:
671 case Instruction::PtrToInt:
672 case Instruction::IntToPtr:
673 case Instruction::BitCast:
674 return ConstantExpr::getCast(getOpcode(), Ops[0], getType());
675 case Instruction::Select:
676 return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
677 case Instruction::InsertElement:
678 return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
679 case Instruction::ExtractElement:
680 return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
681 case Instruction::ShuffleVector:
682 return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
683 case Instruction::GetElementPtr:
684 return ConstantExpr::getGetElementPtr(Ops[0], &Ops[1], NumOps-1);
685 case Instruction::ICmp:
686 case Instruction::FCmp:
687 return ConstantExpr::getCompare(getPredicate(), Ops[0], Ops[1]);
689 assert(getNumOperands() == 2 && "Must be binary operator?");
690 return ConstantExpr::get(getOpcode(), Ops[0], Ops[1]);
695 //===----------------------------------------------------------------------===//
696 // isValueValidForType implementations
698 bool ConstantInt::isValueValidForType(const Type *Ty, uint64_t Val) {
699 unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
700 if (Ty == Type::Int1Ty)
701 return Val == 0 || Val == 1;
703 return true; // always true, has to fit in largest type
704 uint64_t Max = (1ll << NumBits) - 1;
708 bool ConstantInt::isValueValidForType(const Type *Ty, int64_t Val) {
709 unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
710 if (Ty == Type::Int1Ty)
711 return Val == 0 || Val == 1 || Val == -1;
713 return true; // always true, has to fit in largest type
714 int64_t Min = -(1ll << (NumBits-1));
715 int64_t Max = (1ll << (NumBits-1)) - 1;
716 return (Val >= Min && Val <= Max);
719 bool ConstantFP::isValueValidForType(const Type *Ty, const APFloat& Val) {
720 // convert modifies in place, so make a copy.
721 APFloat Val2 = APFloat(Val);
723 switch (Ty->getTypeID()) {
725 return false; // These can't be represented as floating point!
727 // FIXME rounding mode needs to be more flexible
728 case Type::FloatTyID: {
729 if (&Val2.getSemantics() == &APFloat::IEEEsingle)
731 Val2.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven, &losesInfo);
734 case Type::DoubleTyID: {
735 if (&Val2.getSemantics() == &APFloat::IEEEsingle ||
736 &Val2.getSemantics() == &APFloat::IEEEdouble)
738 Val2.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, &losesInfo);
741 case Type::X86_FP80TyID:
742 return &Val2.getSemantics() == &APFloat::IEEEsingle ||
743 &Val2.getSemantics() == &APFloat::IEEEdouble ||
744 &Val2.getSemantics() == &APFloat::x87DoubleExtended;
745 case Type::FP128TyID:
746 return &Val2.getSemantics() == &APFloat::IEEEsingle ||
747 &Val2.getSemantics() == &APFloat::IEEEdouble ||
748 &Val2.getSemantics() == &APFloat::IEEEquad;
749 case Type::PPC_FP128TyID:
750 return &Val2.getSemantics() == &APFloat::IEEEsingle ||
751 &Val2.getSemantics() == &APFloat::IEEEdouble ||
752 &Val2.getSemantics() == &APFloat::PPCDoubleDouble;
756 //===----------------------------------------------------------------------===//
757 // Factory Function Implementation
760 // The number of operands for each ConstantCreator::create method is
761 // determined by the ConstantTraits template.
762 // ConstantCreator - A class that is used to create constants by
763 // ValueMap*. This class should be partially specialized if there is
764 // something strange that needs to be done to interface to the ctor for the
768 template<class ValType>
769 struct ConstantTraits;
771 template<typename T, typename Alloc>
772 struct VISIBILITY_HIDDEN ConstantTraits< std::vector<T, Alloc> > {
773 static unsigned uses(const std::vector<T, Alloc>& v) {
778 template<class ConstantClass, class TypeClass, class ValType>
779 struct VISIBILITY_HIDDEN ConstantCreator {
780 static ConstantClass *create(const TypeClass *Ty, const ValType &V) {
781 return new(ConstantTraits<ValType>::uses(V)) ConstantClass(Ty, V);
785 template<class ConstantClass, class TypeClass>
786 struct VISIBILITY_HIDDEN ConvertConstantType {
787 static void convert(ConstantClass *OldC, const TypeClass *NewTy) {
788 llvm_unreachable("This type cannot be converted!");
792 template<class ValType, class TypeClass, class ConstantClass,
793 bool HasLargeKey = false /*true for arrays and structs*/ >
794 class VISIBILITY_HIDDEN ValueMap : public AbstractTypeUser {
796 typedef std::pair<const Type*, ValType> MapKey;
797 typedef std::map<MapKey, Constant *> MapTy;
798 typedef std::map<Constant*, typename MapTy::iterator> InverseMapTy;
799 typedef std::map<const Type*, typename MapTy::iterator> AbstractTypeMapTy;
801 /// Map - This is the main map from the element descriptor to the Constants.
802 /// This is the primary way we avoid creating two of the same shape
806 /// InverseMap - If "HasLargeKey" is true, this contains an inverse mapping
807 /// from the constants to their element in Map. This is important for
808 /// removal of constants from the array, which would otherwise have to scan
809 /// through the map with very large keys.
810 InverseMapTy InverseMap;
812 /// AbstractTypeMap - Map for abstract type constants.
814 AbstractTypeMapTy AbstractTypeMap;
816 /// ValueMapLock - Mutex for this map.
817 sys::SmartMutex<true> ValueMapLock;
820 // NOTE: This function is not locked. It is the caller's responsibility
821 // to enforce proper synchronization.
822 typename MapTy::iterator map_end() { return Map.end(); }
824 /// InsertOrGetItem - Return an iterator for the specified element.
825 /// If the element exists in the map, the returned iterator points to the
826 /// entry and Exists=true. If not, the iterator points to the newly
827 /// inserted entry and returns Exists=false. Newly inserted entries have
828 /// I->second == 0, and should be filled in.
829 /// NOTE: This function is not locked. It is the caller's responsibility
830 // to enforce proper synchronization.
831 typename MapTy::iterator InsertOrGetItem(std::pair<MapKey, Constant *>
834 std::pair<typename MapTy::iterator, bool> IP = Map.insert(InsertVal);
840 typename MapTy::iterator FindExistingElement(ConstantClass *CP) {
842 typename InverseMapTy::iterator IMI = InverseMap.find(CP);
843 assert(IMI != InverseMap.end() && IMI->second != Map.end() &&
844 IMI->second->second == CP &&
845 "InverseMap corrupt!");
849 typename MapTy::iterator I =
850 Map.find(MapKey(static_cast<const TypeClass*>(CP->getRawType()),
852 if (I == Map.end() || I->second != CP) {
853 // FIXME: This should not use a linear scan. If this gets to be a
854 // performance problem, someone should look at this.
855 for (I = Map.begin(); I != Map.end() && I->second != CP; ++I)
861 ConstantClass* Create(const TypeClass *Ty, const ValType &V,
862 typename MapTy::iterator I) {
863 ConstantClass* Result =
864 ConstantCreator<ConstantClass,TypeClass,ValType>::create(Ty, V);
866 assert(Result->getType() == Ty && "Type specified is not correct!");
867 I = Map.insert(I, std::make_pair(MapKey(Ty, V), Result));
869 if (HasLargeKey) // Remember the reverse mapping if needed.
870 InverseMap.insert(std::make_pair(Result, I));
872 // If the type of the constant is abstract, make sure that an entry
873 // exists for it in the AbstractTypeMap.
874 if (Ty->isAbstract()) {
875 typename AbstractTypeMapTy::iterator TI =
876 AbstractTypeMap.find(Ty);
878 if (TI == AbstractTypeMap.end()) {
879 // Add ourselves to the ATU list of the type.
880 cast<DerivedType>(Ty)->addAbstractTypeUser(this);
882 AbstractTypeMap.insert(TI, std::make_pair(Ty, I));
890 /// getOrCreate - Return the specified constant from the map, creating it if
892 ConstantClass *getOrCreate(const TypeClass *Ty, const ValType &V) {
893 sys::SmartScopedLock<true> Lock(ValueMapLock);
894 MapKey Lookup(Ty, V);
895 ConstantClass* Result = 0;
897 typename MapTy::iterator I = Map.find(Lookup);
900 Result = static_cast<ConstantClass *>(I->second);
903 // If no preexisting value, create one now...
904 Result = Create(Ty, V, I);
910 void remove(ConstantClass *CP) {
911 sys::SmartScopedLock<true> Lock(ValueMapLock);
912 typename MapTy::iterator I = FindExistingElement(CP);
913 assert(I != Map.end() && "Constant not found in constant table!");
914 assert(I->second == CP && "Didn't find correct element?");
916 if (HasLargeKey) // Remember the reverse mapping if needed.
917 InverseMap.erase(CP);
919 // Now that we found the entry, make sure this isn't the entry that
920 // the AbstractTypeMap points to.
921 const TypeClass *Ty = static_cast<const TypeClass *>(I->first.first);
922 if (Ty->isAbstract()) {
923 assert(AbstractTypeMap.count(Ty) &&
924 "Abstract type not in AbstractTypeMap?");
925 typename MapTy::iterator &ATMEntryIt = AbstractTypeMap[Ty];
926 if (ATMEntryIt == I) {
927 // Yes, we are removing the representative entry for this type.
928 // See if there are any other entries of the same type.
929 typename MapTy::iterator TmpIt = ATMEntryIt;
931 // First check the entry before this one...
932 if (TmpIt != Map.begin()) {
934 if (TmpIt->first.first != Ty) // Not the same type, move back...
938 // If we didn't find the same type, try to move forward...
939 if (TmpIt == ATMEntryIt) {
941 if (TmpIt == Map.end() || TmpIt->first.first != Ty)
942 --TmpIt; // No entry afterwards with the same type
945 // If there is another entry in the map of the same abstract type,
946 // update the AbstractTypeMap entry now.
947 if (TmpIt != ATMEntryIt) {
950 // Otherwise, we are removing the last instance of this type
951 // from the table. Remove from the ATM, and from user list.
952 cast<DerivedType>(Ty)->removeAbstractTypeUser(this);
953 AbstractTypeMap.erase(Ty);
962 /// MoveConstantToNewSlot - If we are about to change C to be the element
963 /// specified by I, update our internal data structures to reflect this
965 /// NOTE: This function is not locked. It is the responsibility of the
966 /// caller to enforce proper synchronization if using this method.
967 void MoveConstantToNewSlot(ConstantClass *C, typename MapTy::iterator I) {
968 // First, remove the old location of the specified constant in the map.
969 typename MapTy::iterator OldI = FindExistingElement(C);
970 assert(OldI != Map.end() && "Constant not found in constant table!");
971 assert(OldI->second == C && "Didn't find correct element?");
973 // If this constant is the representative element for its abstract type,
974 // update the AbstractTypeMap so that the representative element is I.
975 if (C->getType()->isAbstract()) {
976 typename AbstractTypeMapTy::iterator ATI =
977 AbstractTypeMap.find(C->getType());
978 assert(ATI != AbstractTypeMap.end() &&
979 "Abstract type not in AbstractTypeMap?");
980 if (ATI->second == OldI)
984 // Remove the old entry from the map.
987 // Update the inverse map so that we know that this constant is now
988 // located at descriptor I.
990 assert(I->second == C && "Bad inversemap entry!");
995 void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
996 sys::SmartScopedLock<true> Lock(ValueMapLock);
997 typename AbstractTypeMapTy::iterator I =
998 AbstractTypeMap.find(cast<Type>(OldTy));
1000 assert(I != AbstractTypeMap.end() &&
1001 "Abstract type not in AbstractTypeMap?");
1003 // Convert a constant at a time until the last one is gone. The last one
1004 // leaving will remove() itself, causing the AbstractTypeMapEntry to be
1005 // eliminated eventually.
1007 ConvertConstantType<ConstantClass,
1008 TypeClass>::convert(
1009 static_cast<ConstantClass *>(I->second->second),
1010 cast<TypeClass>(NewTy));
1012 I = AbstractTypeMap.find(cast<Type>(OldTy));
1013 } while (I != AbstractTypeMap.end());
1016 // If the type became concrete without being refined to any other existing
1017 // type, we just remove ourselves from the ATU list.
1018 void typeBecameConcrete(const DerivedType *AbsTy) {
1019 AbsTy->removeAbstractTypeUser(this);
1023 DOUT << "Constant.cpp: ValueMap\n";
1028 /// destroyConstant - Remove the constant from the constant table...
1030 void ConstantAggregateZero::destroyConstant() {
1031 // Implicitly locked.
1032 getType()->getContext().erase(this);
1033 destroyConstantImpl();
1036 //---- ConstantArray::get() implementation...
1040 struct ConvertConstantType<ConstantArray, ArrayType> {
1041 static void convert(ConstantArray *OldC, const ArrayType *NewTy) {
1042 // Make everyone now use a constant of the new type...
1043 std::vector<Constant*> C;
1044 for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
1045 C.push_back(cast<Constant>(OldC->getOperand(i)));
1046 Constant *New = ConstantArray::get(NewTy, C);
1047 assert(New != OldC && "Didn't replace constant??");
1048 OldC->uncheckedReplaceAllUsesWith(New);
1049 OldC->destroyConstant(); // This constant is now dead, destroy it.
1054 static std::vector<Constant*> getValType(ConstantArray *CA) {
1055 std::vector<Constant*> Elements;
1056 Elements.reserve(CA->getNumOperands());
1057 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1058 Elements.push_back(cast<Constant>(CA->getOperand(i)));
1062 typedef ValueMap<std::vector<Constant*>, ArrayType,
1063 ConstantArray, true /*largekey*/> ArrayConstantsTy;
1064 static ManagedStatic<ArrayConstantsTy> ArrayConstants;
1066 Constant *ConstantArray::get(const ArrayType *Ty,
1067 const std::vector<Constant*> &V) {
1068 // If this is an all-zero array, return a ConstantAggregateZero object
1071 if (!C->isNullValue()) {
1072 // Implicitly locked.
1073 return ArrayConstants->getOrCreate(Ty, V);
1075 for (unsigned i = 1, e = V.size(); i != e; ++i)
1077 // Implicitly locked.
1078 return ArrayConstants->getOrCreate(Ty, V);
1082 return Ty->getContext().getConstantAggregateZero(Ty);
1085 /// destroyConstant - Remove the constant from the constant table...
1087 void ConstantArray::destroyConstant() {
1088 // Implicitly locked.
1089 ArrayConstants->remove(this);
1090 destroyConstantImpl();
1093 /// isString - This method returns true if the array is an array of i8, and
1094 /// if the elements of the array are all ConstantInt's.
1095 bool ConstantArray::isString() const {
1096 // Check the element type for i8...
1097 if (getType()->getElementType() != Type::Int8Ty)
1099 // Check the elements to make sure they are all integers, not constant
1101 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1102 if (!isa<ConstantInt>(getOperand(i)))
1107 /// isCString - This method returns true if the array is a string (see
1108 /// isString) and it ends in a null byte \\0 and does not contains any other
1109 /// null bytes except its terminator.
1110 bool ConstantArray::isCString() const {
1111 // Check the element type for i8...
1112 if (getType()->getElementType() != Type::Int8Ty)
1115 // Last element must be a null.
1116 if (!getOperand(getNumOperands()-1)->isNullValue())
1118 // Other elements must be non-null integers.
1119 for (unsigned i = 0, e = getNumOperands()-1; i != e; ++i) {
1120 if (!isa<ConstantInt>(getOperand(i)))
1122 if (getOperand(i)->isNullValue())
1129 /// getAsString - If the sub-element type of this array is i8
1130 /// then this method converts the array to an std::string and returns it.
1131 /// Otherwise, it asserts out.
1133 std::string ConstantArray::getAsString() const {
1134 assert(isString() && "Not a string!");
1136 Result.reserve(getNumOperands());
1137 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1138 Result.push_back((char)cast<ConstantInt>(getOperand(i))->getZExtValue());
1143 //---- ConstantStruct::get() implementation...
1148 struct ConvertConstantType<ConstantStruct, StructType> {
1149 static void convert(ConstantStruct *OldC, const StructType *NewTy) {
1150 // Make everyone now use a constant of the new type...
1151 std::vector<Constant*> C;
1152 for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
1153 C.push_back(cast<Constant>(OldC->getOperand(i)));
1154 Constant *New = ConstantStruct::get(NewTy, C);
1155 assert(New != OldC && "Didn't replace constant??");
1157 OldC->uncheckedReplaceAllUsesWith(New);
1158 OldC->destroyConstant(); // This constant is now dead, destroy it.
1163 typedef ValueMap<std::vector<Constant*>, StructType,
1164 ConstantStruct, true /*largekey*/> StructConstantsTy;
1165 static ManagedStatic<StructConstantsTy> StructConstants;
1167 static std::vector<Constant*> getValType(ConstantStruct *CS) {
1168 std::vector<Constant*> Elements;
1169 Elements.reserve(CS->getNumOperands());
1170 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i)
1171 Elements.push_back(cast<Constant>(CS->getOperand(i)));
1175 Constant *ConstantStruct::get(const StructType *Ty,
1176 const std::vector<Constant*> &V) {
1177 // Create a ConstantAggregateZero value if all elements are zeros...
1178 for (unsigned i = 0, e = V.size(); i != e; ++i)
1179 if (!V[i]->isNullValue())
1180 // Implicitly locked.
1181 return StructConstants->getOrCreate(Ty, V);
1183 return Ty->getContext().getConstantAggregateZero(Ty);
1186 // destroyConstant - Remove the constant from the constant table...
1188 void ConstantStruct::destroyConstant() {
1189 // Implicitly locked.
1190 StructConstants->remove(this);
1191 destroyConstantImpl();
1194 //---- ConstantVector::get() implementation...
1198 struct ConvertConstantType<ConstantVector, VectorType> {
1199 static void convert(ConstantVector *OldC, const VectorType *NewTy) {
1200 // Make everyone now use a constant of the new type...
1201 std::vector<Constant*> C;
1202 for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
1203 C.push_back(cast<Constant>(OldC->getOperand(i)));
1204 Constant *New = ConstantVector::get(NewTy, C);
1205 assert(New != OldC && "Didn't replace constant??");
1206 OldC->uncheckedReplaceAllUsesWith(New);
1207 OldC->destroyConstant(); // This constant is now dead, destroy it.
1212 static std::vector<Constant*> getValType(ConstantVector *CP) {
1213 std::vector<Constant*> Elements;
1214 Elements.reserve(CP->getNumOperands());
1215 for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
1216 Elements.push_back(CP->getOperand(i));
1220 static ManagedStatic<ValueMap<std::vector<Constant*>, VectorType,
1221 ConstantVector> > VectorConstants;
1223 Constant *ConstantVector::get(const VectorType *Ty,
1224 const std::vector<Constant*> &V) {
1225 assert(!V.empty() && "Vectors can't be empty");
1226 // If this is an all-undef or alll-zero vector, return a
1227 // ConstantAggregateZero or UndefValue.
1229 bool isZero = C->isNullValue();
1230 bool isUndef = isa<UndefValue>(C);
1232 if (isZero || isUndef) {
1233 for (unsigned i = 1, e = V.size(); i != e; ++i)
1235 isZero = isUndef = false;
1241 return Ty->getContext().getConstantAggregateZero(Ty);
1243 return UndefValue::get(Ty);
1245 // Implicitly locked.
1246 return VectorConstants->getOrCreate(Ty, V);
1249 // destroyConstant - Remove the constant from the constant table...
1251 void ConstantVector::destroyConstant() {
1252 // Implicitly locked.
1253 VectorConstants->remove(this);
1254 destroyConstantImpl();
1257 /// This function will return true iff every element in this vector constant
1258 /// is set to all ones.
1259 /// @returns true iff this constant's emements are all set to all ones.
1260 /// @brief Determine if the value is all ones.
1261 bool ConstantVector::isAllOnesValue() const {
1262 // Check out first element.
1263 const Constant *Elt = getOperand(0);
1264 const ConstantInt *CI = dyn_cast<ConstantInt>(Elt);
1265 if (!CI || !CI->isAllOnesValue()) return false;
1266 // Then make sure all remaining elements point to the same value.
1267 for (unsigned I = 1, E = getNumOperands(); I < E; ++I) {
1268 if (getOperand(I) != Elt) return false;
1273 /// getSplatValue - If this is a splat constant, where all of the
1274 /// elements have the same value, return that value. Otherwise return null.
1275 Constant *ConstantVector::getSplatValue() {
1276 // Check out first element.
1277 Constant *Elt = getOperand(0);
1278 // Then make sure all remaining elements point to the same value.
1279 for (unsigned I = 1, E = getNumOperands(); I < E; ++I)
1280 if (getOperand(I) != Elt) return 0;
1284 //---- ConstantPointerNull::get() implementation...
1288 // ConstantPointerNull does not take extra "value" argument...
1289 template<class ValType>
1290 struct ConstantCreator<ConstantPointerNull, PointerType, ValType> {
1291 static ConstantPointerNull *create(const PointerType *Ty, const ValType &V){
1292 return new ConstantPointerNull(Ty);
1297 struct ConvertConstantType<ConstantPointerNull, PointerType> {
1298 static void convert(ConstantPointerNull *OldC, const PointerType *NewTy) {
1299 // Make everyone now use a constant of the new type...
1300 Constant *New = ConstantPointerNull::get(NewTy);
1301 assert(New != OldC && "Didn't replace constant??");
1302 OldC->uncheckedReplaceAllUsesWith(New);
1303 OldC->destroyConstant(); // This constant is now dead, destroy it.
1308 static ManagedStatic<ValueMap<char, PointerType,
1309 ConstantPointerNull> > NullPtrConstants;
1311 static char getValType(ConstantPointerNull *) {
1316 ConstantPointerNull *ConstantPointerNull::get(const PointerType *Ty) {
1317 // Implicitly locked.
1318 return NullPtrConstants->getOrCreate(Ty, 0);
1321 // destroyConstant - Remove the constant from the constant table...
1323 void ConstantPointerNull::destroyConstant() {
1324 // Implicitly locked.
1325 NullPtrConstants->remove(this);
1326 destroyConstantImpl();
1330 //---- UndefValue::get() implementation...
1334 // UndefValue does not take extra "value" argument...
1335 template<class ValType>
1336 struct ConstantCreator<UndefValue, Type, ValType> {
1337 static UndefValue *create(const Type *Ty, const ValType &V) {
1338 return new UndefValue(Ty);
1343 struct ConvertConstantType<UndefValue, Type> {
1344 static void convert(UndefValue *OldC, const Type *NewTy) {
1345 // Make everyone now use a constant of the new type.
1346 Constant *New = UndefValue::get(NewTy);
1347 assert(New != OldC && "Didn't replace constant??");
1348 OldC->uncheckedReplaceAllUsesWith(New);
1349 OldC->destroyConstant(); // This constant is now dead, destroy it.
1354 static ManagedStatic<ValueMap<char, Type, UndefValue> > UndefValueConstants;
1356 static char getValType(UndefValue *) {
1361 UndefValue *UndefValue::get(const Type *Ty) {
1362 // Implicitly locked.
1363 return UndefValueConstants->getOrCreate(Ty, 0);
1366 // destroyConstant - Remove the constant from the constant table.
1368 void UndefValue::destroyConstant() {
1369 // Implicitly locked.
1370 UndefValueConstants->remove(this);
1371 destroyConstantImpl();
1374 //---- MDString::get() implementation
1377 MDString::MDString(const char *begin, const char *end)
1378 : Constant(Type::MetadataTy, MDStringVal, 0, 0),
1379 StrBegin(begin), StrEnd(end) {}
1381 void MDString::destroyConstant() {
1382 getType()->getContext().erase(this);
1383 destroyConstantImpl();
1386 //---- MDNode::get() implementation
1389 MDNode::MDNode(Value*const* Vals, unsigned NumVals)
1390 : Constant(Type::MetadataTy, MDNodeVal, 0, 0) {
1391 for (unsigned i = 0; i != NumVals; ++i)
1392 Node.push_back(ElementVH(Vals[i], this));
1395 void MDNode::Profile(FoldingSetNodeID &ID) const {
1396 for (const_elem_iterator I = elem_begin(), E = elem_end(); I != E; ++I)
1400 void MDNode::destroyConstant() {
1401 getType()->getContext().erase(this);
1402 destroyConstantImpl();
1405 //---- ConstantExpr::get() implementations...
1410 struct ExprMapKeyType {
1411 typedef SmallVector<unsigned, 4> IndexList;
1413 ExprMapKeyType(unsigned opc,
1414 const std::vector<Constant*> &ops,
1415 unsigned short pred = 0,
1416 const IndexList &inds = IndexList())
1417 : opcode(opc), predicate(pred), operands(ops), indices(inds) {}
1420 std::vector<Constant*> operands;
1422 bool operator==(const ExprMapKeyType& that) const {
1423 return this->opcode == that.opcode &&
1424 this->predicate == that.predicate &&
1425 this->operands == that.operands &&
1426 this->indices == that.indices;
1428 bool operator<(const ExprMapKeyType & that) const {
1429 return this->opcode < that.opcode ||
1430 (this->opcode == that.opcode && this->predicate < that.predicate) ||
1431 (this->opcode == that.opcode && this->predicate == that.predicate &&
1432 this->operands < that.operands) ||
1433 (this->opcode == that.opcode && this->predicate == that.predicate &&
1434 this->operands == that.operands && this->indices < that.indices);
1437 bool operator!=(const ExprMapKeyType& that) const {
1438 return !(*this == that);
1446 struct ConstantCreator<ConstantExpr, Type, ExprMapKeyType> {
1447 static ConstantExpr *create(const Type *Ty, const ExprMapKeyType &V,
1448 unsigned short pred = 0) {
1449 if (Instruction::isCast(V.opcode))
1450 return new UnaryConstantExpr(V.opcode, V.operands[0], Ty);
1451 if ((V.opcode >= Instruction::BinaryOpsBegin &&
1452 V.opcode < Instruction::BinaryOpsEnd))
1453 return new BinaryConstantExpr(V.opcode, V.operands[0], V.operands[1]);
1454 if (V.opcode == Instruction::Select)
1455 return new SelectConstantExpr(V.operands[0], V.operands[1],
1457 if (V.opcode == Instruction::ExtractElement)
1458 return new ExtractElementConstantExpr(V.operands[0], V.operands[1]);
1459 if (V.opcode == Instruction::InsertElement)
1460 return new InsertElementConstantExpr(V.operands[0], V.operands[1],
1462 if (V.opcode == Instruction::ShuffleVector)
1463 return new ShuffleVectorConstantExpr(V.operands[0], V.operands[1],
1465 if (V.opcode == Instruction::InsertValue)
1466 return new InsertValueConstantExpr(V.operands[0], V.operands[1],
1468 if (V.opcode == Instruction::ExtractValue)
1469 return new ExtractValueConstantExpr(V.operands[0], V.indices, Ty);
1470 if (V.opcode == Instruction::GetElementPtr) {
1471 std::vector<Constant*> IdxList(V.operands.begin()+1, V.operands.end());
1472 return GetElementPtrConstantExpr::Create(V.operands[0], IdxList, Ty);
1475 // The compare instructions are weird. We have to encode the predicate
1476 // value and it is combined with the instruction opcode by multiplying
1477 // the opcode by one hundred. We must decode this to get the predicate.
1478 if (V.opcode == Instruction::ICmp)
1479 return new CompareConstantExpr(Ty, Instruction::ICmp, V.predicate,
1480 V.operands[0], V.operands[1]);
1481 if (V.opcode == Instruction::FCmp)
1482 return new CompareConstantExpr(Ty, Instruction::FCmp, V.predicate,
1483 V.operands[0], V.operands[1]);
1484 llvm_unreachable("Invalid ConstantExpr!");
1490 struct ConvertConstantType<ConstantExpr, Type> {
1491 static void convert(ConstantExpr *OldC, const Type *NewTy) {
1493 switch (OldC->getOpcode()) {
1494 case Instruction::Trunc:
1495 case Instruction::ZExt:
1496 case Instruction::SExt:
1497 case Instruction::FPTrunc:
1498 case Instruction::FPExt:
1499 case Instruction::UIToFP:
1500 case Instruction::SIToFP:
1501 case Instruction::FPToUI:
1502 case Instruction::FPToSI:
1503 case Instruction::PtrToInt:
1504 case Instruction::IntToPtr:
1505 case Instruction::BitCast:
1506 New = ConstantExpr::getCast(OldC->getOpcode(), OldC->getOperand(0),
1509 case Instruction::Select:
1510 New = ConstantExpr::getSelectTy(NewTy, OldC->getOperand(0),
1511 OldC->getOperand(1),
1512 OldC->getOperand(2));
1515 assert(OldC->getOpcode() >= Instruction::BinaryOpsBegin &&
1516 OldC->getOpcode() < Instruction::BinaryOpsEnd);
1517 New = ConstantExpr::getTy(NewTy, OldC->getOpcode(), OldC->getOperand(0),
1518 OldC->getOperand(1));
1520 case Instruction::GetElementPtr:
1521 // Make everyone now use a constant of the new type...
1522 std::vector<Value*> Idx(OldC->op_begin()+1, OldC->op_end());
1523 New = ConstantExpr::getGetElementPtrTy(NewTy, OldC->getOperand(0),
1524 &Idx[0], Idx.size());
1528 assert(New != OldC && "Didn't replace constant??");
1529 OldC->uncheckedReplaceAllUsesWith(New);
1530 OldC->destroyConstant(); // This constant is now dead, destroy it.
1533 } // end namespace llvm
1536 static ExprMapKeyType getValType(ConstantExpr *CE) {
1537 std::vector<Constant*> Operands;
1538 Operands.reserve(CE->getNumOperands());
1539 for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i)
1540 Operands.push_back(cast<Constant>(CE->getOperand(i)));
1541 return ExprMapKeyType(CE->getOpcode(), Operands,
1542 CE->isCompare() ? CE->getPredicate() : 0,
1544 CE->getIndices() : SmallVector<unsigned, 4>());
1547 static ManagedStatic<ValueMap<ExprMapKeyType, Type,
1548 ConstantExpr> > ExprConstants;
1550 /// This is a utility function to handle folding of casts and lookup of the
1551 /// cast in the ExprConstants map. It is used by the various get* methods below.
1552 static inline Constant *getFoldedCast(
1553 Instruction::CastOps opc, Constant *C, const Type *Ty) {
1554 assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1555 // Fold a few common cases
1557 ConstantFoldCastInstruction(getGlobalContext(), opc, C, Ty))
1560 // Look up the constant in the table first to ensure uniqueness
1561 std::vector<Constant*> argVec(1, C);
1562 ExprMapKeyType Key(opc, argVec);
1564 // Implicitly locked.
1565 return ExprConstants->getOrCreate(Ty, Key);
1568 Constant *ConstantExpr::getCast(unsigned oc, Constant *C, const Type *Ty) {
1569 Instruction::CastOps opc = Instruction::CastOps(oc);
1570 assert(Instruction::isCast(opc) && "opcode out of range");
1571 assert(C && Ty && "Null arguments to getCast");
1572 assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1576 llvm_unreachable("Invalid cast opcode");
1578 case Instruction::Trunc: return getTrunc(C, Ty);
1579 case Instruction::ZExt: return getZExt(C, Ty);
1580 case Instruction::SExt: return getSExt(C, Ty);
1581 case Instruction::FPTrunc: return getFPTrunc(C, Ty);
1582 case Instruction::FPExt: return getFPExtend(C, Ty);
1583 case Instruction::UIToFP: return getUIToFP(C, Ty);
1584 case Instruction::SIToFP: return getSIToFP(C, Ty);
1585 case Instruction::FPToUI: return getFPToUI(C, Ty);
1586 case Instruction::FPToSI: return getFPToSI(C, Ty);
1587 case Instruction::PtrToInt: return getPtrToInt(C, Ty);
1588 case Instruction::IntToPtr: return getIntToPtr(C, Ty);
1589 case Instruction::BitCast: return getBitCast(C, Ty);
1594 Constant *ConstantExpr::getZExtOrBitCast(Constant *C, const Type *Ty) {
1595 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1596 return getCast(Instruction::BitCast, C, Ty);
1597 return getCast(Instruction::ZExt, C, Ty);
1600 Constant *ConstantExpr::getSExtOrBitCast(Constant *C, const Type *Ty) {
1601 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1602 return getCast(Instruction::BitCast, C, Ty);
1603 return getCast(Instruction::SExt, C, Ty);
1606 Constant *ConstantExpr::getTruncOrBitCast(Constant *C, const Type *Ty) {
1607 if (C->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
1608 return getCast(Instruction::BitCast, C, Ty);
1609 return getCast(Instruction::Trunc, C, Ty);
1612 Constant *ConstantExpr::getPointerCast(Constant *S, const Type *Ty) {
1613 assert(isa<PointerType>(S->getType()) && "Invalid cast");
1614 assert((Ty->isInteger() || isa<PointerType>(Ty)) && "Invalid cast");
1616 if (Ty->isInteger())
1617 return getCast(Instruction::PtrToInt, S, Ty);
1618 return getCast(Instruction::BitCast, S, Ty);
1621 Constant *ConstantExpr::getIntegerCast(Constant *C, const Type *Ty,
1623 assert(C->getType()->isIntOrIntVector() &&
1624 Ty->isIntOrIntVector() && "Invalid cast");
1625 unsigned SrcBits = C->getType()->getScalarSizeInBits();
1626 unsigned DstBits = Ty->getScalarSizeInBits();
1627 Instruction::CastOps opcode =
1628 (SrcBits == DstBits ? Instruction::BitCast :
1629 (SrcBits > DstBits ? Instruction::Trunc :
1630 (isSigned ? Instruction::SExt : Instruction::ZExt)));
1631 return getCast(opcode, C, Ty);
1634 Constant *ConstantExpr::getFPCast(Constant *C, const Type *Ty) {
1635 assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
1637 unsigned SrcBits = C->getType()->getScalarSizeInBits();
1638 unsigned DstBits = Ty->getScalarSizeInBits();
1639 if (SrcBits == DstBits)
1640 return C; // Avoid a useless cast
1641 Instruction::CastOps opcode =
1642 (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt);
1643 return getCast(opcode, C, Ty);
1646 Constant *ConstantExpr::getTrunc(Constant *C, const Type *Ty) {
1648 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1649 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1651 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1652 assert(C->getType()->isIntOrIntVector() && "Trunc operand must be integer");
1653 assert(Ty->isIntOrIntVector() && "Trunc produces only integral");
1654 assert(C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1655 "SrcTy must be larger than DestTy for Trunc!");
1657 return getFoldedCast(Instruction::Trunc, C, Ty);
1660 Constant *ConstantExpr::getSExt(Constant *C, const Type *Ty) {
1662 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1663 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1665 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1666 assert(C->getType()->isIntOrIntVector() && "SExt operand must be integral");
1667 assert(Ty->isIntOrIntVector() && "SExt produces only integer");
1668 assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1669 "SrcTy must be smaller than DestTy for SExt!");
1671 return getFoldedCast(Instruction::SExt, C, Ty);
1674 Constant *ConstantExpr::getZExt(Constant *C, const Type *Ty) {
1676 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1677 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1679 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1680 assert(C->getType()->isIntOrIntVector() && "ZEXt operand must be integral");
1681 assert(Ty->isIntOrIntVector() && "ZExt produces only integer");
1682 assert(C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1683 "SrcTy must be smaller than DestTy for ZExt!");
1685 return getFoldedCast(Instruction::ZExt, C, Ty);
1688 Constant *ConstantExpr::getFPTrunc(Constant *C, const Type *Ty) {
1690 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1691 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1693 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1694 assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
1695 C->getType()->getScalarSizeInBits() > Ty->getScalarSizeInBits()&&
1696 "This is an illegal floating point truncation!");
1697 return getFoldedCast(Instruction::FPTrunc, C, Ty);
1700 Constant *ConstantExpr::getFPExtend(Constant *C, const Type *Ty) {
1702 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1703 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1705 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1706 assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
1707 C->getType()->getScalarSizeInBits() < Ty->getScalarSizeInBits()&&
1708 "This is an illegal floating point extension!");
1709 return getFoldedCast(Instruction::FPExt, C, Ty);
1712 Constant *ConstantExpr::getUIToFP(Constant *C, const Type *Ty) {
1714 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1715 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1717 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1718 assert(C->getType()->isIntOrIntVector() && Ty->isFPOrFPVector() &&
1719 "This is an illegal uint to floating point cast!");
1720 return getFoldedCast(Instruction::UIToFP, C, Ty);
1723 Constant *ConstantExpr::getSIToFP(Constant *C, const Type *Ty) {
1725 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1726 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1728 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1729 assert(C->getType()->isIntOrIntVector() && Ty->isFPOrFPVector() &&
1730 "This is an illegal sint to floating point cast!");
1731 return getFoldedCast(Instruction::SIToFP, C, Ty);
1734 Constant *ConstantExpr::getFPToUI(Constant *C, const Type *Ty) {
1736 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1737 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1739 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1740 assert(C->getType()->isFPOrFPVector() && Ty->isIntOrIntVector() &&
1741 "This is an illegal floating point to uint cast!");
1742 return getFoldedCast(Instruction::FPToUI, C, Ty);
1745 Constant *ConstantExpr::getFPToSI(Constant *C, const Type *Ty) {
1747 bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1748 bool toVec = Ty->getTypeID() == Type::VectorTyID;
1750 assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1751 assert(C->getType()->isFPOrFPVector() && Ty->isIntOrIntVector() &&
1752 "This is an illegal floating point to sint cast!");
1753 return getFoldedCast(Instruction::FPToSI, C, Ty);
1756 Constant *ConstantExpr::getPtrToInt(Constant *C, const Type *DstTy) {
1757 assert(isa<PointerType>(C->getType()) && "PtrToInt source must be pointer");
1758 assert(DstTy->isInteger() && "PtrToInt destination must be integral");
1759 return getFoldedCast(Instruction::PtrToInt, C, DstTy);
1762 Constant *ConstantExpr::getIntToPtr(Constant *C, const Type *DstTy) {
1763 assert(C->getType()->isInteger() && "IntToPtr source must be integral");
1764 assert(isa<PointerType>(DstTy) && "IntToPtr destination must be a pointer");
1765 return getFoldedCast(Instruction::IntToPtr, C, DstTy);
1768 Constant *ConstantExpr::getBitCast(Constant *C, const Type *DstTy) {
1769 // BitCast implies a no-op cast of type only. No bits change. However, you
1770 // can't cast pointers to anything but pointers.
1772 const Type *SrcTy = C->getType();
1773 assert((isa<PointerType>(SrcTy) == isa<PointerType>(DstTy)) &&
1774 "BitCast cannot cast pointer to non-pointer and vice versa");
1776 // Now we know we're not dealing with mismatched pointer casts (ptr->nonptr
1777 // or nonptr->ptr). For all the other types, the cast is okay if source and
1778 // destination bit widths are identical.
1779 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
1780 unsigned DstBitSize = DstTy->getPrimitiveSizeInBits();
1782 assert(SrcBitSize == DstBitSize && "BitCast requires types of same width");
1784 // It is common to ask for a bitcast of a value to its own type, handle this
1786 if (C->getType() == DstTy) return C;
1788 return getFoldedCast(Instruction::BitCast, C, DstTy);
1791 Constant *ConstantExpr::getTy(const Type *ReqTy, unsigned Opcode,
1792 Constant *C1, Constant *C2) {
1793 // Check the operands for consistency first
1794 assert(Opcode >= Instruction::BinaryOpsBegin &&
1795 Opcode < Instruction::BinaryOpsEnd &&
1796 "Invalid opcode in binary constant expression");
1797 assert(C1->getType() == C2->getType() &&
1798 "Operand types in binary constant expression should match");
1800 if (ReqTy == C1->getType() || ReqTy == Type::Int1Ty)
1801 if (Constant *FC = ConstantFoldBinaryInstruction(
1802 getGlobalContext(), Opcode, C1, C2))
1803 return FC; // Fold a few common cases...
1805 std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1806 ExprMapKeyType Key(Opcode, argVec);
1808 // Implicitly locked.
1809 return ExprConstants->getOrCreate(ReqTy, Key);
1812 Constant *ConstantExpr::getCompareTy(unsigned short predicate,
1813 Constant *C1, Constant *C2) {
1814 switch (predicate) {
1815 default: llvm_unreachable("Invalid CmpInst predicate");
1816 case CmpInst::FCMP_FALSE: case CmpInst::FCMP_OEQ: case CmpInst::FCMP_OGT:
1817 case CmpInst::FCMP_OGE: case CmpInst::FCMP_OLT: case CmpInst::FCMP_OLE:
1818 case CmpInst::FCMP_ONE: case CmpInst::FCMP_ORD: case CmpInst::FCMP_UNO:
1819 case CmpInst::FCMP_UEQ: case CmpInst::FCMP_UGT: case CmpInst::FCMP_UGE:
1820 case CmpInst::FCMP_ULT: case CmpInst::FCMP_ULE: case CmpInst::FCMP_UNE:
1821 case CmpInst::FCMP_TRUE:
1822 return getFCmp(predicate, C1, C2);
1824 case CmpInst::ICMP_EQ: case CmpInst::ICMP_NE: case CmpInst::ICMP_UGT:
1825 case CmpInst::ICMP_UGE: case CmpInst::ICMP_ULT: case CmpInst::ICMP_ULE:
1826 case CmpInst::ICMP_SGT: case CmpInst::ICMP_SGE: case CmpInst::ICMP_SLT:
1827 case CmpInst::ICMP_SLE:
1828 return getICmp(predicate, C1, C2);
1832 Constant *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2) {
1833 // API compatibility: Adjust integer opcodes to floating-point opcodes.
1834 if (C1->getType()->isFPOrFPVector()) {
1835 if (Opcode == Instruction::Add) Opcode = Instruction::FAdd;
1836 else if (Opcode == Instruction::Sub) Opcode = Instruction::FSub;
1837 else if (Opcode == Instruction::Mul) Opcode = Instruction::FMul;
1841 case Instruction::Add:
1842 case Instruction::Sub:
1843 case Instruction::Mul:
1844 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1845 assert(C1->getType()->isIntOrIntVector() &&
1846 "Tried to create an integer operation on a non-integer type!");
1848 case Instruction::FAdd:
1849 case Instruction::FSub:
1850 case Instruction::FMul:
1851 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1852 assert(C1->getType()->isFPOrFPVector() &&
1853 "Tried to create a floating-point operation on a "
1854 "non-floating-point type!");
1856 case Instruction::UDiv:
1857 case Instruction::SDiv:
1858 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1859 assert(C1->getType()->isIntOrIntVector() &&
1860 "Tried to create an arithmetic operation on a non-arithmetic type!");
1862 case Instruction::FDiv:
1863 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1864 assert(C1->getType()->isFPOrFPVector() &&
1865 "Tried to create an arithmetic operation on a non-arithmetic type!");
1867 case Instruction::URem:
1868 case Instruction::SRem:
1869 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1870 assert(C1->getType()->isIntOrIntVector() &&
1871 "Tried to create an arithmetic operation on a non-arithmetic type!");
1873 case Instruction::FRem:
1874 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1875 assert(C1->getType()->isFPOrFPVector() &&
1876 "Tried to create an arithmetic operation on a non-arithmetic type!");
1878 case Instruction::And:
1879 case Instruction::Or:
1880 case Instruction::Xor:
1881 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1882 assert(C1->getType()->isIntOrIntVector() &&
1883 "Tried to create a logical operation on a non-integral type!");
1885 case Instruction::Shl:
1886 case Instruction::LShr:
1887 case Instruction::AShr:
1888 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1889 assert(C1->getType()->isIntOrIntVector() &&
1890 "Tried to create a shift operation on a non-integer type!");
1897 return getTy(C1->getType(), Opcode, C1, C2);
1900 Constant *ConstantExpr::getCompare(unsigned short pred,
1901 Constant *C1, Constant *C2) {
1902 assert(C1->getType() == C2->getType() && "Op types should be identical!");
1903 return getCompareTy(pred, C1, C2);
1906 Constant *ConstantExpr::getSelectTy(const Type *ReqTy, Constant *C,
1907 Constant *V1, Constant *V2) {
1908 assert(!SelectInst::areInvalidOperands(C, V1, V2)&&"Invalid select operands");
1910 if (ReqTy == V1->getType())
1911 if (Constant *SC = ConstantFoldSelectInstruction(
1912 getGlobalContext(), C, V1, V2))
1913 return SC; // Fold common cases
1915 std::vector<Constant*> argVec(3, C);
1918 ExprMapKeyType Key(Instruction::Select, argVec);
1920 // Implicitly locked.
1921 return ExprConstants->getOrCreate(ReqTy, Key);
1924 Constant *ConstantExpr::getGetElementPtrTy(const Type *ReqTy, Constant *C,
1927 assert(GetElementPtrInst::getIndexedType(C->getType(), Idxs,
1929 cast<PointerType>(ReqTy)->getElementType() &&
1930 "GEP indices invalid!");
1932 if (Constant *FC = ConstantFoldGetElementPtr(
1933 getGlobalContext(), C, (Constant**)Idxs, NumIdx))
1934 return FC; // Fold a few common cases...
1936 assert(isa<PointerType>(C->getType()) &&
1937 "Non-pointer type for constant GetElementPtr expression");
1938 // Look up the constant in the table first to ensure uniqueness
1939 std::vector<Constant*> ArgVec;
1940 ArgVec.reserve(NumIdx+1);
1941 ArgVec.push_back(C);
1942 for (unsigned i = 0; i != NumIdx; ++i)
1943 ArgVec.push_back(cast<Constant>(Idxs[i]));
1944 const ExprMapKeyType Key(Instruction::GetElementPtr, ArgVec);
1946 // Implicitly locked.
1947 return ExprConstants->getOrCreate(ReqTy, Key);
1950 Constant *ConstantExpr::getGetElementPtr(Constant *C, Value* const *Idxs,
1952 // Get the result type of the getelementptr!
1954 GetElementPtrInst::getIndexedType(C->getType(), Idxs, Idxs+NumIdx);
1955 assert(Ty && "GEP indices invalid!");
1956 unsigned As = cast<PointerType>(C->getType())->getAddressSpace();
1957 return getGetElementPtrTy(PointerType::get(Ty, As), C, Idxs, NumIdx);
1960 Constant *ConstantExpr::getGetElementPtr(Constant *C, Constant* const *Idxs,
1962 return getGetElementPtr(C, (Value* const *)Idxs, NumIdx);
1967 ConstantExpr::getICmp(unsigned short pred, Constant* LHS, Constant* RHS) {
1968 assert(LHS->getType() == RHS->getType());
1969 assert(pred >= ICmpInst::FIRST_ICMP_PREDICATE &&
1970 pred <= ICmpInst::LAST_ICMP_PREDICATE && "Invalid ICmp Predicate");
1972 if (Constant *FC = ConstantFoldCompareInstruction(
1973 getGlobalContext(),pred, LHS, RHS))
1974 return FC; // Fold a few common cases...
1976 // Look up the constant in the table first to ensure uniqueness
1977 std::vector<Constant*> ArgVec;
1978 ArgVec.push_back(LHS);
1979 ArgVec.push_back(RHS);
1980 // Get the key type with both the opcode and predicate
1981 const ExprMapKeyType Key(Instruction::ICmp, ArgVec, pred);
1983 // Implicitly locked.
1984 return ExprConstants->getOrCreate(Type::Int1Ty, Key);
1988 ConstantExpr::getFCmp(unsigned short pred, Constant* LHS, Constant* RHS) {
1989 assert(LHS->getType() == RHS->getType());
1990 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE && "Invalid FCmp Predicate");
1992 if (Constant *FC = ConstantFoldCompareInstruction(
1993 getGlobalContext(), pred, LHS, RHS))
1994 return FC; // Fold a few common cases...
1996 // Look up the constant in the table first to ensure uniqueness
1997 std::vector<Constant*> ArgVec;
1998 ArgVec.push_back(LHS);
1999 ArgVec.push_back(RHS);
2000 // Get the key type with both the opcode and predicate
2001 const ExprMapKeyType Key(Instruction::FCmp, ArgVec, pred);
2003 // Implicitly locked.
2004 return ExprConstants->getOrCreate(Type::Int1Ty, Key);
2007 Constant *ConstantExpr::getExtractElementTy(const Type *ReqTy, Constant *Val,
2009 if (Constant *FC = ConstantFoldExtractElementInstruction(
2010 getGlobalContext(), Val, Idx))
2011 return FC; // Fold a few common cases...
2012 // Look up the constant in the table first to ensure uniqueness
2013 std::vector<Constant*> ArgVec(1, Val);
2014 ArgVec.push_back(Idx);
2015 const ExprMapKeyType Key(Instruction::ExtractElement,ArgVec);
2017 // Implicitly locked.
2018 return ExprConstants->getOrCreate(ReqTy, Key);
2021 Constant *ConstantExpr::getExtractElement(Constant *Val, Constant *Idx) {
2022 assert(isa<VectorType>(Val->getType()) &&
2023 "Tried to create extractelement operation on non-vector type!");
2024 assert(Idx->getType() == Type::Int32Ty &&
2025 "Extractelement index must be i32 type!");
2026 return getExtractElementTy(cast<VectorType>(Val->getType())->getElementType(),
2030 Constant *ConstantExpr::getInsertElementTy(const Type *ReqTy, Constant *Val,
2031 Constant *Elt, Constant *Idx) {
2032 if (Constant *FC = ConstantFoldInsertElementInstruction(
2033 getGlobalContext(), Val, Elt, Idx))
2034 return FC; // Fold a few common cases...
2035 // Look up the constant in the table first to ensure uniqueness
2036 std::vector<Constant*> ArgVec(1, Val);
2037 ArgVec.push_back(Elt);
2038 ArgVec.push_back(Idx);
2039 const ExprMapKeyType Key(Instruction::InsertElement,ArgVec);
2041 // Implicitly locked.
2042 return ExprConstants->getOrCreate(ReqTy, Key);
2045 Constant *ConstantExpr::getInsertElement(Constant *Val, Constant *Elt,
2047 assert(isa<VectorType>(Val->getType()) &&
2048 "Tried to create insertelement operation on non-vector type!");
2049 assert(Elt->getType() == cast<VectorType>(Val->getType())->getElementType()
2050 && "Insertelement types must match!");
2051 assert(Idx->getType() == Type::Int32Ty &&
2052 "Insertelement index must be i32 type!");
2053 return getInsertElementTy(Val->getType(), Val, Elt, Idx);
2056 Constant *ConstantExpr::getShuffleVectorTy(const Type *ReqTy, Constant *V1,
2057 Constant *V2, Constant *Mask) {
2058 if (Constant *FC = ConstantFoldShuffleVectorInstruction(
2059 getGlobalContext(), V1, V2, Mask))
2060 return FC; // Fold a few common cases...
2061 // Look up the constant in the table first to ensure uniqueness
2062 std::vector<Constant*> ArgVec(1, V1);
2063 ArgVec.push_back(V2);
2064 ArgVec.push_back(Mask);
2065 const ExprMapKeyType Key(Instruction::ShuffleVector,ArgVec);
2067 // Implicitly locked.
2068 return ExprConstants->getOrCreate(ReqTy, Key);
2071 Constant *ConstantExpr::getShuffleVector(Constant *V1, Constant *V2,
2073 assert(ShuffleVectorInst::isValidOperands(V1, V2, Mask) &&
2074 "Invalid shuffle vector constant expr operands!");
2076 unsigned NElts = cast<VectorType>(Mask->getType())->getNumElements();
2077 const Type *EltTy = cast<VectorType>(V1->getType())->getElementType();
2078 const Type *ShufTy = VectorType::get(EltTy, NElts);
2079 return getShuffleVectorTy(ShufTy, V1, V2, Mask);
2082 Constant *ConstantExpr::getInsertValueTy(const Type *ReqTy, Constant *Agg,
2084 const unsigned *Idxs, unsigned NumIdx) {
2085 assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs,
2086 Idxs+NumIdx) == Val->getType() &&
2087 "insertvalue indices invalid!");
2088 assert(Agg->getType() == ReqTy &&
2089 "insertvalue type invalid!");
2090 assert(Agg->getType()->isFirstClassType() &&
2091 "Non-first-class type for constant InsertValue expression");
2092 Constant *FC = ConstantFoldInsertValueInstruction(
2093 getGlobalContext(), Agg, Val, Idxs, NumIdx);
2094 assert(FC && "InsertValue constant expr couldn't be folded!");
2098 Constant *ConstantExpr::getInsertValue(Constant *Agg, Constant *Val,
2099 const unsigned *IdxList, unsigned NumIdx) {
2100 assert(Agg->getType()->isFirstClassType() &&
2101 "Tried to create insertelement operation on non-first-class type!");
2103 const Type *ReqTy = Agg->getType();
2106 ExtractValueInst::getIndexedType(Agg->getType(), IdxList, IdxList+NumIdx);
2108 assert(ValTy == Val->getType() && "insertvalue indices invalid!");
2109 return getInsertValueTy(ReqTy, Agg, Val, IdxList, NumIdx);
2112 Constant *ConstantExpr::getExtractValueTy(const Type *ReqTy, Constant *Agg,
2113 const unsigned *Idxs, unsigned NumIdx) {
2114 assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs,
2115 Idxs+NumIdx) == ReqTy &&
2116 "extractvalue indices invalid!");
2117 assert(Agg->getType()->isFirstClassType() &&
2118 "Non-first-class type for constant extractvalue expression");
2119 Constant *FC = ConstantFoldExtractValueInstruction(
2120 getGlobalContext(), Agg, Idxs, NumIdx);
2121 assert(FC && "ExtractValue constant expr couldn't be folded!");
2125 Constant *ConstantExpr::getExtractValue(Constant *Agg,
2126 const unsigned *IdxList, unsigned NumIdx) {
2127 assert(Agg->getType()->isFirstClassType() &&
2128 "Tried to create extractelement operation on non-first-class type!");
2131 ExtractValueInst::getIndexedType(Agg->getType(), IdxList, IdxList+NumIdx);
2132 assert(ReqTy && "extractvalue indices invalid!");
2133 return getExtractValueTy(ReqTy, Agg, IdxList, NumIdx);
2136 // destroyConstant - Remove the constant from the constant table...
2138 void ConstantExpr::destroyConstant() {
2139 // Implicitly locked.
2140 ExprConstants->remove(this);
2141 destroyConstantImpl();
2144 const char *ConstantExpr::getOpcodeName() const {
2145 return Instruction::getOpcodeName(getOpcode());
2148 //===----------------------------------------------------------------------===//
2149 // replaceUsesOfWithOnConstant implementations
2151 /// replaceUsesOfWithOnConstant - Update this constant array to change uses of
2152 /// 'From' to be uses of 'To'. This must update the uniquing data structures
2155 /// Note that we intentionally replace all uses of From with To here. Consider
2156 /// a large array that uses 'From' 1000 times. By handling this case all here,
2157 /// ConstantArray::replaceUsesOfWithOnConstant is only invoked once, and that
2158 /// single invocation handles all 1000 uses. Handling them one at a time would
2159 /// work, but would be really slow because it would have to unique each updated
2161 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
2163 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2164 Constant *ToC = cast<Constant>(To);
2166 std::pair<ArrayConstantsTy::MapKey, Constant*> Lookup;
2167 Lookup.first.first = getType();
2168 Lookup.second = this;
2170 std::vector<Constant*> &Values = Lookup.first.second;
2171 Values.reserve(getNumOperands()); // Build replacement array.
2173 // Fill values with the modified operands of the constant array. Also,
2174 // compute whether this turns into an all-zeros array.
2175 bool isAllZeros = false;
2176 unsigned NumUpdated = 0;
2177 if (!ToC->isNullValue()) {
2178 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2179 Constant *Val = cast<Constant>(O->get());
2184 Values.push_back(Val);
2188 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2189 Constant *Val = cast<Constant>(O->get());
2194 Values.push_back(Val);
2195 if (isAllZeros) isAllZeros = Val->isNullValue();
2199 Constant *Replacement = 0;
2202 From->getType()->getContext().getConstantAggregateZero(getType());
2204 // Check to see if we have this array type already.
2205 sys::SmartScopedWriter<true> Writer(*ConstantsLock);
2207 ArrayConstantsTy::MapTy::iterator I =
2208 ArrayConstants->InsertOrGetItem(Lookup, Exists);
2211 Replacement = I->second;
2213 // Okay, the new shape doesn't exist in the system yet. Instead of
2214 // creating a new constant array, inserting it, replaceallusesof'ing the
2215 // old with the new, then deleting the old... just update the current one
2217 ArrayConstants->MoveConstantToNewSlot(this, I);
2219 // Update to the new value. Optimize for the case when we have a single
2220 // operand that we're changing, but handle bulk updates efficiently.
2221 if (NumUpdated == 1) {
2222 unsigned OperandToUpdate = U-OperandList;
2223 assert(getOperand(OperandToUpdate) == From &&
2224 "ReplaceAllUsesWith broken!");
2225 setOperand(OperandToUpdate, ToC);
2227 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2228 if (getOperand(i) == From)
2235 // Otherwise, I do need to replace this with an existing value.
2236 assert(Replacement != this && "I didn't contain From!");
2238 // Everyone using this now uses the replacement.
2239 uncheckedReplaceAllUsesWith(Replacement);
2241 // Delete the old constant!
2245 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
2247 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2248 Constant *ToC = cast<Constant>(To);
2250 unsigned OperandToUpdate = U-OperandList;
2251 assert(getOperand(OperandToUpdate) == From && "ReplaceAllUsesWith broken!");
2253 std::pair<StructConstantsTy::MapKey, Constant*> Lookup;
2254 Lookup.first.first = getType();
2255 Lookup.second = this;
2256 std::vector<Constant*> &Values = Lookup.first.second;
2257 Values.reserve(getNumOperands()); // Build replacement struct.
2260 // Fill values with the modified operands of the constant struct. Also,
2261 // compute whether this turns into an all-zeros struct.
2262 bool isAllZeros = false;
2263 if (!ToC->isNullValue()) {
2264 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O)
2265 Values.push_back(cast<Constant>(O->get()));
2268 for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2269 Constant *Val = cast<Constant>(O->get());
2270 Values.push_back(Val);
2271 if (isAllZeros) isAllZeros = Val->isNullValue();
2274 Values[OperandToUpdate] = ToC;
2276 Constant *Replacement = 0;
2278 Replacement = getType()->getContext().getConstantAggregateZero(getType());
2280 // Check to see if we have this array type already.
2281 sys::SmartScopedWriter<true> Writer(*ConstantsLock);
2283 StructConstantsTy::MapTy::iterator I =
2284 StructConstants->InsertOrGetItem(Lookup, Exists);
2287 Replacement = I->second;
2289 // Okay, the new shape doesn't exist in the system yet. Instead of
2290 // creating a new constant struct, inserting it, replaceallusesof'ing the
2291 // old with the new, then deleting the old... just update the current one
2293 StructConstants->MoveConstantToNewSlot(this, I);
2295 // Update to the new value.
2296 setOperand(OperandToUpdate, ToC);
2301 assert(Replacement != this && "I didn't contain From!");
2303 // Everyone using this now uses the replacement.
2304 uncheckedReplaceAllUsesWith(Replacement);
2306 // Delete the old constant!
2310 void ConstantVector::replaceUsesOfWithOnConstant(Value *From, Value *To,
2312 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2314 std::vector<Constant*> Values;
2315 Values.reserve(getNumOperands()); // Build replacement array...
2316 for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
2317 Constant *Val = getOperand(i);
2318 if (Val == From) Val = cast<Constant>(To);
2319 Values.push_back(Val);
2322 Constant *Replacement = ConstantVector::get(getType(), Values);
2323 assert(Replacement != this && "I didn't contain From!");
2325 // Everyone using this now uses the replacement.
2326 uncheckedReplaceAllUsesWith(Replacement);
2328 // Delete the old constant!
2332 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
2334 assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
2335 Constant *To = cast<Constant>(ToV);
2337 Constant *Replacement = 0;
2338 if (getOpcode() == Instruction::GetElementPtr) {
2339 SmallVector<Constant*, 8> Indices;
2340 Constant *Pointer = getOperand(0);
2341 Indices.reserve(getNumOperands()-1);
2342 if (Pointer == From) Pointer = To;
2344 for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
2345 Constant *Val = getOperand(i);
2346 if (Val == From) Val = To;
2347 Indices.push_back(Val);
2349 Replacement = ConstantExpr::getGetElementPtr(Pointer,
2350 &Indices[0], Indices.size());
2351 } else if (getOpcode() == Instruction::ExtractValue) {
2352 Constant *Agg = getOperand(0);
2353 if (Agg == From) Agg = To;
2355 const SmallVector<unsigned, 4> &Indices = getIndices();
2356 Replacement = ConstantExpr::getExtractValue(Agg,
2357 &Indices[0], Indices.size());
2358 } else if (getOpcode() == Instruction::InsertValue) {
2359 Constant *Agg = getOperand(0);
2360 Constant *Val = getOperand(1);
2361 if (Agg == From) Agg = To;
2362 if (Val == From) Val = To;
2364 const SmallVector<unsigned, 4> &Indices = getIndices();
2365 Replacement = ConstantExpr::getInsertValue(Agg, Val,
2366 &Indices[0], Indices.size());
2367 } else if (isCast()) {
2368 assert(getOperand(0) == From && "Cast only has one use!");
2369 Replacement = ConstantExpr::getCast(getOpcode(), To, getType());
2370 } else if (getOpcode() == Instruction::Select) {
2371 Constant *C1 = getOperand(0);
2372 Constant *C2 = getOperand(1);
2373 Constant *C3 = getOperand(2);
2374 if (C1 == From) C1 = To;
2375 if (C2 == From) C2 = To;
2376 if (C3 == From) C3 = To;
2377 Replacement = ConstantExpr::getSelect(C1, C2, C3);
2378 } else if (getOpcode() == Instruction::ExtractElement) {
2379 Constant *C1 = getOperand(0);
2380 Constant *C2 = getOperand(1);
2381 if (C1 == From) C1 = To;
2382 if (C2 == From) C2 = To;
2383 Replacement = ConstantExpr::getExtractElement(C1, C2);
2384 } else if (getOpcode() == Instruction::InsertElement) {
2385 Constant *C1 = getOperand(0);
2386 Constant *C2 = getOperand(1);
2387 Constant *C3 = getOperand(1);
2388 if (C1 == From) C1 = To;
2389 if (C2 == From) C2 = To;
2390 if (C3 == From) C3 = To;
2391 Replacement = ConstantExpr::getInsertElement(C1, C2, C3);
2392 } else if (getOpcode() == Instruction::ShuffleVector) {
2393 Constant *C1 = getOperand(0);
2394 Constant *C2 = getOperand(1);
2395 Constant *C3 = getOperand(2);
2396 if (C1 == From) C1 = To;
2397 if (C2 == From) C2 = To;
2398 if (C3 == From) C3 = To;
2399 Replacement = ConstantExpr::getShuffleVector(C1, C2, C3);
2400 } else if (isCompare()) {
2401 Constant *C1 = getOperand(0);
2402 Constant *C2 = getOperand(1);
2403 if (C1 == From) C1 = To;
2404 if (C2 == From) C2 = To;
2405 if (getOpcode() == Instruction::ICmp)
2406 Replacement = ConstantExpr::getICmp(getPredicate(), C1, C2);
2408 assert(getOpcode() == Instruction::FCmp);
2409 Replacement = ConstantExpr::getFCmp(getPredicate(), C1, C2);
2411 } else if (getNumOperands() == 2) {
2412 Constant *C1 = getOperand(0);
2413 Constant *C2 = getOperand(1);
2414 if (C1 == From) C1 = To;
2415 if (C2 == From) C2 = To;
2416 Replacement = ConstantExpr::get(getOpcode(), C1, C2);
2418 llvm_unreachable("Unknown ConstantExpr type!");
2422 assert(Replacement != this && "I didn't contain From!");
2424 // Everyone using this now uses the replacement.
2425 uncheckedReplaceAllUsesWith(Replacement);
2427 // Delete the old constant!
2431 void MDNode::replaceElement(Value *From, Value *To) {
2432 SmallVector<Value*, 4> Values;
2433 Values.reserve(getNumElements()); // Build replacement array...
2434 for (unsigned i = 0, e = getNumElements(); i != e; ++i) {
2435 Value *Val = getElement(i);
2436 if (Val == From) Val = To;
2437 Values.push_back(Val);
2440 MDNode *Replacement =
2441 getType()->getContext().getMDNode(&Values[0], Values.size());
2442 assert(Replacement != this && "I didn't contain From!");
2444 uncheckedReplaceAllUsesWith(Replacement);