Fix spelling/grammar.
[oota-llvm.git] / lib / VMCore / Verifier.cpp
index 812ca4a86845d5c4720cb5112e064974be9b416c..1d4ac258eb305a61f5636a7fdd5e9ad5243df37e 100644 (file)
 //  * 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
+//  * All Instructions must be embedded into a basic block
 //  . Function's cannot take a void typed parameter
 //  * 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 global value with no intitalizer
+//  * It is illegal to have a internal global value with no initializer
 //  * 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
@@ -44,6 +43,7 @@
 #include "llvm/iMemory.h"
 #include "llvm/SymbolTable.h"
 #include "llvm/PassManager.h"
+#include "llvm/Intrinsics.h"
 #include "llvm/Analysis/Dominators.h"
 #include "llvm/Support/CFG.h"
 #include "llvm/Support/InstVisitor.h"
@@ -95,8 +95,7 @@ namespace {  // Anonymous namespace for class
     bool doFinalization(Module &M) {
       // Scan through, checking all of the external function's linkage now...
       for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
-        if (I->isExternal() && I->hasInternalLinkage())
-          CheckFailed("Function Declaration has Internal Linkage!", I);
+        visitGlobalValue(*I);
 
       for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
         if (I->isExternal() && I->hasInternalLinkage())
@@ -123,13 +122,16 @@ namespace {  // Anonymous namespace for class
       }
     }
 
+
     // Verification methods...
     void verifySymbolTable(SymbolTable &ST);
+    void visitGlobalValue(GlobalValue &GV);
     void visitFunction(Function &F);
     void visitBasicBlock(BasicBlock &BB);
     void visitPHINode(PHINode &PN);
     void visitBinaryOperator(BinaryOperator &B);
     void visitShiftInst(ShiftInst &SI);
+    void visitVarArgInst(VarArgInst &VAI) { visitInstruction(VAI); }
     void visitCallInst(CallInst &CI);
     void visitGetElementPtrInst(GetElementPtrInst &GEP);
     void visitLoadInst(LoadInst &LI);
@@ -137,6 +139,9 @@ namespace {  // Anonymous namespace for class
     void visitInstruction(Instruction &I);
     void visitTerminatorInst(TerminatorInst &I);
     void visitReturnInst(ReturnInst &RI);
+    void visitUserOp1(Instruction &I);
+    void visitUserOp2(Instruction &I) { visitUserOp1(I); }
+    void visitIntrinsicFunctionCall(LLVMIntrinsic::ID ID, CallInst &CI);
 
     // CheckFailed - A check failed, so print out the condition and the message
     // that failed.  This provides a nice place to put a breakpoint if you want
@@ -170,6 +175,19 @@ namespace {  // Anonymous namespace for class
   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
 
 
+void Verifier::visitGlobalValue(GlobalValue &GV) {
+  Assert1(!GV.isExternal() || GV.hasExternalLinkage(),
+          "Global value has Internal Linkage!", &GV);
+  Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
+          "Only global variables can have appending linkage!", &GV);
+
+  if (GV.hasAppendingLinkage()) {
+    GlobalVariable &GVar = cast<GlobalVariable>(GV);
+    Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
+            "Only global arrays can have appending linkage!", &GV);
+  }
+}
+
 // verifySymbolTable - Verify that a function or module symbol table is ok
 //
 void Verifier::verifySymbolTable(SymbolTable &ST) {
@@ -195,7 +213,6 @@ void Verifier::visitFunction(Function &F) {
   const FunctionType *FT = F.getFunctionType();
   unsigned NumArgs = F.getArgumentList().size();
 
-  Assert2(!FT->isVarArg(), "Cannot define varargs functions in LLVM!", &F, FT);
   Assert2(FT->getNumParams() == NumArgs,
           "# formal arguments must match # of arguments for function type!",
           &F, FT);
@@ -211,7 +228,7 @@ void Verifier::visitFunction(Function &F) {
     verifySymbolTable(F.getSymbolTable());
 
     // Check the entry node
-    BasicBlock *Entry = &F.getEntryNode();
+    BasicBlock *Entry = &F.getEntryBlock();
     Assert1(pred_begin(Entry) == pred_end(Entry),
             "Entry block to function must not have predecessors!", Entry);
   }
@@ -221,6 +238,54 @@ void Verifier::visitFunction(Function &F) {
 // verifyBasicBlock - Verify that a basic block is well formed...
 //
 void Verifier::visitBasicBlock(BasicBlock &BB) {
+  // Check constraints that this basic block imposes on all of the PHI nodes in
+  // it.
+  if (isa<PHINode>(BB.front())) {
+    std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
+    std::sort(Preds.begin(), Preds.end());
+    
+    for (BasicBlock::iterator I = BB.begin();
+         PHINode *PN = dyn_cast<PHINode>(I); ++I) {
+
+      // 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);
+      Assert1(PN->getNumIncomingValues() >= Preds.size(),
+              "PHINode has more entries than the basic block has predecessors!",
+              PN);
+      Assert1(PN->getNumIncomingValues() <= Preds.size(),
+              "PHINode has less entries than the basic block has predecessors!",
+              PN);
+      
+      // Get and sort all incoming values in the PHI node...
+      std::vector<std::pair<BasicBlock*, Value*> > Values;
+      Values.reserve(PN->getNumIncomingValues());
+      for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
+        Values.push_back(std::make_pair(PN->getIncomingBlock(i),
+                                        PN->getIncomingValue(i)));
+      std::sort(Values.begin(), Values.end());
+      
+      for (unsigned i = 0, e = Values.size(); i != e; ++i) {
+        // Check to make sure that if there is more than one entry for a
+        // particular basic block in this PHI node, that the incoming values are
+        // all identical.
+        //
+        Assert4(i == 0 || Values[i].first  != Values[i-1].first ||
+                Values[i].second == Values[i-1].second,
+                "PHI node has multiple entries for the same basic block with "
+                "different incoming values!", PN, Values[i].first,
+                Values[i].second, Values[i-1].second);
+        
+        // Check to make sure that the predecessors and PHI node entries are
+        // matched up.
+        Assert3(Values[i].first == Preds[i],
+                "PHI node entries do not match predecessors!", PN,
+                Values[i].first, Preds[i]);        
+      }
+    }
+  }
+
   // Ensure that basic blocks have terminators!
   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
 }
@@ -243,73 +308,30 @@ void Verifier::visitReturnInst(ReturnInst &RI) {
             "Function return type does not match operand "
             "type of return inst!", &RI, F->getReturnType());
 
-  // Check to make sure that the return value has neccesary properties for
+  // Check to make sure that the return value has necessary properties for
   // terminators...
   visitTerminatorInst(RI);
 }
 
+// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of a
+// pass, if any exist, it's an error.
+//
+void Verifier::visitUserOp1(Instruction &I) {
+  Assert1(0, "User-defined operators should not live outside of a pass!",
+          &I);
+}
 
 // visitPHINode - Ensure that a PHI node is well formed.
 void Verifier::visitPHINode(PHINode &PN) {
   // Ensure that the PHI nodes are all grouped together at the top of the block.
   // This can be tested by checking whether the instruction before this is
-  // either nonexistant (because this is begin()) or is a PHI node.  If not,
+  // either nonexistent (because this is begin()) or is a PHI node.  If not,
   // then there is some other instruction before a PHI.
-  Assert2(PN.getPrev() == 0 || isa<PHINode>(PN.getPrev()),
+  Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
           "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
-  // predecessors for each one...
-  //
-  for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
-    // Make sure all of the incoming values are the right types...
-    Assert2(PN.getType() == PN.getIncomingValue(i)->getType(),
-            "PHI node argument type does not agree with PHI node type!",
-            &PN, PN.getIncomingValue(i));
-
-    BasicBlock *BB = PN.getIncomingBlock(i);
-    std::vector<BasicBlock*>::iterator PI =
-      find(Preds.begin(), Preds.end(), BB);
-    Assert2(PI != Preds.end(), "PHI node has entry for basic block that"
-            " is not a predecessor!", &PN, BB);
-    Preds.erase(PI);
-  }
-  
-  // There should be no entries left in the predecessor list...
-  for (std::vector<BasicBlock*>::iterator I = Preds.begin(),
-         E = Preds.end(); I != E; ++I)
-    Assert2(0, "PHI node does not have entry for a predecessor basic block!",
-            &PN, *I);
-
-  // Now we go through and check to make sure that if there is more than one
-  // entry for a particular basic block in this PHI node, that the incoming
-  // values are all identical.
-  //
-  std::vector<std::pair<BasicBlock*, Value*> > Values;
-  Values.reserve(PN.getNumIncomingValues());
-  for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
-    Values.push_back(std::make_pair(PN.getIncomingBlock(i),
-                                    PN.getIncomingValue(i)));
-
-  // Sort the Values vector so that identical basic block entries are adjacent.
-  std::sort(Values.begin(), Values.end());
-
-  // Check for identical basic blocks with differing incoming values...
-  for (unsigned i = 1, e = PN.getNumIncomingValues(); i < e; ++i)
-    Assert4(Values[i].first  != Values[i-1].first ||
-            Values[i].second == Values[i-1].second,
-            "PHI node has multiple entries for the same basic block with "
-            "different incoming values!", &PN, Values[i].first,
-            Values[i].second, Values[i-1].second);
+  // All other PHI node constraints are checked in the visitBasicBlock method.
 
   visitInstruction(PN);
 }
@@ -337,6 +359,10 @@ void Verifier::visitCallInst(CallInst &CI) {
             "Call parameter type does not match function signature!",
             CI.getOperand(i+1), FTy->getParamType(i));
 
+  if (Function *F = CI.getCalledFunction())
+    if (LLVMIntrinsic::ID ID = (LLVMIntrinsic::ID)F->getIntrinsicID())
+      visitIntrinsicFunctionCall(ID, CI);
+
   visitInstruction(CI);
 }
 
@@ -381,8 +407,6 @@ void Verifier::visitShiftInst(ShiftInst &SI) {
   visitInstruction(SI);
 }
 
-
-
 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
   const Type *ElTy =
     GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
@@ -416,19 +440,6 @@ void Verifier::visitInstruction(Instruction &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
-  // instruction, it is an error!
-  //
-  for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
-       UI != UE; ++UI) {
-    Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
-            *UI);
-    Instruction *Used = cast<Instruction>(*UI);
-    Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
-            " embeded in a basic block!", &I, Used);
-  }
-
   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
          UI != UE; ++UI)
@@ -440,42 +451,101 @@ void Verifier::visitInstruction(Instruction &I) {
   Assert1(I.getType() != Type::VoidTy || !I.hasName(),
           "Instruction has a name, but provides a void value!", &I);
 
-  // Check that a definition dominates all of its uses.
+  // Check that all uses of the instruction, if they are instructions
+  // themselves, actually have parent basic blocks.  If the use is not an
+  // instruction, it is an error!
   //
   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
        UI != UE; ++UI) {
-    Instruction *Use = cast<Instruction>(*UI);
-      
-    // PHI nodes are more difficult than other nodes because they actually
-    // "use" the value in the predecessor basic blocks they correspond to.
-    if (PHINode *PN = dyn_cast<PHINode>(Use)) {
-      for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
-        if (&I == PN->getIncomingValue(i)) {
-          // Make sure that I dominates the end of pred(i)
-          BasicBlock *Pred = PN->getIncomingBlock(i);
-          
-          // 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 {
-      // 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);
+    Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
+            *UI);
+    Instruction *Used = cast<Instruction>(*UI);
+    Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
+            " embeded in a basic block!", &I, Used);
+  }
+
+  for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
+    // Check to make sure that the "address of" an intrinsic function is never
+    // taken.
+    if (Function *F = dyn_cast<Function>(I.getOperand(i)))
+      Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
+              "Cannot take the address of an intrinsic!", &I);
+
+    else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
+      // Check that a definition dominates all of its uses.
+      //
+      if (!isa<PHINode>(I)) {
+        // Definition must dominate use unless use is unreachable!
+        Assert2(DS->dominates(Op->getParent(), BB) ||
+                !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
+                "Instruction does not dominate all uses!", Op, &I);
+      } else {
+        // PHI nodes are more difficult than other nodes because they actually
+        // "use" the value in the predecessor basic blocks they correspond to.
+        BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
+        Assert2(DS->dominates(Op->getParent(), PredBB) ||
+                !DS->dominates(&BB->getParent()->getEntryBlock(), PredBB),
+                "Instruction does not dominate all uses!", Op, &I);
+      }
     }
   }
 }
 
+/// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
+void Verifier::visitIntrinsicFunctionCall(LLVMIntrinsic::ID ID, CallInst &CI) {
+  Function *IF = CI.getCalledFunction();
+  const FunctionType *FT = IF->getFunctionType();
+  Assert1(IF->isExternal(), "Intrinsic functions should never be defined!", IF);
+  unsigned NumArgs = 0;
+
+  // FIXME: this should check the return type of each intrinsic as well, also
+  // arguments!
+  switch (ID) {
+  case LLVMIntrinsic::va_start:
+    Assert1(CI.getParent()->getParent()->getFunctionType()->isVarArg(),
+            "llvm.va_start intrinsic may only occur in function with variable"
+            " args!", &CI);
+    NumArgs = 1;
+    break;
+  case LLVMIntrinsic::va_end:          NumArgs = 1; break;
+  case LLVMIntrinsic::va_copy:         NumArgs = 2; break;
+
+  case LLVMIntrinsic::setjmp:          NumArgs = 1; break;
+  case LLVMIntrinsic::longjmp:         NumArgs = 2; break;
+  case LLVMIntrinsic::sigsetjmp:       NumArgs = 2; break;
+  case LLVMIntrinsic::siglongjmp:      NumArgs = 2; break;
+  case LLVMIntrinsic::alpha_ctlz:      NumArgs = 1; break;
+  case LLVMIntrinsic::alpha_cttz:      NumArgs = 1; break;
+  case LLVMIntrinsic::alpha_ctpop:     NumArgs = 1; break;
+  case LLVMIntrinsic::alpha_umulh:     NumArgs = 2; break;
+  case LLVMIntrinsic::alpha_vecop:     NumArgs = 4; break;
+  case LLVMIntrinsic::alpha_pup:       NumArgs = 3; break;
+  case LLVMIntrinsic::alpha_bytezap:   NumArgs = 2; break;
+  case LLVMIntrinsic::alpha_bytemanip: NumArgs = 3; break;
+  case LLVMIntrinsic::alpha_dfpbop:    NumArgs = 3; break;
+  case LLVMIntrinsic::alpha_dfpuop:    NumArgs = 2; break;
+  case LLVMIntrinsic::alpha_unordered: NumArgs = 2; break;
+  case LLVMIntrinsic::alpha_uqtodfp:   NumArgs = 2; break;
+  case LLVMIntrinsic::alpha_uqtosfp:   NumArgs = 2; break;
+  case LLVMIntrinsic::alpha_dfptosq:   NumArgs = 2; break;
+  case LLVMIntrinsic::alpha_sfptosq:   NumArgs = 2; break;
+
+  case LLVMIntrinsic::not_intrinsic: 
+    assert(0 && "Invalid intrinsic!"); NumArgs = 0; break;
+  }
+
+  Assert1(FT->getNumParams() == NumArgs || (FT->getNumParams() < NumArgs &&
+                                             FT->isVarArg()),
+          "Illegal # arguments for intrinsic function!", IF);
+}
+
 
 //===----------------------------------------------------------------------===//
 //  Implement the public interfaces to this file...
 //===----------------------------------------------------------------------===//
 
-Pass *createVerifierPass() {
+FunctionPass *createVerifierPass() {
   return new Verifier();
 }