Added LLVM project notice to the top of every C++ source file.
[oota-llvm.git] / lib / Bytecode / Reader / ConstantReader.cpp
index 921b875644dffa70f026804a6fde080ad984d5bf..097bdbe1266fa6ae31698ca7ced5a9faafddf439 100644 (file)
@@ -1,26 +1,29 @@
 //===- ReadConst.cpp - Code to constants and constant pools ---------------===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
 // This file implements functionality to deserialize constants and entire 
 // constant pools.
 // 
 // Note that this library should be as fast as possible, reentrant, and 
-// threadsafe!!
+// thread-safe!!
 //
 //===----------------------------------------------------------------------===//
 
 #include "ReaderInternals.h"
 #include "llvm/Module.h"
 #include "llvm/Constants.h"
-#include "llvm/GlobalVariable.h"
 #include <algorithm>
-#include <iostream>
 
-using std::make_pair;
-
-const Type *BytecodeParser::parseTypeConstant(const uchar *&Buf,
-                                             const uchar *EndBuf) {
+const Type *BytecodeParser::parseTypeConstant(const unsigned char *&Buf,
+                                             const unsigned char *EndBuf) {
   unsigned PrimType;
-  if (read_vbr(Buf, EndBuf, PrimType)) return failure<const Type*>(0);
+  if (read_vbr(Buf, EndBuf, PrimType)) throw Error_readvbr;
 
   const Type *Val = 0;
   if ((Val = Type::getPrimitiveType((Type::PrimitiveID)PrimType)))
@@ -29,19 +32,16 @@ const Type *BytecodeParser::parseTypeConstant(const uchar *&Buf,
   switch (PrimType) {
   case Type::FunctionTyID: {
     unsigned Typ;
-    if (read_vbr(Buf, EndBuf, Typ)) return failure(Val);
+    if (read_vbr(Buf, EndBuf, Typ)) return Val;
     const Type *RetType = getType(Typ);
-    if (RetType == 0) return failure(Val);
 
     unsigned NumParams;
-    if (read_vbr(Buf, EndBuf, NumParams)) return failure(Val);
+    if (read_vbr(Buf, EndBuf, NumParams)) return Val;
 
     std::vector<const Type*> Params;
     while (NumParams--) {
-      if (read_vbr(Buf, EndBuf, Typ)) return failure(Val);
-      const Type *Ty = getType(Typ);
-      if (Ty == 0) return failure(Val);
-      Params.push_back(Ty);
+      if (read_vbr(Buf, EndBuf, Typ)) return Val;
+      Params.push_back(getType(Typ));
     }
 
     bool isVarArg = Params.size() && Params.back() == Type::VoidTy;
@@ -51,12 +51,11 @@ const Type *BytecodeParser::parseTypeConstant(const uchar *&Buf,
   }
   case Type::ArrayTyID: {
     unsigned ElTyp;
-    if (read_vbr(Buf, EndBuf, ElTyp)) return failure(Val);
+    if (read_vbr(Buf, EndBuf, ElTyp)) return Val;
     const Type *ElementType = getType(ElTyp);
-    if (ElementType == 0) return failure(Val);
 
     unsigned NumElements;
-    if (read_vbr(Buf, EndBuf, NumElements)) return failure(Val);
+    if (read_vbr(Buf, EndBuf, NumElements)) return Val;
 
     BCR_TRACE(5, "Array Type Constant #" << ElTyp << " size=" 
               << NumElements << "\n");
@@ -66,24 +65,19 @@ const Type *BytecodeParser::parseTypeConstant(const uchar *&Buf,
     unsigned Typ;
     std::vector<const Type*> Elements;
 
-    if (read_vbr(Buf, EndBuf, Typ)) return failure(Val);
+    if (read_vbr(Buf, EndBuf, Typ)) return Val;
     while (Typ) {         // List is terminated by void/0 typeid
-      const Type *Ty = getType(Typ);
-      if (Ty == 0) return failure(Val);
-      Elements.push_back(Ty);
-      
-      if (read_vbr(Buf, EndBuf, Typ)) return failure(Val);
+      Elements.push_back(getType(Typ));
+      if (read_vbr(Buf, EndBuf, Typ)) return Val;
     }
 
     return StructType::get(Elements);
   }
   case Type::PointerTyID: {
     unsigned ElTyp;
-    if (read_vbr(Buf, EndBuf, ElTyp)) return failure(Val);
-    BCR_TRACE(5, "Pointer Type Constant #" << (ElTyp-14) << "\n");
-    const Type *ElementType = getType(ElTyp);
-    if (ElementType == 0) return failure(Val);
-    return PointerType::get(ElementType);
+    if (read_vbr(Buf, EndBuf, ElTyp)) return Val;
+    BCR_TRACE(5, "Pointer Type Constant #" << ElTyp << "\n");
+    return PointerType::get(getType(ElTyp));
   }
 
   case Type::OpaqueTyID: {
@@ -94,62 +88,37 @@ const Type *BytecodeParser::parseTypeConstant(const uchar *&Buf,
     std::cerr << __FILE__ << ":" << __LINE__
               << ": Don't know how to deserialize"
               << " primitive Type " << PrimType << "\n";
-    return failure(Val);
-  }
-}
-
-// refineAbstractType - The callback method is invoked when one of the
-// elements of TypeValues becomes more concrete...
-//
-void BytecodeParser::refineAbstractType(const DerivedType *OldType, 
-                                       const Type *NewType) {
-  if (OldType == NewType &&
-      OldType->isAbstract()) return;  // Type is modified, but same
-
-  TypeValuesListTy::iterator I = find(MethodTypeValues.begin(), 
-                                     MethodTypeValues.end(), OldType);
-  if (I == MethodTypeValues.end()) {
-    I = find(ModuleTypeValues.begin(), ModuleTypeValues.end(), OldType);
-    assert(I != ModuleTypeValues.end() && 
-          "Can't refine a type I don't know about!");
-  }
-
-  if (OldType == NewType) {
-    assert(!OldType->isAbstract());
-    I->removeUserFromConcrete();
-  } else {
-    *I = NewType;  // Update to point to new, more refined type.
+    return Val;
   }
 }
 
-
-
-// parseTypeConstants - We have to use this wierd code to handle recursive
+// parseTypeConstants - We have to use this weird code to handle recursive
 // types.  We know that recursive types will only reference the current slab of
 // values in the type plane, but they can forward reference types before they
 // have been read.  For example, Type #0 might be '{ Ty#1 }' and Type #1 might
 // be 'Ty#0*'.  When reading Type #0, type number one doesn't exist.  To fix
-// this ugly problem, we pesimistically insert an opaque type for each type we
+// this ugly problem, we pessimistically insert an opaque type for each type we
 // are about to read.  This means that forward references will resolve to
 // something and when we reread the type later, we can replace the opaque type
 // with a new resolved concrete type.
 //
 void debug_type_tables();
-bool BytecodeParser::parseTypeConstants(const uchar *&Buf, const uchar *EndBuf,
+void BytecodeParser::parseTypeConstants(const unsigned char *&Buf,
+                                        const unsigned char *EndBuf,
                                        TypeValuesListTy &Tab,
                                        unsigned NumEntries) {
   assert(Tab.size() == 0 && "should not have read type constants in before!");
 
   // Insert a bunch of opaque types to be resolved later...
   for (unsigned i = 0; i < NumEntries; ++i)
-    Tab.push_back(PATypeHandle<Type>(OpaqueType::get(), this));
+    Tab.push_back(OpaqueType::get());
 
   // Loop through reading all of the types.  Forward types will make use of the
   // opaque types just inserted.
   //
   for (unsigned i = 0; i < NumEntries; ++i) {
     const Type *NewTy = parseTypeConstant(Buf, EndBuf), *OldTy = Tab[i].get();
-    if (NewTy == 0) return failure(true);
+    if (NewTy == 0) throw std::string("Parsed invalid type.");
     BCR_TRACE(4, "#" << i << ": Read Type Constant: '" << NewTy <<
               "' Replacing: " << OldTy << "\n");
 
@@ -173,136 +142,113 @@ bool BytecodeParser::parseTypeConstants(const uchar *&Buf, const uchar *EndBuf,
     BCR_TRACE(5, (void*)Tab[i].get() << " - " << Tab[i].get() << "\n");
   }
   debug_type_tables();
-  return false;
 }
 
 
-bool BytecodeParser::parseConstantValue(const uchar *&Buf, const uchar *EndBuf,
-                                        const Type *Ty, Constant *&V) {
+Constant *BytecodeParser::parseConstantValue(const unsigned char *&Buf,
+                                             const unsigned char *EndBuf,
+                                             const Type *Ty) {
 
   // We must check for a ConstantExpr before switching by type because
   // a ConstantExpr can be of any type, and has no explicit value.
   // 
   unsigned isExprNumArgs;               // 0 if not expr; numArgs if is expr
-  if (read_vbr(Buf, EndBuf, isExprNumArgs)) return failure(true);
+  if (read_vbr(Buf, EndBuf, isExprNumArgs)) throw Error_readvbr;
   if (isExprNumArgs) {
     // FIXME: Encoding of constant exprs could be much more compact!
     unsigned Opcode;
     std::vector<Constant*> ArgVec;
     ArgVec.reserve(isExprNumArgs);
-    if (read_vbr(Buf, EndBuf, Opcode)) return failure(true);    
+    if (read_vbr(Buf, EndBuf, Opcode)) throw Error_readvbr;
 
     // Read the slot number and types of each of the arguments
     for (unsigned i = 0; i != isExprNumArgs; ++i) {
       unsigned ArgValSlot, ArgTypeSlot;
-      if (read_vbr(Buf, EndBuf, ArgValSlot)) return failure(true);
-      if (read_vbr(Buf, EndBuf, ArgTypeSlot)) return failure(true);
+      if (read_vbr(Buf, EndBuf, ArgValSlot)) throw Error_readvbr;
+      if (read_vbr(Buf, EndBuf, ArgTypeSlot)) throw Error_readvbr;
       const Type *ArgTy = getType(ArgTypeSlot);
-      if (ArgTy == 0) return failure(true);
       
-      BCR_TRACE(4, "CE Arg " << i << ": Type: '" << ArgTy << "'  slot: "
+      BCR_TRACE(4, "CE Arg " << i << ": Type: '" << *ArgTy << "'  slot: "
                 << ArgValSlot << "\n");
       
       // Get the arg value from its slot if it exists, otherwise a placeholder
-      Value *Val = getValue(ArgTy, ArgValSlot, false);
-      Constant *C;
-      if (Val) {
-        if (!(C = dyn_cast<Constant>(Val))) return failure(true);
-        BCR_TRACE(5, "Constant Found in ValueTable!\n");
-      } else {         // Nope... find or create a forward ref. for it
-        C = fwdRefs.GetFwdRefToConstant(ArgTy, ArgValSlot);
-      }
-      ArgVec.push_back(C);
+      ArgVec.push_back(getConstantValue(ArgTy, ArgValSlot));
     }
     
     // Construct a ConstantExpr of the appropriate kind
     if (isExprNumArgs == 1) {           // All one-operand expressions
-      V = ConstantExpr::get(Opcode, ArgVec[0], Ty);
+      assert(Opcode == Instruction::Cast);
+      return ConstantExpr::getCast(ArgVec[0], Ty);
     } else if (Opcode == Instruction::GetElementPtr) { // GetElementPtr
       std::vector<Constant*> IdxList(ArgVec.begin()+1, ArgVec.end());
-      V = ConstantExpr::getGetElementPtr(ArgVec[0], IdxList);
+      return ConstantExpr::getGetElementPtr(ArgVec[0], IdxList);
     } else {                            // All other 2-operand expressions
-      V = ConstantExpr::get(Opcode, ArgVec[0], ArgVec[1]);
+      return ConstantExpr::get(Opcode, ArgVec[0], ArgVec[1]);
     }
-    return false;
   }
   
   // Ok, not an ConstantExpr.  We now know how to read the given type...
   switch (Ty->getPrimitiveID()) {
   case Type::BoolTyID: {
     unsigned Val;
-    if (read_vbr(Buf, EndBuf, Val)) return failure(true);
-    if (Val != 0 && Val != 1) return failure(true);
-    V = ConstantBool::get(Val == 1);
-    break;
+    if (read_vbr(Buf, EndBuf, Val)) throw Error_readvbr;
+    if (Val != 0 && Val != 1) throw std::string("Invalid boolean value read.");
+    return ConstantBool::get(Val == 1);
   }
 
   case Type::UByteTyID:   // Unsigned integer types...
   case Type::UShortTyID:
   case Type::UIntTyID: {
     unsigned Val;
-    if (read_vbr(Buf, EndBuf, Val)) return failure(true);
-    if (!ConstantUInt::isValueValidForType(Ty, Val)) return failure(true);
-    V = ConstantUInt::get(Ty, Val);
-    break;
+    if (read_vbr(Buf, EndBuf, Val)) throw Error_readvbr;
+    if (!ConstantUInt::isValueValidForType(Ty, Val)) 
+      throw std::string("Invalid unsigned byte/short/int read.");
+    return ConstantUInt::get(Ty, Val);
   }
 
   case Type::ULongTyID: {
     uint64_t Val;
-    if (read_vbr(Buf, EndBuf, Val)) return failure(true);
-    V = ConstantUInt::get(Ty, Val);
-    break;
+    if (read_vbr(Buf, EndBuf, Val)) throw Error_readvbr;
+    return ConstantUInt::get(Ty, Val);
   }
 
-  case Type::SByteTyID:   // Unsigned integer types...
+  case Type::SByteTyID:   // Signed integer types...
   case Type::ShortTyID:
   case Type::IntTyID: {
-    int Val;
-    if (read_vbr(Buf, EndBuf, Val)) return failure(true);
-    if (!ConstantSInt::isValueValidForType(Ty, Val)) return failure(true);
-    V = ConstantSInt::get(Ty, Val);
-    break;
-  }
-
-  case Type::LongTyID: {
+  case Type::LongTyID:
     int64_t Val;
-    if (read_vbr(Buf, EndBuf, Val)) return failure(true);
-    V = ConstantSInt::get(Ty, Val);
-    break;
+    if (read_vbr(Buf, EndBuf, Val)) throw Error_readvbr;
+    if (!ConstantSInt::isValueValidForType(Ty, Val)) 
+      throw std::string("Invalid signed byte/short/int/long read.");
+    return ConstantSInt::get(Ty, Val);
   }
 
   case Type::FloatTyID: {
     float F;
-    if (input_data(Buf, EndBuf, &F, &F+1)) return failure(true);
-    V = ConstantFP::get(Ty, F);
-    break;
+    if (input_data(Buf, EndBuf, &F, &F+1)) throw Error_inputdata;
+    return ConstantFP::get(Ty, F);
   }
 
   case Type::DoubleTyID: {
     double Val;
-    if (input_data(Buf, EndBuf, &Val, &Val+1)) return failure(true);
-    V = ConstantFP::get(Ty, Val);
-    break;
+    if (input_data(Buf, EndBuf, &Val, &Val+1)) throw Error_inputdata;
+    return ConstantFP::get(Ty, Val);
   }
 
   case Type::TypeTyID:
-    assert(0 && "Type constants should be handled seperately!!!");
-    abort();
+    throw std::string("Type constants shouldn't live in constant table!");
 
   case Type::ArrayTyID: {
-    const ArrayType *AT = cast<const ArrayType>(Ty);
+    const ArrayType *AT = cast<ArrayType>(Ty);
     unsigned NumElements = AT->getNumElements();
 
     std::vector<Constant*> Elements;
     while (NumElements--) {   // Read all of the elements of the constant.
       unsigned Slot;
-      if (read_vbr(Buf, EndBuf, Slot)) return failure(true);
-      Value *V = getValue(AT->getElementType(), Slot, false);
-      if (!V || !isa<Constant>(V)) return failure(true);
-      Elements.push_back(cast<Constant>(V));
+      if (read_vbr(Buf, EndBuf, Slot)) throw Error_readvbr;
+      Elements.push_back(getConstantValue(AT->getElementType(), Slot));
     }
-    V = ConstantArray::get(AT, Elements);
-    break;
+    return ConstantArray::get(AT, Elements);
   }
 
   case Type::StructTyID: {
@@ -312,88 +258,99 @@ bool BytecodeParser::parseConstantValue(const uchar *&Buf, const uchar *EndBuf,
     std::vector<Constant *> Elements;
     for (unsigned i = 0; i < ET.size(); ++i) {
       unsigned Slot;
-      if (read_vbr(Buf, EndBuf, Slot)) return failure(true);
-      Value *V = getValue(ET[i], Slot, false);
-      if (!V || !isa<Constant>(V))
-       return failure(true);
-      Elements.push_back(cast<Constant>(V));      
+      if (read_vbr(Buf, EndBuf, Slot)) throw Error_readvbr;
+      Elements.push_back(getConstantValue(ET[i], Slot));
     }
 
-    V = ConstantStruct::get(ST, Elements);
-    break;
+    return ConstantStruct::get(ST, Elements);
   }    
 
-  case Type::PointerTyID: {
-    const PointerType *PT = cast<const PointerType>(Ty);
-    unsigned SubClass;
-    if (read_vbr(Buf, EndBuf, SubClass)) return failure(true);
-    switch (SubClass) {
-    case 0:    // ConstantPointerNull value...
-      V = ConstantPointerNull::get(PT);
-      break;
-
-    case 1: {  // ConstantPointerRef value...
-      unsigned Slot;
-      if (read_vbr(Buf, EndBuf, Slot)) return failure(true);
-      BCR_TRACE(4, "CPR: Type: '" << Ty << "'  slot: " << Slot << "\n");
-
-      // Check to see if we have already read this global variable yet...
-      Value *Val = getValue(PT, Slot, false);
-      GlobalValue* GV;
-      if (Val) {
-        if (!(GV = dyn_cast<GlobalValue>(Val))) return failure(true);
-        BCR_TRACE(5, "Value Found in ValueTable!\n");
-      } else {         // Nope... find or create a forward ref. for it
-        GV = fwdRefs.GetFwdRefToGlobal(PT, Slot);
+  case Type::PointerTyID: {  // ConstantPointerRef value...
+    const PointerType *PT = cast<PointerType>(Ty);
+    unsigned Slot;
+    if (read_vbr(Buf, EndBuf, Slot)) throw Error_readvbr;
+    BCR_TRACE(4, "CPR: Type: '" << Ty << "'  slot: " << Slot << "\n");
+    
+    // Check to see if we have already read this global variable...
+    Value *Val = getValue(PT, Slot, false);
+    GlobalValue *GV;
+    if (Val) {
+      if (!(GV = dyn_cast<GlobalValue>(Val))) 
+        throw std::string("Value of ConstantPointerRef not in ValueTable!");
+      BCR_TRACE(5, "Value Found in ValueTable!\n");
+    } else if (RevisionNum > 0) {
+      // Revision #0 could have forward references to globals that were weird.
+      // We got rid of this in subsequent revs.
+      throw std::string("Forward references to globals not allowed.");
+    } else {         // Nope... find or create a forward ref. for it
+      GlobalRefsType::iterator I = GlobalRefs.find(std::make_pair(PT, Slot));
+      
+      if (I != GlobalRefs.end()) {
+        BCR_TRACE(5, "Previous forward ref found!\n");
+        GV = cast<GlobalValue>(I->second);
+      } else {
+        BCR_TRACE(5, "Creating new forward ref to a global variable!\n");
+        
+        // Create a placeholder for the global variable reference...
+        GlobalVariable *GVar =
+          new GlobalVariable(PT->getElementType(), false,
+                             GlobalValue::InternalLinkage);
+        
+        // Keep track of the fact that we have a forward ref to recycle it
+        GlobalRefs.insert(std::make_pair(std::make_pair(PT, Slot), GVar));
+        
+        // Must temporarily push this value into the module table...
+        TheModule->getGlobalList().push_back(GVar);
+        GV = GVar;
       }
-      V = ConstantPointerRef::get(GV);
-      break;
     }
     
-    default:
-      BCR_TRACE(5, "UNKNOWN Pointer Constant Type!\n");
-      return failure(true);
-    }
-    break;
+    return ConstantPointerRef::get(GV);
   }
 
   default:
-    std::cerr << __FILE__ << ":" << __LINE__ 
-              << ": Don't know how to deserialize constant value of type '"
-              << Ty->getName() << "'\n";
-    return failure(true);
+    throw std::string("Don't know how to deserialize constant value of type '"+
+                      Ty->getDescription());
   }
+}
 
-  return false;
+void BytecodeParser::ParseGlobalTypes(const unsigned char *&Buf,
+                                      const unsigned char *EndBuf) {
+  ValueTable T;
+  ParseConstantPool(Buf, EndBuf, T, ModuleTypeValues);
 }
 
-bool BytecodeParser::ParseConstantPool(const uchar *&Buf, const uchar *EndBuf,
-                                      ValueTable &Tab, 
-                                      TypeValuesListTy &TypeTab) {
+void BytecodeParser::ParseConstantPool(const unsigned char *&Buf,
+                                       const unsigned char *EndBuf,
+                                       ValueTable &Tab, 
+                                       TypeValuesListTy &TypeTab) {
   while (Buf < EndBuf) {
     unsigned NumEntries, Typ;
 
     if (read_vbr(Buf, EndBuf, NumEntries) ||
-        read_vbr(Buf, EndBuf, Typ)) return failure(true);
-    const Type *Ty = getType(Typ);
-    if (Ty == 0) return failure(true);
-    BCR_TRACE(3, "Type: '" << Ty << "'  NumEntries: " << NumEntries << "\n");
-
+        read_vbr(Buf, EndBuf, Typ)) throw Error_readvbr;
     if (Typ == Type::TypeTyID) {
-      if (parseTypeConstants(Buf, EndBuf, TypeTab, NumEntries)) return true;
+      BCR_TRACE(3, "Type: 'type'  NumEntries: " << NumEntries << "\n");
+      parseTypeConstants(Buf, EndBuf, TypeTab, NumEntries);
     } else {
+      const Type *Ty = getType(Typ);
+      BCR_TRACE(3, "Type: '" << *Ty << "'  NumEntries: " << NumEntries << "\n");
+
       for (unsigned i = 0; i < NumEntries; ++i) {
-       Constant *I;
-        int Slot;
-       if (parseConstantValue(Buf, EndBuf, Ty, I)) return failure(true);
-        assert(I && "parseConstantValue returned `!failure' and NULL result");
-       BCR_TRACE(4, "Read Constant: '" << I << "'\n");
-       if ((Slot = insertValue(I, Tab)) < 0) return failure(true);
-        resolveRefsToConstant(I, (unsigned) Slot);
+        Constant *C = parseConstantValue(Buf, EndBuf, Ty);
+        assert(C && "parseConstantValue returned NULL!");
+        BCR_TRACE(4, "Read Constant: '" << *C << "'\n");
+        unsigned Slot = insertValue(C, Typ, Tab);
+
+        // If we are reading a function constant table, make sure that we adjust
+        // the slot number to be the real global constant number.
+        //
+        if (&Tab != &ModuleValues && Typ < ModuleValues.size())
+          Slot += ModuleValues[Typ]->size();
+        ResolveReferencesToValue(C, Slot);
       }
     }
   }
   
-  if (Buf > EndBuf) return failure(true);
-  return false;
+  if (Buf > EndBuf) throw std::string("Read past end of buffer.");
 }