lib/VMCore/Verifier.cpp

   1 //===-- Verifier.cpp - Implement the Module Verifier -------------*- C++ -*-==//
   2 //
   3 // This file defines the function verifier interface, that can be used for some
   4 // sanity checking of input to the system.
   5 //
   6 // Note that this does not provide full 'java style' security and verifications,
   7 // instead it just tries to ensure that code is well formed.
   8 //
   9 //  * Both of a binary operator's parameters are the same type
  10 //  * Verify that the indices of mem access instructions match other operands
  11 //  . Verify that arithmetic and other things are only performed on first class
  12 //    types.  Verify that shifts & logicals only happen on integrals f.e.
  13 //  . All of the constants in a switch statement are of the correct type
  14 //  * The code is in valid SSA form
  15 //  . It should be illegal to put a label into any other type (like a structure)
  16 //    or to return one. [except constant arrays!]
  17 //  * Only phi nodes can be self referential: 'add int %0, %0 ; <int>:0' is bad
  18 //  * PHI nodes must have an entry for each predecessor, with no extras.
  19 //  * PHI nodes must be the first thing in a basic block, all grouped together
  20 //  * All basic blocks should only end with terminator insts, not contain them
  21 //  * The entry node to a function must not have predecessors
  22 //  * All Instructions must be embeded into a basic block
  23 //  . Function's cannot take a void typed parameter
  24 //  * Verify that a function's argument list agrees with it's declared type.
  25 //  . Verify that arrays and structures have fixed elements: No unsized arrays.
  26 //  * It is illegal to specify a name for a void value.
  27 //  * It is illegal to have a internal function that is just a declaration
  28 //  * It is illegal to have a ret instruction that returns a value that does not
  29 //    agree with the function return value type.
  30 //  * Function call argument types match the function prototype
  31 //  * All other things that are tested by asserts spread about the code...
  32 //
  33 //===----------------------------------------------------------------------===//
  34
  35 #include "llvm/Analysis/Verifier.h"
  36 #include "llvm/Pass.h"
  37 #include "llvm/Module.h"
  38 #include "llvm/DerivedTypes.h"
  39 #include "llvm/iPHINode.h"
  40 #include "llvm/iTerminators.h"
  41 #include "llvm/iOther.h"
  42 #include "llvm/iMemory.h"
  43 #include "llvm/SymbolTable.h"
  44 #include "llvm/PassManager.h"
  45 #include "llvm/Analysis/Dominators.h"
  46 #include "llvm/Support/CFG.h"
  47 #include "llvm/Support/InstVisitor.h"
  48 #include "Support/STLExtras.h"
  49 #include <algorithm>
  50 #include <iostream>
  51
  52 namespace {  // Anonymous namespace for class
  53
  54   struct Verifier : public FunctionPass, InstVisitor<Verifier> {
  55     bool Broken;          // Is this module found to be broken?
  56     bool RealPass;        // Are we not being run by a PassManager?
  57     bool AbortBroken;     // If broken, should it or should it not abort?
  58
  59     DominatorSet *DS; // Dominator set, caution can be null!
  60
  61     Verifier() : Broken(false), RealPass(true), AbortBroken(true), DS(0) {}
  62     Verifier(bool AB) : Broken(false), RealPass(true), AbortBroken(AB), DS(0) {}
  63     Verifier(DominatorSet &ds)
  64       : Broken(false), RealPass(false), AbortBroken(false), DS(&ds) {}
  65
  66
  67     bool doInitialization(Module &M) {
  68       verifySymbolTable(M.getSymbolTable());
  69       return false;
  70     }
  71
  72     bool runOnFunction(Function &F) {
  73       // Get dominator information if we are being run by PassManager
  74       if (RealPass) DS = &getAnalysis<DominatorSet>();
  75       visit(F);
  76       return false;
  77     }
  78
  79     bool doFinalization(Module &M) {
  80       // Scan through, checking all of the external function's linkage now...
  81       for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
  82         if (I->isExternal() && I->hasInternalLinkage())
  83           CheckFailed("Function Declaration has Internal Linkage!", I);
  84
  85       if (Broken && AbortBroken) {
  86         std::cerr << "Broken module found, compilation aborted!\n";
  87         abort();
  88       }
  89       return false;
  90     }
  91
  92     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  93       AU.setPreservesAll();
  94       if (RealPass)
  95         AU.addRequired(DominatorSet::ID);
  96     }
  97
  98     // Verification methods...
  99     void verifySymbolTable(SymbolTable *ST);
 100     void visitFunction(Function &F);
 101     void visitBasicBlock(BasicBlock &BB);
 102     void visitPHINode(PHINode &PN);
 103     void visitBinaryOperator(BinaryOperator &B);
 104     void visitCallInst(CallInst &CI);
 105     void visitGetElementPtrInst(GetElementPtrInst &GEP);
 106     void visitLoadInst(LoadInst &LI);
 107     void visitStoreInst(StoreInst &SI);
 108     void visitInstruction(Instruction &I);
 109     void visitTerminatorInst(TerminatorInst &I);
 110     void visitReturnInst(ReturnInst &RI);
 111
 112     // CheckFailed - A check failed, so print out the condition and the message
 113     // that failed.  This provides a nice place to put a breakpoint if you want
 114     // to see why something is not correct.
 115     //
 116     inline void CheckFailed(const std::string &Message,
 117                             const Value *V1 = 0, const Value *V2 = 0,
 118                             const Value *V3 = 0, const Value *V4 = 0) {
 119       std::cerr << Message << "\n";
 120       if (V1) std::cerr << *V1 << "\n";
 121       if (V2) std::cerr << *V2 << "\n";
 122       if (V3) std::cerr << *V3 << "\n";
 123       if (V4) std::cerr << *V4 << "\n";
 124       Broken = true;
 125     }
 126   };
 127
 128   RegisterPass<Verifier> X("verify", "Module Verifier");
 129 }
 130
 131 // Assert - We know that cond should be true, if not print an error message.
 132 #define Assert(C, M) \
 133   do { if (!(C)) { CheckFailed(M); return; } } while (0)
 134 #define Assert1(C, M, V1) \
 135   do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
 136 #define Assert2(C, M, V1, V2) \
 137   do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
 138 #define Assert3(C, M, V1, V2, V3) \
 139   do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
 140 #define Assert4(C, M, V1, V2, V3, V4) \
 141   do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
 142
 143
 144 // verifySymbolTable - Verify that a function or module symbol table is ok
 145 //
 146 void Verifier::verifySymbolTable(SymbolTable *ST) {
 147   if (ST == 0) return;   // No symbol table to process
 148
 149   // Loop over all of the types in the symbol table...
 150   for (SymbolTable::iterator TI = ST->begin(), TE = ST->end(); TI != TE; ++TI)
 151     for (SymbolTable::type_iterator I = TI->second.begin(),
 152            E = TI->second.end(); I != E; ++I) {
 153       Value *V = I->second;
 154
 155       // Check that there are no void typed values in the symbol table.  Values
 156       // with a void type cannot be put into symbol tables because they cannot
 157       // have names!
 158       Assert1(V->getType() != Type::VoidTy,
 159               "Values with void type are not allowed to have names!", V);
 160     }
 161 }
 162
 163
 164 // visitFunction - Verify that a function is ok.
 165 //
 166 void Verifier::visitFunction(Function &F) {
 167   if (F.isExternal()) return;
 168
 169   verifySymbolTable(F.getSymbolTable());
 170
 171   // Check function arguments...
 172   const FunctionType *FT = F.getFunctionType();
 173   unsigned NumArgs = F.getArgumentList().size();
 174
 175   Assert2(!FT->isVarArg(), "Cannot define varargs functions in LLVM!", &F, FT);
 176   Assert2(FT->getParamTypes().size() == NumArgs,
 177           "# formal arguments must match # of arguments for function type!",
 178           &F, FT);
 179
 180   // Check that the argument values match the function type for this function...
 181   if (FT->getParamTypes().size() == NumArgs) {
 182     unsigned i = 0;
 183     for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++i)
 184       Assert2(I->getType() == FT->getParamType(i),
 185               "Argument value does not match function argument type!",
 186               I, FT->getParamType(i));
 187   }
 188
 189   // Check the entry node
 190   BasicBlock *Entry = &F.getEntryNode();
 191   Assert1(pred_begin(Entry) == pred_end(Entry),
 192           "Entry block to function must not have predecessors!", Entry);
 193 }
 194
 195
 196 // verifyBasicBlock - Verify that a basic block is well formed...
 197 //
 198 void Verifier::visitBasicBlock(BasicBlock &BB) {
 199   // Ensure that basic blocks have terminators!
 200   Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
 201 }
 202
 203 void Verifier::visitTerminatorInst(TerminatorInst &I) {
 204   // Ensure that terminators only exist at the end of the basic block.
 205   Assert1(&I == I.getParent()->getTerminator(),
 206           "Terminator found in the middle of a basic block!", I.getParent());
 207   visitInstruction(I);
 208 }
 209
 210 void Verifier::visitReturnInst(ReturnInst &RI) {
 211   Function *F = RI.getParent()->getParent();
 212   if (RI.getNumOperands() == 0)
 213     Assert1(F->getReturnType() == Type::VoidTy,
 214             "Function returns no value, but ret instruction found that does!",
 215             &RI);
 216   else
 217     Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
 218             "Function return type does not match operand "
 219             "type of return inst!", &RI, F->getReturnType());
 220
 221   // Check to make sure that the return value has neccesary properties for
 222   // terminators...
 223   visitTerminatorInst(RI);
 224 }
 225
 226
 227 // visitPHINode - Ensure that a PHI node is well formed.
 228 void Verifier::visitPHINode(PHINode &PN) {
 229   // Ensure that the PHI nodes are all grouped together at the top of the block.
 230   // This can be tested by checking whether the instruction before this is
 231   // either nonexistant (because this is begin()) or is a PHI node.  If not,
 232   // then there is some other instruction before a PHI.
 233   Assert2(PN.getPrev() == 0 || isa<PHINode>(PN.getPrev()),
 234           "PHI nodes not grouped at top of basic block!",
 235           &PN, PN.getParent());
 236
 237   std::vector<BasicBlock*> Preds(pred_begin(PN.getParent()),
 238                                  pred_end(PN.getParent()));
 239   // Loop over all of the incoming values, make sure that there are
 240   // predecessors for each one...
 241   //
 242   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
 243     // Make sure all of the incoming values are the right types...
 244     Assert2(PN.getType() == PN.getIncomingValue(i)->getType(),
 245             "PHI node argument type does not agree with PHI node type!",
 246             &PN, PN.getIncomingValue(i));
 247
 248     BasicBlock *BB = PN.getIncomingBlock(i);
 249     std::vector<BasicBlock*>::iterator PI =
 250       find(Preds.begin(), Preds.end(), BB);
 251     Assert2(PI != Preds.end(), "PHI node has entry for basic block that"
 252             " is not a predecessor!", &PN, BB);
 253     Preds.erase(PI);
 254   }
 255
 256   // There should be no entries left in the predecessor list...
 257   for (std::vector<BasicBlock*>::iterator I = Preds.begin(),
 258          E = Preds.end(); I != E; ++I)
 259     Assert2(0, "PHI node does not have entry for a predecessor basic block!",
 260             &PN, *I);
 261
 262   // Now we go through and check to make sure that if there is more than one
 263   // entry for a particular basic block in this PHI node, that the incoming
 264   // values are all identical.
 265   //
 266   std::vector<std::pair<BasicBlock*, Value*> > Values;
 267   Values.reserve(PN.getNumIncomingValues());
 268   for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
 269     Values.push_back(std::make_pair(PN.getIncomingBlock(i),
 270                                     PN.getIncomingValue(i)));
 271
 272   // Sort the Values vector so that identical basic block entries are adjacent.
 273   std::sort(Values.begin(), Values.end());
 274
 275   // Check for identical basic blocks with differing incoming values...
 276   for (unsigned i = 1, e = PN.getNumIncomingValues(); i < e; ++i)
 277     Assert4(Values[i].first  != Values[i-1].first ||
 278             Values[i].second == Values[i-1].second,
 279             "PHI node has multiple entries for the same basic block with "
 280             "different incoming values!", &PN, Values[i].first,
 281             Values[i].second, Values[i-1].second);
 282
 283   visitInstruction(PN);
 284 }
 285
 286 void Verifier::visitCallInst(CallInst &CI) {
 287   Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
 288           "Called function must be a pointer!", &CI);
 289   const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
 290   Assert1(isa<FunctionType>(FPTy->getElementType()),
 291           "Called function is not pointer to function type!", &CI);
 292
 293   const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
 294
 295   // Verify that the correct number of arguments are being passed
 296   if (FTy->isVarArg())
 297     Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
 298             "Called function requires more parameters than were provided!",&CI);
 299   else
 300     Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
 301             "Incorrect number of arguments passed to called function!", &CI);
 302
 303   // Verify that all arguments to the call match the function type...
 304   for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
 305     Assert2(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
 306             "Call parameter type does not match function signature!",
 307             CI.getOperand(i+1), FTy->getParamType(i));
 308
 309   visitInstruction(CI);
 310 }
 311
 312 // visitBinaryOperator - Check that both arguments to the binary operator are
 313 // of the same type!
 314 //
 315 void Verifier::visitBinaryOperator(BinaryOperator &B) {
 316   Assert2(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
 317           "Both operands to a binary operator are not of the same type!",
 318           B.getOperand(0), B.getOperand(1));
 319
 320   visitInstruction(B);
 321 }
 322
 323 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
 324   const Type *ElTy = MemAccessInst::getIndexedType(GEP.getOperand(0)->getType(),
 325                                                    GEP.copyIndices(), true);
 326   Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
 327   Assert2(PointerType::get(ElTy) == GEP.getType(),
 328           "GEP is not of right type for indices!", &GEP, ElTy);
 329   visitInstruction(GEP);
 330 }
 331
 332 void Verifier::visitLoadInst(LoadInst &LI) {
 333   const Type *ElTy = LoadInst::getIndexedType(LI.getOperand(0)->getType(),
 334                                               LI.copyIndices());
 335   Assert1(ElTy, "Invalid indices for load pointer type!", &LI);
 336   Assert2(ElTy == LI.getType(),
 337           "Load is not of right type for indices!", &LI, ElTy);
 338   visitInstruction(LI);
 339 }
 340
 341 void Verifier::visitStoreInst(StoreInst &SI) {
 342   const Type *ElTy = StoreInst::getIndexedType(SI.getOperand(1)->getType(),
 343                                                SI.copyIndices());
 344   Assert1(ElTy, "Invalid indices for store pointer type!", &SI);
 345   Assert2(ElTy == SI.getOperand(0)->getType(),
 346           "Stored value is not of right type for indices!", &SI, ElTy);
 347   visitInstruction(SI);
 348 }
 349
 350
 351 // verifyInstruction - Verify that an instruction is well formed.
 352 //
 353 void Verifier::visitInstruction(Instruction &I) {
 354   Assert1(I.getParent(), "Instruction not embedded in basic block!", &I);
 355
 356   // Check that all uses of the instruction, if they are instructions
 357   // themselves, actually have parent basic blocks.  If the use is not an
 358   // instruction, it is an error!
 359   //
 360   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
 361        UI != UE; ++UI) {
 362     Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
 363             *UI);
 364     Instruction *Used = cast<Instruction>(*UI);
 365     Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
 366             " embeded in a basic block!", &I, Used);
 367   }
 368
 369   if (!isa<PHINode>(I)) {   // Check that non-phi nodes are not self referential
 370     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
 371          UI != UE; ++UI)
 372       Assert1(*UI != (User*)&I,
 373               "Only PHI nodes may reference their own value!", &I);
 374   }
 375
 376   // Check that void typed values don't have names
 377   Assert1(I.getType() != Type::VoidTy || !I.hasName(),
 378           "Instruction has a name, but provides a void value!", &I);
 379
 380   // Check that a definition dominates all of its uses.
 381   //
 382   for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
 383        UI != UE; ++UI) {
 384     Instruction *Use = cast<Instruction>(*UI);
 385
 386     // PHI nodes are more difficult than other nodes because they actually
 387     // "use" the value in the predecessor basic blocks they correspond to.
 388     if (PHINode *PN = dyn_cast<PHINode>(Use)) {
 389       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 390         if (&I == PN->getIncomingValue(i)) {
 391           // Make sure that I dominates the end of pred(i)
 392           BasicBlock *Pred = PN->getIncomingBlock(i);
 393
 394           Assert2(DS->dominates(I.getParent(), Pred),
 395                   "Instruction does not dominate all uses!",
 396                   &I, PN);
 397         }
 398
 399     } else {
 400       Assert2(DS->dominates(&I, Use),
 401               "Instruction does not dominate all uses!", &I, Use);
 402     }
 403   }
 404 }
 405
 406
 407 //===----------------------------------------------------------------------===//
 408 //  Implement the public interfaces to this file...
 409 //===----------------------------------------------------------------------===//
 410
 411 Pass *createVerifierPass() {
 412   return new Verifier();
 413 }
 414
 415
 416 // verifyFunction - Create
 417 bool verifyFunction(const Function &f) {
 418   Function &F = (Function&)f;
 419   assert(!F.isExternal() && "Cannot verify external functions");
 420
 421   DominatorSet DS;
 422   DS.doInitialization(*F.getParent());
 423   DS.runOnFunction(F);
 424
 425   Verifier V(DS);
 426   V.runOnFunction(F);
 427
 428   DS.doFinalization(*F.getParent());
 429
 430   return V.Broken;
 431 }
 432
 433 // verifyModule - Check a module for errors, printing messages on stderr.
 434 // Return true if the module is corrupt.
 435 //
 436 bool verifyModule(const Module &M) {
 437   PassManager PM;
 438   Verifier *V = new Verifier();
 439   PM.add(V);
 440   PM.run((Module&)M);
 441   return V->Broken;
 442 }