Start using the new function cloning header
[oota-llvm.git] / lib / VMCore / Verifier.cpp
index 4c9f11600ab54588ab194dec365fb077965eb44e..da3449b95c02542dacb4e75c3b8659be4d4f9409 100644 (file)
@@ -8,7 +8,7 @@
 //
 //  * Both of a binary operator's parameters are the same type
 //  * Verify that the indices of mem access instructions match other operands
-//  . Verify that arithmetic and other things are only performed on first class
+//  * Verify that arithmetic and other things are only performed on first class
 //    types.  Verify that shifts & logicals only happen on integrals f.e.
 //  . All of the constants in a switch statement are of the correct type
 //  * The code is in valid SSA form
@@ -17,6 +17,7 @@
 //  * Only phi nodes can be self referential: 'add int %0, %0 ; <int>:0' is bad
 //  * PHI nodes must have an entry for each predecessor, with no extras.
 //  * PHI nodes must be the first thing in a basic block, all grouped together
+//  * PHI nodes must have at least one entry
 //  * All basic blocks should only end with terminator insts, not contain them
 //  * The entry node to a function must not have predecessors
 //  * All Instructions must be embeded into a basic block
@@ -24,7 +25,7 @@
 //  * Verify that a function's argument list agrees with it's declared type.
 //  . Verify that arrays and structures have fixed elements: No unsized arrays.
 //  * It is illegal to specify a name for a void value.
-//  * It is illegal to have a internal function that is just a declaration
+//  * It is illegal to have a internal global value with no intitalizer
 //  * It is illegal to have a ret instruction that returns a value that does not
 //    agree with the function return value type.
 //  * Function call argument types match the function prototype
@@ -39,6 +40,7 @@
 #include "llvm/iPHINode.h"
 #include "llvm/iTerminators.h"
 #include "llvm/iOther.h"
+#include "llvm/iOperators.h"
 #include "llvm/iMemory.h"
 #include "llvm/SymbolTable.h"
 #include "llvm/PassManager.h"
@@ -47,7 +49,6 @@
 #include "llvm/Support/InstVisitor.h"
 #include "Support/STLExtras.h"
 #include <algorithm>
-#include <iostream>
 
 namespace {  // Anonymous namespace for class
 
@@ -66,6 +67,13 @@ namespace {  // Anonymous namespace for class
 
     bool doInitialization(Module &M) {
       verifySymbolTable(M.getSymbolTable());
+
+      // If this is a real pass, in a pass manager, we must abort before
+      // returning back to the pass manager, or else the pass manager may try to
+      // run other passes on the broken module.
+      //
+      if (RealPass)
+        abortIfBroken();
       return false;
     }
 
@@ -73,6 +81,14 @@ namespace {  // Anonymous namespace for class
       // Get dominator information if we are being run by PassManager
       if (RealPass) DS = &getAnalysis<DominatorSet>();
       visit(F);
+
+      // If this is a real pass, in a pass manager, we must abort before
+      // returning back to the pass manager, or else the pass manager may try to
+      // run other passes on the broken module.
+      //
+      if (RealPass)
+        abortIfBroken();
+
       return false;
     }
 
@@ -82,10 +98,12 @@ namespace {  // Anonymous namespace for class
         if (I->isExternal() && I->hasInternalLinkage())
           CheckFailed("Function Declaration has Internal Linkage!", I);
 
-      if (Broken && AbortBroken) {
-        std::cerr << "Broken module found, compilation aborted!\n";
-        abort();
-      }
+      for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
+        if (I->isExternal() && I->hasInternalLinkage())
+          CheckFailed("Global Variable is external with internal linkage!", I);
+
+      // If the module is broken, abort at this time.
+      abortIfBroken();
       return false;
     }
 
@@ -95,12 +113,23 @@ namespace {  // Anonymous namespace for class
         AU.addRequired<DominatorSet>();
     }
 
+    // abortIfBroken - If the module is broken and we are supposed to abort on
+    // this condition, do so.
+    //
+    void abortIfBroken() const {
+      if (Broken && AbortBroken) {
+        std::cerr << "Broken module found, compilation aborted!\n";
+        abort();
+      }
+    }
+
     // Verification methods...
     void verifySymbolTable(SymbolTable *ST);
     void visitFunction(Function &F);
     void visitBasicBlock(BasicBlock &BB);
     void visitPHINode(PHINode &PN);
     void visitBinaryOperator(BinaryOperator &B);
+    void visitShiftInst(ShiftInst &SI);
     void visitCallInst(CallInst &CI);
     void visitGetElementPtrInst(GetElementPtrInst &GEP);
     void visitLoadInst(LoadInst &LI);
@@ -164,32 +193,30 @@ void Verifier::verifySymbolTable(SymbolTable *ST) {
 // visitFunction - Verify that a function is ok.
 //
 void Verifier::visitFunction(Function &F) {
-  if (F.isExternal()) return;
-
-  verifySymbolTable(F.getSymbolTable());
-
   // Check function arguments...
   const FunctionType *FT = F.getFunctionType();
   unsigned NumArgs = F.getArgumentList().size();
 
   Assert2(!FT->isVarArg(), "Cannot define varargs functions in LLVM!", &F, FT);
-  Assert2(FT->getParamTypes().size() == NumArgs,
+  Assert2(FT->getNumParams() == NumArgs,
           "# formal arguments must match # of arguments for function type!",
           &F, FT);
 
   // Check that the argument values match the function type for this function...
-  if (FT->getParamTypes().size() == NumArgs) {
-    unsigned i = 0;
-    for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++i)
-      Assert2(I->getType() == FT->getParamType(i),
-              "Argument value does not match function argument type!",
-              I, FT->getParamType(i));
+  unsigned i = 0;
+  for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++i)
+    Assert2(I->getType() == FT->getParamType(i),
+            "Argument value does not match function argument type!",
+            I, FT->getParamType(i));
+
+  if (!F.isExternal()) {
+    verifySymbolTable(F.getSymbolTable());
+
+    // Check the entry node
+    BasicBlock *Entry = &F.getEntryNode();
+    Assert1(pred_begin(Entry) == pred_end(Entry),
+            "Entry block to function must not have predecessors!", Entry);
   }
-
-  // Check the entry node
-  BasicBlock *Entry = &F.getEntryNode();
-  Assert1(pred_begin(Entry) == pred_end(Entry),
-          "Entry block to function must not have predecessors!", Entry);
 }
 
 
@@ -234,6 +261,12 @@ void Verifier::visitPHINode(PHINode &PN) {
           "PHI nodes not grouped at top of basic block!",
           &PN, PN.getParent());
 
+  // Ensure that PHI nodes have at least one entry!
+  Assert1(PN.getNumIncomingValues() != 0,
+          "PHI nodes must have at least one entry.  If the block is dead, "
+          "the PHI should be removed!",
+          &PN);
+
   std::vector<BasicBlock*> Preds(pred_begin(PN.getParent()),
                                  pred_end(PN.getParent()));
   // Loop over all of the incoming values, make sure that there are
@@ -313,16 +346,49 @@ void Verifier::visitCallInst(CallInst &CI) {
 // of the same type!
 //
 void Verifier::visitBinaryOperator(BinaryOperator &B) {
-  Assert2(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
-          "Both operands to a binary operator are not of the same type!",
-          B.getOperand(0), B.getOperand(1));
-
+  Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
+          "Both operands to a binary operator are not of the same type!", &B);
+
+  // Check that logical operators are only used with integral operands.
+  if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
+      B.getOpcode() == Instruction::Xor) {
+    Assert1(B.getType()->isIntegral(),
+            "Logical operators only work with integral types!", &B);
+    Assert1(B.getType() == B.getOperand(0)->getType(),
+            "Logical operators must have same type for operands and result!",
+            &B);
+  } else if (isa<SetCondInst>(B)) {
+    // Check that setcc instructions return bool
+    Assert1(B.getType() == Type::BoolTy,
+            "setcc instructions must return boolean values!", &B);
+  } else {
+    // Arithmetic operators only work on integer or fp values
+    Assert1(B.getType() == B.getOperand(0)->getType(),
+            "Arithmetic operators must have same type for operands and result!",
+            &B);
+    Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint(),
+            "Arithmetic operators must have integer or fp type!", &B);
+  }
+  
   visitInstruction(B);
 }
 
+void Verifier::visitShiftInst(ShiftInst &SI) {
+  Assert1(SI.getType()->isInteger(),
+          "Shift must return an integer result!", &SI);
+  Assert1(SI.getType() == SI.getOperand(0)->getType(),
+          "Shift return type must be same as first operand!", &SI);
+  Assert1(SI.getOperand(1)->getType() == Type::UByteTy,
+          "Second operand to shift must be ubyte type!", &SI);
+  visitInstruction(SI);
+}
+
+
+
 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
-  const Type *ElTy = MemAccessInst::getIndexedType(GEP.getOperand(0)->getType(),
-                                                   GEP.copyIndices(), true);
+  const Type *ElTy =
+    GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
+                   std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
   Assert2(PointerType::get(ElTy) == GEP.getType(),
           "GEP is not of right type for indices!", &GEP, ElTy);
@@ -330,18 +396,16 @@ void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
 }
 
 void Verifier::visitLoadInst(LoadInst &LI) {
-  const Type *ElTy = LoadInst::getIndexedType(LI.getOperand(0)->getType(),
-                                              LI.copyIndices());
-  Assert1(ElTy, "Invalid indices for load pointer type!", &LI);
+  const Type *ElTy =
+    cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
   Assert2(ElTy == LI.getType(),
           "Load is not of right type for indices!", &LI, ElTy);
   visitInstruction(LI);
 }
 
 void Verifier::visitStoreInst(StoreInst &SI) {
-  const Type *ElTy = StoreInst::getIndexedType(SI.getOperand(1)->getType(),
-                                               SI.copyIndices());
-  Assert1(ElTy, "Invalid indices for store pointer type!", &SI);
+  const Type *ElTy =
+    cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
   Assert2(ElTy == SI.getOperand(0)->getType(),
           "Stored value is not of right type for indices!", &SI, ElTy);
   visitInstruction(SI);
@@ -351,7 +415,8 @@ void Verifier::visitStoreInst(StoreInst &SI) {
 // verifyInstruction - Verify that an instruction is well formed.
 //
 void Verifier::visitInstruction(Instruction &I) {
-  Assert1(I.getParent(), "Instruction not embedded in basic block!", &I);
+  BasicBlock *BB = I.getParent();  
+  Assert1(BB, "Instruction not embedded in basic block!", &I);
 
   // Check that all uses of the instruction, if they are instructions
   // themselves, actually have parent basic blocks.  If the use is not an
@@ -391,13 +456,17 @@ void Verifier::visitInstruction(Instruction &I) {
           // Make sure that I dominates the end of pred(i)
           BasicBlock *Pred = PN->getIncomingBlock(i);
           
-          Assert2(DS->dominates(I.getParent(), Pred), 
+          // Use must be dominated by by definition unless use is unreachable!
+          Assert2(DS->dominates(BB, Pred) ||
+                  !DS->dominates(&BB->getParent()->getEntryNode(), Pred),
                   "Instruction does not dominate all uses!",
                   &I, PN);
         }
 
     } else {
-      Assert2(DS->dominates(&I, Use),
+      // Use must be dominated by by definition unless use is unreachable!
+      Assert2(DS->dominates(&I, Use) ||
+              !DS->dominates(&BB->getParent()->getEntryNode(),Use->getParent()),
               "Instruction does not dominate all uses!", &I, Use);
     }
   }