1 //===-- Verifier.cpp - Implement the Module Verifier -------------*- C++ -*-==//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // 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 i32 %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/CallingConv.h"
44 #include "llvm/Constants.h"
45 #include "llvm/DerivedTypes.h"
46 #include "llvm/InlineAsm.h"
47 #include "llvm/IntrinsicInst.h"
48 #include "llvm/Module.h"
49 #include "llvm/ModuleProvider.h"
50 #include "llvm/Pass.h"
51 #include "llvm/PassManager.h"
52 #include "llvm/Analysis/Dominators.h"
53 #include "llvm/Assembly/Writer.h"
54 #include "llvm/CodeGen/ValueTypes.h"
55 #include "llvm/Support/CallSite.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
70 struct VISIBILITY_HIDDEN PreVerifier : public FunctionPass {
71 static char ID; // Pass ID, replacement for typeid
73 PreVerifier() : FunctionPass(&ID) { }
75 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
79 // Check that the prerequisites for successful DominatorTree construction
81 bool runOnFunction(Function &F) {
84 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
85 if (I->empty() || !I->back().isTerminator()) {
86 cerr << "Basic Block does not have terminator!\n";
87 WriteAsOperand(*cerr, I, true);
101 char PreVerifier::ID = 0;
102 static RegisterPass<PreVerifier>
103 PreVer("preverify", "Preliminary module verification");
104 static const PassInfo *const PreVerifyID = &PreVer;
107 struct VISIBILITY_HIDDEN
108 Verifier : public FunctionPass, InstVisitor<Verifier> {
109 static char ID; // Pass ID, replacement for typeid
110 bool Broken; // Is this module found to be broken?
111 bool RealPass; // Are we not being run by a PassManager?
112 VerifierFailureAction action;
113 // What to do if verification fails.
114 Module *Mod; // Module we are verifying right now
115 DominatorTree *DT; // Dominator Tree, caution can be null!
116 std::stringstream msgs; // A stringstream to collect messages
118 /// InstInThisBlock - when verifying a basic block, keep track of all of the
119 /// instructions we have seen so far. This allows us to do efficient
120 /// dominance checks for the case when an instruction has an operand that is
121 /// an instruction in the same block.
122 SmallPtrSet<Instruction*, 16> InstsInThisBlock;
126 Broken(false), RealPass(true), action(AbortProcessAction),
127 DT(0), msgs( std::ios::app | std::ios::out ) {}
128 explicit Verifier(VerifierFailureAction ctn)
130 Broken(false), RealPass(true), action(ctn), DT(0),
131 msgs( std::ios::app | std::ios::out ) {}
132 explicit Verifier(bool AB)
134 Broken(false), RealPass(true),
135 action( AB ? AbortProcessAction : PrintMessageAction), DT(0),
136 msgs( std::ios::app | std::ios::out ) {}
137 explicit Verifier(DominatorTree &dt)
139 Broken(false), RealPass(false), action(PrintMessageAction),
140 DT(&dt), msgs( std::ios::app | std::ios::out ) {}
143 bool doInitialization(Module &M) {
145 verifyTypeSymbolTable(M.getTypeSymbolTable());
147 // If this is a real pass, in a pass manager, we must abort before
148 // returning back to the pass manager, or else the pass manager may try to
149 // run other passes on the broken module.
151 return abortIfBroken();
155 bool runOnFunction(Function &F) {
156 // Get dominator information if we are being run by PassManager
157 if (RealPass) DT = &getAnalysis<DominatorTree>();
162 InstsInThisBlock.clear();
164 // If this is a real pass, in a pass manager, we must abort before
165 // returning back to the pass manager, or else the pass manager may try to
166 // run other passes on the broken module.
168 return abortIfBroken();
173 bool doFinalization(Module &M) {
174 // Scan through, checking all of the external function's linkage now...
175 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
176 visitGlobalValue(*I);
178 // Check to make sure function prototypes are okay.
179 if (I->isDeclaration()) visitFunction(*I);
182 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
184 visitGlobalVariable(*I);
186 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
188 visitGlobalAlias(*I);
190 // If the module is broken, abort at this time.
191 return abortIfBroken();
194 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
195 AU.setPreservesAll();
196 AU.addRequiredID(PreVerifyID);
198 AU.addRequired<DominatorTree>();
201 /// abortIfBroken - If the module is broken and we are supposed to abort on
202 /// this condition, do so.
204 bool abortIfBroken() {
205 if (!Broken) return false;
206 msgs << "Broken module found, ";
208 default: assert(0 && "Unknown action");
209 case AbortProcessAction:
210 msgs << "compilation aborted!\n";
213 case PrintMessageAction:
214 msgs << "verification continues.\n";
217 case ReturnStatusAction:
218 msgs << "compilation terminated.\n";
224 // Verification methods...
225 void verifyTypeSymbolTable(TypeSymbolTable &ST);
226 void visitGlobalValue(GlobalValue &GV);
227 void visitGlobalVariable(GlobalVariable &GV);
228 void visitGlobalAlias(GlobalAlias &GA);
229 void visitFunction(Function &F);
230 void visitBasicBlock(BasicBlock &BB);
231 using InstVisitor<Verifier>::visit;
233 void visit(Instruction &I);
235 void visitTruncInst(TruncInst &I);
236 void visitZExtInst(ZExtInst &I);
237 void visitSExtInst(SExtInst &I);
238 void visitFPTruncInst(FPTruncInst &I);
239 void visitFPExtInst(FPExtInst &I);
240 void visitFPToUIInst(FPToUIInst &I);
241 void visitFPToSIInst(FPToSIInst &I);
242 void visitUIToFPInst(UIToFPInst &I);
243 void visitSIToFPInst(SIToFPInst &I);
244 void visitIntToPtrInst(IntToPtrInst &I);
245 void visitPtrToIntInst(PtrToIntInst &I);
246 void visitBitCastInst(BitCastInst &I);
247 void visitPHINode(PHINode &PN);
248 void visitBinaryOperator(BinaryOperator &B);
249 void visitICmpInst(ICmpInst &IC);
250 void visitFCmpInst(FCmpInst &FC);
251 void visitExtractElementInst(ExtractElementInst &EI);
252 void visitInsertElementInst(InsertElementInst &EI);
253 void visitShuffleVectorInst(ShuffleVectorInst &EI);
254 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
255 void visitCallInst(CallInst &CI);
256 void visitInvokeInst(InvokeInst &II);
257 void visitGetElementPtrInst(GetElementPtrInst &GEP);
258 void visitLoadInst(LoadInst &LI);
259 void visitStoreInst(StoreInst &SI);
260 void visitInstruction(Instruction &I);
261 void visitTerminatorInst(TerminatorInst &I);
262 void visitReturnInst(ReturnInst &RI);
263 void visitSwitchInst(SwitchInst &SI);
264 void visitSelectInst(SelectInst &SI);
265 void visitUserOp1(Instruction &I);
266 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
267 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
268 void visitAllocationInst(AllocationInst &AI);
269 void visitExtractValueInst(ExtractValueInst &EVI);
270 void visitInsertValueInst(InsertValueInst &IVI);
272 void VerifyCallSite(CallSite CS);
273 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
274 int VT, unsigned ArgNo, std::string &Suffix);
275 void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
276 unsigned RetNum, unsigned ParamNum, ...);
277 void VerifyAttrs(Attributes Attrs, const Type *Ty,
278 bool isReturnValue, const Value *V);
279 void VerifyFunctionAttrs(const FunctionType *FT, const AttrListPtr &Attrs,
282 void WriteValue(const Value *V) {
284 if (isa<Instruction>(V)) {
287 WriteAsOperand(msgs, V, true, Mod);
292 void WriteType(const Type *T) {
294 WriteTypeSymbolic(msgs, T, Mod );
298 // CheckFailed - A check failed, so print out the condition and the message
299 // that failed. This provides a nice place to put a breakpoint if you want
300 // to see why something is not correct.
301 void CheckFailed(const std::string &Message,
302 const Value *V1 = 0, const Value *V2 = 0,
303 const Value *V3 = 0, const Value *V4 = 0) {
304 msgs << Message << "\n";
312 void CheckFailed( const std::string& Message, const Value* V1,
313 const Type* T2, const Value* V3 = 0 ) {
314 msgs << Message << "\n";
321 } // End anonymous namespace
323 char Verifier::ID = 0;
324 static RegisterPass<Verifier> X("verify", "Module Verifier");
326 // Assert - We know that cond should be true, if not print an error message.
327 #define Assert(C, M) \
328 do { if (!(C)) { CheckFailed(M); return; } } while (0)
329 #define Assert1(C, M, V1) \
330 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
331 #define Assert2(C, M, V1, V2) \
332 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
333 #define Assert3(C, M, V1, V2, V3) \
334 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
335 #define Assert4(C, M, V1, V2, V3, V4) \
336 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
339 void Verifier::visit(Instruction &I) {
340 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
341 Assert1(I.getOperand(i) != 0, "Operand is null", &I);
342 InstVisitor<Verifier>::visit(I);
346 void Verifier::visitGlobalValue(GlobalValue &GV) {
347 Assert1(!GV.isDeclaration() ||
348 GV.hasExternalLinkage() ||
349 GV.hasDLLImportLinkage() ||
350 GV.hasExternalWeakLinkage() ||
351 GV.hasGhostLinkage() ||
352 (isa<GlobalAlias>(GV) &&
353 (GV.hasInternalLinkage() || GV.hasWeakLinkage())),
354 "Global is external, but doesn't have external or dllimport or weak linkage!",
357 Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
358 "Global is marked as dllimport, but not external", &GV);
360 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
361 "Only global variables can have appending linkage!", &GV);
363 if (GV.hasAppendingLinkage()) {
364 GlobalVariable &GVar = cast<GlobalVariable>(GV);
365 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
366 "Only global arrays can have appending linkage!", &GV);
370 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
371 if (GV.hasInitializer()) {
372 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
373 "Global variable initializer type does not match global "
374 "variable type!", &GV);
376 Assert1(GV.hasExternalLinkage() || GV.hasDLLImportLinkage() ||
377 GV.hasExternalWeakLinkage(),
378 "invalid linkage type for global declaration", &GV);
381 visitGlobalValue(GV);
384 void Verifier::visitGlobalAlias(GlobalAlias &GA) {
385 Assert1(!GA.getName().empty(),
386 "Alias name cannot be empty!", &GA);
387 Assert1(GA.hasExternalLinkage() || GA.hasInternalLinkage() ||
389 "Alias should have external or external weak linkage!", &GA);
390 Assert1(GA.getAliasee(),
391 "Aliasee cannot be NULL!", &GA);
392 Assert1(GA.getType() == GA.getAliasee()->getType(),
393 "Alias and aliasee types should match!", &GA);
395 if (!isa<GlobalValue>(GA.getAliasee())) {
396 const ConstantExpr *CE = dyn_cast<ConstantExpr>(GA.getAliasee());
397 Assert1(CE && CE->getOpcode() == Instruction::BitCast &&
398 isa<GlobalValue>(CE->getOperand(0)),
399 "Aliasee should be either GlobalValue or bitcast of GlobalValue",
403 const GlobalValue* Aliasee = GA.resolveAliasedGlobal(/*stopOnWeak*/ false);
405 "Aliasing chain should end with function or global variable", &GA);
407 visitGlobalValue(GA);
410 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
413 // VerifyAttrs - Check the given parameter attributes for an argument or return
414 // value of the specified type. The value V is printed in error messages.
415 void Verifier::VerifyAttrs(Attributes Attrs, const Type *Ty,
416 bool isReturnValue, const Value *V) {
417 if (Attrs == Attribute::None)
421 Attributes RetI = Attrs & Attribute::ParameterOnly;
422 Assert1(!RetI, "Attribute " + Attribute::getAsString(RetI) +
423 " does not apply to return values!", V);
425 Attributes FnCheckAttr = Attrs & Attribute::FunctionOnly;
426 Assert1(!FnCheckAttr, "Attribute " + Attribute::getAsString(FnCheckAttr) +
427 " only applies to functions!", V);
430 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
431 Attributes MutI = Attrs & Attribute::MutuallyIncompatible[i];
432 Assert1(!(MutI & (MutI - 1)), "Attributes " +
433 Attribute::getAsString(MutI) + " are incompatible!", V);
436 Attributes TypeI = Attrs & Attribute::typeIncompatible(Ty);
437 Assert1(!TypeI, "Wrong type for attribute " +
438 Attribute::getAsString(TypeI), V);
440 Attributes ByValI = Attrs & Attribute::ByVal;
441 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
442 Assert1(!ByValI || PTy->getElementType()->isSized(),
443 "Attribute " + Attribute::getAsString(ByValI) +
444 " does not support unsized types!", V);
447 "Attribute " + Attribute::getAsString(ByValI) +
448 " only applies to parameters with pointer type!", V);
452 // VerifyFunctionAttrs - Check parameter attributes against a function type.
453 // The value V is printed in error messages.
454 void Verifier::VerifyFunctionAttrs(const FunctionType *FT,
455 const AttrListPtr &Attrs,
460 bool SawNest = false;
462 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
463 const AttributeWithIndex &Attr = Attrs.getSlot(i);
467 Ty = FT->getReturnType();
468 else if (Attr.Index-1 < FT->getNumParams())
469 Ty = FT->getParamType(Attr.Index-1);
471 break; // VarArgs attributes, don't verify.
473 VerifyAttrs(Attr.Attrs, Ty, Attr.Index == 0, V);
475 if (Attr.Attrs & Attribute::Nest) {
476 Assert1(!SawNest, "More than one parameter has attribute nest!", V);
480 if (Attr.Attrs & Attribute::StructRet)
481 Assert1(Attr.Index == 1, "Attribute sret not on first parameter!", V);
484 Attributes FAttrs = Attrs.getFnAttributes();
485 Assert1(!(FAttrs & (~Attribute::FunctionOnly)),
486 "Attribute " + Attribute::getAsString(FAttrs) +
487 " does not apply to function!", V);
490 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
491 Attributes MutI = FAttrs & Attribute::MutuallyIncompatible[i];
492 Assert1(!(MutI & (MutI - 1)), "Attributes " +
493 Attribute::getAsString(MutI) + " are incompatible!", V);
497 static bool VerifyAttributeCount(const AttrListPtr &Attrs, unsigned Params) {
501 unsigned LastSlot = Attrs.getNumSlots() - 1;
502 unsigned LastIndex = Attrs.getSlot(LastSlot).Index;
503 if (LastIndex <= Params
504 || (LastIndex == (unsigned)~0
505 && (LastSlot == 0 || Attrs.getSlot(LastSlot - 1).Index <= Params)))
510 // visitFunction - Verify that a function is ok.
512 void Verifier::visitFunction(Function &F) {
513 // Check function arguments.
514 const FunctionType *FT = F.getFunctionType();
515 unsigned NumArgs = F.arg_size();
517 Assert2(FT->getNumParams() == NumArgs,
518 "# formal arguments must match # of arguments for function type!",
520 Assert1(F.getReturnType()->isFirstClassType() ||
521 F.getReturnType() == Type::VoidTy ||
522 isa<StructType>(F.getReturnType()),
523 "Functions cannot return aggregate values!", &F);
525 Assert1(!F.hasStructRetAttr() || F.getReturnType() == Type::VoidTy,
526 "Invalid struct return type!", &F);
528 const AttrListPtr &Attrs = F.getAttributes();
530 Assert1(VerifyAttributeCount(Attrs, FT->getNumParams()),
531 "Attributes after last parameter!", &F);
533 // Check function attributes.
534 VerifyFunctionAttrs(FT, Attrs, &F);
536 // Check that this function meets the restrictions on this calling convention.
537 switch (F.getCallingConv()) {
542 case CallingConv::Fast:
543 case CallingConv::Cold:
544 case CallingConv::X86_FastCall:
545 Assert1(!F.isVarArg(),
546 "Varargs functions must have C calling conventions!", &F);
550 // Check that the argument values match the function type for this function...
552 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
554 Assert2(I->getType() == FT->getParamType(i),
555 "Argument value does not match function argument type!",
556 I, FT->getParamType(i));
557 Assert1(I->getType()->isFirstClassType(),
558 "Function arguments must have first-class types!", I);
561 if (F.isDeclaration()) {
562 Assert1(F.hasExternalLinkage() || F.hasDLLImportLinkage() ||
563 F.hasExternalWeakLinkage() || F.hasGhostLinkage(),
564 "invalid linkage type for function declaration", &F);
566 // Verify that this function (which has a body) is not named "llvm.*". It
567 // is not legal to define intrinsics.
568 if (F.getName().size() >= 5)
569 Assert1(F.getName().substr(0, 5) != "llvm.",
570 "llvm intrinsics cannot be defined!", &F);
572 // Check the entry node
573 BasicBlock *Entry = &F.getEntryBlock();
574 Assert1(pred_begin(Entry) == pred_end(Entry),
575 "Entry block to function must not have predecessors!", Entry);
580 // verifyBasicBlock - Verify that a basic block is well formed...
582 void Verifier::visitBasicBlock(BasicBlock &BB) {
583 InstsInThisBlock.clear();
585 // Ensure that basic blocks have terminators!
586 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
588 // Check constraints that this basic block imposes on all of the PHI nodes in
590 if (isa<PHINode>(BB.front())) {
591 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
592 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
593 std::sort(Preds.begin(), Preds.end());
595 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
597 // Ensure that PHI nodes have at least one entry!
598 Assert1(PN->getNumIncomingValues() != 0,
599 "PHI nodes must have at least one entry. If the block is dead, "
600 "the PHI should be removed!", PN);
601 Assert1(PN->getNumIncomingValues() == Preds.size(),
602 "PHINode should have one entry for each predecessor of its "
603 "parent basic block!", PN);
605 // Get and sort all incoming values in the PHI node...
607 Values.reserve(PN->getNumIncomingValues());
608 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
609 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
610 PN->getIncomingValue(i)));
611 std::sort(Values.begin(), Values.end());
613 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
614 // Check to make sure that if there is more than one entry for a
615 // particular basic block in this PHI node, that the incoming values are
618 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
619 Values[i].second == Values[i-1].second,
620 "PHI node has multiple entries for the same basic block with "
621 "different incoming values!", PN, Values[i].first,
622 Values[i].second, Values[i-1].second);
624 // Check to make sure that the predecessors and PHI node entries are
626 Assert3(Values[i].first == Preds[i],
627 "PHI node entries do not match predecessors!", PN,
628 Values[i].first, Preds[i]);
634 void Verifier::visitTerminatorInst(TerminatorInst &I) {
635 // Ensure that terminators only exist at the end of the basic block.
636 Assert1(&I == I.getParent()->getTerminator(),
637 "Terminator found in the middle of a basic block!", I.getParent());
641 void Verifier::visitReturnInst(ReturnInst &RI) {
642 Function *F = RI.getParent()->getParent();
643 unsigned N = RI.getNumOperands();
644 if (F->getReturnType() == Type::VoidTy)
646 "Found return instr that returns non-void in Function of void "
647 "return type!", &RI, F->getReturnType());
648 else if (N == 1 && F->getReturnType() == RI.getOperand(0)->getType()) {
649 // Exactly one return value and it matches the return type. Good.
650 } else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
651 // The return type is a struct; check for multiple return values.
652 Assert2(STy->getNumElements() == N,
653 "Incorrect number of return values in ret instruction!",
654 &RI, F->getReturnType());
655 for (unsigned i = 0; i != N; ++i)
656 Assert2(STy->getElementType(i) == RI.getOperand(i)->getType(),
657 "Function return type does not match operand "
658 "type of return inst!", &RI, F->getReturnType());
659 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(F->getReturnType())) {
660 // The return type is an array; check for multiple return values.
661 Assert2(ATy->getNumElements() == N,
662 "Incorrect number of return values in ret instruction!",
663 &RI, F->getReturnType());
664 for (unsigned i = 0; i != N; ++i)
665 Assert2(ATy->getElementType() == RI.getOperand(i)->getType(),
666 "Function return type does not match operand "
667 "type of return inst!", &RI, F->getReturnType());
669 CheckFailed("Function return type does not match operand "
670 "type of return inst!", &RI, F->getReturnType());
673 // Check to make sure that the return value has necessary properties for
675 visitTerminatorInst(RI);
678 void Verifier::visitSwitchInst(SwitchInst &SI) {
679 // Check to make sure that all of the constants in the switch instruction
680 // have the same type as the switched-on value.
681 const Type *SwitchTy = SI.getCondition()->getType();
682 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
683 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
684 "Switch constants must all be same type as switch value!", &SI);
686 visitTerminatorInst(SI);
689 void Verifier::visitSelectInst(SelectInst &SI) {
690 Assert1(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
692 "Invalid operands for select instruction!", &SI);
694 Assert1(SI.getTrueValue()->getType() == SI.getType(),
695 "Select values must have same type as select instruction!", &SI);
696 visitInstruction(SI);
700 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
701 /// a pass, if any exist, it's an error.
703 void Verifier::visitUserOp1(Instruction &I) {
704 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
707 void Verifier::visitTruncInst(TruncInst &I) {
708 // Get the source and destination types
709 const Type *SrcTy = I.getOperand(0)->getType();
710 const Type *DestTy = I.getType();
712 // Get the size of the types in bits, we'll need this later
713 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
714 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
716 Assert1(SrcTy->isIntOrIntVector(), "Trunc only operates on integer", &I);
717 Assert1(DestTy->isIntOrIntVector(), "Trunc only produces integer", &I);
718 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
723 void Verifier::visitZExtInst(ZExtInst &I) {
724 // Get the source and destination types
725 const Type *SrcTy = I.getOperand(0)->getType();
726 const Type *DestTy = I.getType();
728 // Get the size of the types in bits, we'll need this later
729 Assert1(SrcTy->isIntOrIntVector(), "ZExt only operates on integer", &I);
730 Assert1(DestTy->isIntOrIntVector(), "ZExt only produces an integer", &I);
731 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
732 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
734 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
739 void Verifier::visitSExtInst(SExtInst &I) {
740 // Get the source and destination types
741 const Type *SrcTy = I.getOperand(0)->getType();
742 const Type *DestTy = I.getType();
744 // Get the size of the types in bits, we'll need this later
745 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
746 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
748 Assert1(SrcTy->isIntOrIntVector(), "SExt only operates on integer", &I);
749 Assert1(DestTy->isIntOrIntVector(), "SExt only produces an integer", &I);
750 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
755 void Verifier::visitFPTruncInst(FPTruncInst &I) {
756 // Get the source and destination types
757 const Type *SrcTy = I.getOperand(0)->getType();
758 const Type *DestTy = I.getType();
759 // Get the size of the types in bits, we'll need this later
760 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
761 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
763 Assert1(SrcTy->isFPOrFPVector(),"FPTrunc only operates on FP", &I);
764 Assert1(DestTy->isFPOrFPVector(),"FPTrunc only produces an FP", &I);
765 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
770 void Verifier::visitFPExtInst(FPExtInst &I) {
771 // Get the source and destination types
772 const Type *SrcTy = I.getOperand(0)->getType();
773 const Type *DestTy = I.getType();
775 // Get the size of the types in bits, we'll need this later
776 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
777 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
779 Assert1(SrcTy->isFPOrFPVector(),"FPExt only operates on FP", &I);
780 Assert1(DestTy->isFPOrFPVector(),"FPExt only produces an FP", &I);
781 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
786 void Verifier::visitUIToFPInst(UIToFPInst &I) {
787 // Get the source and destination types
788 const Type *SrcTy = I.getOperand(0)->getType();
789 const Type *DestTy = I.getType();
791 bool SrcVec = isa<VectorType>(SrcTy);
792 bool DstVec = isa<VectorType>(DestTy);
794 Assert1(SrcVec == DstVec,
795 "UIToFP source and dest must both be vector or scalar", &I);
796 Assert1(SrcTy->isIntOrIntVector(),
797 "UIToFP source must be integer or integer vector", &I);
798 Assert1(DestTy->isFPOrFPVector(),
799 "UIToFP result must be FP or FP vector", &I);
801 if (SrcVec && DstVec)
802 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
803 cast<VectorType>(DestTy)->getNumElements(),
804 "UIToFP source and dest vector length mismatch", &I);
809 void Verifier::visitSIToFPInst(SIToFPInst &I) {
810 // Get the source and destination types
811 const Type *SrcTy = I.getOperand(0)->getType();
812 const Type *DestTy = I.getType();
814 bool SrcVec = SrcTy->getTypeID() == Type::VectorTyID;
815 bool DstVec = DestTy->getTypeID() == Type::VectorTyID;
817 Assert1(SrcVec == DstVec,
818 "SIToFP source and dest must both be vector or scalar", &I);
819 Assert1(SrcTy->isIntOrIntVector(),
820 "SIToFP source must be integer or integer vector", &I);
821 Assert1(DestTy->isFPOrFPVector(),
822 "SIToFP result must be FP or FP vector", &I);
824 if (SrcVec && DstVec)
825 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
826 cast<VectorType>(DestTy)->getNumElements(),
827 "SIToFP source and dest vector length mismatch", &I);
832 void Verifier::visitFPToUIInst(FPToUIInst &I) {
833 // Get the source and destination types
834 const Type *SrcTy = I.getOperand(0)->getType();
835 const Type *DestTy = I.getType();
837 bool SrcVec = isa<VectorType>(SrcTy);
838 bool DstVec = isa<VectorType>(DestTy);
840 Assert1(SrcVec == DstVec,
841 "FPToUI source and dest must both be vector or scalar", &I);
842 Assert1(SrcTy->isFPOrFPVector(), "FPToUI source must be FP or FP vector", &I);
843 Assert1(DestTy->isIntOrIntVector(),
844 "FPToUI result must be integer or integer vector", &I);
846 if (SrcVec && DstVec)
847 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
848 cast<VectorType>(DestTy)->getNumElements(),
849 "FPToUI source and dest vector length mismatch", &I);
854 void Verifier::visitFPToSIInst(FPToSIInst &I) {
855 // Get the source and destination types
856 const Type *SrcTy = I.getOperand(0)->getType();
857 const Type *DestTy = I.getType();
859 bool SrcVec = isa<VectorType>(SrcTy);
860 bool DstVec = isa<VectorType>(DestTy);
862 Assert1(SrcVec == DstVec,
863 "FPToSI source and dest must both be vector or scalar", &I);
864 Assert1(SrcTy->isFPOrFPVector(),
865 "FPToSI source must be FP or FP vector", &I);
866 Assert1(DestTy->isIntOrIntVector(),
867 "FPToSI result must be integer or integer vector", &I);
869 if (SrcVec && DstVec)
870 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
871 cast<VectorType>(DestTy)->getNumElements(),
872 "FPToSI source and dest vector length mismatch", &I);
877 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
878 // Get the source and destination types
879 const Type *SrcTy = I.getOperand(0)->getType();
880 const Type *DestTy = I.getType();
882 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
883 Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
888 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
889 // Get the source and destination types
890 const Type *SrcTy = I.getOperand(0)->getType();
891 const Type *DestTy = I.getType();
893 Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
894 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
899 void Verifier::visitBitCastInst(BitCastInst &I) {
900 // Get the source and destination types
901 const Type *SrcTy = I.getOperand(0)->getType();
902 const Type *DestTy = I.getType();
904 // Get the size of the types in bits, we'll need this later
905 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
906 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
908 // BitCast implies a no-op cast of type only. No bits change.
909 // However, you can't cast pointers to anything but pointers.
910 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
911 "Bitcast requires both operands to be pointer or neither", &I);
912 Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
914 // Disallow aggregates.
915 Assert1(!SrcTy->isAggregateType(),
916 "Bitcast operand must not be aggregate", &I);
917 Assert1(!DestTy->isAggregateType(),
918 "Bitcast type must not be aggregate", &I);
923 /// visitPHINode - Ensure that a PHI node is well formed.
925 void Verifier::visitPHINode(PHINode &PN) {
926 // Ensure that the PHI nodes are all grouped together at the top of the block.
927 // This can be tested by checking whether the instruction before this is
928 // either nonexistent (because this is begin()) or is a PHI node. If not,
929 // then there is some other instruction before a PHI.
930 Assert2(&PN == &PN.getParent()->front() ||
931 isa<PHINode>(--BasicBlock::iterator(&PN)),
932 "PHI nodes not grouped at top of basic block!",
933 &PN, PN.getParent());
935 // Check that all of the operands of the PHI node have the same type as the
937 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
938 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
939 "PHI node operands are not the same type as the result!", &PN);
941 // All other PHI node constraints are checked in the visitBasicBlock method.
943 visitInstruction(PN);
946 void Verifier::VerifyCallSite(CallSite CS) {
947 Instruction *I = CS.getInstruction();
949 Assert1(isa<PointerType>(CS.getCalledValue()->getType()),
950 "Called function must be a pointer!", I);
951 const PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
952 Assert1(isa<FunctionType>(FPTy->getElementType()),
953 "Called function is not pointer to function type!", I);
955 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
957 // Verify that the correct number of arguments are being passed
959 Assert1(CS.arg_size() >= FTy->getNumParams(),
960 "Called function requires more parameters than were provided!",I);
962 Assert1(CS.arg_size() == FTy->getNumParams(),
963 "Incorrect number of arguments passed to called function!", I);
965 // Verify that all arguments to the call match the function type...
966 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
967 Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
968 "Call parameter type does not match function signature!",
969 CS.getArgument(i), FTy->getParamType(i), I);
971 const AttrListPtr &Attrs = CS.getAttributes();
973 Assert1(VerifyAttributeCount(Attrs, CS.arg_size()),
974 "Attributes after last parameter!", I);
976 // Verify call attributes.
977 VerifyFunctionAttrs(FTy, Attrs, I);
980 // Check attributes on the varargs part.
981 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
982 Attributes Attr = Attrs.getParamAttributes(Idx);
984 VerifyAttrs(Attr, CS.getArgument(Idx-1)->getType(), false, I);
986 Attributes VArgI = Attr & Attribute::VarArgsIncompatible;
987 Assert1(!VArgI, "Attribute " + Attribute::getAsString(VArgI) +
988 " cannot be used for vararg call arguments!", I);
991 visitInstruction(*I);
994 void Verifier::visitCallInst(CallInst &CI) {
997 if (Function *F = CI.getCalledFunction()) {
998 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
999 visitIntrinsicFunctionCall(ID, CI);
1003 void Verifier::visitInvokeInst(InvokeInst &II) {
1004 VerifyCallSite(&II);
1007 /// visitBinaryOperator - Check that both arguments to the binary operator are
1008 /// of the same type!
1010 void Verifier::visitBinaryOperator(BinaryOperator &B) {
1011 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
1012 "Both operands to a binary operator are not of the same type!", &B);
1014 switch (B.getOpcode()) {
1015 // Check that logical operators are only used with integral operands.
1016 case Instruction::And:
1017 case Instruction::Or:
1018 case Instruction::Xor:
1019 Assert1(B.getType()->isInteger() ||
1020 (isa<VectorType>(B.getType()) &&
1021 cast<VectorType>(B.getType())->getElementType()->isInteger()),
1022 "Logical operators only work with integral types!", &B);
1023 Assert1(B.getType() == B.getOperand(0)->getType(),
1024 "Logical operators must have same type for operands and result!",
1027 case Instruction::Shl:
1028 case Instruction::LShr:
1029 case Instruction::AShr:
1030 Assert1(B.getType()->isInteger() ||
1031 (isa<VectorType>(B.getType()) &&
1032 cast<VectorType>(B.getType())->getElementType()->isInteger()),
1033 "Shifts only work with integral types!", &B);
1034 Assert1(B.getType() == B.getOperand(0)->getType(),
1035 "Shift return type must be same as operands!", &B);
1038 // Arithmetic operators only work on integer or fp values
1039 Assert1(B.getType() == B.getOperand(0)->getType(),
1040 "Arithmetic operators must have same type for operands and result!",
1042 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
1043 isa<VectorType>(B.getType()),
1044 "Arithmetic operators must have integer, fp, or vector type!", &B);
1048 visitInstruction(B);
1051 void Verifier::visitICmpInst(ICmpInst& IC) {
1052 // Check that the operands are the same type
1053 const Type* Op0Ty = IC.getOperand(0)->getType();
1054 const Type* Op1Ty = IC.getOperand(1)->getType();
1055 Assert1(Op0Ty == Op1Ty,
1056 "Both operands to ICmp instruction are not of the same type!", &IC);
1057 // Check that the operands are the right type
1058 Assert1(Op0Ty->isIntOrIntVector() || isa<PointerType>(Op0Ty),
1059 "Invalid operand types for ICmp instruction", &IC);
1060 visitInstruction(IC);
1063 void Verifier::visitFCmpInst(FCmpInst& FC) {
1064 // Check that the operands are the same type
1065 const Type* Op0Ty = FC.getOperand(0)->getType();
1066 const Type* Op1Ty = FC.getOperand(1)->getType();
1067 Assert1(Op0Ty == Op1Ty,
1068 "Both operands to FCmp instruction are not of the same type!", &FC);
1069 // Check that the operands are the right type
1070 Assert1(Op0Ty->isFPOrFPVector(),
1071 "Invalid operand types for FCmp instruction", &FC);
1072 visitInstruction(FC);
1075 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
1076 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
1078 "Invalid extractelement operands!", &EI);
1079 visitInstruction(EI);
1082 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
1083 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
1086 "Invalid insertelement operands!", &IE);
1087 visitInstruction(IE);
1090 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
1091 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
1093 "Invalid shufflevector operands!", &SV);
1095 const VectorType *VTy = dyn_cast<VectorType>(SV.getOperand(0)->getType());
1096 Assert1(VTy, "Operands are not a vector type", &SV);
1098 // Check to see if Mask is valid.
1099 if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
1100 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
1101 if (ConstantInt* CI = dyn_cast<ConstantInt>(MV->getOperand(i))) {
1102 Assert1(!CI->uge(VTy->getNumElements()*2),
1103 "Invalid shufflevector shuffle mask!", &SV);
1105 Assert1(isa<UndefValue>(MV->getOperand(i)),
1106 "Invalid shufflevector shuffle mask!", &SV);
1110 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
1111 isa<ConstantAggregateZero>(SV.getOperand(2)),
1112 "Invalid shufflevector shuffle mask!", &SV);
1115 visitInstruction(SV);
1118 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1119 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
1121 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
1122 Idxs.begin(), Idxs.end());
1123 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
1124 Assert2(isa<PointerType>(GEP.getType()) &&
1125 cast<PointerType>(GEP.getType())->getElementType() == ElTy,
1126 "GEP is not of right type for indices!", &GEP, ElTy);
1127 visitInstruction(GEP);
1130 void Verifier::visitLoadInst(LoadInst &LI) {
1132 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
1133 Assert2(ElTy == LI.getType(),
1134 "Load result type does not match pointer operand type!", &LI, ElTy);
1135 visitInstruction(LI);
1138 void Verifier::visitStoreInst(StoreInst &SI) {
1140 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
1141 Assert2(ElTy == SI.getOperand(0)->getType(),
1142 "Stored value type does not match pointer operand type!", &SI, ElTy);
1143 visitInstruction(SI);
1146 void Verifier::visitAllocationInst(AllocationInst &AI) {
1147 const PointerType *PTy = AI.getType();
1148 Assert1(PTy->getAddressSpace() == 0,
1149 "Allocation instruction pointer not in the generic address space!",
1151 Assert1(PTy->getElementType()->isSized(), "Cannot allocate unsized type",
1153 visitInstruction(AI);
1156 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
1157 Assert1(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
1158 EVI.idx_begin(), EVI.idx_end()) ==
1160 "Invalid ExtractValueInst operands!", &EVI);
1162 visitInstruction(EVI);
1165 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
1166 Assert1(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
1167 IVI.idx_begin(), IVI.idx_end()) ==
1168 IVI.getOperand(1)->getType(),
1169 "Invalid InsertValueInst operands!", &IVI);
1171 visitInstruction(IVI);
1174 /// verifyInstruction - Verify that an instruction is well formed.
1176 void Verifier::visitInstruction(Instruction &I) {
1177 BasicBlock *BB = I.getParent();
1178 Assert1(BB, "Instruction not embedded in basic block!", &I);
1180 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
1181 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
1183 Assert1(*UI != (User*)&I ||
1184 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1185 "Only PHI nodes may reference their own value!", &I);
1188 // Verify that if this is a terminator that it is at the end of the block.
1189 if (isa<TerminatorInst>(I))
1190 Assert1(BB->getTerminator() == &I, "Terminator not at end of block!", &I);
1193 // Check that void typed values don't have names
1194 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
1195 "Instruction has a name, but provides a void value!", &I);
1197 // Check that the return value of the instruction is either void or a legal
1199 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType()
1200 || ((isa<CallInst>(I) || isa<InvokeInst>(I))
1201 && isa<StructType>(I.getType())),
1202 "Instruction returns a non-scalar type!", &I);
1204 // Check that all uses of the instruction, if they are instructions
1205 // themselves, actually have parent basic blocks. If the use is not an
1206 // instruction, it is an error!
1207 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
1209 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
1211 Instruction *Used = cast<Instruction>(*UI);
1212 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
1213 " embeded in a basic block!", &I, Used);
1216 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1217 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
1219 // Check to make sure that only first-class-values are operands to
1221 if (!I.getOperand(i)->getType()->isFirstClassType()) {
1222 Assert1(0, "Instruction operands must be first-class values!", &I);
1225 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
1226 // Check to make sure that the "address of" an intrinsic function is never
1228 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
1229 "Cannot take the address of an intrinsic!", &I);
1230 Assert1(F->getParent() == Mod, "Referencing function in another module!",
1232 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
1233 Assert1(OpBB->getParent() == BB->getParent(),
1234 "Referring to a basic block in another function!", &I);
1235 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
1236 Assert1(OpArg->getParent() == BB->getParent(),
1237 "Referring to an argument in another function!", &I);
1238 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
1239 Assert1(GV->getParent() == Mod, "Referencing global in another module!",
1241 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
1242 BasicBlock *OpBlock = Op->getParent();
1244 // Check that a definition dominates all of its uses.
1245 if (!isa<PHINode>(I)) {
1246 // Invoke results are only usable in the normal destination, not in the
1247 // exceptional destination.
1248 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1249 OpBlock = II->getNormalDest();
1251 Assert2(OpBlock != II->getUnwindDest(),
1252 "No uses of invoke possible due to dominance structure!",
1255 // If the normal successor of an invoke instruction has multiple
1256 // predecessors, then the normal edge from the invoke is critical, so
1257 // the invoke value can only be live if the destination block
1258 // dominates all of it's predecessors (other than the invoke) or if
1259 // the invoke value is only used by a phi in the successor.
1260 if (!OpBlock->getSinglePredecessor() &&
1261 DT->dominates(&BB->getParent()->getEntryBlock(), BB)) {
1262 // The first case we allow is if the use is a PHI operand in the
1263 // normal block, and if that PHI operand corresponds to the invoke's
1266 if (PHINode *PN = dyn_cast<PHINode>(&I))
1267 if (PN->getParent() == OpBlock &&
1268 PN->getIncomingBlock(i/2) == Op->getParent())
1271 // If it is used by something non-phi, then the other case is that
1272 // 'OpBlock' dominates all of its predecessors other than the
1273 // invoke. In this case, the invoke value can still be used.
1276 for (pred_iterator PI = pred_begin(OpBlock),
1277 E = pred_end(OpBlock); PI != E; ++PI) {
1278 if (*PI != II->getParent() && !DT->dominates(OpBlock, *PI)) {
1285 "Invoke value defined on critical edge but not dead!", &I,
1288 } else if (OpBlock == BB) {
1289 // If they are in the same basic block, make sure that the definition
1290 // comes before the use.
1291 Assert2(InstsInThisBlock.count(Op) ||
1292 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1293 "Instruction does not dominate all uses!", Op, &I);
1296 // Definition must dominate use unless use is unreachable!
1297 Assert2(InstsInThisBlock.count(Op) || DT->dominates(Op, &I) ||
1298 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1299 "Instruction does not dominate all uses!", Op, &I);
1301 // PHI nodes are more difficult than other nodes because they actually
1302 // "use" the value in the predecessor basic blocks they correspond to.
1303 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
1304 Assert2(DT->dominates(OpBlock, PredBB) ||
1305 !DT->dominates(&BB->getParent()->getEntryBlock(), PredBB),
1306 "Instruction does not dominate all uses!", Op, &I);
1308 } else if (isa<InlineAsm>(I.getOperand(i))) {
1309 Assert1(i == 0 && (isa<CallInst>(I) || isa<InvokeInst>(I)),
1310 "Cannot take the address of an inline asm!", &I);
1313 InstsInThisBlock.insert(&I);
1316 // Flags used by TableGen to mark intrinsic parameters with the
1317 // LLVMExtendedElementVectorType and LLVMTruncatedElementVectorType classes.
1318 static const unsigned ExtendedElementVectorType = 0x40000000;
1319 static const unsigned TruncatedElementVectorType = 0x20000000;
1321 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1323 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1324 Function *IF = CI.getCalledFunction();
1325 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1328 #define GET_INTRINSIC_VERIFIER
1329 #include "llvm/Intrinsics.gen"
1330 #undef GET_INTRINSIC_VERIFIER
1335 case Intrinsic::memcpy:
1336 case Intrinsic::memmove:
1337 case Intrinsic::memset:
1338 Assert1(isa<ConstantInt>(CI.getOperand(4)),
1339 "alignment argument of memory intrinsics must be a constant int",
1342 case Intrinsic::gcroot:
1343 case Intrinsic::gcwrite:
1344 case Intrinsic::gcread:
1345 if (ID == Intrinsic::gcroot) {
1347 dyn_cast<AllocaInst>(CI.getOperand(1)->stripPointerCasts());
1348 Assert1(AI && isa<PointerType>(AI->getType()->getElementType()),
1349 "llvm.gcroot parameter #1 must be a pointer alloca.", &CI);
1350 Assert1(isa<Constant>(CI.getOperand(2)),
1351 "llvm.gcroot parameter #2 must be a constant.", &CI);
1354 Assert1(CI.getParent()->getParent()->hasGC(),
1355 "Enclosing function does not use GC.", &CI);
1357 case Intrinsic::init_trampoline:
1358 Assert1(isa<Function>(CI.getOperand(2)->stripPointerCasts()),
1359 "llvm.init_trampoline parameter #2 must resolve to a function.",
1362 case Intrinsic::prefetch:
1363 Assert1(isa<ConstantInt>(CI.getOperand(2)) &&
1364 isa<ConstantInt>(CI.getOperand(3)) &&
1365 cast<ConstantInt>(CI.getOperand(2))->getZExtValue() < 2 &&
1366 cast<ConstantInt>(CI.getOperand(3))->getZExtValue() < 4,
1367 "invalid arguments to llvm.prefetch",
1370 case Intrinsic::stackprotector:
1371 Assert1(isa<AllocaInst>(CI.getOperand(2)->stripPointerCasts()),
1372 "llvm.stackprotector parameter #2 must resolve to an alloca.",
1378 /// Produce a string to identify an intrinsic parameter or return value.
1379 /// The ArgNo value numbers the return values from 0 to NumRets-1 and the
1380 /// parameters beginning with NumRets.
1382 static std::string IntrinsicParam(unsigned ArgNo, unsigned NumRets) {
1383 if (ArgNo < NumRets) {
1385 return "Intrinsic result type";
1387 return "Intrinsic result type #" + utostr(ArgNo);
1389 return "Intrinsic parameter #" + utostr(ArgNo - NumRets);
1392 bool Verifier::PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
1393 int VT, unsigned ArgNo, std::string &Suffix) {
1394 const FunctionType *FTy = F->getFunctionType();
1396 unsigned NumElts = 0;
1397 const Type *EltTy = Ty;
1398 const VectorType *VTy = dyn_cast<VectorType>(Ty);
1400 EltTy = VTy->getElementType();
1401 NumElts = VTy->getNumElements();
1404 const Type *RetTy = FTy->getReturnType();
1405 const StructType *ST = dyn_cast<StructType>(RetTy);
1406 unsigned NumRets = 1;
1408 NumRets = ST->getNumElements();
1413 // Check flags that indicate a type that is an integral vector type with
1414 // elements that are larger or smaller than the elements of the matched
1416 if ((Match & (ExtendedElementVectorType |
1417 TruncatedElementVectorType)) != 0) {
1418 const IntegerType *IEltTy = dyn_cast<IntegerType>(EltTy);
1419 if (!VTy || !IEltTy) {
1420 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1421 "an integral vector type.", F);
1424 // Adjust the current Ty (in the opposite direction) rather than
1425 // the type being matched against.
1426 if ((Match & ExtendedElementVectorType) != 0) {
1427 if ((IEltTy->getBitWidth() & 1) != 0) {
1428 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " vector "
1429 "element bit-width is odd.", F);
1432 Ty = VectorType::getTruncatedElementVectorType(VTy);
1434 Ty = VectorType::getExtendedElementVectorType(VTy);
1435 Match &= ~(ExtendedElementVectorType | TruncatedElementVectorType);
1438 if (Match <= static_cast<int>(NumRets - 1)) {
1440 RetTy = ST->getElementType(Match);
1443 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1444 "match return type.", F);
1448 if (Ty != FTy->getParamType(Match - 1)) {
1449 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1450 "match parameter %" + utostr(Match - 1) + ".", F);
1454 } else if (VT == MVT::iAny) {
1455 if (!EltTy->isInteger()) {
1456 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1457 "an integer type.", F);
1461 unsigned GotBits = cast<IntegerType>(EltTy)->getBitWidth();
1465 Suffix += "v" + utostr(NumElts);
1467 Suffix += "i" + utostr(GotBits);;
1469 // Check some constraints on various intrinsics.
1471 default: break; // Not everything needs to be checked.
1472 case Intrinsic::bswap:
1473 if (GotBits < 16 || GotBits % 16 != 0) {
1474 CheckFailed("Intrinsic requires even byte width argument", F);
1479 } else if (VT == MVT::fAny) {
1480 if (!EltTy->isFloatingPoint()) {
1481 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1482 "a floating-point type.", F);
1489 Suffix += "v" + utostr(NumElts);
1491 Suffix += MVT::getMVT(EltTy).getMVTString();
1492 } else if (VT == MVT::iPTR) {
1493 if (!isa<PointerType>(Ty)) {
1494 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1495 "pointer and a pointer is required.", F);
1498 } else if (VT == MVT::iPTRAny) {
1499 // Outside of TableGen, we don't distinguish iPTRAny (to any address space)
1500 // and iPTR. In the verifier, we can not distinguish which case we have so
1501 // allow either case to be legal.
1502 if (const PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
1503 Suffix += ".p" + utostr(PTyp->getAddressSpace()) +
1504 MVT::getMVT(PTyp->getElementType()).getMVTString();
1506 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1507 "pointer and a pointer is required.", F);
1510 } else if (MVT((MVT::SimpleValueType)VT).isVector()) {
1511 MVT VVT = MVT((MVT::SimpleValueType)VT);
1513 // If this is a vector argument, verify the number and type of elements.
1514 if (VVT.getVectorElementType() != MVT::getMVT(EltTy)) {
1515 CheckFailed("Intrinsic prototype has incorrect vector element type!", F);
1519 if (VVT.getVectorNumElements() != NumElts) {
1520 CheckFailed("Intrinsic prototype has incorrect number of "
1521 "vector elements!", F);
1524 } else if (MVT((MVT::SimpleValueType)VT).getTypeForMVT() != EltTy) {
1525 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is wrong!", F);
1527 } else if (EltTy != Ty) {
1528 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is a vector "
1529 "and a scalar is required.", F);
1536 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1537 /// Intrinsics.gen. This implements a little state machine that verifies the
1538 /// prototype of intrinsics.
1539 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
1541 unsigned ParamNum, ...) {
1543 va_start(VA, ParamNum);
1544 const FunctionType *FTy = F->getFunctionType();
1546 // For overloaded intrinsics, the Suffix of the function name must match the
1547 // types of the arguments. This variable keeps track of the expected
1548 // suffix, to be checked at the end.
1551 if (FTy->getNumParams() + FTy->isVarArg() != ParamNum) {
1552 CheckFailed("Intrinsic prototype has incorrect number of arguments!", F);
1556 const Type *Ty = FTy->getReturnType();
1557 const StructType *ST = dyn_cast<StructType>(Ty);
1559 // Verify the return types.
1560 if (ST && ST->getNumElements() != RetNum) {
1561 CheckFailed("Intrinsic prototype has incorrect number of return types!", F);
1565 for (unsigned ArgNo = 0; ArgNo < RetNum; ++ArgNo) {
1566 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1568 if (ST) Ty = ST->getElementType(ArgNo);
1570 if (!PerformTypeCheck(ID, F, Ty, VT, ArgNo, Suffix))
1574 // Verify the parameter types.
1575 for (unsigned ArgNo = 0; ArgNo < ParamNum; ++ArgNo) {
1576 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1578 if (VT == MVT::isVoid && ArgNo > 0) {
1579 if (!FTy->isVarArg())
1580 CheckFailed("Intrinsic prototype has no '...'!", F);
1584 if (!PerformTypeCheck(ID, F, FTy->getParamType(ArgNo), VT, ArgNo + RetNum,
1591 // For intrinsics without pointer arguments, if we computed a Suffix then the
1592 // intrinsic is overloaded and we need to make sure that the name of the
1593 // function is correct. We add the suffix to the name of the intrinsic and
1594 // compare against the given function name. If they are not the same, the
1595 // function name is invalid. This ensures that overloading of intrinsics
1596 // uses a sane and consistent naming convention. Note that intrinsics with
1597 // pointer argument may or may not be overloaded so we will check assuming it
1598 // has a suffix and not.
1599 if (!Suffix.empty()) {
1600 std::string Name(Intrinsic::getName(ID));
1601 if (Name + Suffix != F->getName()) {
1602 CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1603 F->getName().substr(Name.length()) + "'. It should be '" +
1608 // Check parameter attributes.
1609 Assert1(F->getAttributes() == Intrinsic::getAttributes(ID),
1610 "Intrinsic has wrong parameter attributes!", F);
1614 //===----------------------------------------------------------------------===//
1615 // Implement the public interfaces to this file...
1616 //===----------------------------------------------------------------------===//
1618 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1619 return new Verifier(action);
1623 // verifyFunction - Create
1624 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1625 Function &F = const_cast<Function&>(f);
1626 assert(!F.isDeclaration() && "Cannot verify external functions");
1628 ExistingModuleProvider MP(F.getParent());
1629 FunctionPassManager FPM(&MP);
1630 Verifier *V = new Verifier(action);
1637 /// verifyModule - Check a module for errors, printing messages on stderr.
1638 /// Return true if the module is corrupt.
1640 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1641 std::string *ErrorInfo) {
1643 Verifier *V = new Verifier(action);
1645 PM.run(const_cast<Module&>(M));
1647 if (ErrorInfo && V->Broken)
1648 *ErrorInfo = V->msgs.str();