Use -Wl,-x instead of -s: it is more portable, and in particular,
[oota-llvm.git] / lib / VMCore / Constants.cpp
index 234b64705b923894b9dbe18b35af7462b66a86d1..3887e33274a693d72cae36299a8f2ac9e491822c 100644 (file)
@@ -4,7 +4,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-#define __STDC_LIMIT_MACROS           // Get defs for INT64_MAX and friends...
 #include "llvm/Constants.h"
 #include "llvm/DerivedTypes.h"
 #include "llvm/iMemory.h"
@@ -34,6 +33,34 @@ void Constant::setName(const std::string &Name, SymbolTable *ST) {
   if (Name.size()) ST->insert(Name, this);
 }
 
+void Constant::destroyConstantImpl() {
+  // When a Constant is destroyed, there may be lingering
+  // references to the constant by other constants in the constant pool.  These
+  // constants are implicitly dependant on the module that is being deleted,
+  // but they don't know that.  Because we only find out when the CPV is
+  // deleted, we must now notify all of our users (that should only be
+  // Constants) that they are, in fact, invalid now and should be deleted.
+  //
+  while (!use_empty()) {
+    Value *V = use_back();
+#ifndef NDEBUG      // Only in -g mode...
+    if (!isa<Constant>(V))
+      std::cerr << "While deleting: " << *this
+                << "\n\nUse still stuck around after Def is destroyed: "
+                << *V << "\n\n";
+#endif
+    assert(isa<Constant>(V) && "References remain to Constant being destroyed");
+    Constant *CPV = cast<Constant>(V);
+    CPV->destroyConstant();
+
+    // The constant should remove itself from our use list...
+    assert((use_empty() || use_back() != V) && "Constant not removed!");
+  }
+
+  // Value has no outstanding references it is safe to delete it now...
+  delete this;
+}
+
 // Static constructor to create a '0' constant of arbitrary type...
 Constant *Constant::getNullValue(const Type *Ty) {
   switch (Ty->getPrimitiveID()) {
@@ -58,34 +85,78 @@ Constant *Constant::getNullValue(const Type *Ty) {
   }
 }
 
-void Constant::destroyConstantImpl() {
-  // When a Constant is destroyed, there may be lingering
-  // references to the constant by other constants in the constant pool.  These
-  // constants are implicitly dependant on the module that is being deleted,
-  // but they don't know that.  Because we only find out when the CPV is
-  // deleted, we must now notify all of our users (that should only be
-  // Constants) that they are, in fact, invalid now and should be deleted.
-  //
-  while (!use_empty()) {
-    Value *V = use_back();
-#ifndef NDEBUG      // Only in -g mode...
-    if (!isa<Constant>(V))
-      std::cerr << "While deleting: " << *this
-                << "\n\nUse still stuck around after Def is destroyed: "
-                << *V << "\n\n";
-#endif
-    assert(isa<Constant>(V) && "References remain to Constant being destroyed");
-    Constant *CPV = cast<Constant>(V);
-    CPV->destroyConstant();
+// Static constructor to create the maximum constant of an integral type...
+ConstantIntegral *ConstantIntegral::getMaxValue(const Type *Ty) {
+  switch (Ty->getPrimitiveID()) {
+  case Type::BoolTyID:   return ConstantBool::True;
+  case Type::SByteTyID:
+  case Type::ShortTyID:
+  case Type::IntTyID:
+  case Type::LongTyID: {
+    // Calculate 011111111111111... 
+    unsigned TypeBits = Ty->getPrimitiveSize()*8;
+    int64_t Val = INT64_MAX;             // All ones
+    Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
+    return ConstantSInt::get(Ty, Val);
+  }
 
-    // The constant should remove itself from our use list...
-    assert((use_empty() || use_back() != V) && "Constant not removed!");
+  case Type::UByteTyID:
+  case Type::UShortTyID:
+  case Type::UIntTyID:
+  case Type::ULongTyID:  return getAllOnesValue(Ty);
+
+  default: return 0;
   }
+}
 
-  // Value has no outstanding references it is safe to delete it now...
-  delete this;
+// Static constructor to create the minimum constant for an integral type...
+ConstantIntegral *ConstantIntegral::getMinValue(const Type *Ty) {
+  switch (Ty->getPrimitiveID()) {
+  case Type::BoolTyID:   return ConstantBool::False;
+  case Type::SByteTyID:
+  case Type::ShortTyID:
+  case Type::IntTyID:
+  case Type::LongTyID: {
+     // Calculate 1111111111000000000000 
+     unsigned TypeBits = Ty->getPrimitiveSize()*8;
+     int64_t Val = -1;                    // All ones
+     Val <<= TypeBits-1;                  // Shift over to the right spot
+     return ConstantSInt::get(Ty, Val);
+  }
+
+  case Type::UByteTyID:
+  case Type::UShortTyID:
+  case Type::UIntTyID:
+  case Type::ULongTyID:  return ConstantUInt::get(Ty, 0);
+
+  default: return 0;
+  }
+}
+
+// Static constructor to create an integral constant with all bits set
+ConstantIntegral *ConstantIntegral::getAllOnesValue(const Type *Ty) {
+  switch (Ty->getPrimitiveID()) {
+  case Type::BoolTyID:   return ConstantBool::True;
+  case Type::SByteTyID:
+  case Type::ShortTyID:
+  case Type::IntTyID:
+  case Type::LongTyID:   return ConstantSInt::get(Ty, -1);
+
+  case Type::UByteTyID:
+  case Type::UShortTyID:
+  case Type::UIntTyID:
+  case Type::ULongTyID: {
+    // Calculate ~0 of the right type...
+    unsigned TypeBits = Ty->getPrimitiveSize()*8;
+    uint64_t Val = ~0ULL;                // All ones
+    Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
+    return ConstantUInt::get(Ty, Val);
+  }
+  default: return 0;
+  }
 }
 
+
 //===----------------------------------------------------------------------===//
 //                            ConstantXXX Classes
 //===----------------------------------------------------------------------===//
@@ -93,19 +164,23 @@ void Constant::destroyConstantImpl() {
 //===----------------------------------------------------------------------===//
 //                             Normal Constructors
 
-ConstantBool::ConstantBool(bool V) : Constant(Type::BoolTy) {
+ConstantBool::ConstantBool(bool V) : ConstantIntegral(Type::BoolTy) {
   Val = V;
 }
 
-ConstantInt::ConstantInt(const Type *Ty, uint64_t V) : Constant(Ty) {
+ConstantInt::ConstantInt(const Type *Ty, uint64_t V) : ConstantIntegral(Ty) {
   Val.Unsigned = V;
 }
 
 ConstantSInt::ConstantSInt(const Type *Ty, int64_t V) : ConstantInt(Ty, V) {
+  assert(Ty->isInteger() && Ty->isSigned() &&
+         "Illegal type for unsigned integer constant!");
   assert(isValueValidForType(Ty, V) && "Value too large for type!");
 }
 
 ConstantUInt::ConstantUInt(const Type *Ty, uint64_t V) : ConstantInt(Ty, V) {
+  assert(Ty->isInteger() && Ty->isUnsigned() &&
+         "Illegal type for unsigned integer constant!");
   assert(isValueValidForType(Ty, V) && "Value too large for type!");
 }
 
@@ -116,7 +191,8 @@ ConstantFP::ConstantFP(const Type *Ty, double V) : Constant(Ty) {
 
 ConstantArray::ConstantArray(const ArrayType *T,
                              const std::vector<Constant*> &V) : Constant(T) {
-  for (unsigned i = 0; i < V.size(); i++) {
+  Operands.reserve(V.size());
+  for (unsigned i = 0, e = V.size(); i != e; ++i) {
     assert(V[i]->getType() == T->getElementType());
     Operands.push_back(Use(V[i], this));
   }
@@ -127,7 +203,8 @@ ConstantStruct::ConstantStruct(const StructType *T,
   const StructType::ElementTypes &ETypes = T->getElementTypes();
   assert(V.size() == ETypes.size() &&
          "Invalid initializer vector for constant structure");
-  for (unsigned i = 0; i < V.size(); i++) {
+  Operands.reserve(V.size());
+  for (unsigned i = 0, e = V.size(); i != e; ++i) {
     assert(V[i]->getType() == ETypes[i]);
     Operands.push_back(Use(V[i], this));
   }
@@ -138,21 +215,20 @@ ConstantPointerRef::ConstantPointerRef(GlobalValue *GV)
   Operands.push_back(Use(GV, this));
 }
 
-ConstantExpr::ConstantExpr(unsigned opCode, Constant *C,  const Type *Ty)
-  : Constant(Ty), iType(opCode) {
+ConstantExpr::ConstantExpr(unsigned Opcode, Constant *C, const Type *Ty)
+  : Constant(Ty), iType(Opcode) {
   Operands.push_back(Use(C, this));
 }
 
-ConstantExpr::ConstantExpr(unsigned opCode, Constant* C1,
-                           Constant* C2, const Type *Ty)
-  : Constant(Ty), iType(opCode) {
+ConstantExpr::ConstantExpr(unsigned Opcode, Constant *C1, Constant *C2)
+  : Constant(C1->getType()), iType(Opcode) {
   Operands.push_back(Use(C1, this));
   Operands.push_back(Use(C2, this));
 }
 
-ConstantExpr::ConstantExpr(unsigned opCode, Constant* C,
-                          const std::vector<Constant*> &IdxList, const Type *Ty)
-  : Constant(Ty), iType(opCode) {
+ConstantExpr::ConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
+                           const Type *DestTy)
+  : Constant(DestTy), iType(Instruction::GetElementPtr) {
   Operands.reserve(1+IdxList.size());
   Operands.push_back(Use(C, this));
   for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
@@ -164,9 +240,13 @@ ConstantExpr::ConstantExpr(unsigned opCode, Constant* C,
 //===----------------------------------------------------------------------===//
 //                           classof implementations
 
-bool ConstantInt::classof(const Constant *CPV) {
+bool ConstantIntegral::classof(const Constant *CPV) {
   return CPV->getType()->isIntegral() && !isa<ConstantExpr>(CPV);
 }
+
+bool ConstantInt::classof(const Constant *CPV) {
+  return CPV->getType()->isInteger() && !isa<ConstantExpr>(CPV);
+}
 bool ConstantSInt::classof(const Constant *CPV) {
   return CPV->getType()->isSigned() && !isa<ConstantExpr>(CPV);
 }
@@ -246,6 +326,112 @@ bool ConstantFP::isValueValidForType(const Type *Ty, double Val) {
   }
 };
 
+//===----------------------------------------------------------------------===//
+//                replaceUsesOfWithOnConstant implementations
+
+void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To) {
+  assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
+
+  std::vector<Constant*> Values;
+  Values.reserve(getValues().size());  // Build replacement array...
+  for (unsigned i = 0, e = getValues().size(); i != e; ++i) {
+    Constant *Val = cast<Constant>(getValues()[i]);
+    if (Val == From) Val = cast<Constant>(To);
+    Values.push_back(Val);
+  }
+  
+  ConstantArray *Replacement = ConstantArray::get(getType(), Values);
+  assert(Replacement != this && "I didn't contain From!");
+
+  // Everyone using this now uses the replacement...
+  replaceAllUsesWith(Replacement);
+  
+  // Delete the old constant!
+  destroyConstant();  
+}
+
+void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To) {
+  assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
+
+  std::vector<Constant*> Values;
+  Values.reserve(getValues().size());
+  for (unsigned i = 0, e = getValues().size(); i != e; ++i) {
+    Constant *Val = cast<Constant>(getValues()[i]);
+    if (Val == From) Val = cast<Constant>(To);
+    Values.push_back(Val);
+  }
+  
+  ConstantStruct *Replacement = ConstantStruct::get(getType(), Values);
+  assert(Replacement != this && "I didn't contain From!");
+
+  // Everyone using this now uses the replacement...
+  replaceAllUsesWith(Replacement);
+  
+  // Delete the old constant!
+  destroyConstant();
+}
+
+void ConstantPointerRef::replaceUsesOfWithOnConstant(Value *From, Value *To) {
+  if (isa<GlobalValue>(To)) {
+    assert(From == getOperand(0) && "Doesn't contain from!");
+    ConstantPointerRef *Replacement =
+      ConstantPointerRef::get(cast<GlobalValue>(To));
+    
+    // Everyone using this now uses the replacement...
+    replaceAllUsesWith(Replacement);
+    
+    // Delete the old constant!
+    destroyConstant();
+  } else {
+    // Just replace ourselves with the To value specified.
+    replaceAllUsesWith(To);
+  
+    // Delete the old constant!
+    destroyConstant();
+  }
+}
+
+void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *To) {
+  assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
+
+  ConstantExpr *Replacement = 0;
+  if (getOpcode() == Instruction::GetElementPtr) {
+    std::vector<Constant*> Indices;
+    Constant *Pointer = cast<Constant>(getOperand(0));
+    Indices.reserve(getNumOperands()-1);
+    if (Pointer == From) Pointer = cast<Constant>(To);
+    
+    for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
+      Constant *Val = cast<Constant>(getOperand(i));
+      if (Val == From) Val = cast<Constant>(To);
+      Indices.push_back(Val);
+    }
+    Replacement = ConstantExpr::getGetElementPtr(Pointer, Indices);
+  } else if (getOpcode() == Instruction::Cast) {
+    assert(getOperand(0) == From && "Cast only has one use!");
+    Replacement = ConstantExpr::getCast(cast<Constant>(To), getType());
+  } else if (getNumOperands() == 2) {
+    Constant *C1 = cast<Constant>(getOperand(0));
+    Constant *C2 = cast<Constant>(getOperand(1));
+    if (C1 == From) C1 = cast<Constant>(To);
+    if (C2 == From) C2 = cast<Constant>(To);
+    Replacement = ConstantExpr::get(getOpcode(), C1, C2);
+  } else {
+    assert(0 && "Unknown ConstantExpr type!");
+    return;
+  }
+  
+  assert(Replacement != this && "I didn't contain From!");
+
+  // Everyone using this now uses the replacement...
+  replaceAllUsesWith(Replacement);
+  
+  // Delete the old constant!
+  destroyConstant();
+}
+
+
+
 //===----------------------------------------------------------------------===//
 //                      Factory Function Implementation
 
@@ -346,6 +532,24 @@ void ConstantArray::destroyConstant() {
   destroyConstantImpl();
 }
 
+// getAsString - If the sub-element type of this array is either sbyte or ubyte,
+// then this method converts the array to an std::string and returns it.
+// Otherwise, it asserts out.
+//
+std::string ConstantArray::getAsString() const {
+  std::string Result;
+  if (getType()->getElementType() == Type::SByteTy)
+    for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
+      Result += (char)cast<ConstantSInt>(getOperand(i))->getValue();
+  else {
+    assert(getType()->getElementType() == Type::UByteTy && "Not a string!");
+    for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
+      Result += (char)cast<ConstantUInt>(getOperand(i))->getValue();
+  }
+  return Result;
+}
+
+
 //---- ConstantStruct::get() implementation...
 //
 static ValueMap<std::vector<Constant*>, ConstantStruct> StructConstants;
@@ -365,6 +569,7 @@ void ConstantStruct::destroyConstant() {
   destroyConstantImpl();
 }
 
+
 //---- ConstantPointerNull::get() implementation...
 //
 static ValueMap<char, ConstantPointerNull> NullPtrConstants;
@@ -376,6 +581,14 @@ ConstantPointerNull *ConstantPointerNull::get(const PointerType *Ty) {
   return Result;
 }
 
+// destroyConstant - Remove the constant from the constant table...
+//
+void ConstantPointerNull::destroyConstant() {
+  NullPtrConstants.remove(this);
+  destroyConstantImpl();
+}
+
+
 //---- ConstantPointerRef::get() implementation...
 //
 ConstantPointerRef *ConstantPointerRef::get(GlobalValue *GV) {
@@ -385,90 +598,78 @@ ConstantPointerRef *ConstantPointerRef::get(GlobalValue *GV) {
   return GV->getParent()->getConstantPointerRef(GV);
 }
 
+// destroyConstant - Remove the constant from the constant table...
+//
+void ConstantPointerRef::destroyConstant() {
+  getValue()->getParent()->destroyConstantPointerRef(this);
+  destroyConstantImpl();
+}
+
+
 //---- ConstantExpr::get() implementations...
-// Return NULL on invalid expressions.
 //
 typedef pair<unsigned, vector<Constant*> > ExprMapKeyType;
 static ValueMap<const ExprMapKeyType, ConstantExpr> ExprConstants;
 
-ConstantExpr *ConstantExpr::get(unsigned Opcode, Constant *C, const Type *Ty) {
+ConstantExpr *ConstantExpr::getCast(Constant *C, const Type *Ty) {
 
   // Look up the constant in the table first to ensure uniqueness
   vector<Constant*> argVec(1, C);
-  const ExprMapKeyType &Key = make_pair(Opcode, argVec);
+  const ExprMapKeyType &Key = make_pair(Instruction::Cast, argVec);
   ConstantExpr *Result = ExprConstants.get(Ty, Key);
   if (Result) return Result;
   
   // Its not in the table so create a new one and put it in the table.
-  // Check the operands for consistency first
-  assert(Opcode == Instruction::Cast ||
-         (Opcode >= Instruction::FirstUnaryOp &&
-          Opcode < Instruction::NumUnaryOps) &&
-         "Invalid opcode in unary ConstantExpr!");
-
-  // type of operand will not match result for Cast operation
-  assert((Opcode == Instruction::Cast || Ty == C->getType()) &&
-         "Type of operand in unary constant expression should match result");
-  
-  Result = new ConstantExpr(Opcode, C, Ty);
+  Result = new ConstantExpr(Instruction::Cast, C, Ty);
   ExprConstants.add(Ty, Key, Result);
   return Result;
 }
 
-ConstantExpr *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2,
-                                const Type *Ty) {
-
+ConstantExpr *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2) {
   // Look up the constant in the table first to ensure uniqueness
   vector<Constant*> argVec(1, C1); argVec.push_back(C2);
   const ExprMapKeyType &Key = make_pair(Opcode, argVec);
-  ConstantExpr *Result = ExprConstants.get(Ty, Key);
+  ConstantExpr *Result = ExprConstants.get(C1->getType(), Key);
   if (Result) return Result;
   
   // Its not in the table so create a new one and put it in the table.
   // Check the operands for consistency first
-  assert((Opcode >= Instruction::FirstBinaryOp &&
-          Opcode < Instruction::NumBinaryOps) &&
-         "Invalid opcode  in binary constant expression");
+  assert((Opcode >= Instruction::BinaryOpsBegin &&
+          Opcode < Instruction::BinaryOpsEnd) &&
+         "Invalid opcode in binary constant expression");
 
-  assert(Ty == C1->getType() && Ty == C2->getType() &&
-         "Operand types in binary constant expression should match result");
+  assert(C1->getType() == C2->getType() &&
+         "Operand types in binary constant expression should match");
   
-  Result = new ConstantExpr(Opcode, C1, C2, Ty);
-  ExprConstants.add(Ty, Key, Result);
+  Result = new ConstantExpr(Opcode, C1, C2);
+  ExprConstants.add(C1->getType(), Key, Result);
   return Result;
 }
 
-ConstantExpr *ConstantExpr::get(unsigned Opcode, Constant *C,
-                                const std::vector<Constant*> &IdxList,
-                                const Type *Ty) {
+ConstantExpr *ConstantExpr::getGetElementPtr(Constant *C,
+                                        const std::vector<Constant*> &IdxList) {
+  const Type *Ty = C->getType();
 
   // Look up the constant in the table first to ensure uniqueness
   vector<Constant*> argVec(1, C);
   argVec.insert(argVec.end(), IdxList.begin(), IdxList.end());
   
-  const ExprMapKeyType &Key = make_pair(Opcode, argVec);
+  const ExprMapKeyType &Key = make_pair(Instruction::GetElementPtr, argVec);
   ConstantExpr *Result = ExprConstants.get(Ty, Key);
   if (Result) return Result;
-  
+
   // Its not in the table so create a new one and put it in the table.
   // Check the operands for consistency first
-  // Must be a getElementPtr.  Check for valid getElementPtr expression.
   // 
-  assert(Opcode == Instruction::GetElementPtr &&
-         "Operator other than GetElementPtr used with an index list");
-
   assert(isa<PointerType>(Ty) &&
          "Non-pointer type for constant GelElementPtr expression");
 
+  // Check that the indices list is valid...
   std::vector<Value*> ValIdxList(IdxList.begin(), IdxList.end());
-  const Type *fldType = GetElementPtrInst::getIndexedType(C->getType(),
-                                                          ValIdxList, true);
-  assert(fldType && "Invalid index list for constant GelElementPtr expression");
-
-  assert(cast<PointerType>(Ty)->getElementType() == fldType &&
-         "Type for constant GelElementPtr expression doesn't match field type");
+  const Type *DestTy = GetElementPtrInst::getIndexedType(Ty, ValIdxList, true);
+  assert(DestTy && "Invalid index list for constant GelElementPtr expression");
   
-  Result = new ConstantExpr(Opcode, C, IdxList, Ty);
+  Result = new ConstantExpr(C, IdxList, PointerType::get(DestTy));
   ExprConstants.add(Ty, Key, Result);
   return Result;
 }
@@ -480,31 +681,29 @@ void ConstantExpr::destroyConstant() {
   destroyConstantImpl();
 }
 
-const char *ConstantExpr::getOpcodeName(unsigned Opcode) {
-  return Instruction::getOpcodeName(Opcode);
+const char *ConstantExpr::getOpcodeName() const {
+  return Instruction::getOpcodeName(getOpcode());
 }
 
+unsigned Constant::mutateReferences(Value *OldV, Value *NewV) {
+  // Uses of constant pointer refs are global values, not constants!
+  if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(this)) {
+    GlobalValue *NewGV = cast<GlobalValue>(NewV);
+    GlobalValue *OldGV = CPR->getValue();
 
-//---- ConstantPointerRef::mutateReferences() implementation...
-//
-unsigned ConstantPointerRef::mutateReferences(Value *OldV, Value *NewV) {
-  assert(getValue() == OldV && "Cannot mutate old value if I'm not using it!");
-  GlobalValue *NewGV = cast<GlobalValue>(NewV);
-  getValue()->getParent()->mutateConstantPointerRef(getValue(), NewGV);
-  Operands[0] = NewGV;
-  return 1;
-}
-
+    assert(OldGV == OldV && "Cannot mutate old value if I'm not using it!");
 
-//---- ConstantPointerExpr::mutateReferences() implementation...
-//
-unsigned ConstantExpr::mutateReferences(Value* OldV, Value *NewV) {
-  unsigned NumReplaced = 0;
-  Constant *NewC = cast<Constant>(NewV);
-  for (unsigned i = 0, N = getNumOperands(); i != N; ++i)
-    if (Operands[i] == OldV) {
-      ++NumReplaced;
-      Operands[i] = NewC;
-    }
-  return NumReplaced;
+    OldGV->getParent()->mutateConstantPointerRef(OldGV, NewGV);
+    Operands[0] = NewGV;
+    return 1;
+  } else {
+    Constant *NewC = cast<Constant>(NewV);
+    unsigned NumReplaced = 0;
+    for (unsigned i = 0, N = getNumOperands(); i != N; ++i)
+      if (Operands[i] == OldV) {
+        ++NumReplaced;
+        Operands[i] = NewC;
+      }
+    return NumReplaced;
+  }
 }