1 //===-- Verifier.cpp - Implement the Module Verifier -------------*- C++ -*-==//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the function verifier interface, that can be used for some
11 // sanity checking of input to the system.
13 // Note that this does not provide full `Java style' security and verifications,
14 // instead it just tries to ensure that code is well-formed.
16 // * Both of a binary operator's parameters are of the same type
17 // * Verify that the indices of mem access instructions match other operands
18 // * Verify that arithmetic and other things are only performed on first-class
19 // types. Verify that shifts & logicals only happen on integrals f.e.
20 // * All of the constants in a switch statement are of the correct type
21 // * The code is in valid SSA form
22 // * It should be illegal to put a label into any other type (like a structure)
23 // or to return one. [except constant arrays!]
24 // * Only phi nodes can be self referential: 'add int %0, %0 ; <int>:0' is bad
25 // * PHI nodes must have an entry for each predecessor, with no extras.
26 // * PHI nodes must be the first thing in a basic block, all grouped together
27 // * PHI nodes must have at least one entry
28 // * All basic blocks should only end with terminator insts, not contain them
29 // * The entry node to a function must not have predecessors
30 // * All Instructions must be embedded into a basic block
31 // * Functions cannot take a void-typed parameter
32 // * Verify that a function's argument list agrees with it's declared type.
33 // * It is illegal to specify a name for a void value.
34 // * It is illegal to have a internal global value with no initializer
35 // * It is illegal to have a ret instruction that returns a value that does not
36 // agree with the function return value type.
37 // * Function call argument types match the function prototype
38 // * All other things that are tested by asserts spread about the code...
40 //===----------------------------------------------------------------------===//
42 #include "llvm/Analysis/Verifier.h"
43 #include "llvm/Assembly/Writer.h"
44 #include "llvm/CallingConv.h"
45 #include "llvm/Constants.h"
46 #include "llvm/Pass.h"
47 #include "llvm/Module.h"
48 #include "llvm/ModuleProvider.h"
49 #include "llvm/ParameterAttributes.h"
50 #include "llvm/DerivedTypes.h"
51 #include "llvm/InlineAsm.h"
52 #include "llvm/Instructions.h"
53 #include "llvm/Intrinsics.h"
54 #include "llvm/PassManager.h"
55 #include "llvm/Analysis/Dominators.h"
56 #include "llvm/Support/CFG.h"
57 #include "llvm/Support/InstVisitor.h"
58 #include "llvm/Support/Streams.h"
59 #include "llvm/ADT/SmallPtrSet.h"
60 #include "llvm/ADT/SmallVector.h"
61 #include "llvm/ADT/StringExtras.h"
62 #include "llvm/ADT/STLExtras.h"
63 #include "llvm/Support/Compiler.h"
69 namespace { // Anonymous namespace for class
71 struct VISIBILITY_HIDDEN
72 Verifier : public FunctionPass, InstVisitor<Verifier> {
73 static char ID; // Pass ID, replacement for typeid
74 bool Broken; // Is this module found to be broken?
75 bool RealPass; // Are we not being run by a PassManager?
76 VerifierFailureAction action;
77 // What to do if verification fails.
78 Module *Mod; // Module we are verifying right now
79 DominatorTree *DT; // Dominator Tree, caution can be null!
80 std::stringstream msgs; // A stringstream to collect messages
82 /// InstInThisBlock - when verifying a basic block, keep track of all of the
83 /// instructions we have seen so far. This allows us to do efficient
84 /// dominance checks for the case when an instruction has an operand that is
85 /// an instruction in the same block.
86 SmallPtrSet<Instruction*, 16> InstsInThisBlock;
89 : FunctionPass((intptr_t)&ID),
90 Broken(false), RealPass(true), action(AbortProcessAction),
91 DT(0), msgs( std::ios::app | std::ios::out ) {}
92 Verifier( VerifierFailureAction ctn )
93 : FunctionPass((intptr_t)&ID),
94 Broken(false), RealPass(true), action(ctn), DT(0),
95 msgs( std::ios::app | std::ios::out ) {}
97 : FunctionPass((intptr_t)&ID),
98 Broken(false), RealPass(true),
99 action( AB ? AbortProcessAction : PrintMessageAction), DT(0),
100 msgs( std::ios::app | std::ios::out ) {}
101 Verifier(DominatorTree &dt)
102 : FunctionPass((intptr_t)&ID),
103 Broken(false), RealPass(false), action(PrintMessageAction),
104 DT(&dt), msgs( std::ios::app | std::ios::out ) {}
107 bool doInitialization(Module &M) {
109 verifyTypeSymbolTable(M.getTypeSymbolTable());
111 // If this is a real pass, in a pass manager, we must abort before
112 // returning back to the pass manager, or else the pass manager may try to
113 // run other passes on the broken module.
115 return abortIfBroken();
119 bool runOnFunction(Function &F) {
120 // Get dominator information if we are being run by PassManager
121 if (RealPass) DT = &getAnalysis<DominatorTree>();
126 InstsInThisBlock.clear();
128 // If this is a real pass, in a pass manager, we must abort before
129 // returning back to the pass manager, or else the pass manager may try to
130 // run other passes on the broken module.
132 return abortIfBroken();
137 bool doFinalization(Module &M) {
138 // Scan through, checking all of the external function's linkage now...
139 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
140 visitGlobalValue(*I);
142 // Check to make sure function prototypes are okay.
143 if (I->isDeclaration()) visitFunction(*I);
146 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
148 visitGlobalVariable(*I);
150 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
152 visitGlobalAlias(*I);
154 // If the module is broken, abort at this time.
155 return abortIfBroken();
158 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
159 AU.setPreservesAll();
161 AU.addRequired<DominatorTree>();
164 /// abortIfBroken - If the module is broken and we are supposed to abort on
165 /// this condition, do so.
167 bool abortIfBroken() {
169 msgs << "Broken module found, ";
171 case AbortProcessAction:
172 msgs << "compilation aborted!\n";
175 case PrintMessageAction:
176 msgs << "verification continues.\n";
179 case ReturnStatusAction:
180 msgs << "compilation terminated.\n";
188 // Verification methods...
189 void verifyTypeSymbolTable(TypeSymbolTable &ST);
190 void visitGlobalValue(GlobalValue &GV);
191 void visitGlobalVariable(GlobalVariable &GV);
192 void visitGlobalAlias(GlobalAlias &GA);
193 void visitFunction(Function &F);
194 void visitBasicBlock(BasicBlock &BB);
195 void visitTruncInst(TruncInst &I);
196 void visitZExtInst(ZExtInst &I);
197 void visitSExtInst(SExtInst &I);
198 void visitFPTruncInst(FPTruncInst &I);
199 void visitFPExtInst(FPExtInst &I);
200 void visitFPToUIInst(FPToUIInst &I);
201 void visitFPToSIInst(FPToSIInst &I);
202 void visitUIToFPInst(UIToFPInst &I);
203 void visitSIToFPInst(SIToFPInst &I);
204 void visitIntToPtrInst(IntToPtrInst &I);
205 void visitPtrToIntInst(PtrToIntInst &I);
206 void visitBitCastInst(BitCastInst &I);
207 void visitPHINode(PHINode &PN);
208 void visitBinaryOperator(BinaryOperator &B);
209 void visitICmpInst(ICmpInst &IC);
210 void visitFCmpInst(FCmpInst &FC);
211 void visitExtractElementInst(ExtractElementInst &EI);
212 void visitInsertElementInst(InsertElementInst &EI);
213 void visitShuffleVectorInst(ShuffleVectorInst &EI);
214 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
215 void visitCallInst(CallInst &CI);
216 void visitGetElementPtrInst(GetElementPtrInst &GEP);
217 void visitLoadInst(LoadInst &LI);
218 void visitStoreInst(StoreInst &SI);
219 void visitInstruction(Instruction &I);
220 void visitTerminatorInst(TerminatorInst &I);
221 void visitReturnInst(ReturnInst &RI);
222 void visitSwitchInst(SwitchInst &SI);
223 void visitSelectInst(SelectInst &SI);
224 void visitUserOp1(Instruction &I);
225 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
226 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
228 void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F, ...);
230 void WriteValue(const Value *V) {
232 if (isa<Instruction>(V)) {
235 WriteAsOperand(msgs, V, true, Mod);
240 void WriteType(const Type* T ) {
242 WriteTypeSymbolic(msgs, T, Mod );
246 // CheckFailed - A check failed, so print out the condition and the message
247 // that failed. This provides a nice place to put a breakpoint if you want
248 // to see why something is not correct.
249 void CheckFailed(const std::string &Message,
250 const Value *V1 = 0, const Value *V2 = 0,
251 const Value *V3 = 0, const Value *V4 = 0) {
252 msgs << Message << "\n";
260 void CheckFailed( const std::string& Message, const Value* V1,
261 const Type* T2, const Value* V3 = 0 ) {
262 msgs << Message << "\n";
270 char Verifier::ID = 0;
271 RegisterPass<Verifier> X("verify", "Module Verifier");
272 } // End anonymous namespace
275 // Assert - We know that cond should be true, if not print an error message.
276 #define Assert(C, M) \
277 do { if (!(C)) { CheckFailed(M); return; } } while (0)
278 #define Assert1(C, M, V1) \
279 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
280 #define Assert2(C, M, V1, V2) \
281 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
282 #define Assert3(C, M, V1, V2, V3) \
283 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
284 #define Assert4(C, M, V1, V2, V3, V4) \
285 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
288 void Verifier::visitGlobalValue(GlobalValue &GV) {
289 Assert1(!GV.isDeclaration() ||
290 GV.hasExternalLinkage() ||
291 GV.hasDLLImportLinkage() ||
292 GV.hasExternalWeakLinkage() ||
293 (isa<GlobalAlias>(GV) &&
294 (GV.hasInternalLinkage() || GV.hasWeakLinkage())),
295 "Global is external, but doesn't have external or dllimport or weak linkage!",
298 Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
299 "Global is marked as dllimport, but not external", &GV);
301 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
302 "Only global variables can have appending linkage!", &GV);
304 if (GV.hasAppendingLinkage()) {
305 GlobalVariable &GVar = cast<GlobalVariable>(GV);
306 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
307 "Only global arrays can have appending linkage!", &GV);
311 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
312 if (GV.hasInitializer())
313 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
314 "Global variable initializer type does not match global "
315 "variable type!", &GV);
317 visitGlobalValue(GV);
320 void Verifier::visitGlobalAlias(GlobalAlias &GA) {
321 Assert1(!GA.getName().empty(),
322 "Alias name cannot be empty!", &GA);
323 Assert1(GA.hasExternalLinkage() || GA.hasInternalLinkage() ||
325 "Alias should have external or external weak linkage!", &GA);
326 Assert1(GA.getType() == GA.getAliasee()->getType(),
327 "Alias and aliasee types should match!", &GA);
329 if (!isa<GlobalValue>(GA.getAliasee())) {
330 const ConstantExpr *CE = dyn_cast<ConstantExpr>(GA.getAliasee());
331 Assert1(CE && CE->getOpcode() == Instruction::BitCast &&
332 isa<GlobalValue>(CE->getOperand(0)),
333 "Aliasee should be either GlobalValue or bitcast of GlobalValue",
337 visitGlobalValue(GA);
340 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
343 // visitFunction - Verify that a function is ok.
345 void Verifier::visitFunction(Function &F) {
346 // Check function arguments.
347 const FunctionType *FT = F.getFunctionType();
348 unsigned NumArgs = F.getArgumentList().size();
350 Assert2(FT->getNumParams() == NumArgs,
351 "# formal arguments must match # of arguments for function type!",
353 Assert1(F.getReturnType()->isFirstClassType() ||
354 F.getReturnType() == Type::VoidTy,
355 "Functions cannot return aggregate values!", &F);
357 Assert1(!FT->isStructReturn() ||
358 (FT->getReturnType() == Type::VoidTy &&
359 FT->getNumParams() > 0 && isa<PointerType>(FT->getParamType(0))),
360 "Invalid struct-return function!", &F);
362 if (const ParamAttrsList *Attrs = FT->getParamAttrs()) {
365 Assert(!Attrs->paramHasAttr(0, ParamAttr::ByVal),
366 "Attribute ByVal should not apply to functions!");
368 for (FunctionType::param_iterator I = FT->param_begin(),
369 E = FT->param_end(); I != E; ++I, ++Idx) {
370 if (Attrs->paramHasAttr(Idx, ParamAttr::ZExt) ||
371 Attrs->paramHasAttr(Idx, ParamAttr::SExt))
372 Assert1(FT->getParamType(Idx-1)->isInteger(),
373 "Attribute ZExt should only apply to Integer type!", &F);
374 if (Attrs->paramHasAttr(Idx, ParamAttr::NoAlias))
375 Assert1(isa<PointerType>(FT->getParamType(Idx-1)),
376 "Attribute NoAlias should only apply to Pointer type!", &F);
377 if (Attrs->paramHasAttr(Idx, ParamAttr::ByVal)) {
378 Assert1(isa<PointerType>(FT->getParamType(Idx-1)),
379 "Attribute ByVal should only apply to pointer to structs!", &F);
380 const PointerType *Ty =
381 cast<PointerType>(FT->getParamType(Idx-1));
382 Assert1(isa<StructType>(Ty->getElementType()),
383 "Attribute ByVal should only apply to pointer to structs!", &F);
388 // Check that this function meets the restrictions on this calling convention.
389 switch (F.getCallingConv()) {
394 case CallingConv::Fast:
395 case CallingConv::Cold:
396 case CallingConv::X86_FastCall:
397 Assert1(!F.isVarArg(),
398 "Varargs functions must have C calling conventions!", &F);
402 // Check that the argument values match the function type for this function...
404 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
406 Assert2(I->getType() == FT->getParamType(i),
407 "Argument value does not match function argument type!",
408 I, FT->getParamType(i));
409 // Make sure no aggregates are passed by value.
410 Assert1(I->getType()->isFirstClassType(),
411 "Functions cannot take aggregates as arguments by value!", I);
414 if (!F.isDeclaration()) {
415 // Verify that this function (which has a body) is not named "llvm.*". It
416 // is not legal to define intrinsics.
417 if (F.getName().size() >= 5)
418 Assert1(F.getName().substr(0, 5) != "llvm.",
419 "llvm intrinsics cannot be defined!", &F);
421 // Check the entry node
422 BasicBlock *Entry = &F.getEntryBlock();
423 Assert1(pred_begin(Entry) == pred_end(Entry),
424 "Entry block to function must not have predecessors!", Entry);
429 // verifyBasicBlock - Verify that a basic block is well formed...
431 void Verifier::visitBasicBlock(BasicBlock &BB) {
432 InstsInThisBlock.clear();
434 // Ensure that basic blocks have terminators!
435 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
437 // Check constraints that this basic block imposes on all of the PHI nodes in
439 if (isa<PHINode>(BB.front())) {
440 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
441 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
442 std::sort(Preds.begin(), Preds.end());
444 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
446 // Ensure that PHI nodes have at least one entry!
447 Assert1(PN->getNumIncomingValues() != 0,
448 "PHI nodes must have at least one entry. If the block is dead, "
449 "the PHI should be removed!", PN);
450 Assert1(PN->getNumIncomingValues() == Preds.size(),
451 "PHINode should have one entry for each predecessor of its "
452 "parent basic block!", PN);
454 // Get and sort all incoming values in the PHI node...
456 Values.reserve(PN->getNumIncomingValues());
457 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
458 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
459 PN->getIncomingValue(i)));
460 std::sort(Values.begin(), Values.end());
462 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
463 // Check to make sure that if there is more than one entry for a
464 // particular basic block in this PHI node, that the incoming values are
467 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
468 Values[i].second == Values[i-1].second,
469 "PHI node has multiple entries for the same basic block with "
470 "different incoming values!", PN, Values[i].first,
471 Values[i].second, Values[i-1].second);
473 // Check to make sure that the predecessors and PHI node entries are
475 Assert3(Values[i].first == Preds[i],
476 "PHI node entries do not match predecessors!", PN,
477 Values[i].first, Preds[i]);
483 void Verifier::visitTerminatorInst(TerminatorInst &I) {
484 // Ensure that terminators only exist at the end of the basic block.
485 Assert1(&I == I.getParent()->getTerminator(),
486 "Terminator found in the middle of a basic block!", I.getParent());
490 void Verifier::visitReturnInst(ReturnInst &RI) {
491 Function *F = RI.getParent()->getParent();
492 if (RI.getNumOperands() == 0)
493 Assert2(F->getReturnType() == Type::VoidTy,
494 "Found return instr that returns void in Function of non-void "
495 "return type!", &RI, F->getReturnType());
497 Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
498 "Function return type does not match operand "
499 "type of return inst!", &RI, F->getReturnType());
501 // Check to make sure that the return value has necessary properties for
503 visitTerminatorInst(RI);
506 void Verifier::visitSwitchInst(SwitchInst &SI) {
507 // Check to make sure that all of the constants in the switch instruction
508 // have the same type as the switched-on value.
509 const Type *SwitchTy = SI.getCondition()->getType();
510 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
511 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
512 "Switch constants must all be same type as switch value!", &SI);
514 visitTerminatorInst(SI);
517 void Verifier::visitSelectInst(SelectInst &SI) {
518 Assert1(SI.getCondition()->getType() == Type::Int1Ty,
519 "Select condition type must be bool!", &SI);
520 Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
521 "Select values must have identical types!", &SI);
522 Assert1(SI.getTrueValue()->getType() == SI.getType(),
523 "Select values must have same type as select instruction!", &SI);
524 visitInstruction(SI);
528 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
529 /// a pass, if any exist, it's an error.
531 void Verifier::visitUserOp1(Instruction &I) {
532 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
535 void Verifier::visitTruncInst(TruncInst &I) {
536 // Get the source and destination types
537 const Type *SrcTy = I.getOperand(0)->getType();
538 const Type *DestTy = I.getType();
540 // Get the size of the types in bits, we'll need this later
541 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
542 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
544 Assert1(SrcTy->isInteger(), "Trunc only operates on integer", &I);
545 Assert1(DestTy->isInteger(), "Trunc only produces integer", &I);
546 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
551 void Verifier::visitZExtInst(ZExtInst &I) {
552 // Get the source and destination types
553 const Type *SrcTy = I.getOperand(0)->getType();
554 const Type *DestTy = I.getType();
556 // Get the size of the types in bits, we'll need this later
557 Assert1(SrcTy->isInteger(), "ZExt only operates on integer", &I);
558 Assert1(DestTy->isInteger(), "ZExt only produces an integer", &I);
559 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
560 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
562 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
567 void Verifier::visitSExtInst(SExtInst &I) {
568 // Get the source and destination types
569 const Type *SrcTy = I.getOperand(0)->getType();
570 const Type *DestTy = I.getType();
572 // Get the size of the types in bits, we'll need this later
573 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
574 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
576 Assert1(SrcTy->isInteger(), "SExt only operates on integer", &I);
577 Assert1(DestTy->isInteger(), "SExt only produces an integer", &I);
578 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
583 void Verifier::visitFPTruncInst(FPTruncInst &I) {
584 // Get the source and destination types
585 const Type *SrcTy = I.getOperand(0)->getType();
586 const Type *DestTy = I.getType();
587 // Get the size of the types in bits, we'll need this later
588 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
589 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
591 Assert1(SrcTy->isFloatingPoint(),"FPTrunc only operates on FP", &I);
592 Assert1(DestTy->isFloatingPoint(),"FPTrunc only produces an FP", &I);
593 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
598 void Verifier::visitFPExtInst(FPExtInst &I) {
599 // Get the source and destination types
600 const Type *SrcTy = I.getOperand(0)->getType();
601 const Type *DestTy = I.getType();
603 // Get the size of the types in bits, we'll need this later
604 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
605 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
607 Assert1(SrcTy->isFloatingPoint(),"FPExt only operates on FP", &I);
608 Assert1(DestTy->isFloatingPoint(),"FPExt only produces an FP", &I);
609 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
614 void Verifier::visitUIToFPInst(UIToFPInst &I) {
615 // Get the source and destination types
616 const Type *SrcTy = I.getOperand(0)->getType();
617 const Type *DestTy = I.getType();
619 Assert1(SrcTy->isInteger(),"UInt2FP source must be integral", &I);
620 Assert1(DestTy->isFloatingPoint(),"UInt2FP result must be FP", &I);
625 void Verifier::visitSIToFPInst(SIToFPInst &I) {
626 // Get the source and destination types
627 const Type *SrcTy = I.getOperand(0)->getType();
628 const Type *DestTy = I.getType();
630 Assert1(SrcTy->isInteger(),"SInt2FP source must be integral", &I);
631 Assert1(DestTy->isFloatingPoint(),"SInt2FP result must be FP", &I);
636 void Verifier::visitFPToUIInst(FPToUIInst &I) {
637 // Get the source and destination types
638 const Type *SrcTy = I.getOperand(0)->getType();
639 const Type *DestTy = I.getType();
641 Assert1(SrcTy->isFloatingPoint(),"FP2UInt source must be FP", &I);
642 Assert1(DestTy->isInteger(),"FP2UInt result must be integral", &I);
647 void Verifier::visitFPToSIInst(FPToSIInst &I) {
648 // Get the source and destination types
649 const Type *SrcTy = I.getOperand(0)->getType();
650 const Type *DestTy = I.getType();
652 Assert1(SrcTy->isFloatingPoint(),"FPToSI source must be FP", &I);
653 Assert1(DestTy->isInteger(),"FP2ToI result must be integral", &I);
658 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
659 // Get the source and destination types
660 const Type *SrcTy = I.getOperand(0)->getType();
661 const Type *DestTy = I.getType();
663 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
664 Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
669 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
670 // Get the source and destination types
671 const Type *SrcTy = I.getOperand(0)->getType();
672 const Type *DestTy = I.getType();
674 Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
675 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
680 void Verifier::visitBitCastInst(BitCastInst &I) {
681 // Get the source and destination types
682 const Type *SrcTy = I.getOperand(0)->getType();
683 const Type *DestTy = I.getType();
685 // Get the size of the types in bits, we'll need this later
686 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
687 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
689 // BitCast implies a no-op cast of type only. No bits change.
690 // However, you can't cast pointers to anything but pointers.
691 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
692 "Bitcast requires both operands to be pointer or neither", &I);
693 Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
698 /// visitPHINode - Ensure that a PHI node is well formed.
700 void Verifier::visitPHINode(PHINode &PN) {
701 // Ensure that the PHI nodes are all grouped together at the top of the block.
702 // This can be tested by checking whether the instruction before this is
703 // either nonexistent (because this is begin()) or is a PHI node. If not,
704 // then there is some other instruction before a PHI.
705 Assert2(&PN == &PN.getParent()->front() ||
706 isa<PHINode>(--BasicBlock::iterator(&PN)),
707 "PHI nodes not grouped at top of basic block!",
708 &PN, PN.getParent());
710 // Check that all of the operands of the PHI node have the same type as the
712 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
713 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
714 "PHI node operands are not the same type as the result!", &PN);
716 // All other PHI node constraints are checked in the visitBasicBlock method.
718 visitInstruction(PN);
721 void Verifier::visitCallInst(CallInst &CI) {
722 Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
723 "Called function must be a pointer!", &CI);
724 const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
725 Assert1(isa<FunctionType>(FPTy->getElementType()),
726 "Called function is not pointer to function type!", &CI);
728 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
730 // Verify that the correct number of arguments are being passed
732 Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
733 "Called function requires more parameters than were provided!",&CI);
735 Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
736 "Incorrect number of arguments passed to called function!", &CI);
738 // Verify that all arguments to the call match the function type...
739 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
740 Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
741 "Call parameter type does not match function signature!",
742 CI.getOperand(i+1), FTy->getParamType(i), &CI);
744 if (Function *F = CI.getCalledFunction())
745 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
746 visitIntrinsicFunctionCall(ID, CI);
748 visitInstruction(CI);
751 /// visitBinaryOperator - Check that both arguments to the binary operator are
752 /// of the same type!
754 void Verifier::visitBinaryOperator(BinaryOperator &B) {
755 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
756 "Both operands to a binary operator are not of the same type!", &B);
758 switch (B.getOpcode()) {
759 // Check that logical operators are only used with integral operands.
760 case Instruction::And:
761 case Instruction::Or:
762 case Instruction::Xor:
763 Assert1(B.getType()->isInteger() ||
764 (isa<VectorType>(B.getType()) &&
765 cast<VectorType>(B.getType())->getElementType()->isInteger()),
766 "Logical operators only work with integral types!", &B);
767 Assert1(B.getType() == B.getOperand(0)->getType(),
768 "Logical operators must have same type for operands and result!",
771 case Instruction::Shl:
772 case Instruction::LShr:
773 case Instruction::AShr:
774 Assert1(B.getType()->isInteger(),
775 "Shift must return an integer result!", &B);
776 Assert1(B.getType() == B.getOperand(0)->getType(),
777 "Shift return type must be same as operands!", &B);
780 // Arithmetic operators only work on integer or fp values
781 Assert1(B.getType() == B.getOperand(0)->getType(),
782 "Arithmetic operators must have same type for operands and result!",
784 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
785 isa<VectorType>(B.getType()),
786 "Arithmetic operators must have integer, fp, or vector type!", &B);
793 void Verifier::visitICmpInst(ICmpInst& IC) {
794 // Check that the operands are the same type
795 const Type* Op0Ty = IC.getOperand(0)->getType();
796 const Type* Op1Ty = IC.getOperand(1)->getType();
797 Assert1(Op0Ty == Op1Ty,
798 "Both operands to ICmp instruction are not of the same type!", &IC);
799 // Check that the operands are the right type
800 Assert1(Op0Ty->isInteger() || isa<PointerType>(Op0Ty),
801 "Invalid operand types for ICmp instruction", &IC);
802 visitInstruction(IC);
805 void Verifier::visitFCmpInst(FCmpInst& FC) {
806 // Check that the operands are the same type
807 const Type* Op0Ty = FC.getOperand(0)->getType();
808 const Type* Op1Ty = FC.getOperand(1)->getType();
809 Assert1(Op0Ty == Op1Ty,
810 "Both operands to FCmp instruction are not of the same type!", &FC);
811 // Check that the operands are the right type
812 Assert1(Op0Ty->isFloatingPoint(),
813 "Invalid operand types for FCmp instruction", &FC);
814 visitInstruction(FC);
817 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
818 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
820 "Invalid extractelement operands!", &EI);
821 visitInstruction(EI);
824 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
825 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
828 "Invalid insertelement operands!", &IE);
829 visitInstruction(IE);
832 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
833 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
835 "Invalid shufflevector operands!", &SV);
836 Assert1(SV.getType() == SV.getOperand(0)->getType(),
837 "Result of shufflevector must match first operand type!", &SV);
839 // Check to see if Mask is valid.
840 if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
841 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
842 Assert1(isa<ConstantInt>(MV->getOperand(i)) ||
843 isa<UndefValue>(MV->getOperand(i)),
844 "Invalid shufflevector shuffle mask!", &SV);
847 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
848 isa<ConstantAggregateZero>(SV.getOperand(2)),
849 "Invalid shufflevector shuffle mask!", &SV);
852 visitInstruction(SV);
855 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
856 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
858 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
859 &Idxs[0], Idxs.size(), true);
860 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
861 Assert2(isa<PointerType>(GEP.getType()) &&
862 cast<PointerType>(GEP.getType())->getElementType() == ElTy,
863 "GEP is not of right type for indices!", &GEP, ElTy);
864 visitInstruction(GEP);
867 void Verifier::visitLoadInst(LoadInst &LI) {
869 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
870 Assert2(ElTy == LI.getType(),
871 "Load result type does not match pointer operand type!", &LI, ElTy);
872 visitInstruction(LI);
875 void Verifier::visitStoreInst(StoreInst &SI) {
877 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
878 Assert2(ElTy == SI.getOperand(0)->getType(),
879 "Stored value type does not match pointer operand type!", &SI, ElTy);
880 visitInstruction(SI);
884 /// verifyInstruction - Verify that an instruction is well formed.
886 void Verifier::visitInstruction(Instruction &I) {
887 BasicBlock *BB = I.getParent();
888 Assert1(BB, "Instruction not embedded in basic block!", &I);
890 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
891 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
893 Assert1(*UI != (User*)&I ||
894 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
895 "Only PHI nodes may reference their own value!", &I);
898 // Check that void typed values don't have names
899 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
900 "Instruction has a name, but provides a void value!", &I);
902 // Check that the return value of the instruction is either void or a legal
904 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
905 "Instruction returns a non-scalar type!", &I);
907 // Check that all uses of the instruction, if they are instructions
908 // themselves, actually have parent basic blocks. If the use is not an
909 // instruction, it is an error!
910 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
912 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
914 Instruction *Used = cast<Instruction>(*UI);
915 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
916 " embeded in a basic block!", &I, Used);
919 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
920 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
922 // Check to make sure that only first-class-values are operands to
924 Assert1(I.getOperand(i)->getType()->isFirstClassType(),
925 "Instruction operands must be first-class values!", &I);
927 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
928 // Check to make sure that the "address of" an intrinsic function is never
930 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
931 "Cannot take the address of an intrinsic!", &I);
932 Assert1(F->getParent() == Mod, "Referencing function in another module!",
934 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
935 Assert1(OpBB->getParent() == BB->getParent(),
936 "Referring to a basic block in another function!", &I);
937 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
938 Assert1(OpArg->getParent() == BB->getParent(),
939 "Referring to an argument in another function!", &I);
940 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
941 Assert1(GV->getParent() == Mod, "Referencing global in another module!",
943 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
944 BasicBlock *OpBlock = Op->getParent();
946 // Check that a definition dominates all of its uses.
947 if (!isa<PHINode>(I)) {
948 // Invoke results are only usable in the normal destination, not in the
949 // exceptional destination.
950 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
951 OpBlock = II->getNormalDest();
953 Assert2(OpBlock != II->getUnwindDest(),
954 "No uses of invoke possible due to dominance structure!",
957 // If the normal successor of an invoke instruction has multiple
958 // predecessors, then the normal edge from the invoke is critical, so
959 // the invoke value can only be live if the destination block
960 // dominates all of it's predecessors (other than the invoke) or if
961 // the invoke value is only used by a phi in the successor.
962 if (!OpBlock->getSinglePredecessor() &&
963 DT->dominates(&BB->getParent()->getEntryBlock(), BB)) {
964 // The first case we allow is if the use is a PHI operand in the
965 // normal block, and if that PHI operand corresponds to the invoke's
968 if (PHINode *PN = dyn_cast<PHINode>(&I))
969 if (PN->getParent() == OpBlock &&
970 PN->getIncomingBlock(i/2) == Op->getParent())
973 // If it is used by something non-phi, then the other case is that
974 // 'OpBlock' dominates all of its predecessors other than the
975 // invoke. In this case, the invoke value can still be used.
978 for (pred_iterator PI = pred_begin(OpBlock),
979 E = pred_end(OpBlock); PI != E; ++PI) {
980 if (*PI != II->getParent() && !DT->dominates(OpBlock, *PI)) {
987 "Invoke value defined on critical edge but not dead!", &I,
990 } else if (OpBlock == BB) {
991 // If they are in the same basic block, make sure that the definition
992 // comes before the use.
993 Assert2(InstsInThisBlock.count(Op) ||
994 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
995 "Instruction does not dominate all uses!", Op, &I);
998 // Definition must dominate use unless use is unreachable!
999 Assert2(DT->dominates(OpBlock, BB) ||
1000 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1001 "Instruction does not dominate all uses!", Op, &I);
1003 // PHI nodes are more difficult than other nodes because they actually
1004 // "use" the value in the predecessor basic blocks they correspond to.
1005 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
1006 Assert2(DT->dominates(OpBlock, PredBB) ||
1007 !DT->dominates(&BB->getParent()->getEntryBlock(), PredBB),
1008 "Instruction does not dominate all uses!", Op, &I);
1010 } else if (isa<InlineAsm>(I.getOperand(i))) {
1011 Assert1(i == 0 && isa<CallInst>(I),
1012 "Cannot take the address of an inline asm!", &I);
1015 InstsInThisBlock.insert(&I);
1018 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1020 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1021 Function *IF = CI.getCalledFunction();
1022 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1025 #define GET_INTRINSIC_VERIFIER
1026 #include "llvm/Intrinsics.gen"
1027 #undef GET_INTRINSIC_VERIFIER
1030 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1031 /// Intrinsics.gen. This implements a little state machine that verifies the
1032 /// prototype of intrinsics.
1033 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F, ...) {
1037 const FunctionType *FTy = F->getFunctionType();
1039 // For overloaded intrinsics, the Suffix of the function name must match the
1040 // types of the arguments. This variable keeps track of the expected
1041 // suffix, to be checked at the end.
1044 // Note that "arg#0" is the return type.
1045 for (unsigned ArgNo = 0; 1; ++ArgNo) {
1046 int TypeID = va_arg(VA, int);
1053 if (ArgNo != FTy->getNumParams()+1)
1054 CheckFailed("Intrinsic prototype has too many arguments!", F);
1058 if (ArgNo == FTy->getNumParams()+1) {
1059 CheckFailed("Intrinsic prototype has too few arguments!", F);
1065 Ty = FTy->getReturnType();
1067 Ty = FTy->getParamType(ArgNo-1);
1069 if (TypeID != Ty->getTypeID()) {
1071 CheckFailed("Intrinsic prototype has incorrect result type!", F);
1073 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
1077 if (TypeID == Type::IntegerTyID) {
1078 unsigned ExpectedBits = (unsigned) va_arg(VA, int);
1079 unsigned GotBits = cast<IntegerType>(Ty)->getBitWidth();
1080 if (ExpectedBits == 0) {
1081 Suffix += ".i" + utostr(GotBits);
1082 } else if (GotBits != ExpectedBits) {
1083 std::string bitmsg = " Expected " + utostr(ExpectedBits) + " but got "+
1084 utostr(GotBits) + " bits.";
1086 CheckFailed("Intrinsic prototype has incorrect integer result width!"
1089 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " has "
1090 "incorrect integer width!" + bitmsg, F);
1093 // Check some constraints on various intrinsics.
1095 default: break; // Not everything needs to be checked.
1096 case Intrinsic::bswap:
1097 if (GotBits < 16 || GotBits % 16 != 0)
1098 CheckFailed("Intrinsic requires even byte width argument", F);
1100 case Intrinsic::part_set:
1101 case Intrinsic::part_select:
1103 unsigned ResultBits =
1104 cast<IntegerType>(FTy->getReturnType())->getBitWidth();
1105 if (GotBits != ResultBits)
1106 CheckFailed("Intrinsic requires the bit widths of the first "
1107 "parameter and the result to match", F);
1111 } else if (TypeID == Type::VectorTyID) {
1112 // If this is a vector argument, verify the number and type of elements.
1113 const VectorType *PTy = cast<VectorType>(Ty);
1114 int ElemTy = va_arg(VA, int);
1115 if (ElemTy != PTy->getElementType()->getTypeID()) {
1116 CheckFailed("Intrinsic prototype has incorrect vector element type!",
1120 if (ElemTy == Type::IntegerTyID) {
1121 unsigned NumBits = (unsigned)va_arg(VA, int);
1122 unsigned ExpectedBits =
1123 cast<IntegerType>(PTy->getElementType())->getBitWidth();
1124 if (NumBits != ExpectedBits) {
1125 CheckFailed("Intrinsic prototype has incorrect vector element type!",
1130 if ((unsigned)va_arg(VA, int) != PTy->getNumElements()) {
1131 CheckFailed("Intrinsic prototype has incorrect number of "
1132 "vector elements!",F);
1140 // If we computed a Suffix then the intrinsic is overloaded and we need to
1141 // make sure that the name of the function is correct. We add the suffix to
1142 // the name of the intrinsic and compare against the given function name. If
1143 // they are not the same, the function name is invalid. This ensures that
1144 // overloading of intrinsics uses a sane and consistent naming convention.
1145 if (!Suffix.empty()) {
1146 std::string Name(Intrinsic::getName(ID));
1147 if (Name + Suffix != F->getName())
1148 CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1149 F->getName().substr(Name.length()) + "'. It should be '" +
1155 //===----------------------------------------------------------------------===//
1156 // Implement the public interfaces to this file...
1157 //===----------------------------------------------------------------------===//
1159 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1160 return new Verifier(action);
1164 // verifyFunction - Create
1165 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1166 Function &F = const_cast<Function&>(f);
1167 assert(!F.isDeclaration() && "Cannot verify external functions");
1169 FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
1170 Verifier *V = new Verifier(action);
1176 /// verifyModule - Check a module for errors, printing messages on stderr.
1177 /// Return true if the module is corrupt.
1179 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1180 std::string *ErrorInfo) {
1182 Verifier *V = new Verifier(action);
1186 if (ErrorInfo && V->Broken)
1187 *ErrorInfo = V->msgs.str();