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/MDNode.h"
49 #include "llvm/Module.h"
50 #include "llvm/ModuleProvider.h"
51 #include "llvm/Pass.h"
52 #include "llvm/PassManager.h"
53 #include "llvm/Analysis/Dominators.h"
54 #include "llvm/Assembly/Writer.h"
55 #include "llvm/CodeGen/ValueTypes.h"
56 #include "llvm/Support/CallSite.h"
57 #include "llvm/Support/CFG.h"
58 #include "llvm/Support/InstVisitor.h"
59 #include "llvm/Support/Streams.h"
60 #include "llvm/ADT/SmallPtrSet.h"
61 #include "llvm/ADT/SmallVector.h"
62 #include "llvm/ADT/StringExtras.h"
63 #include "llvm/ADT/STLExtras.h"
64 #include "llvm/Support/Compiler.h"
65 #include "llvm/Support/raw_ostream.h"
71 namespace { // Anonymous namespace for class
72 struct VISIBILITY_HIDDEN PreVerifier : public FunctionPass {
73 static char ID; // Pass ID, replacement for typeid
75 PreVerifier() : FunctionPass(&ID) { }
77 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
81 // Check that the prerequisites for successful DominatorTree construction
83 bool runOnFunction(Function &F) {
86 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
87 if (I->empty() || !I->back().isTerminator()) {
88 cerr << "Basic Block does not have terminator!\n";
89 WriteAsOperand(*cerr, I, true);
103 char PreVerifier::ID = 0;
104 static RegisterPass<PreVerifier>
105 PreVer("preverify", "Preliminary module verification");
106 static const PassInfo *const PreVerifyID = &PreVer;
109 struct VISIBILITY_HIDDEN
110 Verifier : public FunctionPass, InstVisitor<Verifier> {
111 static char ID; // Pass ID, replacement for typeid
112 bool Broken; // Is this module found to be broken?
113 bool RealPass; // Are we not being run by a PassManager?
114 VerifierFailureAction action;
115 // What to do if verification fails.
116 Module *Mod; // Module we are verifying right now
117 DominatorTree *DT; // Dominator Tree, caution can be null!
118 std::stringstream msgs; // A stringstream to collect messages
120 /// InstInThisBlock - when verifying a basic block, keep track of all of the
121 /// instructions we have seen so far. This allows us to do efficient
122 /// dominance checks for the case when an instruction has an operand that is
123 /// an instruction in the same block.
124 SmallPtrSet<Instruction*, 16> InstsInThisBlock;
128 Broken(false), RealPass(true), action(AbortProcessAction),
129 DT(0), msgs( std::ios::app | std::ios::out ) {}
130 explicit Verifier(VerifierFailureAction ctn)
132 Broken(false), RealPass(true), action(ctn), DT(0),
133 msgs( std::ios::app | std::ios::out ) {}
134 explicit Verifier(bool AB)
136 Broken(false), RealPass(true),
137 action( AB ? AbortProcessAction : PrintMessageAction), DT(0),
138 msgs( std::ios::app | std::ios::out ) {}
139 explicit Verifier(DominatorTree &dt)
141 Broken(false), RealPass(false), action(PrintMessageAction),
142 DT(&dt), msgs( std::ios::app | std::ios::out ) {}
145 bool doInitialization(Module &M) {
147 verifyTypeSymbolTable(M.getTypeSymbolTable());
149 // If this is a real pass, in a pass manager, we must abort before
150 // returning back to the pass manager, or else the pass manager may try to
151 // run other passes on the broken module.
153 return abortIfBroken();
157 bool runOnFunction(Function &F) {
158 // Get dominator information if we are being run by PassManager
159 if (RealPass) DT = &getAnalysis<DominatorTree>();
164 InstsInThisBlock.clear();
166 // If this is a real pass, in a pass manager, we must abort before
167 // returning back to the pass manager, or else the pass manager may try to
168 // run other passes on the broken module.
170 return abortIfBroken();
175 bool doFinalization(Module &M) {
176 // Scan through, checking all of the external function's linkage now...
177 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
178 visitGlobalValue(*I);
180 // Check to make sure function prototypes are okay.
181 if (I->isDeclaration()) visitFunction(*I);
184 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
186 visitGlobalVariable(*I);
188 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
190 visitGlobalAlias(*I);
192 // If the module is broken, abort at this time.
193 return abortIfBroken();
196 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
197 AU.setPreservesAll();
198 AU.addRequiredID(PreVerifyID);
200 AU.addRequired<DominatorTree>();
203 /// abortIfBroken - If the module is broken and we are supposed to abort on
204 /// this condition, do so.
206 bool abortIfBroken() {
207 if (!Broken) return false;
208 msgs << "Broken module found, ";
210 default: assert(0 && "Unknown action");
211 case AbortProcessAction:
212 msgs << "compilation aborted!\n";
215 case PrintMessageAction:
216 msgs << "verification continues.\n";
219 case ReturnStatusAction:
220 msgs << "compilation terminated.\n";
226 // Verification methods...
227 void verifyTypeSymbolTable(TypeSymbolTable &ST);
228 void visitGlobalValue(GlobalValue &GV);
229 void visitGlobalVariable(GlobalVariable &GV);
230 void visitGlobalAlias(GlobalAlias &GA);
231 void visitFunction(Function &F);
232 void visitBasicBlock(BasicBlock &BB);
233 using InstVisitor<Verifier>::visit;
235 void visit(Instruction &I);
237 void visitTruncInst(TruncInst &I);
238 void visitZExtInst(ZExtInst &I);
239 void visitSExtInst(SExtInst &I);
240 void visitFPTruncInst(FPTruncInst &I);
241 void visitFPExtInst(FPExtInst &I);
242 void visitFPToUIInst(FPToUIInst &I);
243 void visitFPToSIInst(FPToSIInst &I);
244 void visitUIToFPInst(UIToFPInst &I);
245 void visitSIToFPInst(SIToFPInst &I);
246 void visitIntToPtrInst(IntToPtrInst &I);
247 void visitPtrToIntInst(PtrToIntInst &I);
248 void visitBitCastInst(BitCastInst &I);
249 void visitPHINode(PHINode &PN);
250 void visitBinaryOperator(BinaryOperator &B);
251 void visitICmpInst(ICmpInst &IC);
252 void visitFCmpInst(FCmpInst &FC);
253 void visitExtractElementInst(ExtractElementInst &EI);
254 void visitInsertElementInst(InsertElementInst &EI);
255 void visitShuffleVectorInst(ShuffleVectorInst &EI);
256 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
257 void visitCallInst(CallInst &CI);
258 void visitInvokeInst(InvokeInst &II);
259 void visitGetElementPtrInst(GetElementPtrInst &GEP);
260 void visitLoadInst(LoadInst &LI);
261 void visitStoreInst(StoreInst &SI);
262 void visitInstruction(Instruction &I);
263 void visitTerminatorInst(TerminatorInst &I);
264 void visitReturnInst(ReturnInst &RI);
265 void visitSwitchInst(SwitchInst &SI);
266 void visitSelectInst(SelectInst &SI);
267 void visitUserOp1(Instruction &I);
268 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
269 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
270 void visitAllocationInst(AllocationInst &AI);
271 void visitExtractValueInst(ExtractValueInst &EVI);
272 void visitInsertValueInst(InsertValueInst &IVI);
274 void VerifyCallSite(CallSite CS);
275 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
276 int VT, unsigned ArgNo, std::string &Suffix);
277 void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
278 unsigned RetNum, unsigned ParamNum, ...);
279 void VerifyAttrs(Attributes Attrs, const Type *Ty,
280 bool isReturnValue, const Value *V);
281 void VerifyFunctionAttrs(const FunctionType *FT, const AttrListPtr &Attrs,
283 bool VerifyMDNode(const MDNode *N);
285 void WriteValue(const Value *V) {
287 if (isa<Instruction>(V)) {
290 WriteAsOperand(msgs, V, true, Mod);
295 void WriteType(const Type *T) {
297 raw_os_ostream RO(msgs);
299 WriteTypeSymbolic(RO, T, Mod);
303 // CheckFailed - A check failed, so print out the condition and the message
304 // that failed. This provides a nice place to put a breakpoint if you want
305 // to see why something is not correct.
306 void CheckFailed(const std::string &Message,
307 const Value *V1 = 0, const Value *V2 = 0,
308 const Value *V3 = 0, const Value *V4 = 0) {
309 msgs << Message << "\n";
317 void CheckFailed( const std::string& Message, const Value* V1,
318 const Type* T2, const Value* V3 = 0 ) {
319 msgs << Message << "\n";
326 } // End anonymous namespace
328 char Verifier::ID = 0;
329 static RegisterPass<Verifier> X("verify", "Module Verifier");
331 // Assert - We know that cond should be true, if not print an error message.
332 #define Assert(C, M) \
333 do { if (!(C)) { CheckFailed(M); return; } } while (0)
334 #define Assert1(C, M, V1) \
335 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
336 #define Assert2(C, M, V1, V2) \
337 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
338 #define Assert3(C, M, V1, V2, V3) \
339 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
340 #define Assert4(C, M, V1, V2, V3, V4) \
341 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
343 void Verifier::visit(Instruction &I) {
344 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
345 Assert1(I.getOperand(i) != 0, "Operand is null", &I);
346 InstVisitor<Verifier>::visit(I);
350 void Verifier::visitGlobalValue(GlobalValue &GV) {
351 Assert1(!GV.isDeclaration() ||
352 GV.hasExternalLinkage() ||
353 GV.hasDLLImportLinkage() ||
354 GV.hasExternalWeakLinkage() ||
355 GV.hasGhostLinkage() ||
356 (isa<GlobalAlias>(GV) &&
357 (GV.hasLocalLinkage() || GV.hasWeakLinkage())),
358 "Global is external, but doesn't have external or dllimport or weak linkage!",
361 Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
362 "Global is marked as dllimport, but not external", &GV);
364 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
365 "Only global variables can have appending linkage!", &GV);
367 if (GV.hasAppendingLinkage()) {
368 GlobalVariable &GVar = cast<GlobalVariable>(GV);
369 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
370 "Only global arrays can have appending linkage!", &GV);
374 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
375 if (GV.hasInitializer()) {
376 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
377 "Global variable initializer type does not match global "
378 "variable type!", &GV);
380 // Verify that any metadata used in a global initializer points only to
382 if (MDNode *FirstNode = dyn_cast<MDNode>(GV.getInitializer())) {
383 if (VerifyMDNode(FirstNode)) {
384 SmallVector<const MDNode *, 4> NodesToAnalyze;
385 NodesToAnalyze.push_back(FirstNode);
386 while (!NodesToAnalyze.empty()) {
387 const MDNode *N = NodesToAnalyze.back();
388 NodesToAnalyze.pop_back();
390 for (MDNode::const_elem_iterator I = N->elem_begin(),
391 E = N->elem_end(); I != E; ++I)
392 if (const Value *V = *I) {
393 if (const MDNode *Next = dyn_cast<MDNode>(V))
394 NodesToAnalyze.push_back(Next);
396 Assert3(isa<Constant>(V),
397 "reference to instruction from global metadata node",
404 Assert1(GV.hasExternalLinkage() || GV.hasDLLImportLinkage() ||
405 GV.hasExternalWeakLinkage(),
406 "invalid linkage type for global declaration", &GV);
409 visitGlobalValue(GV);
412 void Verifier::visitGlobalAlias(GlobalAlias &GA) {
413 Assert1(!GA.getName().empty(),
414 "Alias name cannot be empty!", &GA);
415 Assert1(GA.hasExternalLinkage() || GA.hasLocalLinkage() ||
417 "Alias should have external or external weak linkage!", &GA);
418 Assert1(GA.getAliasee(),
419 "Aliasee cannot be NULL!", &GA);
420 Assert1(GA.getType() == GA.getAliasee()->getType(),
421 "Alias and aliasee types should match!", &GA);
423 if (!isa<GlobalValue>(GA.getAliasee())) {
424 const ConstantExpr *CE = dyn_cast<ConstantExpr>(GA.getAliasee());
426 (CE->getOpcode() == Instruction::BitCast ||
427 CE->getOpcode() == Instruction::GetElementPtr) &&
428 isa<GlobalValue>(CE->getOperand(0)),
429 "Aliasee should be either GlobalValue or bitcast of GlobalValue",
433 const GlobalValue* Aliasee = GA.resolveAliasedGlobal(/*stopOnWeak*/ false);
435 "Aliasing chain should end with function or global variable", &GA);
437 visitGlobalValue(GA);
440 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
443 // VerifyAttrs - Check the given parameter attributes for an argument or return
444 // value of the specified type. The value V is printed in error messages.
445 void Verifier::VerifyAttrs(Attributes Attrs, const Type *Ty,
446 bool isReturnValue, const Value *V) {
447 if (Attrs == Attribute::None)
451 Attributes RetI = Attrs & Attribute::ParameterOnly;
452 Assert1(!RetI, "Attribute " + Attribute::getAsString(RetI) +
453 " does not apply to return values!", V);
455 Attributes FnCheckAttr = Attrs & Attribute::FunctionOnly;
456 Assert1(!FnCheckAttr, "Attribute " + Attribute::getAsString(FnCheckAttr) +
457 " only applies to functions!", V);
460 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
461 Attributes MutI = Attrs & Attribute::MutuallyIncompatible[i];
462 Assert1(!(MutI & (MutI - 1)), "Attributes " +
463 Attribute::getAsString(MutI) + " are incompatible!", V);
466 Attributes TypeI = Attrs & Attribute::typeIncompatible(Ty);
467 Assert1(!TypeI, "Wrong type for attribute " +
468 Attribute::getAsString(TypeI), V);
470 Attributes ByValI = Attrs & Attribute::ByVal;
471 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
472 Assert1(!ByValI || PTy->getElementType()->isSized(),
473 "Attribute " + Attribute::getAsString(ByValI) +
474 " does not support unsized types!", V);
477 "Attribute " + Attribute::getAsString(ByValI) +
478 " only applies to parameters with pointer type!", V);
482 // VerifyFunctionAttrs - Check parameter attributes against a function type.
483 // The value V is printed in error messages.
484 void Verifier::VerifyFunctionAttrs(const FunctionType *FT,
485 const AttrListPtr &Attrs,
490 bool SawNest = false;
492 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
493 const AttributeWithIndex &Attr = Attrs.getSlot(i);
497 Ty = FT->getReturnType();
498 else if (Attr.Index-1 < FT->getNumParams())
499 Ty = FT->getParamType(Attr.Index-1);
501 break; // VarArgs attributes, don't verify.
503 VerifyAttrs(Attr.Attrs, Ty, Attr.Index == 0, V);
505 if (Attr.Attrs & Attribute::Nest) {
506 Assert1(!SawNest, "More than one parameter has attribute nest!", V);
510 if (Attr.Attrs & Attribute::StructRet)
511 Assert1(Attr.Index == 1, "Attribute sret not on first parameter!", V);
514 Attributes FAttrs = Attrs.getFnAttributes();
515 Assert1(!(FAttrs & (~Attribute::FunctionOnly)),
516 "Attribute " + Attribute::getAsString(FAttrs) +
517 " does not apply to function!", V);
520 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
521 Attributes MutI = FAttrs & Attribute::MutuallyIncompatible[i];
522 Assert1(!(MutI & (MutI - 1)), "Attributes " +
523 Attribute::getAsString(MutI) + " are incompatible!", V);
527 static bool VerifyAttributeCount(const AttrListPtr &Attrs, unsigned Params) {
531 unsigned LastSlot = Attrs.getNumSlots() - 1;
532 unsigned LastIndex = Attrs.getSlot(LastSlot).Index;
533 if (LastIndex <= Params
534 || (LastIndex == (unsigned)~0
535 && (LastSlot == 0 || Attrs.getSlot(LastSlot - 1).Index <= Params)))
540 // visitFunction - Verify that a function is ok.
542 void Verifier::visitFunction(Function &F) {
543 // Check function arguments.
544 const FunctionType *FT = F.getFunctionType();
545 unsigned NumArgs = F.arg_size();
547 Assert2(FT->getNumParams() == NumArgs,
548 "# formal arguments must match # of arguments for function type!",
550 Assert1(F.getReturnType()->isFirstClassType() ||
551 F.getReturnType() == Type::VoidTy ||
552 isa<StructType>(F.getReturnType()),
553 "Functions cannot return aggregate values!", &F);
555 Assert1(!F.hasStructRetAttr() || F.getReturnType() == Type::VoidTy,
556 "Invalid struct return type!", &F);
558 const AttrListPtr &Attrs = F.getAttributes();
560 Assert1(VerifyAttributeCount(Attrs, FT->getNumParams()),
561 "Attributes after last parameter!", &F);
563 // Check function attributes.
564 VerifyFunctionAttrs(FT, Attrs, &F);
566 // Check that this function meets the restrictions on this calling convention.
567 switch (F.getCallingConv()) {
572 case CallingConv::Fast:
573 case CallingConv::Cold:
574 case CallingConv::X86_FastCall:
575 Assert1(!F.isVarArg(),
576 "Varargs functions must have C calling conventions!", &F);
580 bool isLLVMdotName = F.getName().size() >= 5 &&
581 F.getName().substr(0, 5) == "llvm.";
583 Assert1(F.getReturnType() != Type::MetadataTy,
584 "Function may not return metadata unless it's an intrinsic", &F);
586 // Check that the argument values match the function type for this function...
588 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
590 Assert2(I->getType() == FT->getParamType(i),
591 "Argument value does not match function argument type!",
592 I, FT->getParamType(i));
593 Assert1(I->getType()->isFirstClassType(),
594 "Function arguments must have first-class types!", I);
596 Assert2(I->getType() != Type::MetadataTy,
597 "Function takes metadata but isn't an intrinsic", I, &F);
600 if (F.isDeclaration()) {
601 Assert1(F.hasExternalLinkage() || F.hasDLLImportLinkage() ||
602 F.hasExternalWeakLinkage() || F.hasGhostLinkage(),
603 "invalid linkage type for function declaration", &F);
605 // Verify that this function (which has a body) is not named "llvm.*". It
606 // is not legal to define intrinsics.
607 Assert1(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
609 // Check the entry node
610 BasicBlock *Entry = &F.getEntryBlock();
611 Assert1(pred_begin(Entry) == pred_end(Entry),
612 "Entry block to function must not have predecessors!", Entry);
617 // verifyBasicBlock - Verify that a basic block is well formed...
619 void Verifier::visitBasicBlock(BasicBlock &BB) {
620 InstsInThisBlock.clear();
622 // Ensure that basic blocks have terminators!
623 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
625 // Check constraints that this basic block imposes on all of the PHI nodes in
627 if (isa<PHINode>(BB.front())) {
628 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
629 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
630 std::sort(Preds.begin(), Preds.end());
632 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
634 // Ensure that PHI nodes have at least one entry!
635 Assert1(PN->getNumIncomingValues() != 0,
636 "PHI nodes must have at least one entry. If the block is dead, "
637 "the PHI should be removed!", PN);
638 Assert1(PN->getNumIncomingValues() == Preds.size(),
639 "PHINode should have one entry for each predecessor of its "
640 "parent basic block!", PN);
642 // Get and sort all incoming values in the PHI node...
644 Values.reserve(PN->getNumIncomingValues());
645 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
646 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
647 PN->getIncomingValue(i)));
648 std::sort(Values.begin(), Values.end());
650 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
651 // Check to make sure that if there is more than one entry for a
652 // particular basic block in this PHI node, that the incoming values are
655 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
656 Values[i].second == Values[i-1].second,
657 "PHI node has multiple entries for the same basic block with "
658 "different incoming values!", PN, Values[i].first,
659 Values[i].second, Values[i-1].second);
661 // Check to make sure that the predecessors and PHI node entries are
663 Assert3(Values[i].first == Preds[i],
664 "PHI node entries do not match predecessors!", PN,
665 Values[i].first, Preds[i]);
671 void Verifier::visitTerminatorInst(TerminatorInst &I) {
672 // Ensure that terminators only exist at the end of the basic block.
673 Assert1(&I == I.getParent()->getTerminator(),
674 "Terminator found in the middle of a basic block!", I.getParent());
678 void Verifier::visitReturnInst(ReturnInst &RI) {
679 Function *F = RI.getParent()->getParent();
680 unsigned N = RI.getNumOperands();
681 if (F->getReturnType() == Type::VoidTy)
683 "Found return instr that returns non-void in Function of void "
684 "return type!", &RI, F->getReturnType());
685 else if (N == 1 && F->getReturnType() == RI.getOperand(0)->getType()) {
686 // Exactly one return value and it matches the return type. Good.
687 } else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
688 // The return type is a struct; check for multiple return values.
689 Assert2(STy->getNumElements() == N,
690 "Incorrect number of return values in ret instruction!",
691 &RI, F->getReturnType());
692 for (unsigned i = 0; i != N; ++i)
693 Assert2(STy->getElementType(i) == RI.getOperand(i)->getType(),
694 "Function return type does not match operand "
695 "type of return inst!", &RI, F->getReturnType());
696 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(F->getReturnType())) {
697 // The return type is an array; check for multiple return values.
698 Assert2(ATy->getNumElements() == N,
699 "Incorrect number of return values in ret instruction!",
700 &RI, F->getReturnType());
701 for (unsigned i = 0; i != N; ++i)
702 Assert2(ATy->getElementType() == RI.getOperand(i)->getType(),
703 "Function return type does not match operand "
704 "type of return inst!", &RI, F->getReturnType());
706 CheckFailed("Function return type does not match operand "
707 "type of return inst!", &RI, F->getReturnType());
710 // Check to make sure that the return value has necessary properties for
712 visitTerminatorInst(RI);
715 void Verifier::visitSwitchInst(SwitchInst &SI) {
716 // Check to make sure that all of the constants in the switch instruction
717 // have the same type as the switched-on value.
718 const Type *SwitchTy = SI.getCondition()->getType();
719 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
720 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
721 "Switch constants must all be same type as switch value!", &SI);
723 visitTerminatorInst(SI);
726 void Verifier::visitSelectInst(SelectInst &SI) {
727 Assert1(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
729 "Invalid operands for select instruction!", &SI);
731 Assert1(SI.getTrueValue()->getType() == SI.getType(),
732 "Select values must have same type as select instruction!", &SI);
733 visitInstruction(SI);
737 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
738 /// a pass, if any exist, it's an error.
740 void Verifier::visitUserOp1(Instruction &I) {
741 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
744 void Verifier::visitTruncInst(TruncInst &I) {
745 // Get the source and destination types
746 const Type *SrcTy = I.getOperand(0)->getType();
747 const Type *DestTy = I.getType();
749 // Get the size of the types in bits, we'll need this later
750 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
751 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
753 Assert1(SrcTy->isIntOrIntVector(), "Trunc only operates on integer", &I);
754 Assert1(DestTy->isIntOrIntVector(), "Trunc only produces integer", &I);
755 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
756 "trunc source and destination must both be a vector or neither", &I);
757 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
762 void Verifier::visitZExtInst(ZExtInst &I) {
763 // Get the source and destination types
764 const Type *SrcTy = I.getOperand(0)->getType();
765 const Type *DestTy = I.getType();
767 // Get the size of the types in bits, we'll need this later
768 Assert1(SrcTy->isIntOrIntVector(), "ZExt only operates on integer", &I);
769 Assert1(DestTy->isIntOrIntVector(), "ZExt only produces an integer", &I);
770 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
771 "zext source and destination must both be a vector or neither", &I);
772 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
773 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
775 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
780 void Verifier::visitSExtInst(SExtInst &I) {
781 // Get the source and destination types
782 const Type *SrcTy = I.getOperand(0)->getType();
783 const Type *DestTy = I.getType();
785 // Get the size of the types in bits, we'll need this later
786 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
787 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
789 Assert1(SrcTy->isIntOrIntVector(), "SExt only operates on integer", &I);
790 Assert1(DestTy->isIntOrIntVector(), "SExt only produces an integer", &I);
791 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
792 "sext source and destination must both be a vector or neither", &I);
793 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
798 void Verifier::visitFPTruncInst(FPTruncInst &I) {
799 // Get the source and destination types
800 const Type *SrcTy = I.getOperand(0)->getType();
801 const Type *DestTy = I.getType();
802 // Get the size of the types in bits, we'll need this later
803 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
804 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
806 Assert1(SrcTy->isFPOrFPVector(),"FPTrunc only operates on FP", &I);
807 Assert1(DestTy->isFPOrFPVector(),"FPTrunc only produces an FP", &I);
808 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
809 "fptrunc source and destination must both be a vector or neither",&I);
810 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
815 void Verifier::visitFPExtInst(FPExtInst &I) {
816 // Get the source and destination types
817 const Type *SrcTy = I.getOperand(0)->getType();
818 const Type *DestTy = I.getType();
820 // Get the size of the types in bits, we'll need this later
821 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
822 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
824 Assert1(SrcTy->isFPOrFPVector(),"FPExt only operates on FP", &I);
825 Assert1(DestTy->isFPOrFPVector(),"FPExt only produces an FP", &I);
826 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
827 "fpext source and destination must both be a vector or neither", &I);
828 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
833 void Verifier::visitUIToFPInst(UIToFPInst &I) {
834 // Get the source and destination types
835 const Type *SrcTy = I.getOperand(0)->getType();
836 const Type *DestTy = I.getType();
838 bool SrcVec = isa<VectorType>(SrcTy);
839 bool DstVec = isa<VectorType>(DestTy);
841 Assert1(SrcVec == DstVec,
842 "UIToFP source and dest must both be vector or scalar", &I);
843 Assert1(SrcTy->isIntOrIntVector(),
844 "UIToFP source must be integer or integer vector", &I);
845 Assert1(DestTy->isFPOrFPVector(),
846 "UIToFP result must be FP or FP vector", &I);
848 if (SrcVec && DstVec)
849 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
850 cast<VectorType>(DestTy)->getNumElements(),
851 "UIToFP source and dest vector length mismatch", &I);
856 void Verifier::visitSIToFPInst(SIToFPInst &I) {
857 // Get the source and destination types
858 const Type *SrcTy = I.getOperand(0)->getType();
859 const Type *DestTy = I.getType();
861 bool SrcVec = SrcTy->getTypeID() == Type::VectorTyID;
862 bool DstVec = DestTy->getTypeID() == Type::VectorTyID;
864 Assert1(SrcVec == DstVec,
865 "SIToFP source and dest must both be vector or scalar", &I);
866 Assert1(SrcTy->isIntOrIntVector(),
867 "SIToFP source must be integer or integer vector", &I);
868 Assert1(DestTy->isFPOrFPVector(),
869 "SIToFP result must be FP or FP vector", &I);
871 if (SrcVec && DstVec)
872 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
873 cast<VectorType>(DestTy)->getNumElements(),
874 "SIToFP source and dest vector length mismatch", &I);
879 void Verifier::visitFPToUIInst(FPToUIInst &I) {
880 // Get the source and destination types
881 const Type *SrcTy = I.getOperand(0)->getType();
882 const Type *DestTy = I.getType();
884 bool SrcVec = isa<VectorType>(SrcTy);
885 bool DstVec = isa<VectorType>(DestTy);
887 Assert1(SrcVec == DstVec,
888 "FPToUI source and dest must both be vector or scalar", &I);
889 Assert1(SrcTy->isFPOrFPVector(), "FPToUI source must be FP or FP vector", &I);
890 Assert1(DestTy->isIntOrIntVector(),
891 "FPToUI result must be integer or integer vector", &I);
893 if (SrcVec && DstVec)
894 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
895 cast<VectorType>(DestTy)->getNumElements(),
896 "FPToUI source and dest vector length mismatch", &I);
901 void Verifier::visitFPToSIInst(FPToSIInst &I) {
902 // Get the source and destination types
903 const Type *SrcTy = I.getOperand(0)->getType();
904 const Type *DestTy = I.getType();
906 bool SrcVec = isa<VectorType>(SrcTy);
907 bool DstVec = isa<VectorType>(DestTy);
909 Assert1(SrcVec == DstVec,
910 "FPToSI source and dest must both be vector or scalar", &I);
911 Assert1(SrcTy->isFPOrFPVector(),
912 "FPToSI source must be FP or FP vector", &I);
913 Assert1(DestTy->isIntOrIntVector(),
914 "FPToSI result must be integer or integer vector", &I);
916 if (SrcVec && DstVec)
917 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
918 cast<VectorType>(DestTy)->getNumElements(),
919 "FPToSI source and dest vector length mismatch", &I);
924 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
925 // Get the source and destination types
926 const Type *SrcTy = I.getOperand(0)->getType();
927 const Type *DestTy = I.getType();
929 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
930 Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
935 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
936 // Get the source and destination types
937 const Type *SrcTy = I.getOperand(0)->getType();
938 const Type *DestTy = I.getType();
940 Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
941 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
946 void Verifier::visitBitCastInst(BitCastInst &I) {
947 // Get the source and destination types
948 const Type *SrcTy = I.getOperand(0)->getType();
949 const Type *DestTy = I.getType();
951 // Get the size of the types in bits, we'll need this later
952 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
953 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
955 // BitCast implies a no-op cast of type only. No bits change.
956 // However, you can't cast pointers to anything but pointers.
957 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
958 "Bitcast requires both operands to be pointer or neither", &I);
959 Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
961 // Disallow aggregates.
962 Assert1(!SrcTy->isAggregateType(),
963 "Bitcast operand must not be aggregate", &I);
964 Assert1(!DestTy->isAggregateType(),
965 "Bitcast type must not be aggregate", &I);
970 /// visitPHINode - Ensure that a PHI node is well formed.
972 void Verifier::visitPHINode(PHINode &PN) {
973 // Ensure that the PHI nodes are all grouped together at the top of the block.
974 // This can be tested by checking whether the instruction before this is
975 // either nonexistent (because this is begin()) or is a PHI node. If not,
976 // then there is some other instruction before a PHI.
977 Assert2(&PN == &PN.getParent()->front() ||
978 isa<PHINode>(--BasicBlock::iterator(&PN)),
979 "PHI nodes not grouped at top of basic block!",
980 &PN, PN.getParent());
982 // Check that all of the operands of the PHI node have the same type as the
984 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
985 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
986 "PHI node operands are not the same type as the result!", &PN);
988 // All other PHI node constraints are checked in the visitBasicBlock method.
990 visitInstruction(PN);
993 void Verifier::VerifyCallSite(CallSite CS) {
994 Instruction *I = CS.getInstruction();
996 Assert1(isa<PointerType>(CS.getCalledValue()->getType()),
997 "Called function must be a pointer!", I);
998 const PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
999 Assert1(isa<FunctionType>(FPTy->getElementType()),
1000 "Called function is not pointer to function type!", I);
1002 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1004 // Verify that the correct number of arguments are being passed
1005 if (FTy->isVarArg())
1006 Assert1(CS.arg_size() >= FTy->getNumParams(),
1007 "Called function requires more parameters than were provided!",I);
1009 Assert1(CS.arg_size() == FTy->getNumParams(),
1010 "Incorrect number of arguments passed to called function!", I);
1012 // Verify that all arguments to the call match the function type...
1013 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1014 Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
1015 "Call parameter type does not match function signature!",
1016 CS.getArgument(i), FTy->getParamType(i), I);
1018 const AttrListPtr &Attrs = CS.getAttributes();
1020 Assert1(VerifyAttributeCount(Attrs, CS.arg_size()),
1021 "Attributes after last parameter!", I);
1023 // Verify call attributes.
1024 VerifyFunctionAttrs(FTy, Attrs, I);
1026 if (FTy->isVarArg())
1027 // Check attributes on the varargs part.
1028 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
1029 Attributes Attr = Attrs.getParamAttributes(Idx);
1031 VerifyAttrs(Attr, CS.getArgument(Idx-1)->getType(), false, I);
1033 Attributes VArgI = Attr & Attribute::VarArgsIncompatible;
1034 Assert1(!VArgI, "Attribute " + Attribute::getAsString(VArgI) +
1035 " cannot be used for vararg call arguments!", I);
1038 // Verify that there's no metadata unless it's a direct call to an intrinsic.
1039 if (!CS.getCalledFunction() || CS.getCalledFunction()->getName().size() < 5 ||
1040 CS.getCalledFunction()->getName().substr(0, 5) != "llvm.") {
1041 Assert1(FTy->getReturnType() != Type::MetadataTy,
1042 "Only intrinsics may return metadata", I);
1043 for (FunctionType::param_iterator PI = FTy->param_begin(),
1044 PE = FTy->param_end(); PI != PE; ++PI)
1045 Assert1(PI->get() != Type::MetadataTy, "Function has metadata parameter "
1046 "but isn't an intrinsic", I);
1049 visitInstruction(*I);
1052 void Verifier::visitCallInst(CallInst &CI) {
1053 VerifyCallSite(&CI);
1055 if (Function *F = CI.getCalledFunction())
1056 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
1057 visitIntrinsicFunctionCall(ID, CI);
1060 void Verifier::visitInvokeInst(InvokeInst &II) {
1061 VerifyCallSite(&II);
1064 /// visitBinaryOperator - Check that both arguments to the binary operator are
1065 /// of the same type!
1067 void Verifier::visitBinaryOperator(BinaryOperator &B) {
1068 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
1069 "Both operands to a binary operator are not of the same type!", &B);
1071 switch (B.getOpcode()) {
1072 // Check that logical operators are only used with integral operands.
1073 case Instruction::And:
1074 case Instruction::Or:
1075 case Instruction::Xor:
1076 Assert1(B.getType()->isInteger() ||
1077 (isa<VectorType>(B.getType()) &&
1078 cast<VectorType>(B.getType())->getElementType()->isInteger()),
1079 "Logical operators only work with integral types!", &B);
1080 Assert1(B.getType() == B.getOperand(0)->getType(),
1081 "Logical operators must have same type for operands and result!",
1084 case Instruction::Shl:
1085 case Instruction::LShr:
1086 case Instruction::AShr:
1087 Assert1(B.getType()->isInteger() ||
1088 (isa<VectorType>(B.getType()) &&
1089 cast<VectorType>(B.getType())->getElementType()->isInteger()),
1090 "Shifts only work with integral types!", &B);
1091 Assert1(B.getType() == B.getOperand(0)->getType(),
1092 "Shift return type must be same as operands!", &B);
1095 // Arithmetic operators only work on integer or fp values
1096 Assert1(B.getType() == B.getOperand(0)->getType(),
1097 "Arithmetic operators must have same type for operands and result!",
1099 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint() ||
1100 isa<VectorType>(B.getType()),
1101 "Arithmetic operators must have integer, fp, or vector type!", &B);
1105 visitInstruction(B);
1108 void Verifier::visitICmpInst(ICmpInst& IC) {
1109 // Check that the operands are the same type
1110 const Type* Op0Ty = IC.getOperand(0)->getType();
1111 const Type* Op1Ty = IC.getOperand(1)->getType();
1112 Assert1(Op0Ty == Op1Ty,
1113 "Both operands to ICmp instruction are not of the same type!", &IC);
1114 // Check that the operands are the right type
1115 Assert1(Op0Ty->isIntOrIntVector() || isa<PointerType>(Op0Ty),
1116 "Invalid operand types for ICmp instruction", &IC);
1118 visitInstruction(IC);
1121 void Verifier::visitFCmpInst(FCmpInst& FC) {
1122 // Check that the operands are the same type
1123 const Type* Op0Ty = FC.getOperand(0)->getType();
1124 const Type* Op1Ty = FC.getOperand(1)->getType();
1125 Assert1(Op0Ty == Op1Ty,
1126 "Both operands to FCmp instruction are not of the same type!", &FC);
1127 // Check that the operands are the right type
1128 Assert1(Op0Ty->isFPOrFPVector(),
1129 "Invalid operand types for FCmp instruction", &FC);
1130 visitInstruction(FC);
1133 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
1134 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
1136 "Invalid extractelement operands!", &EI);
1137 visitInstruction(EI);
1140 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
1141 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
1144 "Invalid insertelement operands!", &IE);
1145 visitInstruction(IE);
1148 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
1149 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
1151 "Invalid shufflevector operands!", &SV);
1153 const VectorType *VTy = dyn_cast<VectorType>(SV.getOperand(0)->getType());
1154 Assert1(VTy, "Operands are not a vector type", &SV);
1156 // Check to see if Mask is valid.
1157 if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
1158 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
1159 if (ConstantInt* CI = dyn_cast<ConstantInt>(MV->getOperand(i))) {
1160 Assert1(!CI->uge(VTy->getNumElements()*2),
1161 "Invalid shufflevector shuffle mask!", &SV);
1163 Assert1(isa<UndefValue>(MV->getOperand(i)),
1164 "Invalid shufflevector shuffle mask!", &SV);
1168 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
1169 isa<ConstantAggregateZero>(SV.getOperand(2)),
1170 "Invalid shufflevector shuffle mask!", &SV);
1173 visitInstruction(SV);
1176 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1177 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
1179 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
1180 Idxs.begin(), Idxs.end());
1181 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
1182 Assert2(isa<PointerType>(GEP.getType()) &&
1183 cast<PointerType>(GEP.getType())->getElementType() == ElTy,
1184 "GEP is not of right type for indices!", &GEP, ElTy);
1185 visitInstruction(GEP);
1188 void Verifier::visitLoadInst(LoadInst &LI) {
1190 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
1191 Assert2(ElTy == LI.getType(),
1192 "Load result type does not match pointer operand type!", &LI, ElTy);
1193 Assert1(ElTy != Type::MetadataTy, "Can't load metadata!", &LI);
1194 visitInstruction(LI);
1197 void Verifier::visitStoreInst(StoreInst &SI) {
1199 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
1200 Assert2(ElTy == SI.getOperand(0)->getType(),
1201 "Stored value type does not match pointer operand type!", &SI, ElTy);
1202 Assert1(ElTy != Type::MetadataTy, "Can't store metadata!", &SI);
1203 visitInstruction(SI);
1206 void Verifier::visitAllocationInst(AllocationInst &AI) {
1207 const PointerType *PTy = AI.getType();
1208 Assert1(PTy->getAddressSpace() == 0,
1209 "Allocation instruction pointer not in the generic address space!",
1211 Assert1(PTy->getElementType()->isSized(), "Cannot allocate unsized type",
1213 visitInstruction(AI);
1216 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
1217 Assert1(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
1218 EVI.idx_begin(), EVI.idx_end()) ==
1220 "Invalid ExtractValueInst operands!", &EVI);
1222 visitInstruction(EVI);
1225 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
1226 Assert1(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
1227 IVI.idx_begin(), IVI.idx_end()) ==
1228 IVI.getOperand(1)->getType(),
1229 "Invalid InsertValueInst operands!", &IVI);
1231 visitInstruction(IVI);
1234 /// verifyInstruction - Verify that an instruction is well formed.
1236 void Verifier::visitInstruction(Instruction &I) {
1237 BasicBlock *BB = I.getParent();
1238 Assert1(BB, "Instruction not embedded in basic block!", &I);
1240 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
1241 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
1243 Assert1(*UI != (User*)&I || !DT->isReachableFromEntry(BB),
1244 "Only PHI nodes may reference their own value!", &I);
1247 // Verify that if this is a terminator that it is at the end of the block.
1248 if (isa<TerminatorInst>(I))
1249 Assert1(BB->getTerminator() == &I, "Terminator not at end of block!", &I);
1252 // Check that void typed values don't have names
1253 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
1254 "Instruction has a name, but provides a void value!", &I);
1256 // Check that the return value of the instruction is either void or a legal
1258 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType()
1259 || ((isa<CallInst>(I) || isa<InvokeInst>(I))
1260 && isa<StructType>(I.getType())),
1261 "Instruction returns a non-scalar type!", &I);
1263 // Check that the instruction doesn't produce metadata or metadata*. Calls
1264 // all already checked against the callee type.
1265 Assert1(I.getType() != Type::MetadataTy ||
1266 isa<CallInst>(I) || isa<InvokeInst>(I),
1267 "Invalid use of metadata!", &I);
1269 if (const PointerType *PTy = dyn_cast<PointerType>(I.getType()))
1270 Assert1(PTy->getElementType() != Type::MetadataTy,
1271 "Instructions may not produce pointer to metadata.", &I);
1274 // Check that all uses of the instruction, if they are instructions
1275 // themselves, actually have parent basic blocks. If the use is not an
1276 // instruction, it is an error!
1277 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
1279 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
1281 Instruction *Used = cast<Instruction>(*UI);
1282 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
1283 " embedded in a basic block!", &I, Used);
1286 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1287 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
1289 // Check to make sure that only first-class-values are operands to
1291 if (!I.getOperand(i)->getType()->isFirstClassType()) {
1292 Assert1(0, "Instruction operands must be first-class values!", &I);
1295 if (const PointerType *PTy =
1296 dyn_cast<PointerType>(I.getOperand(i)->getType()))
1297 Assert1(PTy->getElementType() != Type::MetadataTy,
1298 "Invalid use of metadata pointer.", &I);
1300 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
1301 // Check to make sure that the "address of" an intrinsic function is never
1303 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
1304 "Cannot take the address of an intrinsic!", &I);
1305 Assert1(F->getParent() == Mod, "Referencing function in another module!",
1307 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
1308 Assert1(OpBB->getParent() == BB->getParent(),
1309 "Referring to a basic block in another function!", &I);
1310 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
1311 Assert1(OpArg->getParent() == BB->getParent(),
1312 "Referring to an argument in another function!", &I);
1313 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
1314 Assert1(GV->getParent() == Mod, "Referencing global in another module!",
1316 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
1317 BasicBlock *OpBlock = Op->getParent();
1319 // Check that a definition dominates all of its uses.
1320 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1321 // Invoke results are only usable in the normal destination, not in the
1322 // exceptional destination.
1323 BasicBlock *NormalDest = II->getNormalDest();
1325 Assert2(NormalDest != II->getUnwindDest(),
1326 "No uses of invoke possible due to dominance structure!",
1329 // PHI nodes differ from other nodes because they actually "use" the
1330 // value in the predecessor basic blocks they correspond to.
1331 BasicBlock *UseBlock = BB;
1332 if (isa<PHINode>(I))
1333 UseBlock = cast<BasicBlock>(I.getOperand(i+1));
1335 if (isa<PHINode>(I) && UseBlock == OpBlock) {
1336 // Special case of a phi node in the normal destination or the unwind
1338 Assert2(BB == NormalDest || !DT->isReachableFromEntry(UseBlock),
1339 "Invoke result not available in the unwind destination!",
1342 Assert2(DT->dominates(NormalDest, UseBlock) ||
1343 !DT->isReachableFromEntry(UseBlock),
1344 "Invoke result does not dominate all uses!", Op, &I);
1346 // If the normal successor of an invoke instruction has multiple
1347 // predecessors, then the normal edge from the invoke is critical,
1348 // so the invoke value can only be live if the destination block
1349 // dominates all of it's predecessors (other than the invoke).
1350 if (!NormalDest->getSinglePredecessor() &&
1351 DT->isReachableFromEntry(UseBlock))
1352 // If it is used by something non-phi, then the other case is that
1353 // 'NormalDest' dominates all of its predecessors other than the
1354 // invoke. In this case, the invoke value can still be used.
1355 for (pred_iterator PI = pred_begin(NormalDest),
1356 E = pred_end(NormalDest); PI != E; ++PI)
1357 if (*PI != II->getParent() && !DT->dominates(NormalDest, *PI) &&
1358 DT->isReachableFromEntry(*PI)) {
1359 CheckFailed("Invoke result does not dominate all uses!", Op,&I);
1363 } else if (isa<PHINode>(I)) {
1364 // PHI nodes are more difficult than other nodes because they actually
1365 // "use" the value in the predecessor basic blocks they correspond to.
1366 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
1367 Assert2(DT->dominates(OpBlock, PredBB) ||
1368 !DT->isReachableFromEntry(PredBB),
1369 "Instruction does not dominate all uses!", Op, &I);
1371 if (OpBlock == BB) {
1372 // If they are in the same basic block, make sure that the definition
1373 // comes before the use.
1374 Assert2(InstsInThisBlock.count(Op) || !DT->isReachableFromEntry(BB),
1375 "Instruction does not dominate all uses!", Op, &I);
1378 // Definition must dominate use unless use is unreachable!
1379 Assert2(InstsInThisBlock.count(Op) || DT->dominates(Op, &I) ||
1380 !DT->isReachableFromEntry(BB),
1381 "Instruction does not dominate all uses!", Op, &I);
1383 } else if (isa<InlineAsm>(I.getOperand(i))) {
1384 Assert1(i == 0 && (isa<CallInst>(I) || isa<InvokeInst>(I)),
1385 "Cannot take the address of an inline asm!", &I);
1388 InstsInThisBlock.insert(&I);
1391 // Flags used by TableGen to mark intrinsic parameters with the
1392 // LLVMExtendedElementVectorType and LLVMTruncatedElementVectorType classes.
1393 static const unsigned ExtendedElementVectorType = 0x40000000;
1394 static const unsigned TruncatedElementVectorType = 0x20000000;
1396 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1398 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1399 Function *IF = CI.getCalledFunction();
1400 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1403 #define GET_INTRINSIC_VERIFIER
1404 #include "llvm/Intrinsics.gen"
1405 #undef GET_INTRINSIC_VERIFIER
1410 case Intrinsic::dbg_declare: // llvm.dbg.declare
1411 if (Constant *C = dyn_cast<Constant>(CI.getOperand(1)))
1412 Assert1(C && !isa<ConstantPointerNull>(C),
1413 "invalid llvm.dbg.declare intrinsic call", &CI);
1415 case Intrinsic::memcpy:
1416 case Intrinsic::memmove:
1417 case Intrinsic::memset:
1418 Assert1(isa<ConstantInt>(CI.getOperand(4)),
1419 "alignment argument of memory intrinsics must be a constant int",
1422 case Intrinsic::gcroot:
1423 case Intrinsic::gcwrite:
1424 case Intrinsic::gcread:
1425 if (ID == Intrinsic::gcroot) {
1427 dyn_cast<AllocaInst>(CI.getOperand(1)->stripPointerCasts());
1428 Assert1(AI && isa<PointerType>(AI->getType()->getElementType()),
1429 "llvm.gcroot parameter #1 must be a pointer alloca.", &CI);
1430 Assert1(isa<Constant>(CI.getOperand(2)),
1431 "llvm.gcroot parameter #2 must be a constant.", &CI);
1434 Assert1(CI.getParent()->getParent()->hasGC(),
1435 "Enclosing function does not use GC.", &CI);
1437 case Intrinsic::init_trampoline:
1438 Assert1(isa<Function>(CI.getOperand(2)->stripPointerCasts()),
1439 "llvm.init_trampoline parameter #2 must resolve to a function.",
1442 case Intrinsic::prefetch:
1443 Assert1(isa<ConstantInt>(CI.getOperand(2)) &&
1444 isa<ConstantInt>(CI.getOperand(3)) &&
1445 cast<ConstantInt>(CI.getOperand(2))->getZExtValue() < 2 &&
1446 cast<ConstantInt>(CI.getOperand(3))->getZExtValue() < 4,
1447 "invalid arguments to llvm.prefetch",
1450 case Intrinsic::stackprotector:
1451 Assert1(isa<AllocaInst>(CI.getOperand(2)->stripPointerCasts()),
1452 "llvm.stackprotector parameter #2 must resolve to an alloca.",
1458 /// Produce a string to identify an intrinsic parameter or return value.
1459 /// The ArgNo value numbers the return values from 0 to NumRets-1 and the
1460 /// parameters beginning with NumRets.
1462 static std::string IntrinsicParam(unsigned ArgNo, unsigned NumRets) {
1463 if (ArgNo < NumRets) {
1465 return "Intrinsic result type";
1467 return "Intrinsic result type #" + utostr(ArgNo);
1469 return "Intrinsic parameter #" + utostr(ArgNo - NumRets);
1472 bool Verifier::PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
1473 int VT, unsigned ArgNo, std::string &Suffix) {
1474 const FunctionType *FTy = F->getFunctionType();
1476 unsigned NumElts = 0;
1477 const Type *EltTy = Ty;
1478 const VectorType *VTy = dyn_cast<VectorType>(Ty);
1480 EltTy = VTy->getElementType();
1481 NumElts = VTy->getNumElements();
1484 const Type *RetTy = FTy->getReturnType();
1485 const StructType *ST = dyn_cast<StructType>(RetTy);
1486 unsigned NumRets = 1;
1488 NumRets = ST->getNumElements();
1493 // Check flags that indicate a type that is an integral vector type with
1494 // elements that are larger or smaller than the elements of the matched
1496 if ((Match & (ExtendedElementVectorType |
1497 TruncatedElementVectorType)) != 0) {
1498 const IntegerType *IEltTy = dyn_cast<IntegerType>(EltTy);
1499 if (!VTy || !IEltTy) {
1500 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1501 "an integral vector type.", F);
1504 // Adjust the current Ty (in the opposite direction) rather than
1505 // the type being matched against.
1506 if ((Match & ExtendedElementVectorType) != 0) {
1507 if ((IEltTy->getBitWidth() & 1) != 0) {
1508 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " vector "
1509 "element bit-width is odd.", F);
1512 Ty = VectorType::getTruncatedElementVectorType(VTy);
1514 Ty = VectorType::getExtendedElementVectorType(VTy);
1515 Match &= ~(ExtendedElementVectorType | TruncatedElementVectorType);
1518 if (Match <= static_cast<int>(NumRets - 1)) {
1520 RetTy = ST->getElementType(Match);
1523 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1524 "match return type.", F);
1528 if (Ty != FTy->getParamType(Match - 1)) {
1529 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1530 "match parameter %" + utostr(Match - 1) + ".", F);
1534 } else if (VT == MVT::iAny) {
1535 if (!EltTy->isInteger()) {
1536 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1537 "an integer type.", F);
1541 unsigned GotBits = cast<IntegerType>(EltTy)->getBitWidth();
1545 Suffix += "v" + utostr(NumElts);
1547 Suffix += "i" + utostr(GotBits);
1549 // Check some constraints on various intrinsics.
1551 default: break; // Not everything needs to be checked.
1552 case Intrinsic::bswap:
1553 if (GotBits < 16 || GotBits % 16 != 0) {
1554 CheckFailed("Intrinsic requires even byte width argument", F);
1559 } else if (VT == MVT::fAny) {
1560 if (!EltTy->isFloatingPoint()) {
1561 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1562 "a floating-point type.", F);
1569 Suffix += "v" + utostr(NumElts);
1571 Suffix += MVT::getMVT(EltTy).getMVTString();
1572 } else if (VT == MVT::iPTR) {
1573 if (!isa<PointerType>(Ty)) {
1574 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1575 "pointer and a pointer is required.", F);
1578 } else if (VT == MVT::iPTRAny) {
1579 // Outside of TableGen, we don't distinguish iPTRAny (to any address space)
1580 // and iPTR. In the verifier, we can not distinguish which case we have so
1581 // allow either case to be legal.
1582 if (const PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
1583 Suffix += ".p" + utostr(PTyp->getAddressSpace()) +
1584 MVT::getMVT(PTyp->getElementType()).getMVTString();
1586 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1587 "pointer and a pointer is required.", F);
1590 } else if (MVT((MVT::SimpleValueType)VT).isVector()) {
1591 MVT VVT = MVT((MVT::SimpleValueType)VT);
1593 // If this is a vector argument, verify the number and type of elements.
1594 if (VVT.getVectorElementType() != MVT::getMVT(EltTy)) {
1595 CheckFailed("Intrinsic prototype has incorrect vector element type!", F);
1599 if (VVT.getVectorNumElements() != NumElts) {
1600 CheckFailed("Intrinsic prototype has incorrect number of "
1601 "vector elements!", F);
1604 } else if (MVT((MVT::SimpleValueType)VT).getTypeForMVT() != EltTy) {
1605 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is wrong!", F);
1607 } else if (EltTy != Ty) {
1608 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is a vector "
1609 "and a scalar is required.", F);
1616 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1617 /// Intrinsics.gen. This implements a little state machine that verifies the
1618 /// prototype of intrinsics.
1619 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
1621 unsigned ParamNum, ...) {
1623 va_start(VA, ParamNum);
1624 const FunctionType *FTy = F->getFunctionType();
1626 // For overloaded intrinsics, the Suffix of the function name must match the
1627 // types of the arguments. This variable keeps track of the expected
1628 // suffix, to be checked at the end.
1631 if (FTy->getNumParams() + FTy->isVarArg() != ParamNum) {
1632 CheckFailed("Intrinsic prototype has incorrect number of arguments!", F);
1636 const Type *Ty = FTy->getReturnType();
1637 const StructType *ST = dyn_cast<StructType>(Ty);
1639 // Verify the return types.
1640 if (ST && ST->getNumElements() != RetNum) {
1641 CheckFailed("Intrinsic prototype has incorrect number of return types!", F);
1645 for (unsigned ArgNo = 0; ArgNo < RetNum; ++ArgNo) {
1646 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1648 if (ST) Ty = ST->getElementType(ArgNo);
1650 if (!PerformTypeCheck(ID, F, Ty, VT, ArgNo, Suffix))
1654 // Verify the parameter types.
1655 for (unsigned ArgNo = 0; ArgNo < ParamNum; ++ArgNo) {
1656 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1658 if (VT == MVT::isVoid && ArgNo > 0) {
1659 if (!FTy->isVarArg())
1660 CheckFailed("Intrinsic prototype has no '...'!", F);
1664 if (!PerformTypeCheck(ID, F, FTy->getParamType(ArgNo), VT, ArgNo + RetNum,
1671 // For intrinsics without pointer arguments, if we computed a Suffix then the
1672 // intrinsic is overloaded and we need to make sure that the name of the
1673 // function is correct. We add the suffix to the name of the intrinsic and
1674 // compare against the given function name. If they are not the same, the
1675 // function name is invalid. This ensures that overloading of intrinsics
1676 // uses a sane and consistent naming convention. Note that intrinsics with
1677 // pointer argument may or may not be overloaded so we will check assuming it
1678 // has a suffix and not.
1679 if (!Suffix.empty()) {
1680 std::string Name(Intrinsic::getName(ID));
1681 if (Name + Suffix != F->getName()) {
1682 CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1683 F->getName().substr(Name.length()) + "'. It should be '" +
1688 // Check parameter attributes.
1689 Assert1(F->getAttributes() == Intrinsic::getAttributes(ID),
1690 "Intrinsic has wrong parameter attributes!", F);
1693 /// Verify that an MDNode is not cyclic.
1694 bool Verifier::VerifyMDNode(const MDNode *N) {
1695 if (N->elem_empty()) return true;
1697 // The current DFS path through the nodes. Node and element number.
1698 typedef std::pair<const MDNode *, MDNode::const_elem_iterator> Edge;
1699 SmallVector<Edge, 8> Path;
1701 Path.push_back(std::make_pair(N, N->elem_begin()));
1702 while (!Path.empty()) {
1703 Edge &e = Path.back();
1704 const MDNode *&e_N = e.first;
1705 MDNode::const_elem_iterator &e_I = e.second;
1707 if (e_N->elem_end() == e_I) {
1712 for (MDNode::const_elem_iterator e_E = e_N->elem_end(); e_I != e_E; ++e_I) {
1713 if (const MDNode *C = dyn_cast_or_null<MDNode>(e_I->operator Value*())) {
1714 // Is child MDNode C already in the Path?
1715 for (SmallVectorImpl<Edge>::iterator I = Path.begin(), E = Path.end();
1717 if (I->first != C) {
1718 CheckFailed("MDNode is cyclic.", C);
1723 Path.push_back(std::make_pair(C, C->elem_begin()));
1732 //===----------------------------------------------------------------------===//
1733 // Implement the public interfaces to this file...
1734 //===----------------------------------------------------------------------===//
1736 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1737 return new Verifier(action);
1741 // verifyFunction - Create
1742 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1743 Function &F = const_cast<Function&>(f);
1744 assert(!F.isDeclaration() && "Cannot verify external functions");
1746 ExistingModuleProvider MP(F.getParent());
1747 FunctionPassManager FPM(&MP);
1748 Verifier *V = new Verifier(action);
1755 /// verifyModule - Check a module for errors, printing messages on stderr.
1756 /// Return true if the module is corrupt.
1758 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1759 std::string *ErrorInfo) {
1761 Verifier *V = new Verifier(action);
1763 PM.run(const_cast<Module&>(M));
1765 if (ErrorInfo && V->Broken)
1766 *ErrorInfo = V->msgs.str();