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"
64 #include "llvm/Support/raw_ostream.h"
70 namespace { // Anonymous namespace for class
71 struct VISIBILITY_HIDDEN PreVerifier : public FunctionPass {
72 static char ID; // Pass ID, replacement for typeid
74 PreVerifier() : FunctionPass(&ID) { }
76 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
80 // Check that the prerequisites for successful DominatorTree construction
82 bool runOnFunction(Function &F) {
85 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
86 if (I->empty() || !I->back().isTerminator()) {
87 cerr << "Basic Block does not have terminator!\n";
88 WriteAsOperand(*cerr, I, true);
102 char PreVerifier::ID = 0;
103 static RegisterPass<PreVerifier>
104 PreVer("preverify", "Preliminary module verification");
105 static const PassInfo *const PreVerifyID = &PreVer;
108 struct VISIBILITY_HIDDEN
109 Verifier : public FunctionPass, InstVisitor<Verifier> {
110 static char ID; // Pass ID, replacement for typeid
111 bool Broken; // Is this module found to be broken?
112 bool RealPass; // Are we not being run by a PassManager?
113 VerifierFailureAction action;
114 // What to do if verification fails.
115 Module *Mod; // Module we are verifying right now
116 DominatorTree *DT; // Dominator Tree, caution can be null!
117 std::stringstream msgs; // A stringstream to collect messages
119 /// InstInThisBlock - when verifying a basic block, keep track of all of the
120 /// instructions we have seen so far. This allows us to do efficient
121 /// dominance checks for the case when an instruction has an operand that is
122 /// an instruction in the same block.
123 SmallPtrSet<Instruction*, 16> InstsInThisBlock;
127 Broken(false), RealPass(true), action(AbortProcessAction),
128 DT(0), msgs( std::ios::app | std::ios::out ) {}
129 explicit Verifier(VerifierFailureAction ctn)
131 Broken(false), RealPass(true), action(ctn), DT(0),
132 msgs( std::ios::app | std::ios::out ) {}
133 explicit Verifier(bool AB)
135 Broken(false), RealPass(true),
136 action( AB ? AbortProcessAction : PrintMessageAction), DT(0),
137 msgs( std::ios::app | std::ios::out ) {}
138 explicit Verifier(DominatorTree &dt)
140 Broken(false), RealPass(false), action(PrintMessageAction),
141 DT(&dt), msgs( std::ios::app | std::ios::out ) {}
144 bool doInitialization(Module &M) {
146 verifyTypeSymbolTable(M.getTypeSymbolTable());
148 // If this is a real pass, in a pass manager, we must abort before
149 // returning back to the pass manager, or else the pass manager may try to
150 // run other passes on the broken module.
152 return abortIfBroken();
156 bool runOnFunction(Function &F) {
157 // Get dominator information if we are being run by PassManager
158 if (RealPass) DT = &getAnalysis<DominatorTree>();
163 InstsInThisBlock.clear();
165 // If this is a real pass, in a pass manager, we must abort before
166 // returning back to the pass manager, or else the pass manager may try to
167 // run other passes on the broken module.
169 return abortIfBroken();
174 bool doFinalization(Module &M) {
175 // Scan through, checking all of the external function's linkage now...
176 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
177 visitGlobalValue(*I);
179 // Check to make sure function prototypes are okay.
180 if (I->isDeclaration()) visitFunction(*I);
183 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
185 visitGlobalVariable(*I);
187 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
189 visitGlobalAlias(*I);
191 // If the module is broken, abort at this time.
192 return abortIfBroken();
195 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
196 AU.setPreservesAll();
197 AU.addRequiredID(PreVerifyID);
199 AU.addRequired<DominatorTree>();
202 /// abortIfBroken - If the module is broken and we are supposed to abort on
203 /// this condition, do so.
205 bool abortIfBroken() {
206 if (!Broken) return false;
207 msgs << "Broken module found, ";
209 default: assert(0 && "Unknown action");
210 case AbortProcessAction:
211 msgs << "compilation aborted!\n";
214 case PrintMessageAction:
215 msgs << "verification continues.\n";
218 case ReturnStatusAction:
219 msgs << "compilation terminated.\n";
225 // Verification methods...
226 void verifyTypeSymbolTable(TypeSymbolTable &ST);
227 void visitGlobalValue(GlobalValue &GV);
228 void visitGlobalVariable(GlobalVariable &GV);
229 void visitGlobalAlias(GlobalAlias &GA);
230 void visitFunction(Function &F);
231 void visitBasicBlock(BasicBlock &BB);
232 using InstVisitor<Verifier>::visit;
234 void visit(Instruction &I);
236 void visitTruncInst(TruncInst &I);
237 void visitZExtInst(ZExtInst &I);
238 void visitSExtInst(SExtInst &I);
239 void visitFPTruncInst(FPTruncInst &I);
240 void visitFPExtInst(FPExtInst &I);
241 void visitFPToUIInst(FPToUIInst &I);
242 void visitFPToSIInst(FPToSIInst &I);
243 void visitUIToFPInst(UIToFPInst &I);
244 void visitSIToFPInst(SIToFPInst &I);
245 void visitIntToPtrInst(IntToPtrInst &I);
246 void visitPtrToIntInst(PtrToIntInst &I);
247 void visitBitCastInst(BitCastInst &I);
248 void visitPHINode(PHINode &PN);
249 void visitBinaryOperator(BinaryOperator &B);
250 void visitICmpInst(ICmpInst &IC);
251 void visitFCmpInst(FCmpInst &FC);
252 void visitExtractElementInst(ExtractElementInst &EI);
253 void visitInsertElementInst(InsertElementInst &EI);
254 void visitShuffleVectorInst(ShuffleVectorInst &EI);
255 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
256 void visitCallInst(CallInst &CI);
257 void visitInvokeInst(InvokeInst &II);
258 void visitGetElementPtrInst(GetElementPtrInst &GEP);
259 void visitLoadInst(LoadInst &LI);
260 void visitStoreInst(StoreInst &SI);
261 void visitInstruction(Instruction &I);
262 void visitTerminatorInst(TerminatorInst &I);
263 void visitReturnInst(ReturnInst &RI);
264 void visitSwitchInst(SwitchInst &SI);
265 void visitSelectInst(SelectInst &SI);
266 void visitUserOp1(Instruction &I);
267 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
268 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
269 void visitAllocationInst(AllocationInst &AI);
270 void visitExtractValueInst(ExtractValueInst &EVI);
271 void visitInsertValueInst(InsertValueInst &IVI);
273 void VerifyCallSite(CallSite CS);
274 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
275 int VT, unsigned ArgNo, std::string &Suffix);
276 void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
277 unsigned RetNum, unsigned ParamNum, ...);
278 void VerifyAttrs(Attributes Attrs, const Type *Ty,
279 bool isReturnValue, const Value *V);
280 void VerifyFunctionAttrs(const FunctionType *FT, const AttrListPtr &Attrs,
283 void WriteValue(const Value *V) {
285 if (isa<Instruction>(V)) {
288 WriteAsOperand(msgs, V, true, Mod);
293 void WriteType(const Type *T) {
295 raw_os_ostream RO(msgs);
297 WriteTypeSymbolic(RO, T, Mod);
301 // CheckFailed - A check failed, so print out the condition and the message
302 // that failed. This provides a nice place to put a breakpoint if you want
303 // to see why something is not correct.
304 void CheckFailed(const std::string &Message,
305 const Value *V1 = 0, const Value *V2 = 0,
306 const Value *V3 = 0, const Value *V4 = 0) {
307 msgs << Message << "\n";
315 void CheckFailed( const std::string& Message, const Value* V1,
316 const Type* T2, const Value* V3 = 0 ) {
317 msgs << Message << "\n";
324 } // End anonymous namespace
326 char Verifier::ID = 0;
327 static RegisterPass<Verifier> X("verify", "Module Verifier");
329 // Assert - We know that cond should be true, if not print an error message.
330 #define Assert(C, M) \
331 do { if (!(C)) { CheckFailed(M); return; } } while (0)
332 #define Assert1(C, M, V1) \
333 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
334 #define Assert2(C, M, V1, V2) \
335 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
336 #define Assert3(C, M, V1, V2, V3) \
337 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
338 #define Assert4(C, M, V1, V2, V3, V4) \
339 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
341 /// Check whether or not a Value is metadata or made up of a constant
342 /// expression involving metadata.
343 static bool isMetadata(Value *X) {
344 SmallPtrSet<Value *, 8> Visited;
345 SmallVector<Value *, 8> Queue;
348 while (!Queue.empty()) {
349 Value *V = Queue.back();
351 if (!Visited.insert(V))
354 if (isa<MDString>(V) || isa<MDNode>(V))
356 if (!isa<ConstantExpr>(V))
358 ConstantExpr *CE = cast<ConstantExpr>(V);
360 if (CE->getType() != Type::EmptyStructTy)
363 // The only constant expression that works on metadata type is select.
364 if (CE->getOpcode() != Instruction::Select) return false;
366 Queue.push_back(CE->getOperand(1));
367 Queue.push_back(CE->getOperand(2));
372 void Verifier::visit(Instruction &I) {
373 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
374 Assert1(I.getOperand(i) != 0, "Operand is null", &I);
375 InstVisitor<Verifier>::visit(I);
379 void Verifier::visitGlobalValue(GlobalValue &GV) {
380 Assert1(!GV.isDeclaration() ||
381 GV.hasExternalLinkage() ||
382 GV.hasDLLImportLinkage() ||
383 GV.hasExternalWeakLinkage() ||
384 GV.hasGhostLinkage() ||
385 (isa<GlobalAlias>(GV) &&
386 (GV.hasLocalLinkage() || GV.hasWeakLinkage())),
387 "Global is external, but doesn't have external or dllimport or weak linkage!",
390 Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
391 "Global is marked as dllimport, but not external", &GV);
393 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
394 "Only global variables can have appending linkage!", &GV);
396 if (GV.hasAppendingLinkage()) {
397 GlobalVariable &GVar = cast<GlobalVariable>(GV);
398 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
399 "Only global arrays can have appending linkage!", &GV);
403 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
404 if (GV.hasInitializer()) {
405 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
406 "Global variable initializer type does not match global "
407 "variable type!", &GV);
409 Assert1(GV.hasExternalLinkage() || GV.hasDLLImportLinkage() ||
410 GV.hasExternalWeakLinkage(),
411 "invalid linkage type for global declaration", &GV);
414 visitGlobalValue(GV);
417 void Verifier::visitGlobalAlias(GlobalAlias &GA) {
418 Assert1(!GA.getName().empty(),
419 "Alias name cannot be empty!", &GA);
420 Assert1(GA.hasExternalLinkage() || GA.hasLocalLinkage() ||
422 "Alias should have external or external weak linkage!", &GA);
423 Assert1(GA.getAliasee(),
424 "Aliasee cannot be NULL!", &GA);
425 Assert1(GA.getType() == GA.getAliasee()->getType(),
426 "Alias and aliasee types should match!", &GA);
428 if (!isa<GlobalValue>(GA.getAliasee())) {
429 const ConstantExpr *CE = dyn_cast<ConstantExpr>(GA.getAliasee());
430 Assert1(CE && CE->getOpcode() == Instruction::BitCast &&
431 isa<GlobalValue>(CE->getOperand(0)),
432 "Aliasee should be either GlobalValue or bitcast of GlobalValue",
436 const GlobalValue* Aliasee = GA.resolveAliasedGlobal(/*stopOnWeak*/ false);
438 "Aliasing chain should end with function or global variable", &GA);
440 visitGlobalValue(GA);
443 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
446 // VerifyAttrs - Check the given parameter attributes for an argument or return
447 // value of the specified type. The value V is printed in error messages.
448 void Verifier::VerifyAttrs(Attributes Attrs, const Type *Ty,
449 bool isReturnValue, const Value *V) {
450 if (Attrs == Attribute::None)
454 Attributes RetI = Attrs & Attribute::ParameterOnly;
455 Assert1(!RetI, "Attribute " + Attribute::getAsString(RetI) +
456 " does not apply to return values!", V);
458 Attributes FnCheckAttr = Attrs & Attribute::FunctionOnly;
459 Assert1(!FnCheckAttr, "Attribute " + Attribute::getAsString(FnCheckAttr) +
460 " only applies to functions!", V);
463 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
464 Attributes MutI = Attrs & Attribute::MutuallyIncompatible[i];
465 Assert1(!(MutI & (MutI - 1)), "Attributes " +
466 Attribute::getAsString(MutI) + " are incompatible!", V);
469 Attributes TypeI = Attrs & Attribute::typeIncompatible(Ty);
470 Assert1(!TypeI, "Wrong type for attribute " +
471 Attribute::getAsString(TypeI), V);
473 Attributes ByValI = Attrs & Attribute::ByVal;
474 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
475 Assert1(!ByValI || PTy->getElementType()->isSized(),
476 "Attribute " + Attribute::getAsString(ByValI) +
477 " does not support unsized types!", V);
480 "Attribute " + Attribute::getAsString(ByValI) +
481 " only applies to parameters with pointer type!", V);
485 // VerifyFunctionAttrs - Check parameter attributes against a function type.
486 // The value V is printed in error messages.
487 void Verifier::VerifyFunctionAttrs(const FunctionType *FT,
488 const AttrListPtr &Attrs,
493 bool SawNest = false;
495 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
496 const AttributeWithIndex &Attr = Attrs.getSlot(i);
500 Ty = FT->getReturnType();
501 else if (Attr.Index-1 < FT->getNumParams())
502 Ty = FT->getParamType(Attr.Index-1);
504 break; // VarArgs attributes, don't verify.
506 VerifyAttrs(Attr.Attrs, Ty, Attr.Index == 0, V);
508 if (Attr.Attrs & Attribute::Nest) {
509 Assert1(!SawNest, "More than one parameter has attribute nest!", V);
513 if (Attr.Attrs & Attribute::StructRet)
514 Assert1(Attr.Index == 1, "Attribute sret not on first parameter!", V);
517 Attributes FAttrs = Attrs.getFnAttributes();
518 Assert1(!(FAttrs & (~Attribute::FunctionOnly)),
519 "Attribute " + Attribute::getAsString(FAttrs) +
520 " does not apply to function!", V);
523 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
524 Attributes MutI = FAttrs & Attribute::MutuallyIncompatible[i];
525 Assert1(!(MutI & (MutI - 1)), "Attributes " +
526 Attribute::getAsString(MutI) + " are incompatible!", V);
530 static bool VerifyAttributeCount(const AttrListPtr &Attrs, unsigned Params) {
534 unsigned LastSlot = Attrs.getNumSlots() - 1;
535 unsigned LastIndex = Attrs.getSlot(LastSlot).Index;
536 if (LastIndex <= Params
537 || (LastIndex == (unsigned)~0
538 && (LastSlot == 0 || Attrs.getSlot(LastSlot - 1).Index <= Params)))
543 // visitFunction - Verify that a function is ok.
545 void Verifier::visitFunction(Function &F) {
546 // Check function arguments.
547 const FunctionType *FT = F.getFunctionType();
548 unsigned NumArgs = F.arg_size();
550 Assert2(FT->getNumParams() == NumArgs,
551 "# formal arguments must match # of arguments for function type!",
553 Assert1(F.getReturnType()->isFirstClassType() ||
554 F.getReturnType() == Type::VoidTy ||
555 isa<StructType>(F.getReturnType()),
556 "Functions cannot return aggregate values!", &F);
558 Assert1(!F.hasStructRetAttr() || F.getReturnType() == Type::VoidTy,
559 "Invalid struct return type!", &F);
561 const AttrListPtr &Attrs = F.getAttributes();
563 Assert1(VerifyAttributeCount(Attrs, FT->getNumParams()),
564 "Attributes after last parameter!", &F);
566 // Check function attributes.
567 VerifyFunctionAttrs(FT, Attrs, &F);
569 // Check that this function meets the restrictions on this calling convention.
570 switch (F.getCallingConv()) {
575 case CallingConv::Fast:
576 case CallingConv::Cold:
577 case CallingConv::X86_FastCall:
578 Assert1(!F.isVarArg(),
579 "Varargs functions must have C calling conventions!", &F);
583 // Check that the argument values match the function type for this function...
585 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
587 Assert2(I->getType() == FT->getParamType(i),
588 "Argument value does not match function argument type!",
589 I, FT->getParamType(i));
590 Assert1(I->getType()->isFirstClassType(),
591 "Function arguments must have first-class types!", I);
594 if (F.isDeclaration()) {
595 Assert1(F.hasExternalLinkage() || F.hasDLLImportLinkage() ||
596 F.hasExternalWeakLinkage() || F.hasGhostLinkage(),
597 "invalid linkage type for function declaration", &F);
599 // Verify that this function (which has a body) is not named "llvm.*". It
600 // is not legal to define intrinsics.
601 if (F.getName().size() >= 5)
602 Assert1(F.getName().substr(0, 5) != "llvm.",
603 "llvm intrinsics cannot be defined!", &F);
605 // Check the entry node
606 BasicBlock *Entry = &F.getEntryBlock();
607 Assert1(pred_begin(Entry) == pred_end(Entry),
608 "Entry block to function must not have predecessors!", Entry);
613 // verifyBasicBlock - Verify that a basic block is well formed...
615 void Verifier::visitBasicBlock(BasicBlock &BB) {
616 InstsInThisBlock.clear();
618 // Ensure that basic blocks have terminators!
619 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
621 // Check constraints that this basic block imposes on all of the PHI nodes in
623 if (isa<PHINode>(BB.front())) {
624 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
625 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
626 std::sort(Preds.begin(), Preds.end());
628 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
630 // Ensure that PHI nodes have at least one entry!
631 Assert1(PN->getNumIncomingValues() != 0,
632 "PHI nodes must have at least one entry. If the block is dead, "
633 "the PHI should be removed!", PN);
634 Assert1(PN->getNumIncomingValues() == Preds.size(),
635 "PHINode should have one entry for each predecessor of its "
636 "parent basic block!", PN);
638 // Get and sort all incoming values in the PHI node...
640 Values.reserve(PN->getNumIncomingValues());
641 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
642 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
643 PN->getIncomingValue(i)));
644 std::sort(Values.begin(), Values.end());
646 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
647 // Check to make sure that if there is more than one entry for a
648 // particular basic block in this PHI node, that the incoming values are
651 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
652 Values[i].second == Values[i-1].second,
653 "PHI node has multiple entries for the same basic block with "
654 "different incoming values!", PN, Values[i].first,
655 Values[i].second, Values[i-1].second);
657 // Check to make sure that the predecessors and PHI node entries are
659 Assert3(Values[i].first == Preds[i],
660 "PHI node entries do not match predecessors!", PN,
661 Values[i].first, Preds[i]);
667 void Verifier::visitTerminatorInst(TerminatorInst &I) {
668 // Ensure that terminators only exist at the end of the basic block.
669 Assert1(&I == I.getParent()->getTerminator(),
670 "Terminator found in the middle of a basic block!", I.getParent());
674 void Verifier::visitReturnInst(ReturnInst &RI) {
675 Function *F = RI.getParent()->getParent();
676 unsigned N = RI.getNumOperands();
677 if (F->getReturnType() == Type::VoidTy)
679 "Found return instr that returns non-void in Function of void "
680 "return type!", &RI, F->getReturnType());
681 else if (N == 1 && F->getReturnType() == RI.getOperand(0)->getType()) {
682 Assert1(!isMetadata(RI.getOperand(0)), "Invalid use of metadata!", &RI);
683 // Exactly one return value and it matches the return type. Good.
684 } else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
685 // The return type is a struct; check for multiple return values.
686 Assert2(STy->getNumElements() == N,
687 "Incorrect number of return values in ret instruction!",
688 &RI, F->getReturnType());
689 for (unsigned i = 0; i != N; ++i)
690 Assert2(STy->getElementType(i) == RI.getOperand(i)->getType(),
691 "Function return type does not match operand "
692 "type of return inst!", &RI, F->getReturnType());
693 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(F->getReturnType())) {
694 // The return type is an array; check for multiple return values.
695 Assert2(ATy->getNumElements() == N,
696 "Incorrect number of return values in ret instruction!",
697 &RI, F->getReturnType());
698 for (unsigned i = 0; i != N; ++i)
699 Assert2(ATy->getElementType() == RI.getOperand(i)->getType(),
700 "Function return type does not match operand "
701 "type of return inst!", &RI, F->getReturnType());
703 CheckFailed("Function return type does not match operand "
704 "type of return inst!", &RI, F->getReturnType());
707 // Check to make sure that the return value has necessary properties for
709 visitTerminatorInst(RI);
712 void Verifier::visitSwitchInst(SwitchInst &SI) {
713 // Check to make sure that all of the constants in the switch instruction
714 // have the same type as the switched-on value.
715 const Type *SwitchTy = SI.getCondition()->getType();
716 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
717 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
718 "Switch constants must all be same type as switch value!", &SI);
720 visitTerminatorInst(SI);
723 void Verifier::visitSelectInst(SelectInst &SI) {
724 Assert1(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
726 "Invalid operands for select instruction!", &SI);
728 Assert1(SI.getTrueValue()->getType() == SI.getType(),
729 "Select values must have same type as select instruction!", &SI);
730 Assert1(!isMetadata(SI.getOperand(1)) && !isMetadata(SI.getOperand(2)),
731 "Invalid use of metadata!", &SI);
732 visitInstruction(SI);
736 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
737 /// a pass, if any exist, it's an error.
739 void Verifier::visitUserOp1(Instruction &I) {
740 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
743 void Verifier::visitTruncInst(TruncInst &I) {
744 // Get the source and destination types
745 const Type *SrcTy = I.getOperand(0)->getType();
746 const Type *DestTy = I.getType();
748 // Get the size of the types in bits, we'll need this later
749 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
750 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
752 Assert1(SrcTy->isIntOrIntVector(), "Trunc only operates on integer", &I);
753 Assert1(DestTy->isIntOrIntVector(), "Trunc only produces integer", &I);
754 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
755 "trunc source and destination must both be a vector or neither", &I);
756 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
761 void Verifier::visitZExtInst(ZExtInst &I) {
762 // Get the source and destination types
763 const Type *SrcTy = I.getOperand(0)->getType();
764 const Type *DestTy = I.getType();
766 // Get the size of the types in bits, we'll need this later
767 Assert1(SrcTy->isIntOrIntVector(), "ZExt only operates on integer", &I);
768 Assert1(DestTy->isIntOrIntVector(), "ZExt only produces an integer", &I);
769 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
770 "zext source and destination must both be a vector or neither", &I);
771 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
772 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
774 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
779 void Verifier::visitSExtInst(SExtInst &I) {
780 // Get the source and destination types
781 const Type *SrcTy = I.getOperand(0)->getType();
782 const Type *DestTy = I.getType();
784 // Get the size of the types in bits, we'll need this later
785 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
786 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
788 Assert1(SrcTy->isIntOrIntVector(), "SExt only operates on integer", &I);
789 Assert1(DestTy->isIntOrIntVector(), "SExt only produces an integer", &I);
790 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
791 "sext source and destination must both be a vector or neither", &I);
792 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
797 void Verifier::visitFPTruncInst(FPTruncInst &I) {
798 // Get the source and destination types
799 const Type *SrcTy = I.getOperand(0)->getType();
800 const Type *DestTy = I.getType();
801 // Get the size of the types in bits, we'll need this later
802 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
803 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
805 Assert1(SrcTy->isFPOrFPVector(),"FPTrunc only operates on FP", &I);
806 Assert1(DestTy->isFPOrFPVector(),"FPTrunc only produces an FP", &I);
807 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
808 "fptrunc source and destination must both be a vector or neither",&I);
809 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
814 void Verifier::visitFPExtInst(FPExtInst &I) {
815 // Get the source and destination types
816 const Type *SrcTy = I.getOperand(0)->getType();
817 const Type *DestTy = I.getType();
819 // Get the size of the types in bits, we'll need this later
820 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
821 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
823 Assert1(SrcTy->isFPOrFPVector(),"FPExt only operates on FP", &I);
824 Assert1(DestTy->isFPOrFPVector(),"FPExt only produces an FP", &I);
825 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
826 "fpext source and destination must both be a vector or neither", &I);
827 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
832 void Verifier::visitUIToFPInst(UIToFPInst &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 "UIToFP source and dest must both be vector or scalar", &I);
842 Assert1(SrcTy->isIntOrIntVector(),
843 "UIToFP source must be integer or integer vector", &I);
844 Assert1(DestTy->isFPOrFPVector(),
845 "UIToFP result must be FP or FP vector", &I);
847 if (SrcVec && DstVec)
848 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
849 cast<VectorType>(DestTy)->getNumElements(),
850 "UIToFP source and dest vector length mismatch", &I);
855 void Verifier::visitSIToFPInst(SIToFPInst &I) {
856 // Get the source and destination types
857 const Type *SrcTy = I.getOperand(0)->getType();
858 const Type *DestTy = I.getType();
860 bool SrcVec = SrcTy->getTypeID() == Type::VectorTyID;
861 bool DstVec = DestTy->getTypeID() == Type::VectorTyID;
863 Assert1(SrcVec == DstVec,
864 "SIToFP source and dest must both be vector or scalar", &I);
865 Assert1(SrcTy->isIntOrIntVector(),
866 "SIToFP source must be integer or integer vector", &I);
867 Assert1(DestTy->isFPOrFPVector(),
868 "SIToFP result must be FP or FP vector", &I);
870 if (SrcVec && DstVec)
871 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
872 cast<VectorType>(DestTy)->getNumElements(),
873 "SIToFP source and dest vector length mismatch", &I);
878 void Verifier::visitFPToUIInst(FPToUIInst &I) {
879 // Get the source and destination types
880 const Type *SrcTy = I.getOperand(0)->getType();
881 const Type *DestTy = I.getType();
883 bool SrcVec = isa<VectorType>(SrcTy);
884 bool DstVec = isa<VectorType>(DestTy);
886 Assert1(SrcVec == DstVec,
887 "FPToUI source and dest must both be vector or scalar", &I);
888 Assert1(SrcTy->isFPOrFPVector(), "FPToUI source must be FP or FP vector", &I);
889 Assert1(DestTy->isIntOrIntVector(),
890 "FPToUI result must be integer or integer vector", &I);
892 if (SrcVec && DstVec)
893 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
894 cast<VectorType>(DestTy)->getNumElements(),
895 "FPToUI source and dest vector length mismatch", &I);
900 void Verifier::visitFPToSIInst(FPToSIInst &I) {
901 // Get the source and destination types
902 const Type *SrcTy = I.getOperand(0)->getType();
903 const Type *DestTy = I.getType();
905 bool SrcVec = isa<VectorType>(SrcTy);
906 bool DstVec = isa<VectorType>(DestTy);
908 Assert1(SrcVec == DstVec,
909 "FPToSI source and dest must both be vector or scalar", &I);
910 Assert1(SrcTy->isFPOrFPVector(),
911 "FPToSI source must be FP or FP vector", &I);
912 Assert1(DestTy->isIntOrIntVector(),
913 "FPToSI result must be integer or integer vector", &I);
915 if (SrcVec && DstVec)
916 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
917 cast<VectorType>(DestTy)->getNumElements(),
918 "FPToSI source and dest vector length mismatch", &I);
923 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
924 // Get the source and destination types
925 const Type *SrcTy = I.getOperand(0)->getType();
926 const Type *DestTy = I.getType();
928 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
929 Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
934 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
935 // Get the source and destination types
936 const Type *SrcTy = I.getOperand(0)->getType();
937 const Type *DestTy = I.getType();
939 Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
940 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
945 void Verifier::visitBitCastInst(BitCastInst &I) {
946 // Get the source and destination types
947 const Type *SrcTy = I.getOperand(0)->getType();
948 const Type *DestTy = I.getType();
950 // Get the size of the types in bits, we'll need this later
951 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
952 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
954 // BitCast implies a no-op cast of type only. No bits change.
955 // However, you can't cast pointers to anything but pointers.
956 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
957 "Bitcast requires both operands to be pointer or neither", &I);
958 Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
960 // Disallow aggregates.
961 Assert1(!SrcTy->isAggregateType(),
962 "Bitcast operand must not be aggregate", &I);
963 Assert1(!DestTy->isAggregateType(),
964 "Bitcast type must not be aggregate", &I);
969 /// visitPHINode - Ensure that a PHI node is well formed.
971 void Verifier::visitPHINode(PHINode &PN) {
972 // Ensure that the PHI nodes are all grouped together at the top of the block.
973 // This can be tested by checking whether the instruction before this is
974 // either nonexistent (because this is begin()) or is a PHI node. If not,
975 // then there is some other instruction before a PHI.
976 Assert2(&PN == &PN.getParent()->front() ||
977 isa<PHINode>(--BasicBlock::iterator(&PN)),
978 "PHI nodes not grouped at top of basic block!",
979 &PN, PN.getParent());
981 // Check that all of the operands of the PHI node have the same type as the
983 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
984 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
985 "PHI node operands are not the same type as the result!", &PN);
987 // Check that it's not a PHI of metadata.
988 if (PN.getType() == Type::EmptyStructTy) {
989 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
990 Assert1(!isMetadata(PN.getIncomingValue(i)),
991 "Invalid use of metadata!", &PN);
994 // All other PHI node constraints are checked in the visitBasicBlock method.
996 visitInstruction(PN);
999 void Verifier::VerifyCallSite(CallSite CS) {
1000 Instruction *I = CS.getInstruction();
1002 Assert1(isa<PointerType>(CS.getCalledValue()->getType()),
1003 "Called function must be a pointer!", I);
1004 const PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
1005 Assert1(isa<FunctionType>(FPTy->getElementType()),
1006 "Called function is not pointer to function type!", I);
1008 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1010 // Verify that the correct number of arguments are being passed
1011 if (FTy->isVarArg())
1012 Assert1(CS.arg_size() >= FTy->getNumParams(),
1013 "Called function requires more parameters than were provided!",I);
1015 Assert1(CS.arg_size() == FTy->getNumParams(),
1016 "Incorrect number of arguments passed to called function!", I);
1018 // Verify that all arguments to the call match the function type...
1019 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1020 Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
1021 "Call parameter type does not match function signature!",
1022 CS.getArgument(i), FTy->getParamType(i), I);
1024 if (CS.getCalledValue()->getNameLen() < 5 ||
1025 strncmp(CS.getCalledValue()->getNameStart(), "llvm.", 5) != 0) {
1026 // Verify that none of the arguments are metadata...
1027 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1028 Assert2(!isMetadata(CS.getArgument(i)), "Invalid use of metadata!",
1029 CS.getArgument(i), I);
1032 const AttrListPtr &Attrs = CS.getAttributes();
1034 Assert1(VerifyAttributeCount(Attrs, CS.arg_size()),
1035 "Attributes after last parameter!", I);
1037 // Verify call attributes.
1038 VerifyFunctionAttrs(FTy, Attrs, I);
1040 if (FTy->isVarArg())
1041 // Check attributes on the varargs part.
1042 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
1043 Attributes Attr = Attrs.getParamAttributes(Idx);
1045 VerifyAttrs(Attr, CS.getArgument(Idx-1)->getType(), false, I);
1047 Attributes VArgI = Attr & Attribute::VarArgsIncompatible;
1048 Assert1(!VArgI, "Attribute " + Attribute::getAsString(VArgI) +
1049 " cannot be used for vararg call arguments!", I);
1052 visitInstruction(*I);
1055 void Verifier::visitCallInst(CallInst &CI) {
1056 VerifyCallSite(&CI);
1058 if (Function *F = CI.getCalledFunction())
1059 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
1060 visitIntrinsicFunctionCall(ID, CI);
1063 void Verifier::visitInvokeInst(InvokeInst &II) {
1064 VerifyCallSite(&II);
1067 /// visitBinaryOperator - Check that both arguments to the binary operator are
1068 /// of the same type!
1070 void Verifier::visitBinaryOperator(BinaryOperator &B) {
1071 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
1072 "Both operands to a binary operator are not of the same type!", &B);
1074 switch (B.getOpcode()) {
1075 // Check that logical operators are only used with integral operands.
1076 case Instruction::And:
1077 case Instruction::Or:
1078 case Instruction::Xor:
1079 Assert1(B.getType()->isInteger() ||
1080 (isa<VectorType>(B.getType()) &&
1081 cast<VectorType>(B.getType())->getElementType()->isInteger()),
1082 "Logical operators only work with integral types!", &B);
1083 Assert1(B.getType() == B.getOperand(0)->getType(),
1084 "Logical operators must have same type for operands and result!",
1087 case Instruction::Shl:
1088 case Instruction::LShr:
1089 case Instruction::AShr:
1090 Assert1(B.getType()->isInteger() ||
1091 (isa<VectorType>(B.getType()) &&
1092 cast<VectorType>(B.getType())->getElementType()->isInteger()),
1093 "Shifts only work with integral types!", &B);
1094 Assert1(B.getType() == B.getOperand(0)->getType(),
1095 "Shift return type must be same as operands!", &B);
1098 // Arithmetic operators only work on integer or fp values
1099 Assert1(B.getType() == B.getOperand(0)->getType(),
1100 "Arithmetic operators must have same type for operands and result!",
1102 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
1103 isa<VectorType>(B.getType()),
1104 "Arithmetic operators must have integer, fp, or vector type!", &B);
1108 visitInstruction(B);
1111 void Verifier::visitICmpInst(ICmpInst& IC) {
1112 // Check that the operands are the same type
1113 const Type* Op0Ty = IC.getOperand(0)->getType();
1114 const Type* Op1Ty = IC.getOperand(1)->getType();
1115 Assert1(Op0Ty == Op1Ty,
1116 "Both operands to ICmp instruction are not of the same type!", &IC);
1117 // Check that the operands are the right type
1118 Assert1(Op0Ty->isIntOrIntVector() || isa<PointerType>(Op0Ty),
1119 "Invalid operand types for ICmp instruction", &IC);
1120 visitInstruction(IC);
1123 void Verifier::visitFCmpInst(FCmpInst& FC) {
1124 // Check that the operands are the same type
1125 const Type* Op0Ty = FC.getOperand(0)->getType();
1126 const Type* Op1Ty = FC.getOperand(1)->getType();
1127 Assert1(Op0Ty == Op1Ty,
1128 "Both operands to FCmp instruction are not of the same type!", &FC);
1129 // Check that the operands are the right type
1130 Assert1(Op0Ty->isFPOrFPVector(),
1131 "Invalid operand types for FCmp instruction", &FC);
1132 visitInstruction(FC);
1135 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
1136 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
1138 "Invalid extractelement operands!", &EI);
1139 visitInstruction(EI);
1142 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
1143 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
1146 "Invalid insertelement operands!", &IE);
1147 visitInstruction(IE);
1150 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
1151 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
1153 "Invalid shufflevector operands!", &SV);
1155 const VectorType *VTy = dyn_cast<VectorType>(SV.getOperand(0)->getType());
1156 Assert1(VTy, "Operands are not a vector type", &SV);
1158 // Check to see if Mask is valid.
1159 if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
1160 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
1161 if (ConstantInt* CI = dyn_cast<ConstantInt>(MV->getOperand(i))) {
1162 Assert1(!CI->uge(VTy->getNumElements()*2),
1163 "Invalid shufflevector shuffle mask!", &SV);
1165 Assert1(isa<UndefValue>(MV->getOperand(i)),
1166 "Invalid shufflevector shuffle mask!", &SV);
1170 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
1171 isa<ConstantAggregateZero>(SV.getOperand(2)),
1172 "Invalid shufflevector shuffle mask!", &SV);
1175 visitInstruction(SV);
1178 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1179 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
1181 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
1182 Idxs.begin(), Idxs.end());
1183 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
1184 Assert2(isa<PointerType>(GEP.getType()) &&
1185 cast<PointerType>(GEP.getType())->getElementType() == ElTy,
1186 "GEP is not of right type for indices!", &GEP, ElTy);
1187 visitInstruction(GEP);
1190 void Verifier::visitLoadInst(LoadInst &LI) {
1192 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
1193 Assert2(ElTy == LI.getType(),
1194 "Load result type does not match pointer operand type!", &LI, ElTy);
1195 visitInstruction(LI);
1198 void Verifier::visitStoreInst(StoreInst &SI) {
1200 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
1201 Assert2(ElTy == SI.getOperand(0)->getType(),
1202 "Stored value type does not match pointer operand type!", &SI, ElTy);
1203 Assert1(!isMetadata(SI.getOperand(0)), "Invalid use of metadata!", &SI);
1204 visitInstruction(SI);
1207 void Verifier::visitAllocationInst(AllocationInst &AI) {
1208 const PointerType *PTy = AI.getType();
1209 Assert1(PTy->getAddressSpace() == 0,
1210 "Allocation instruction pointer not in the generic address space!",
1212 Assert1(PTy->getElementType()->isSized(), "Cannot allocate unsized type",
1214 visitInstruction(AI);
1217 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
1218 Assert1(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
1219 EVI.idx_begin(), EVI.idx_end()) ==
1221 "Invalid ExtractValueInst operands!", &EVI);
1223 visitInstruction(EVI);
1226 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
1227 Assert1(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
1228 IVI.idx_begin(), IVI.idx_end()) ==
1229 IVI.getOperand(1)->getType(),
1230 "Invalid InsertValueInst operands!", &IVI);
1232 visitInstruction(IVI);
1235 /// verifyInstruction - Verify that an instruction is well formed.
1237 void Verifier::visitInstruction(Instruction &I) {
1238 BasicBlock *BB = I.getParent();
1239 Assert1(BB, "Instruction not embedded in basic block!", &I);
1241 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
1242 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
1244 Assert1(*UI != (User*)&I ||
1245 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1246 "Only PHI nodes may reference their own value!", &I);
1249 // Verify that if this is a terminator that it is at the end of the block.
1250 if (isa<TerminatorInst>(I))
1251 Assert1(BB->getTerminator() == &I, "Terminator not at end of block!", &I);
1254 // Check that void typed values don't have names
1255 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
1256 "Instruction has a name, but provides a void value!", &I);
1258 // Check that the return value of the instruction is either void or a legal
1260 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType()
1261 || ((isa<CallInst>(I) || isa<InvokeInst>(I))
1262 && isa<StructType>(I.getType())),
1263 "Instruction returns a non-scalar type!", &I);
1265 // Check that all uses of the instruction, if they are instructions
1266 // themselves, actually have parent basic blocks. If the use is not an
1267 // instruction, it is an error!
1268 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
1270 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
1272 Instruction *Used = cast<Instruction>(*UI);
1273 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
1274 " embedded in a basic block!", &I, Used);
1277 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1278 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
1280 // Check to make sure that only first-class-values are operands to
1282 if (!I.getOperand(i)->getType()->isFirstClassType()) {
1283 Assert1(0, "Instruction operands must be first-class values!", &I);
1286 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
1287 // Check to make sure that the "address of" an intrinsic function is never
1289 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
1290 "Cannot take the address of an intrinsic!", &I);
1291 Assert1(F->getParent() == Mod, "Referencing function in another module!",
1293 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
1294 Assert1(OpBB->getParent() == BB->getParent(),
1295 "Referring to a basic block in another function!", &I);
1296 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
1297 Assert1(OpArg->getParent() == BB->getParent(),
1298 "Referring to an argument in another function!", &I);
1299 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
1300 Assert1(GV->getParent() == Mod, "Referencing global in another module!",
1302 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
1303 BasicBlock *OpBlock = Op->getParent();
1305 // Check that a definition dominates all of its uses.
1306 if (!isa<PHINode>(I)) {
1307 // Invoke results are only usable in the normal destination, not in the
1308 // exceptional destination.
1309 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1310 OpBlock = II->getNormalDest();
1312 Assert2(OpBlock != II->getUnwindDest(),
1313 "No uses of invoke possible due to dominance structure!",
1316 // If the normal successor of an invoke instruction has multiple
1317 // predecessors, then the normal edge from the invoke is critical, so
1318 // the invoke value can only be live if the destination block
1319 // dominates all of it's predecessors (other than the invoke) or if
1320 // the invoke value is only used by a phi in the successor.
1321 if (!OpBlock->getSinglePredecessor() &&
1322 DT->dominates(&BB->getParent()->getEntryBlock(), BB)) {
1323 // The first case we allow is if the use is a PHI operand in the
1324 // normal block, and if that PHI operand corresponds to the invoke's
1327 if (PHINode *PN = dyn_cast<PHINode>(&I))
1328 if (PN->getParent() == OpBlock &&
1329 PN->getIncomingBlock(i/2) == Op->getParent())
1332 // If it is used by something non-phi, then the other case is that
1333 // 'OpBlock' dominates all of its predecessors other than the
1334 // invoke. In this case, the invoke value can still be used.
1337 for (pred_iterator PI = pred_begin(OpBlock),
1338 E = pred_end(OpBlock); PI != E; ++PI) {
1339 if (*PI != II->getParent() && !DT->dominates(OpBlock, *PI)) {
1346 "Invoke value defined on critical edge but not dead!", &I,
1349 } else if (OpBlock == BB) {
1350 // If they are in the same basic block, make sure that the definition
1351 // comes before the use.
1352 Assert2(InstsInThisBlock.count(Op) ||
1353 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1354 "Instruction does not dominate all uses!", Op, &I);
1357 // Definition must dominate use unless use is unreachable!
1358 Assert2(InstsInThisBlock.count(Op) || DT->dominates(Op, &I) ||
1359 !DT->dominates(&BB->getParent()->getEntryBlock(), BB),
1360 "Instruction does not dominate all uses!", Op, &I);
1362 // PHI nodes are more difficult than other nodes because they actually
1363 // "use" the value in the predecessor basic blocks they correspond to.
1364 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
1365 Assert2(DT->dominates(OpBlock, PredBB) ||
1366 !DT->dominates(&BB->getParent()->getEntryBlock(), PredBB),
1367 "Instruction does not dominate all uses!", Op, &I);
1369 } else if (isa<InlineAsm>(I.getOperand(i))) {
1370 Assert1(i == 0 && (isa<CallInst>(I) || isa<InvokeInst>(I)),
1371 "Cannot take the address of an inline asm!", &I);
1374 InstsInThisBlock.insert(&I);
1377 // Flags used by TableGen to mark intrinsic parameters with the
1378 // LLVMExtendedElementVectorType and LLVMTruncatedElementVectorType classes.
1379 static const unsigned ExtendedElementVectorType = 0x40000000;
1380 static const unsigned TruncatedElementVectorType = 0x20000000;
1382 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1384 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1385 Function *IF = CI.getCalledFunction();
1386 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1389 #define GET_INTRINSIC_VERIFIER
1390 #include "llvm/Intrinsics.gen"
1391 #undef GET_INTRINSIC_VERIFIER
1396 case Intrinsic::dbg_declare: // llvm.dbg.declare
1397 if (Constant *C = dyn_cast<Constant>(CI.getOperand(1)))
1398 Assert1(C && !isa<ConstantPointerNull>(C),
1399 "invalid llvm.dbg.declare intrinsic call", &CI);
1401 case Intrinsic::memcpy:
1402 case Intrinsic::memmove:
1403 case Intrinsic::memset:
1404 Assert1(isa<ConstantInt>(CI.getOperand(4)),
1405 "alignment argument of memory intrinsics must be a constant int",
1408 case Intrinsic::gcroot:
1409 case Intrinsic::gcwrite:
1410 case Intrinsic::gcread:
1411 if (ID == Intrinsic::gcroot) {
1413 dyn_cast<AllocaInst>(CI.getOperand(1)->stripPointerCasts());
1414 Assert1(AI && isa<PointerType>(AI->getType()->getElementType()),
1415 "llvm.gcroot parameter #1 must be a pointer alloca.", &CI);
1416 Assert1(isa<Constant>(CI.getOperand(2)),
1417 "llvm.gcroot parameter #2 must be a constant.", &CI);
1420 Assert1(CI.getParent()->getParent()->hasGC(),
1421 "Enclosing function does not use GC.", &CI);
1423 case Intrinsic::init_trampoline:
1424 Assert1(isa<Function>(CI.getOperand(2)->stripPointerCasts()),
1425 "llvm.init_trampoline parameter #2 must resolve to a function.",
1428 case Intrinsic::prefetch:
1429 Assert1(isa<ConstantInt>(CI.getOperand(2)) &&
1430 isa<ConstantInt>(CI.getOperand(3)) &&
1431 cast<ConstantInt>(CI.getOperand(2))->getZExtValue() < 2 &&
1432 cast<ConstantInt>(CI.getOperand(3))->getZExtValue() < 4,
1433 "invalid arguments to llvm.prefetch",
1436 case Intrinsic::stackprotector:
1437 Assert1(isa<AllocaInst>(CI.getOperand(2)->stripPointerCasts()),
1438 "llvm.stackprotector parameter #2 must resolve to an alloca.",
1444 /// Produce a string to identify an intrinsic parameter or return value.
1445 /// The ArgNo value numbers the return values from 0 to NumRets-1 and the
1446 /// parameters beginning with NumRets.
1448 static std::string IntrinsicParam(unsigned ArgNo, unsigned NumRets) {
1449 if (ArgNo < NumRets) {
1451 return "Intrinsic result type";
1453 return "Intrinsic result type #" + utostr(ArgNo);
1455 return "Intrinsic parameter #" + utostr(ArgNo - NumRets);
1458 bool Verifier::PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
1459 int VT, unsigned ArgNo, std::string &Suffix) {
1460 const FunctionType *FTy = F->getFunctionType();
1462 unsigned NumElts = 0;
1463 const Type *EltTy = Ty;
1464 const VectorType *VTy = dyn_cast<VectorType>(Ty);
1466 EltTy = VTy->getElementType();
1467 NumElts = VTy->getNumElements();
1470 const Type *RetTy = FTy->getReturnType();
1471 const StructType *ST = dyn_cast<StructType>(RetTy);
1472 unsigned NumRets = 1;
1474 NumRets = ST->getNumElements();
1479 // Check flags that indicate a type that is an integral vector type with
1480 // elements that are larger or smaller than the elements of the matched
1482 if ((Match & (ExtendedElementVectorType |
1483 TruncatedElementVectorType)) != 0) {
1484 const IntegerType *IEltTy = dyn_cast<IntegerType>(EltTy);
1485 if (!VTy || !IEltTy) {
1486 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1487 "an integral vector type.", F);
1490 // Adjust the current Ty (in the opposite direction) rather than
1491 // the type being matched against.
1492 if ((Match & ExtendedElementVectorType) != 0) {
1493 if ((IEltTy->getBitWidth() & 1) != 0) {
1494 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " vector "
1495 "element bit-width is odd.", F);
1498 Ty = VectorType::getTruncatedElementVectorType(VTy);
1500 Ty = VectorType::getExtendedElementVectorType(VTy);
1501 Match &= ~(ExtendedElementVectorType | TruncatedElementVectorType);
1504 if (Match <= static_cast<int>(NumRets - 1)) {
1506 RetTy = ST->getElementType(Match);
1509 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1510 "match return type.", F);
1514 if (Ty != FTy->getParamType(Match - 1)) {
1515 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1516 "match parameter %" + utostr(Match - 1) + ".", F);
1520 } else if (VT == MVT::iAny) {
1521 if (!EltTy->isInteger()) {
1522 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1523 "an integer type.", F);
1527 unsigned GotBits = cast<IntegerType>(EltTy)->getBitWidth();
1531 Suffix += "v" + utostr(NumElts);
1533 Suffix += "i" + utostr(GotBits);
1535 // Check some constraints on various intrinsics.
1537 default: break; // Not everything needs to be checked.
1538 case Intrinsic::bswap:
1539 if (GotBits < 16 || GotBits % 16 != 0) {
1540 CheckFailed("Intrinsic requires even byte width argument", F);
1545 } else if (VT == MVT::fAny) {
1546 if (!EltTy->isFloatingPoint()) {
1547 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1548 "a floating-point type.", F);
1555 Suffix += "v" + utostr(NumElts);
1557 Suffix += MVT::getMVT(EltTy).getMVTString();
1558 } else if (VT == MVT::iPTR) {
1559 if (!isa<PointerType>(Ty)) {
1560 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1561 "pointer and a pointer is required.", F);
1564 } else if (VT == MVT::iPTRAny) {
1565 // Outside of TableGen, we don't distinguish iPTRAny (to any address space)
1566 // and iPTR. In the verifier, we can not distinguish which case we have so
1567 // allow either case to be legal.
1568 if (const PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
1569 Suffix += ".p" + utostr(PTyp->getAddressSpace()) +
1570 MVT::getMVT(PTyp->getElementType()).getMVTString();
1572 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1573 "pointer and a pointer is required.", F);
1576 } else if (MVT((MVT::SimpleValueType)VT).isVector()) {
1577 MVT VVT = MVT((MVT::SimpleValueType)VT);
1579 // If this is a vector argument, verify the number and type of elements.
1580 if (VVT.getVectorElementType() != MVT::getMVT(EltTy)) {
1581 CheckFailed("Intrinsic prototype has incorrect vector element type!", F);
1585 if (VVT.getVectorNumElements() != NumElts) {
1586 CheckFailed("Intrinsic prototype has incorrect number of "
1587 "vector elements!", F);
1590 } else if (MVT((MVT::SimpleValueType)VT).getTypeForMVT() != EltTy) {
1591 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is wrong!", F);
1593 } else if (EltTy != Ty) {
1594 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is a vector "
1595 "and a scalar is required.", F);
1602 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1603 /// Intrinsics.gen. This implements a little state machine that verifies the
1604 /// prototype of intrinsics.
1605 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
1607 unsigned ParamNum, ...) {
1609 va_start(VA, ParamNum);
1610 const FunctionType *FTy = F->getFunctionType();
1612 // For overloaded intrinsics, the Suffix of the function name must match the
1613 // types of the arguments. This variable keeps track of the expected
1614 // suffix, to be checked at the end.
1617 if (FTy->getNumParams() + FTy->isVarArg() != ParamNum) {
1618 CheckFailed("Intrinsic prototype has incorrect number of arguments!", F);
1622 const Type *Ty = FTy->getReturnType();
1623 const StructType *ST = dyn_cast<StructType>(Ty);
1625 // Verify the return types.
1626 if (ST && ST->getNumElements() != RetNum) {
1627 CheckFailed("Intrinsic prototype has incorrect number of return types!", F);
1631 for (unsigned ArgNo = 0; ArgNo < RetNum; ++ArgNo) {
1632 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1634 if (ST) Ty = ST->getElementType(ArgNo);
1636 if (!PerformTypeCheck(ID, F, Ty, VT, ArgNo, Suffix))
1640 // Verify the parameter types.
1641 for (unsigned ArgNo = 0; ArgNo < ParamNum; ++ArgNo) {
1642 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1644 if (VT == MVT::isVoid && ArgNo > 0) {
1645 if (!FTy->isVarArg())
1646 CheckFailed("Intrinsic prototype has no '...'!", F);
1650 if (!PerformTypeCheck(ID, F, FTy->getParamType(ArgNo), VT, ArgNo + RetNum,
1657 // For intrinsics without pointer arguments, if we computed a Suffix then the
1658 // intrinsic is overloaded and we need to make sure that the name of the
1659 // function is correct. We add the suffix to the name of the intrinsic and
1660 // compare against the given function name. If they are not the same, the
1661 // function name is invalid. This ensures that overloading of intrinsics
1662 // uses a sane and consistent naming convention. Note that intrinsics with
1663 // pointer argument may or may not be overloaded so we will check assuming it
1664 // has a suffix and not.
1665 if (!Suffix.empty()) {
1666 std::string Name(Intrinsic::getName(ID));
1667 if (Name + Suffix != F->getName()) {
1668 CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1669 F->getName().substr(Name.length()) + "'. It should be '" +
1674 // Check parameter attributes.
1675 Assert1(F->getAttributes() == Intrinsic::getAttributes(ID),
1676 "Intrinsic has wrong parameter attributes!", F);
1680 //===----------------------------------------------------------------------===//
1681 // Implement the public interfaces to this file...
1682 //===----------------------------------------------------------------------===//
1684 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1685 return new Verifier(action);
1689 // verifyFunction - Create
1690 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1691 Function &F = const_cast<Function&>(f);
1692 assert(!F.isDeclaration() && "Cannot verify external functions");
1694 ExistingModuleProvider MP(F.getParent());
1695 FunctionPassManager FPM(&MP);
1696 Verifier *V = new Verifier(action);
1703 /// verifyModule - Check a module for errors, printing messages on stderr.
1704 /// Return true if the module is corrupt.
1706 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1707 std::string *ErrorInfo) {
1709 Verifier *V = new Verifier(action);
1711 PM.run(const_cast<Module&>(M));
1713 if (ErrorInfo && V->Broken)
1714 *ErrorInfo = V->msgs.str();