This is the initial check-in for adding register scavenging to PPC. (Currently,
[oota-llvm.git] / lib / VMCore / Verifier.cpp
index 08f031f40ed60b8dc8137952d7821a006302744f..9ce886cd86279bf447b7b771e5954d554b9c26d1 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     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 is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 #include "llvm/Pass.h"
 #include "llvm/Module.h"
 #include "llvm/ModuleProvider.h"
-#include "llvm/ParameterAttributes.h"
+#include "llvm/ParamAttrsList.h"
 #include "llvm/DerivedTypes.h"
 #include "llvm/InlineAsm.h"
 #include "llvm/IntrinsicInst.h"
 #include "llvm/PassManager.h"
 #include "llvm/Analysis/Dominators.h"
 #include "llvm/CodeGen/ValueTypes.h"
+#include "llvm/Support/CallSite.h"
 #include "llvm/Support/CFG.h"
 #include "llvm/Support/InstVisitor.h"
 #include "llvm/Support/Streams.h"
@@ -243,6 +244,7 @@ namespace {  // Anonymous namespace for class
     void visitShuffleVectorInst(ShuffleVectorInst &EI);
     void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
     void visitCallInst(CallInst &CI);
+    void visitInvokeInst(InvokeInst &II);
     void visitGetElementPtrInst(GetElementPtrInst &GEP);
     void visitLoadInst(LoadInst &LI);
     void visitStoreInst(StoreInst &SI);
@@ -255,9 +257,15 @@ namespace {  // Anonymous namespace for class
     void visitUserOp2(Instruction &I) { visitUserOp1(I); }
     void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
     void visitAllocationInst(AllocationInst &AI);
+    void visitGetResultInst(GetResultInst &GRI);
 
+    void VerifyCallSite(CallSite CS);
     void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
                                   unsigned Count, ...);
+    void VerifyAttrs(ParameterAttributes Attrs, const Type *Ty,
+                     bool isReturnValue, const Value *V);
+    void VerifyFunctionAttrs(const FunctionType *FT, const ParamAttrsList *Attrs,
+                             const Value *V);
 
     void WriteValue(const Value *V) {
       if (!V) return;
@@ -377,6 +385,61 @@ void Verifier::visitGlobalAlias(GlobalAlias &GA) {
 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
 }
 
+// VerifyAttrs - Check the given parameter attributes for an argument or return
+// value of the specified type.  The value V is printed in error messages.
+void Verifier::VerifyAttrs(ParameterAttributes Attrs, const Type *Ty, 
+                           bool isReturnValue, const Value *V) {
+  if (Attrs == ParamAttr::None)
+    return;
+
+  if (isReturnValue) {
+    ParameterAttributes RetI = Attrs & ParamAttr::ParameterOnly;
+    Assert1(!RetI, "Attribute " + ParamAttrsList::getParamAttrsText(RetI) +
+            "does not apply to return values!", V);
+  } else {
+    ParameterAttributes ParmI = Attrs & ParamAttr::ReturnOnly;
+    Assert1(!ParmI, "Attribute " + ParamAttrsList::getParamAttrsText(ParmI) +
+            "only applies to return values!", V);
+  }
+
+  for (unsigned i = 0;
+       i < array_lengthof(ParamAttr::MutuallyIncompatible); ++i) {
+    ParameterAttributes MutI = Attrs & ParamAttr::MutuallyIncompatible[i];
+    Assert1(!(MutI & (MutI - 1)), "Attributes " +
+            ParamAttrsList::getParamAttrsText(MutI) + "are incompatible!", V);
+  }
+
+  ParameterAttributes TypeI = Attrs & ParamAttr::typeIncompatible(Ty);
+  Assert1(!TypeI, "Wrong type for attribute " +
+          ParamAttrsList::getParamAttrsText(TypeI), V);
+}
+
+// VerifyFunctionAttrs - Check parameter attributes against a function type.
+// The value V is printed in error messages.
+void Verifier::VerifyFunctionAttrs(const FunctionType *FT,
+                                   const ParamAttrsList *Attrs,
+                                   const Value *V) {
+  if (!Attrs)
+    return;
+
+  bool SawNest = false;
+
+  for (unsigned Idx = 0; Idx <= FT->getNumParams(); ++Idx) {
+    ParameterAttributes Attr = Attrs->getParamAttrs(Idx);
+
+    VerifyAttrs(Attr, FT->getParamType(Idx-1), !Idx, V);
+
+    if (Attr & ParamAttr::Nest) {
+      Assert1(!SawNest, "More than one parameter has attribute nest!", V);
+      SawNest = true;
+    }
+
+    if (Attr & ParamAttr::StructRet) {
+      Assert1(Idx == 1, "Attribute sret not on first parameter!", V);
+    }
+  }
+}
+
 // visitFunction - Verify that a function is ok.
 //
 void Verifier::visitFunction(Function &F) {
@@ -388,73 +451,22 @@ void Verifier::visitFunction(Function &F) {
           "# formal arguments must match # of arguments for function type!",
           &F, FT);
   Assert1(F.getReturnType()->isFirstClassType() ||
-          F.getReturnType() == Type::VoidTy,
+          F.getReturnType() == Type::VoidTy || 
+          isa<StructType>(F.getReturnType()),
           "Functions cannot return aggregate values!", &F);
 
-  Assert1(!F.isStructReturn() || FT->getReturnType() == Type::VoidTy,
-          "Invalid struct-return function!", &F);
+  Assert1(!F.hasStructRetAttr() || F.getReturnType() == Type::VoidTy,
+          "Invalid struct return type!", &F);
 
-  bool SawSRet = false;
+  const ParamAttrsList *Attrs = F.getParamAttrs();
 
-  if (const ParamAttrsList *Attrs = F.getParamAttrs()) {
-    Assert1(Attrs->size() &&
-            Attrs->getParamIndex(Attrs->size()-1) <= FT->getNumParams(),
-            "Function has excess attributes!", &F);
+  Assert1(!Attrs ||
+          (Attrs->size() &&
+           Attrs->getParamIndex(Attrs->size()-1) <= FT->getNumParams()),
+          "Attributes after last parameter!", &F);
 
-    bool SawNest = false;
-
-    for (unsigned Idx = 0; Idx <= FT->getNumParams(); ++Idx) {
-      uint16_t Attr = Attrs->getParamAttrs(Idx);
-
-      if (!Idx) {
-        uint16_t RetI = Attr & ParamAttr::ParameterOnly;
-        Assert1(!RetI, "Attribute " + Attrs->getParamAttrsText(RetI) +
-                "should not apply to functions!", &F);
-      } else {
-        uint16_t ParmI = Attr & ParamAttr::ReturnOnly;
-        Assert1(!ParmI, "Attribute " + Attrs->getParamAttrsText(ParmI) +
-                "should only be applied to function!", &F);
-
-      }
-
-      for (unsigned i = 0;
-           i < array_lengthof(ParamAttr::MutuallyIncompatible); ++i) {
-        uint16_t MutI = Attr & ParamAttr::MutuallyIncompatible[i];
-        Assert1(!(MutI & (MutI - 1)), "Attributes " +
-                Attrs->getParamAttrsText(MutI) + "are incompatible!", &F);
-      }
-
-      uint16_t IType = Attr & ParamAttr::IntegerTypeOnly;
-      Assert1(!IType || FT->getParamType(Idx-1)->isInteger(),
-              "Attribute " + Attrs->getParamAttrsText(IType) +
-              "should only apply to Integer type!", &F);
-
-      uint16_t PType = Attr & ParamAttr::PointerTypeOnly;
-      Assert1(!PType || isa<PointerType>(FT->getParamType(Idx-1)),
-              "Attribute " + Attrs->getParamAttrsText(PType) +
-              "should only apply to Pointer type!", &F);
-
-      if (Attr & ParamAttr::ByVal) {
-        const PointerType *Ty =
-            dyn_cast<PointerType>(FT->getParamType(Idx-1));
-        Assert1(!Ty || isa<StructType>(Ty->getElementType()),
-                "Attribute byval should only apply to pointer to structs!", &F);
-      }
-
-      if (Attr & ParamAttr::Nest) {
-        Assert1(!SawNest, "More than one parameter has attribute nest!", &F);
-        SawNest = true;
-      }
-
-      if (Attr & ParamAttr::StructRet) {
-        SawSRet = true;
-        Assert1(Idx == 1, "Attribute sret not on first parameter!", &F);
-      }
-    }
-  }
-
-  Assert1(SawSRet == F.isStructReturn(),
-          "StructReturn function with no sret attribute!", &F);
+  // Check function attributes.
+  VerifyFunctionAttrs(FT, Attrs, &F);
 
   // Check that this function meets the restrictions on this calling convention.
   switch (F.getCallingConv()) {
@@ -564,14 +576,22 @@ void Verifier::visitTerminatorInst(TerminatorInst &I) {
 
 void Verifier::visitReturnInst(ReturnInst &RI) {
   Function *F = RI.getParent()->getParent();
-  if (RI.getNumOperands() == 0)
+  unsigned N = RI.getNumOperands();
+  if (N == 0) 
     Assert2(F->getReturnType() == Type::VoidTy,
             "Found return instr that returns void in Function of non-void "
             "return type!", &RI, F->getReturnType());
-  else
+  else if (N == 1)
     Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
             "Function return type does not match operand "
             "type of return inst!", &RI, F->getReturnType());
+  else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
+    for (unsigned i = 0; i < N; i++)
+      Assert2(STy->getElementType(i) == RI.getOperand(i)->getType(),
+              "Function return type does not match operand "
+              "type of return inst!", &RI, F->getReturnType());
+  } else
+    Assert1(0, "Invalid return type!", &RI);
 
   // Check to make sure that the return value has necessary properties for
   // terminators...
@@ -825,35 +845,67 @@ void Verifier::visitPHINode(PHINode &PN) {
   visitInstruction(PN);
 }
 
-void Verifier::visitCallInst(CallInst &CI) {
-  Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
-          "Called function must be a pointer!", &CI);
-  const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
+void Verifier::VerifyCallSite(CallSite CS) {
+  Instruction *I = CS.getInstruction();
+
+  Assert1(isa<PointerType>(CS.getCalledValue()->getType()),
+          "Called function must be a pointer!", I);
+  const PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
   Assert1(isa<FunctionType>(FPTy->getElementType()),
-          "Called function is not pointer to function type!", &CI);
+          "Called function is not pointer to function type!", I);
 
   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
 
   // Verify that the correct number of arguments are being passed
   if (FTy->isVarArg())
-    Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
-            "Called function requires more parameters than were provided!",&CI);
+    Assert1(CS.arg_size() >= FTy->getNumParams(),
+            "Called function requires more parameters than were provided!",I);
   else
-    Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
-            "Incorrect number of arguments passed to called function!", &CI);
+    Assert1(CS.arg_size() == FTy->getNumParams(),
+            "Incorrect number of arguments passed to called function!", I);
 
   // Verify that all arguments to the call match the function type...
   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
-    Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
+    Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
             "Call parameter type does not match function signature!",
-            CI.getOperand(i+1), FTy->getParamType(i), &CI);
+            CS.getArgument(i), FTy->getParamType(i), I);
+
+  const ParamAttrsList *Attrs = CS.getParamAttrs();
+
+  Assert1(!Attrs ||
+          (Attrs->size() &&
+           Attrs->getParamIndex(Attrs->size()-1) <= CS.arg_size()),
+          "Attributes after last argument!", I);
+
+  // Verify call attributes.
+  VerifyFunctionAttrs(FTy, Attrs, I);
+
+  if (Attrs && FTy->isVarArg())
+    // Check attributes on the varargs part.
+    for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
+      ParameterAttributes Attr = Attrs->getParamAttrs(Idx);
+
+      VerifyAttrs(Attr, CS.getArgument(Idx-1)->getType(), false, I);
+
+      ParameterAttributes VArgI = Attr & ParamAttr::VarArgsIncompatible;
+      Assert1(!VArgI, "Attribute " + ParamAttrsList::getParamAttrsText(VArgI) +
+              "cannot be used for vararg call arguments!", I);
+    }
+
+  visitInstruction(*I);
+}
+
+void Verifier::visitCallInst(CallInst &CI) {
+  VerifyCallSite(&CI);
 
   if (Function *F = CI.getCalledFunction()) {
     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
       visitIntrinsicFunctionCall(ID, CI);
   }
-  
-  visitInstruction(CI);
+}
+
+void Verifier::visitInvokeInst(InvokeInst &II) {
+  VerifyCallSite(&II);
 }
 
 /// visitBinaryOperator - Check that both arguments to the binary operator are
@@ -989,12 +1041,21 @@ void Verifier::visitStoreInst(StoreInst &SI) {
 }
 
 void Verifier::visitAllocationInst(AllocationInst &AI) {
-  const PointerType *Ptr = AI.getType();
-  Assert(Ptr->getAddressSpace() == 0, 
-    "Allocation instruction pointer not in the generic address space!");
+  const PointerType *PTy = AI.getType();
+  Assert1(PTy->getAddressSpace() == 0, 
+          "Allocation instruction pointer not in the generic address space!",
+          &AI);
+  Assert1(PTy->getElementType()->isSized(), "Cannot allocate unsized type",
+          &AI);
   visitInstruction(AI);
 }
 
+void Verifier::visitGetResultInst(GetResultInst &GRI) {
+  Assert1(GRI.isValidOperands(GRI.getAggregateValue(), GRI.getIndex()),
+          "Invalid GetResultInst operands!", &GRI);
+  visitInstruction(GRI);
+}
+
 
 /// verifyInstruction - Verify that an instruction is well formed.
 ///
@@ -1009,6 +1070,11 @@ void Verifier::visitInstruction(Instruction &I) {
               !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
               "Only PHI nodes may reference their own value!", &I);
   }
+  
+  // Verify that if this is a terminator that it is at the end of the block.
+  if (isa<TerminatorInst>(I))
+    Assert1(BB->getTerminator() == &I, "Terminator not at end of block!", &I);
+  
 
   // Check that void typed values don't have names
   Assert1(I.getType() != Type::VoidTy || !I.hasName(),
@@ -1016,7 +1082,9 @@ void Verifier::visitInstruction(Instruction &I) {
 
   // Check that the return value of the instruction is either void or a legal
   // value type.
-  Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
+  Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType()
+          || ((isa<CallInst>(I) || isa<InvokeInst>(I)) 
+              && isa<StructType>(I.getType())),
           "Instruction returns a non-scalar type!", &I);
 
   // Check that all uses of the instruction, if they are instructions
@@ -1036,9 +1104,23 @@ void Verifier::visitInstruction(Instruction &I) {
 
     // Check to make sure that only first-class-values are operands to
     // instructions.
-    Assert1(I.getOperand(i)->getType()->isFirstClassType(),
-            "Instruction operands must be first-class values!", &I);
-  
+    if (!I.getOperand(i)->getType()->isFirstClassType()) {
+      if (isa<ReturnInst>(I) || isa<GetResultInst>(I))
+        Assert1(isa<StructType>(I.getOperand(i)->getType()),
+                "Invalid ReturnInst operands!", &I);
+      else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
+        if (const PointerType *PT = dyn_cast<PointerType>
+            (I.getOperand(i)->getType())) {
+          const Type *ETy = PT->getElementType();
+          Assert1(isa<StructType>(ETy), "Invalid CallInst operands!", &I);
+        }
+        else
+          Assert1(0, "Invalid CallInst operands!", &I);
+      }
+      else
+        Assert1(0, "Instruction operands must be first-class values!", &I);
+    }
+    
     if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
       // Check to make sure that the "address of" an intrinsic function is never
       // taken.
@@ -1123,19 +1205,13 @@ void Verifier::visitInstruction(Instruction &I) {
                 "Instruction does not dominate all uses!", Op, &I);
       }
     } else if (isa<InlineAsm>(I.getOperand(i))) {
-      Assert1(i == 0 && isa<CallInst>(I),
+      Assert1(i == 0 && (isa<CallInst>(I) || isa<InvokeInst>(I)),
               "Cannot take the address of an inline asm!", &I);
     }
   }
   InstsInThisBlock.insert(&I);
 }
 
-static bool HasPtrPtrType(Value *Val) {
-  if (const PointerType *PtrTy = dyn_cast<PointerType>(Val->getType()))
-    return isa<PointerType>(PtrTy->getElementType());
-  return false;
-}
-
 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
 ///
 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
@@ -1151,29 +1227,50 @@ void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
   default:
     break;
   case Intrinsic::gcroot:
-    Assert1(HasPtrPtrType(CI.getOperand(1)),
-            "llvm.gcroot parameter #1 must be a pointer to a pointer.", &CI);
-    Assert1(isa<AllocaInst>(IntrinsicInst::StripPointerCasts(CI.getOperand(1))),
-            "llvm.gcroot parameter #1 must be an alloca (or a bitcast of one).",
-            &CI);
-    Assert1(isa<Constant>(CI.getOperand(2)),
-            "llvm.gcroot parameter #2 must be a constant.", &CI);
-    break;
   case Intrinsic::gcwrite:
-    Assert1(CI.getOperand(3)->getType()
-            == PointerType::getUnqual(CI.getOperand(1)->getType()),
-            "Call to llvm.gcwrite must be with type 'void (%ty*, %ty2*, %ty**)'.",
-            &CI);
-    break;
-  case Intrinsic::gcread:
-    Assert1(CI.getOperand(2)->getType() == PointerType::getUnqual(CI.getType()),
-            "Call to llvm.gcread must be with type '%ty* (%ty2*, %ty**).'",
-            &CI);
-    break;
+  case Intrinsic::gcread: {
+      Type *PtrTy    = PointerType::getUnqual(Type::Int8Ty),
+           *PtrPtrTy = PointerType::getUnqual(PtrTy);
+      
+      switch (ID) {
+      default:
+        break;
+      case Intrinsic::gcroot:
+        Assert1(CI.getOperand(1)->getType() == PtrPtrTy,
+                "Intrinsic parameter #1 is not i8**.", &CI);
+        Assert1(CI.getOperand(2)->getType() == PtrTy,
+                "Intrinsic parameter #2 is not i8*.", &CI);
+        Assert1(isa<AllocaInst>(
+                  IntrinsicInst::StripPointerCasts(CI.getOperand(1))),
+                "llvm.gcroot parameter #1 must be an alloca.", &CI);
+        Assert1(isa<Constant>(CI.getOperand(2)),
+                "llvm.gcroot parameter #2 must be a constant.", &CI);
+        break;
+      case Intrinsic::gcwrite:
+        Assert1(CI.getOperand(1)->getType() == PtrTy,
+                "Intrinsic parameter #1 is not a i8*.", &CI);
+        Assert1(CI.getOperand(2)->getType() == PtrTy,
+                "Intrinsic parameter #2 is not a i8*.", &CI);
+        Assert1(CI.getOperand(3)->getType() == PtrPtrTy,
+                "Intrinsic parameter #3 is not a i8**.", &CI);
+        break;
+      case Intrinsic::gcread:
+        Assert1(CI.getOperand(1)->getType() == PtrTy,
+                "Intrinsic parameter #1 is not a i8*.", &CI);
+        Assert1(CI.getOperand(2)->getType() == PtrPtrTy,
+                "Intrinsic parameter #2 is not a i8**.", &CI);
+        break;
+      }
+      
+      Assert1(CI.getParent()->getParent()->hasCollector(),
+              "Enclosing function does not specify a collector algorithm.",
+              &CI);
+    } break;
   case Intrinsic::init_trampoline:
     Assert1(isa<Function>(IntrinsicInst::StripPointerCasts(CI.getOperand(2))),
             "llvm.init_trampoline parameter #2 must resolve to a function.",
             &CI);
+    break;
   }
 }