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() || FT->getReturnType() == Type::VoidTy,
358 "Invalid struct-return function!", &F);
360 const uint16_t ReturnIncompatible =
361 ParamAttr::ByVal | ParamAttr::InReg |
362 ParamAttr::Nest | ParamAttr::StructRet;
364 const uint16_t ParameterIncompatible =
365 ParamAttr::NoReturn | ParamAttr::NoUnwind;
367 const uint16_t MutuallyIncompatible =
368 ParamAttr::ByVal | ParamAttr::InReg |
369 ParamAttr::Nest | ParamAttr::StructRet;
371 const uint16_t IntegerTypeOnly =
372 ParamAttr::SExt | ParamAttr::ZExt;
374 const uint16_t PointerTypeOnly =
375 ParamAttr::ByVal | ParamAttr::Nest |
376 ParamAttr::NoAlias | ParamAttr::StructRet;
378 bool SawSRet = false;
380 if (const ParamAttrsList *Attrs = FT->getParamAttrs()) {
382 bool SawNest = false;
384 uint16_t RetI = Attrs->getParamAttrs(0) & ReturnIncompatible;
385 Assert1(!RetI, "Attribute " + Attrs->getParamAttrsText(RetI) +
386 "should not apply to functions!", &F);
388 for (FunctionType::param_iterator I = FT->param_begin(),
389 E = FT->param_end(); I != E; ++I, ++Idx) {
391 uint16_t Attr = Attrs->getParamAttrs(Idx);
393 uint16_t ParmI = Attr & ParameterIncompatible;
394 Assert1(!ParmI, "Attribute " + Attrs->getParamAttrsText(ParmI) +
395 "should only be applied to function!", &F);
397 uint16_t MutI = Attr & MutuallyIncompatible;
398 Assert1(!(MutI & (MutI - 1)), "Attributes " +
399 Attrs->getParamAttrsText(MutI) + "are incompatible!", &F);
401 uint16_t IType = Attr & IntegerTypeOnly;
402 Assert1(!IType || FT->getParamType(Idx-1)->isInteger(),
403 "Attribute " + Attrs->getParamAttrsText(IType) +
404 "should only apply to Integer type!", &F);
406 uint16_t PType = Attr & PointerTypeOnly;
407 Assert1(!PType || isa<PointerType>(FT->getParamType(Idx-1)),
408 "Attribute " + Attrs->getParamAttrsText(PType) +
409 "should only apply to Pointer type!", &F);
411 if (Attrs->paramHasAttr(Idx, ParamAttr::ByVal)) {
412 const PointerType *Ty =
413 dyn_cast<PointerType>(FT->getParamType(Idx-1));
414 Assert1(!Ty || isa<StructType>(Ty->getElementType()),
415 "Attribute byval should only apply to pointer to structs!", &F);
418 if (Attrs->paramHasAttr(Idx, ParamAttr::Nest)) {
419 Assert1(!SawNest, "More than one parameter has attribute nest!", &F);
423 if (Attrs->paramHasAttr(Idx, ParamAttr::StructRet)) {
425 Assert1(Idx == 1, "Attribute sret not on first parameter!", &F);
430 Assert1(SawSRet == FT->isStructReturn(),
431 "StructReturn function with no sret attribute!", &F);
433 // Check that this function meets the restrictions on this calling convention.
434 switch (F.getCallingConv()) {
439 case CallingConv::Fast:
440 case CallingConv::Cold:
441 case CallingConv::X86_FastCall:
442 Assert1(!F.isVarArg(),
443 "Varargs functions must have C calling conventions!", &F);
447 // Check that the argument values match the function type for this function...
449 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
451 Assert2(I->getType() == FT->getParamType(i),
452 "Argument value does not match function argument type!",
453 I, FT->getParamType(i));
454 // Make sure no aggregates are passed by value.
455 Assert1(I->getType()->isFirstClassType(),
456 "Functions cannot take aggregates as arguments by value!", I);
459 if (!F.isDeclaration()) {
460 // Verify that this function (which has a body) is not named "llvm.*". It
461 // is not legal to define intrinsics.
462 if (F.getName().size() >= 5)
463 Assert1(F.getName().substr(0, 5) != "llvm.",
464 "llvm intrinsics cannot be defined!", &F);
466 // Check the entry node
467 BasicBlock *Entry = &F.getEntryBlock();
468 Assert1(pred_begin(Entry) == pred_end(Entry),
469 "Entry block to function must not have predecessors!", Entry);
474 // verifyBasicBlock - Verify that a basic block is well formed...
476 void Verifier::visitBasicBlock(BasicBlock &BB) {
477 InstsInThisBlock.clear();
479 // Ensure that basic blocks have terminators!
480 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
482 // Check constraints that this basic block imposes on all of the PHI nodes in
484 if (isa<PHINode>(BB.front())) {
485 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
486 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
487 std::sort(Preds.begin(), Preds.end());
489 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
491 // Ensure that PHI nodes have at least one entry!
492 Assert1(PN->getNumIncomingValues() != 0,
493 "PHI nodes must have at least one entry. If the block is dead, "
494 "the PHI should be removed!", PN);
495 Assert1(PN->getNumIncomingValues() == Preds.size(),
496 "PHINode should have one entry for each predecessor of its "
497 "parent basic block!", PN);
499 // Get and sort all incoming values in the PHI node...
501 Values.reserve(PN->getNumIncomingValues());
502 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
503 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
504 PN->getIncomingValue(i)));
505 std::sort(Values.begin(), Values.end());
507 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
508 // Check to make sure that if there is more than one entry for a
509 // particular basic block in this PHI node, that the incoming values are
512 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
513 Values[i].second == Values[i-1].second,
514 "PHI node has multiple entries for the same basic block with "
515 "different incoming values!", PN, Values[i].first,
516 Values[i].second, Values[i-1].second);
518 // Check to make sure that the predecessors and PHI node entries are
520 Assert3(Values[i].first == Preds[i],
521 "PHI node entries do not match predecessors!", PN,
522 Values[i].first, Preds[i]);
528 void Verifier::visitTerminatorInst(TerminatorInst &I) {
529 // Ensure that terminators only exist at the end of the basic block.
530 Assert1(&I == I.getParent()->getTerminator(),
531 "Terminator found in the middle of a basic block!", I.getParent());
535 void Verifier::visitReturnInst(ReturnInst &RI) {
536 Function *F = RI.getParent()->getParent();
537 if (RI.getNumOperands() == 0)
538 Assert2(F->getReturnType() == Type::VoidTy,
539 "Found return instr that returns void in Function of non-void "
540 "return type!", &RI, F->getReturnType());
542 Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
543 "Function return type does not match operand "
544 "type of return inst!", &RI, F->getReturnType());
546 // Check to make sure that the return value has necessary properties for
548 visitTerminatorInst(RI);
551 void Verifier::visitSwitchInst(SwitchInst &SI) {
552 // Check to make sure that all of the constants in the switch instruction
553 // have the same type as the switched-on value.
554 const Type *SwitchTy = SI.getCondition()->getType();
555 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
556 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
557 "Switch constants must all be same type as switch value!", &SI);
559 visitTerminatorInst(SI);
562 void Verifier::visitSelectInst(SelectInst &SI) {
563 Assert1(SI.getCondition()->getType() == Type::Int1Ty,
564 "Select condition type must be bool!", &SI);
565 Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
566 "Select values must have identical types!", &SI);
567 Assert1(SI.getTrueValue()->getType() == SI.getType(),
568 "Select values must have same type as select instruction!", &SI);
569 visitInstruction(SI);
573 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
574 /// a pass, if any exist, it's an error.
576 void Verifier::visitUserOp1(Instruction &I) {
577 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
580 void Verifier::visitTruncInst(TruncInst &I) {
581 // Get the source and destination types
582 const Type *SrcTy = I.getOperand(0)->getType();
583 const Type *DestTy = I.getType();
585 // Get the size of the types in bits, we'll need this later
586 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
587 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
589 Assert1(SrcTy->isInteger(), "Trunc only operates on integer", &I);
590 Assert1(DestTy->isInteger(), "Trunc only produces integer", &I);
591 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
596 void Verifier::visitZExtInst(ZExtInst &I) {
597 // Get the source and destination types
598 const Type *SrcTy = I.getOperand(0)->getType();
599 const Type *DestTy = I.getType();
601 // Get the size of the types in bits, we'll need this later
602 Assert1(SrcTy->isInteger(), "ZExt only operates on integer", &I);
603 Assert1(DestTy->isInteger(), "ZExt only produces an integer", &I);
604 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
605 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
607 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
612 void Verifier::visitSExtInst(SExtInst &I) {
613 // Get the source and destination types
614 const Type *SrcTy = I.getOperand(0)->getType();
615 const Type *DestTy = I.getType();
617 // Get the size of the types in bits, we'll need this later
618 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
619 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
621 Assert1(SrcTy->isInteger(), "SExt only operates on integer", &I);
622 Assert1(DestTy->isInteger(), "SExt only produces an integer", &I);
623 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
628 void Verifier::visitFPTruncInst(FPTruncInst &I) {
629 // Get the source and destination types
630 const Type *SrcTy = I.getOperand(0)->getType();
631 const Type *DestTy = I.getType();
632 // Get the size of the types in bits, we'll need this later
633 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
634 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
636 Assert1(SrcTy->isFloatingPoint(),"FPTrunc only operates on FP", &I);
637 Assert1(DestTy->isFloatingPoint(),"FPTrunc only produces an FP", &I);
638 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
643 void Verifier::visitFPExtInst(FPExtInst &I) {
644 // Get the source and destination types
645 const Type *SrcTy = I.getOperand(0)->getType();
646 const Type *DestTy = I.getType();
648 // Get the size of the types in bits, we'll need this later
649 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
650 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
652 Assert1(SrcTy->isFloatingPoint(),"FPExt only operates on FP", &I);
653 Assert1(DestTy->isFloatingPoint(),"FPExt only produces an FP", &I);
654 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
659 void Verifier::visitUIToFPInst(UIToFPInst &I) {
660 // Get the source and destination types
661 const Type *SrcTy = I.getOperand(0)->getType();
662 const Type *DestTy = I.getType();
664 Assert1(SrcTy->isInteger(),"UInt2FP source must be integral", &I);
665 Assert1(DestTy->isFloatingPoint(),"UInt2FP result must be FP", &I);
670 void Verifier::visitSIToFPInst(SIToFPInst &I) {
671 // Get the source and destination types
672 const Type *SrcTy = I.getOperand(0)->getType();
673 const Type *DestTy = I.getType();
675 Assert1(SrcTy->isInteger(),"SInt2FP source must be integral", &I);
676 Assert1(DestTy->isFloatingPoint(),"SInt2FP result must be FP", &I);
681 void Verifier::visitFPToUIInst(FPToUIInst &I) {
682 // Get the source and destination types
683 const Type *SrcTy = I.getOperand(0)->getType();
684 const Type *DestTy = I.getType();
686 Assert1(SrcTy->isFloatingPoint(),"FP2UInt source must be FP", &I);
687 Assert1(DestTy->isInteger(),"FP2UInt result must be integral", &I);
692 void Verifier::visitFPToSIInst(FPToSIInst &I) {
693 // Get the source and destination types
694 const Type *SrcTy = I.getOperand(0)->getType();
695 const Type *DestTy = I.getType();
697 Assert1(SrcTy->isFloatingPoint(),"FPToSI source must be FP", &I);
698 Assert1(DestTy->isInteger(),"FP2ToI result must be integral", &I);
703 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
704 // Get the source and destination types
705 const Type *SrcTy = I.getOperand(0)->getType();
706 const Type *DestTy = I.getType();
708 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
709 Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
714 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
715 // Get the source and destination types
716 const Type *SrcTy = I.getOperand(0)->getType();
717 const Type *DestTy = I.getType();
719 Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
720 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
725 void Verifier::visitBitCastInst(BitCastInst &I) {
726 // Get the source and destination types
727 const Type *SrcTy = I.getOperand(0)->getType();
728 const Type *DestTy = I.getType();
730 // Get the size of the types in bits, we'll need this later
731 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
732 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
734 // BitCast implies a no-op cast of type only. No bits change.
735 // However, you can't cast pointers to anything but pointers.
736 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
737 "Bitcast requires both operands to be pointer or neither", &I);
738 Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
743 /// visitPHINode - Ensure that a PHI node is well formed.
745 void Verifier::visitPHINode(PHINode &PN) {
746 // Ensure that the PHI nodes are all grouped together at the top of the block.
747 // This can be tested by checking whether the instruction before this is
748 // either nonexistent (because this is begin()) or is a PHI node. If not,
749 // then there is some other instruction before a PHI.
750 Assert2(&PN == &PN.getParent()->front() ||
751 isa<PHINode>(--BasicBlock::iterator(&PN)),
752 "PHI nodes not grouped at top of basic block!",
753 &PN, PN.getParent());
755 // Check that all of the operands of the PHI node have the same type as the
757 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
758 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
759 "PHI node operands are not the same type as the result!", &PN);
761 // All other PHI node constraints are checked in the visitBasicBlock method.
763 visitInstruction(PN);
766 void Verifier::visitCallInst(CallInst &CI) {
767 Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
768 "Called function must be a pointer!", &CI);
769 const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
770 Assert1(isa<FunctionType>(FPTy->getElementType()),
771 "Called function is not pointer to function type!", &CI);
773 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
775 // Verify that the correct number of arguments are being passed
777 Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
778 "Called function requires more parameters than were provided!",&CI);
780 Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
781 "Incorrect number of arguments passed to called function!", &CI);
783 // Verify that all arguments to the call match the function type...
784 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
785 Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
786 "Call parameter type does not match function signature!",
787 CI.getOperand(i+1), FTy->getParamType(i), &CI);
789 if (Function *F = CI.getCalledFunction())
790 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
791 visitIntrinsicFunctionCall(ID, CI);
793 visitInstruction(CI);
796 /// visitBinaryOperator - Check that both arguments to the binary operator are
797 /// of the same type!
799 void Verifier::visitBinaryOperator(BinaryOperator &B) {
800 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
801 "Both operands to a binary operator are not of the same type!", &B);
803 switch (B.getOpcode()) {
804 // Check that logical operators are only used with integral operands.
805 case Instruction::And:
806 case Instruction::Or:
807 case Instruction::Xor:
808 Assert1(B.getType()->isInteger() ||
809 (isa<VectorType>(B.getType()) &&
810 cast<VectorType>(B.getType())->getElementType()->isInteger()),
811 "Logical operators only work with integral types!", &B);
812 Assert1(B.getType() == B.getOperand(0)->getType(),
813 "Logical operators must have same type for operands and result!",
816 case Instruction::Shl:
817 case Instruction::LShr:
818 case Instruction::AShr:
819 Assert1(B.getType()->isInteger(),
820 "Shift must return an integer result!", &B);
821 Assert1(B.getType() == B.getOperand(0)->getType(),
822 "Shift return type must be same as operands!", &B);
825 // Arithmetic operators only work on integer or fp values
826 Assert1(B.getType() == B.getOperand(0)->getType(),
827 "Arithmetic operators must have same type for operands and result!",
829 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
830 isa<VectorType>(B.getType()),
831 "Arithmetic operators must have integer, fp, or vector type!", &B);
838 void Verifier::visitICmpInst(ICmpInst& IC) {
839 // Check that the operands are the same type
840 const Type* Op0Ty = IC.getOperand(0)->getType();
841 const Type* Op1Ty = IC.getOperand(1)->getType();
842 Assert1(Op0Ty == Op1Ty,
843 "Both operands to ICmp instruction are not of the same type!", &IC);
844 // Check that the operands are the right type
845 Assert1(Op0Ty->isInteger() || isa<PointerType>(Op0Ty),
846 "Invalid operand types for ICmp instruction", &IC);
847 visitInstruction(IC);
850 void Verifier::visitFCmpInst(FCmpInst& FC) {
851 // Check that the operands are the same type
852 const Type* Op0Ty = FC.getOperand(0)->getType();
853 const Type* Op1Ty = FC.getOperand(1)->getType();
854 Assert1(Op0Ty == Op1Ty,
855 "Both operands to FCmp instruction are not of the same type!", &FC);
856 // Check that the operands are the right type
857 Assert1(Op0Ty->isFloatingPoint(),
858 "Invalid operand types for FCmp instruction", &FC);
859 visitInstruction(FC);
862 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
863 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
865 "Invalid extractelement operands!", &EI);
866 visitInstruction(EI);
869 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
870 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
873 "Invalid insertelement operands!", &IE);
874 visitInstruction(IE);
877 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
878 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
880 "Invalid shufflevector operands!", &SV);
881 Assert1(SV.getType() == SV.getOperand(0)->getType(),
882 "Result of shufflevector must match first operand type!", &SV);
884 // Check to see if Mask is valid.
885 if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
886 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
887 Assert1(isa<ConstantInt>(MV->getOperand(i)) ||
888 isa<UndefValue>(MV->getOperand(i)),
889 "Invalid shufflevector shuffle mask!", &SV);
892 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
893 isa<ConstantAggregateZero>(SV.getOperand(2)),
894 "Invalid shufflevector shuffle mask!", &SV);
897 visitInstruction(SV);
900 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
901 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
903 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
904 &Idxs[0], Idxs.size(), true);
905 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
906 Assert2(isa<PointerType>(GEP.getType()) &&
907 cast<PointerType>(GEP.getType())->getElementType() == ElTy,
908 "GEP is not of right type for indices!", &GEP, ElTy);
909 visitInstruction(GEP);
912 void Verifier::visitLoadInst(LoadInst &LI) {
914 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
915 Assert2(ElTy == LI.getType(),
916 "Load result type does not match pointer operand type!", &LI, ElTy);
917 visitInstruction(LI);
920 void Verifier::visitStoreInst(StoreInst &SI) {
922 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
923 Assert2(ElTy == SI.getOperand(0)->getType(),
924 "Stored value type does not match pointer operand type!", &SI, ElTy);
925 visitInstruction(SI);
929 /// verifyInstruction - Verify that an instruction is well formed.
931 void Verifier::visitInstruction(Instruction &I) {
932 BasicBlock *BB = I.getParent();
933 Assert1(BB, "Instruction not embedded in basic block!", &I);
935 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
936 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
938 Assert1(*UI != (User*)&I ||
939 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
940 "Only PHI nodes may reference their own value!", &I);
943 // Check that void typed values don't have names
944 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
945 "Instruction has a name, but provides a void value!", &I);
947 // Check that the return value of the instruction is either void or a legal
949 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
950 "Instruction returns a non-scalar type!", &I);
952 // Check that all uses of the instruction, if they are instructions
953 // themselves, actually have parent basic blocks. If the use is not an
954 // instruction, it is an error!
955 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
957 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
959 Instruction *Used = cast<Instruction>(*UI);
960 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
961 " embeded in a basic block!", &I, Used);
964 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
965 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
967 // Check to make sure that only first-class-values are operands to
969 Assert1(I.getOperand(i)->getType()->isFirstClassType(),
970 "Instruction operands must be first-class values!", &I);
972 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
973 // Check to make sure that the "address of" an intrinsic function is never
975 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
976 "Cannot take the address of an intrinsic!", &I);
977 Assert1(F->getParent() == Mod, "Referencing function in another module!",
979 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
980 Assert1(OpBB->getParent() == BB->getParent(),
981 "Referring to a basic block in another function!", &I);
982 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
983 Assert1(OpArg->getParent() == BB->getParent(),
984 "Referring to an argument in another function!", &I);
985 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
986 Assert1(GV->getParent() == Mod, "Referencing global in another module!",
988 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
989 BasicBlock *OpBlock = Op->getParent();
991 // Check that a definition dominates all of its uses.
992 if (!isa<PHINode>(I)) {
993 // Invoke results are only usable in the normal destination, not in the
994 // exceptional destination.
995 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
996 OpBlock = II->getNormalDest();
998 Assert2(OpBlock != II->getUnwindDest(),
999 "No uses of invoke possible due to dominance structure!",
1002 // If the normal successor of an invoke instruction has multiple
1003 // predecessors, then the normal edge from the invoke is critical, so
1004 // the invoke value can only be live if the destination block
1005 // dominates all of it's predecessors (other than the invoke) or if
1006 // the invoke value is only used by a phi in the successor.
1007 if (!OpBlock->getSinglePredecessor() &&
1008 DT->dominates(&BB->getParent()->getEntryBlock(), BB)) {
1009 // The first case we allow is if the use is a PHI operand in the
1010 // normal block, and if that PHI operand corresponds to the invoke's
1013 if (PHINode *PN = dyn_cast<PHINode>(&I))
1014 if (PN->getParent() == OpBlock &&
1015 PN->getIncomingBlock(i/2) == Op->getParent())
1018 // If it is used by something non-phi, then the other case is that
1019 // 'OpBlock' dominates all of its predecessors other than the
1020 // invoke. In this case, the invoke value can still be used.
1023 for (pred_iterator PI = pred_begin(OpBlock),
1024 E = pred_end(OpBlock); PI != E; ++PI) {
1025 if (*PI != II->getParent() && !DT->dominates(OpBlock, *PI)) {
1032 "Invoke value defined on critical edge but not dead!", &I,
1035 } else if (OpBlock == BB) {
1036 // If they are in the same basic block, make sure that the definition
1037 // comes before the use.
1038 Assert2(InstsInThisBlock.count(Op) ||
1039 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1040 "Instruction does not dominate all uses!", Op, &I);
1043 // Definition must dominate use unless use is unreachable!
1044 Assert2(DT->dominates(OpBlock, BB) ||
1045 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1046 "Instruction does not dominate all uses!", Op, &I);
1048 // PHI nodes are more difficult than other nodes because they actually
1049 // "use" the value in the predecessor basic blocks they correspond to.
1050 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
1051 Assert2(DT->dominates(OpBlock, PredBB) ||
1052 !DT->dominates(&BB->getParent()->getEntryBlock(), PredBB),
1053 "Instruction does not dominate all uses!", Op, &I);
1055 } else if (isa<InlineAsm>(I.getOperand(i))) {
1056 Assert1(i == 0 && isa<CallInst>(I),
1057 "Cannot take the address of an inline asm!", &I);
1060 InstsInThisBlock.insert(&I);
1063 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1065 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1066 Function *IF = CI.getCalledFunction();
1067 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1070 #define GET_INTRINSIC_VERIFIER
1071 #include "llvm/Intrinsics.gen"
1072 #undef GET_INTRINSIC_VERIFIER
1075 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1076 /// Intrinsics.gen. This implements a little state machine that verifies the
1077 /// prototype of intrinsics.
1078 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F, ...) {
1082 const FunctionType *FTy = F->getFunctionType();
1084 // For overloaded intrinsics, the Suffix of the function name must match the
1085 // types of the arguments. This variable keeps track of the expected
1086 // suffix, to be checked at the end.
1089 // Note that "arg#0" is the return type.
1090 for (unsigned ArgNo = 0; 1; ++ArgNo) {
1091 int TypeID = va_arg(VA, int);
1098 if (ArgNo != FTy->getNumParams()+1)
1099 CheckFailed("Intrinsic prototype has too many arguments!", F);
1103 if (ArgNo == FTy->getNumParams()+1) {
1104 CheckFailed("Intrinsic prototype has too few arguments!", F);
1110 Ty = FTy->getReturnType();
1112 Ty = FTy->getParamType(ArgNo-1);
1114 if (TypeID != Ty->getTypeID()) {
1116 CheckFailed("Intrinsic prototype has incorrect result type!", F);
1118 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " is wrong!",F);
1122 if (TypeID == Type::IntegerTyID) {
1123 unsigned ExpectedBits = (unsigned) va_arg(VA, int);
1124 unsigned GotBits = cast<IntegerType>(Ty)->getBitWidth();
1125 if (ExpectedBits == 0) {
1126 Suffix += ".i" + utostr(GotBits);
1127 } else if (GotBits != ExpectedBits) {
1128 std::string bitmsg = " Expected " + utostr(ExpectedBits) + " but got "+
1129 utostr(GotBits) + " bits.";
1131 CheckFailed("Intrinsic prototype has incorrect integer result width!"
1134 CheckFailed("Intrinsic parameter #" + utostr(ArgNo-1) + " has "
1135 "incorrect integer width!" + bitmsg, F);
1138 // Check some constraints on various intrinsics.
1140 default: break; // Not everything needs to be checked.
1141 case Intrinsic::bswap:
1142 if (GotBits < 16 || GotBits % 16 != 0)
1143 CheckFailed("Intrinsic requires even byte width argument", F);
1145 case Intrinsic::part_set:
1146 case Intrinsic::part_select:
1148 unsigned ResultBits =
1149 cast<IntegerType>(FTy->getReturnType())->getBitWidth();
1150 if (GotBits != ResultBits)
1151 CheckFailed("Intrinsic requires the bit widths of the first "
1152 "parameter and the result to match", F);
1156 } else if (TypeID == Type::VectorTyID) {
1157 // If this is a vector argument, verify the number and type of elements.
1158 const VectorType *PTy = cast<VectorType>(Ty);
1159 int ElemTy = va_arg(VA, int);
1160 if (ElemTy != PTy->getElementType()->getTypeID()) {
1161 CheckFailed("Intrinsic prototype has incorrect vector element type!",
1165 if (ElemTy == Type::IntegerTyID) {
1166 unsigned NumBits = (unsigned)va_arg(VA, int);
1167 unsigned ExpectedBits =
1168 cast<IntegerType>(PTy->getElementType())->getBitWidth();
1169 if (NumBits != ExpectedBits) {
1170 CheckFailed("Intrinsic prototype has incorrect vector element type!",
1175 if ((unsigned)va_arg(VA, int) != PTy->getNumElements()) {
1176 CheckFailed("Intrinsic prototype has incorrect number of "
1177 "vector elements!",F);
1185 // If we computed a Suffix then the intrinsic is overloaded and we need to
1186 // make sure that the name of the function is correct. We add the suffix to
1187 // the name of the intrinsic and compare against the given function name. If
1188 // they are not the same, the function name is invalid. This ensures that
1189 // overloading of intrinsics uses a sane and consistent naming convention.
1190 if (!Suffix.empty()) {
1191 std::string Name(Intrinsic::getName(ID));
1192 if (Name + Suffix != F->getName())
1193 CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1194 F->getName().substr(Name.length()) + "'. It should be '" +
1200 //===----------------------------------------------------------------------===//
1201 // Implement the public interfaces to this file...
1202 //===----------------------------------------------------------------------===//
1204 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1205 return new Verifier(action);
1209 // verifyFunction - Create
1210 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1211 Function &F = const_cast<Function&>(f);
1212 assert(!F.isDeclaration() && "Cannot verify external functions");
1214 FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
1215 Verifier *V = new Verifier(action);
1221 /// verifyModule - Check a module for errors, printing messages on stderr.
1222 /// Return true if the module is corrupt.
1224 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1225 std::string *ErrorInfo) {
1227 Verifier *V = new Verifier(action);
1231 if (ErrorInfo && V->Broken)
1232 *ErrorInfo = V->msgs.str();