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/Metadata.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/ErrorHandling.h"
66 #include "llvm/Support/raw_ostream.h"
72 namespace { // Anonymous namespace for class
73 struct VISIBILITY_HIDDEN PreVerifier : public FunctionPass {
74 static char ID; // Pass ID, replacement for typeid
76 PreVerifier() : FunctionPass(&ID) { }
78 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
82 // Check that the prerequisites for successful DominatorTree construction
84 bool runOnFunction(Function &F) {
87 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
88 if (I->empty() || !I->back().isTerminator()) {
89 cerr << "Basic Block does not have terminator!\n";
90 WriteAsOperand(*cerr, I, true);
97 llvm_report_error("Broken module, no Basic Block terminator!");
104 char PreVerifier::ID = 0;
105 static RegisterPass<PreVerifier>
106 PreVer("preverify", "Preliminary module verification");
107 static const PassInfo *const PreVerifyID = &PreVer;
110 struct VISIBILITY_HIDDEN
111 Verifier : public FunctionPass, InstVisitor<Verifier> {
112 static char ID; // Pass ID, replacement for typeid
113 bool Broken; // Is this module found to be broken?
114 bool RealPass; // Are we not being run by a PassManager?
115 VerifierFailureAction action;
116 // What to do if verification fails.
117 Module *Mod; // Module we are verifying right now
118 DominatorTree *DT; // Dominator Tree, caution can be null!
119 std::stringstream msgs; // A stringstream to collect messages
121 /// InstInThisBlock - when verifying a basic block, keep track of all of the
122 /// instructions we have seen so far. This allows us to do efficient
123 /// dominance checks for the case when an instruction has an operand that is
124 /// an instruction in the same block.
125 SmallPtrSet<Instruction*, 16> InstsInThisBlock;
129 Broken(false), RealPass(true), action(AbortProcessAction),
130 DT(0), msgs( std::ios::app | std::ios::out ) {}
131 explicit Verifier(VerifierFailureAction ctn)
133 Broken(false), RealPass(true), action(ctn), DT(0),
134 msgs( std::ios::app | std::ios::out ) {}
135 explicit Verifier(bool AB)
137 Broken(false), RealPass(true),
138 action( AB ? AbortProcessAction : PrintMessageAction), DT(0),
139 msgs( std::ios::app | std::ios::out ) {}
140 explicit Verifier(DominatorTree &dt)
142 Broken(false), RealPass(false), action(PrintMessageAction),
143 DT(&dt), msgs( std::ios::app | std::ios::out ) {}
146 bool doInitialization(Module &M) {
148 verifyTypeSymbolTable(M.getTypeSymbolTable());
150 // If this is a real pass, in a pass manager, we must abort before
151 // returning back to the pass manager, or else the pass manager may try to
152 // run other passes on the broken module.
154 return abortIfBroken();
158 bool runOnFunction(Function &F) {
159 // Get dominator information if we are being run by PassManager
160 if (RealPass) DT = &getAnalysis<DominatorTree>();
165 InstsInThisBlock.clear();
167 // If this is a real pass, in a pass manager, we must abort before
168 // returning back to the pass manager, or else the pass manager may try to
169 // run other passes on the broken module.
171 return abortIfBroken();
176 bool doFinalization(Module &M) {
177 // Scan through, checking all of the external function's linkage now...
178 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
179 visitGlobalValue(*I);
181 // Check to make sure function prototypes are okay.
182 if (I->isDeclaration()) visitFunction(*I);
185 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
187 visitGlobalVariable(*I);
189 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
191 visitGlobalAlias(*I);
193 // If the module is broken, abort at this time.
194 return abortIfBroken();
197 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
198 AU.setPreservesAll();
199 AU.addRequiredID(PreVerifyID);
201 AU.addRequired<DominatorTree>();
204 /// abortIfBroken - If the module is broken and we are supposed to abort on
205 /// this condition, do so.
207 bool abortIfBroken() {
208 if (!Broken) return false;
209 msgs << "Broken module found, ";
211 default: llvm_unreachable("Unknown action");
212 case AbortProcessAction:
213 msgs << "compilation aborted!\n";
215 // Client should choose different reaction if abort is not desired
217 case PrintMessageAction:
218 msgs << "verification continues.\n";
221 case ReturnStatusAction:
222 msgs << "compilation terminated.\n";
228 // Verification methods...
229 void verifyTypeSymbolTable(TypeSymbolTable &ST);
230 void visitGlobalValue(GlobalValue &GV);
231 void visitGlobalVariable(GlobalVariable &GV);
232 void visitGlobalAlias(GlobalAlias &GA);
233 void visitFunction(Function &F);
234 void visitBasicBlock(BasicBlock &BB);
235 using InstVisitor<Verifier>::visit;
237 void visit(Instruction &I);
239 void visitTruncInst(TruncInst &I);
240 void visitZExtInst(ZExtInst &I);
241 void visitSExtInst(SExtInst &I);
242 void visitFPTruncInst(FPTruncInst &I);
243 void visitFPExtInst(FPExtInst &I);
244 void visitFPToUIInst(FPToUIInst &I);
245 void visitFPToSIInst(FPToSIInst &I);
246 void visitUIToFPInst(UIToFPInst &I);
247 void visitSIToFPInst(SIToFPInst &I);
248 void visitIntToPtrInst(IntToPtrInst &I);
249 void visitPtrToIntInst(PtrToIntInst &I);
250 void visitBitCastInst(BitCastInst &I);
251 void visitPHINode(PHINode &PN);
252 void visitBinaryOperator(BinaryOperator &B);
253 void visitICmpInst(ICmpInst &IC);
254 void visitFCmpInst(FCmpInst &FC);
255 void visitExtractElementInst(ExtractElementInst &EI);
256 void visitInsertElementInst(InsertElementInst &EI);
257 void visitShuffleVectorInst(ShuffleVectorInst &EI);
258 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
259 void visitCallInst(CallInst &CI);
260 void visitInvokeInst(InvokeInst &II);
261 void visitGetElementPtrInst(GetElementPtrInst &GEP);
262 void visitLoadInst(LoadInst &LI);
263 void visitStoreInst(StoreInst &SI);
264 void visitInstruction(Instruction &I);
265 void visitTerminatorInst(TerminatorInst &I);
266 void visitReturnInst(ReturnInst &RI);
267 void visitSwitchInst(SwitchInst &SI);
268 void visitSelectInst(SelectInst &SI);
269 void visitUserOp1(Instruction &I);
270 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
271 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
272 void visitAllocationInst(AllocationInst &AI);
273 void visitExtractValueInst(ExtractValueInst &EVI);
274 void visitInsertValueInst(InsertValueInst &IVI);
276 void VerifyCallSite(CallSite CS);
277 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
278 int VT, unsigned ArgNo, std::string &Suffix);
279 void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
280 unsigned RetNum, unsigned ParamNum, ...);
281 void VerifyParameterAttrs(Attributes Attrs, const Type *Ty,
282 bool isReturnValue, const Value *V);
283 void VerifyFunctionAttrs(const FunctionType *FT, const AttrListPtr &Attrs,
286 void WriteValue(const Value *V) {
288 if (isa<Instruction>(V)) {
291 WriteAsOperand(msgs, V, true, Mod);
296 void WriteType(const Type *T) {
298 raw_os_ostream RO(msgs);
300 WriteTypeSymbolic(RO, T, Mod);
304 // CheckFailed - A check failed, so print out the condition and the message
305 // that failed. This provides a nice place to put a breakpoint if you want
306 // to see why something is not correct.
307 void CheckFailed(const Twine &Message,
308 const Value *V1 = 0, const Value *V2 = 0,
309 const Value *V3 = 0, const Value *V4 = 0) {
310 msgs << Message.str() << "\n";
318 void CheckFailed(const Twine &Message, const Value* V1,
319 const Type* T2, const Value* V3 = 0) {
320 msgs << Message.str() << "\n";
327 } // End anonymous namespace
329 char Verifier::ID = 0;
330 static RegisterPass<Verifier> X("verify", "Module Verifier");
332 // Assert - We know that cond should be true, if not print an error message.
333 #define Assert(C, M) \
334 do { if (!(C)) { CheckFailed(M); return; } } while (0)
335 #define Assert1(C, M, V1) \
336 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
337 #define Assert2(C, M, V1, V2) \
338 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
339 #define Assert3(C, M, V1, V2, V3) \
340 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
341 #define Assert4(C, M, V1, V2, V3, V4) \
342 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
344 void Verifier::visit(Instruction &I) {
345 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
346 Assert1(I.getOperand(i) != 0, "Operand is null", &I);
347 InstVisitor<Verifier>::visit(I);
351 void Verifier::visitGlobalValue(GlobalValue &GV) {
352 Assert1(!GV.isDeclaration() ||
353 GV.hasExternalLinkage() ||
354 GV.hasDLLImportLinkage() ||
355 GV.hasExternalWeakLinkage() ||
356 GV.hasGhostLinkage() ||
357 (isa<GlobalAlias>(GV) &&
358 (GV.hasLocalLinkage() || GV.hasWeakLinkage())),
359 "Global is external, but doesn't have external or dllimport or weak linkage!",
362 Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
363 "Global is marked as dllimport, but not external", &GV);
365 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
366 "Only global variables can have appending linkage!", &GV);
368 if (GV.hasAppendingLinkage()) {
369 GlobalVariable &GVar = cast<GlobalVariable>(GV);
370 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
371 "Only global arrays can have appending linkage!", &GV);
375 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
376 if (GV.hasInitializer()) {
377 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
378 "Global variable initializer type does not match global "
379 "variable type!", &GV);
381 // If the global has common linkage, it must have a zero initializer.
382 if (GV.hasCommonLinkage())
383 Assert1(GV.getInitializer()->isNullValue(),
384 "'common' global must have a zero initializer!", &GV);
387 // Verify that any metadata used in a global initializer points only to
389 if (MDNode *FirstNode = dyn_cast<MDNode>(GV.getInitializer())) {
390 SmallVector<const MDNode *, 4> NodesToAnalyze;
391 NodesToAnalyze.push_back(FirstNode);
392 while (!NodesToAnalyze.empty()) {
393 const MDNode *N = NodesToAnalyze.back();
394 NodesToAnalyze.pop_back();
396 for (MDNode::const_elem_iterator I = N->elem_begin(),
397 E = N->elem_end(); I != E; ++I)
398 if (const Value *V = *I) {
399 if (const MDNode *Next = dyn_cast<MDNode>(V))
400 NodesToAnalyze.push_back(Next);
402 Assert3(isa<Constant>(V),
403 "reference to instruction from global metadata node",
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());
431 (CE->getOpcode() == Instruction::BitCast ||
432 CE->getOpcode() == Instruction::GetElementPtr) &&
433 isa<GlobalValue>(CE->getOperand(0)),
434 "Aliasee should be either GlobalValue or bitcast of GlobalValue",
438 const GlobalValue* Aliasee = GA.resolveAliasedGlobal(/*stopOnWeak*/ false);
440 "Aliasing chain should end with function or global variable", &GA);
442 visitGlobalValue(GA);
445 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
448 // VerifyParameterAttrs - Check the given attributes for an argument or return
449 // value of the specified type. The value V is printed in error messages.
450 void Verifier::VerifyParameterAttrs(Attributes Attrs, const Type *Ty,
451 bool isReturnValue, const Value *V) {
452 if (Attrs == Attribute::None)
455 Attributes FnCheckAttr = Attrs & Attribute::FunctionOnly;
456 Assert1(!FnCheckAttr, "Attribute " + Attribute::getAsString(FnCheckAttr) +
457 " only applies to the function!", V);
460 Attributes RetI = Attrs & Attribute::ParameterOnly;
461 Assert1(!RetI, "Attribute " + Attribute::getAsString(RetI) +
462 " does not apply to return values!", V);
466 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
467 Attributes MutI = Attrs & Attribute::MutuallyIncompatible[i];
468 Assert1(!(MutI & (MutI - 1)), "Attributes " +
469 Attribute::getAsString(MutI) + " are incompatible!", V);
472 Attributes TypeI = Attrs & Attribute::typeIncompatible(Ty);
473 Assert1(!TypeI, "Wrong type for attribute " +
474 Attribute::getAsString(TypeI), V);
476 Attributes ByValI = Attrs & Attribute::ByVal;
477 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
478 Assert1(!ByValI || PTy->getElementType()->isSized(),
479 "Attribute " + Attribute::getAsString(ByValI) +
480 " does not support unsized types!", V);
483 "Attribute " + Attribute::getAsString(ByValI) +
484 " only applies to parameters with pointer type!", V);
488 // VerifyFunctionAttrs - Check parameter attributes against a function type.
489 // The value V is printed in error messages.
490 void Verifier::VerifyFunctionAttrs(const FunctionType *FT,
491 const AttrListPtr &Attrs,
496 bool SawNest = false;
498 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
499 const AttributeWithIndex &Attr = Attrs.getSlot(i);
503 Ty = FT->getReturnType();
504 else if (Attr.Index-1 < FT->getNumParams())
505 Ty = FT->getParamType(Attr.Index-1);
507 break; // VarArgs attributes, verified elsewhere.
509 VerifyParameterAttrs(Attr.Attrs, Ty, Attr.Index == 0, V);
511 if (Attr.Attrs & Attribute::Nest) {
512 Assert1(!SawNest, "More than one parameter has attribute nest!", V);
516 if (Attr.Attrs & Attribute::StructRet)
517 Assert1(Attr.Index == 1, "Attribute sret not on first parameter!", V);
520 Attributes FAttrs = Attrs.getFnAttributes();
521 Attributes NotFn = FAttrs & (~Attribute::FunctionOnly);
522 Assert1(!NotFn, "Attribute " + Attribute::getAsString(NotFn) +
523 " does not apply to the function!", V);
526 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
527 Attributes MutI = FAttrs & Attribute::MutuallyIncompatible[i];
528 Assert1(!(MutI & (MutI - 1)), "Attributes " +
529 Attribute::getAsString(MutI) + " are incompatible!", V);
533 static bool VerifyAttributeCount(const AttrListPtr &Attrs, unsigned Params) {
537 unsigned LastSlot = Attrs.getNumSlots() - 1;
538 unsigned LastIndex = Attrs.getSlot(LastSlot).Index;
539 if (LastIndex <= Params
540 || (LastIndex == (unsigned)~0
541 && (LastSlot == 0 || Attrs.getSlot(LastSlot - 1).Index <= Params)))
546 // visitFunction - Verify that a function is ok.
548 void Verifier::visitFunction(Function &F) {
549 // Check function arguments.
550 const FunctionType *FT = F.getFunctionType();
551 unsigned NumArgs = F.arg_size();
553 Assert1(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
554 Assert2(FT->getNumParams() == NumArgs,
555 "# formal arguments must match # of arguments for function type!",
557 Assert1(F.getReturnType()->isFirstClassType() ||
558 F.getReturnType() == Type::VoidTy ||
559 isa<StructType>(F.getReturnType()),
560 "Functions cannot return aggregate values!", &F);
562 Assert1(!F.hasStructRetAttr() || F.getReturnType() == Type::VoidTy,
563 "Invalid struct return type!", &F);
565 const AttrListPtr &Attrs = F.getAttributes();
567 Assert1(VerifyAttributeCount(Attrs, FT->getNumParams()),
568 "Attributes after last parameter!", &F);
570 // Check function attributes.
571 VerifyFunctionAttrs(FT, Attrs, &F);
573 // Check that this function meets the restrictions on this calling convention.
574 switch (F.getCallingConv()) {
579 case CallingConv::Fast:
580 case CallingConv::Cold:
581 case CallingConv::X86_FastCall:
582 Assert1(!F.isVarArg(),
583 "Varargs functions must have C calling conventions!", &F);
587 bool isLLVMdotName = F.getName().size() >= 5 &&
588 F.getName().substr(0, 5) == "llvm.";
590 Assert1(F.getReturnType() != Type::MetadataTy,
591 "Function may not return metadata unless it's an intrinsic", &F);
593 // Check that the argument values match the function type for this function...
595 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
597 Assert2(I->getType() == FT->getParamType(i),
598 "Argument value does not match function argument type!",
599 I, FT->getParamType(i));
600 Assert1(I->getType()->isFirstClassType(),
601 "Function arguments must have first-class types!", I);
603 Assert2(I->getType() != Type::MetadataTy,
604 "Function takes metadata but isn't an intrinsic", I, &F);
607 if (F.isDeclaration()) {
608 Assert1(F.hasExternalLinkage() || F.hasDLLImportLinkage() ||
609 F.hasExternalWeakLinkage() || F.hasGhostLinkage(),
610 "invalid linkage type for function declaration", &F);
612 // Verify that this function (which has a body) is not named "llvm.*". It
613 // is not legal to define intrinsics.
614 Assert1(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
616 // Check the entry node
617 BasicBlock *Entry = &F.getEntryBlock();
618 Assert1(pred_begin(Entry) == pred_end(Entry),
619 "Entry block to function must not have predecessors!", Entry);
624 // verifyBasicBlock - Verify that a basic block is well formed...
626 void Verifier::visitBasicBlock(BasicBlock &BB) {
627 InstsInThisBlock.clear();
629 // Ensure that basic blocks have terminators!
630 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
632 // Check constraints that this basic block imposes on all of the PHI nodes in
634 if (isa<PHINode>(BB.front())) {
635 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
636 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
637 std::sort(Preds.begin(), Preds.end());
639 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
641 // Ensure that PHI nodes have at least one entry!
642 Assert1(PN->getNumIncomingValues() != 0,
643 "PHI nodes must have at least one entry. If the block is dead, "
644 "the PHI should be removed!", PN);
645 Assert1(PN->getNumIncomingValues() == Preds.size(),
646 "PHINode should have one entry for each predecessor of its "
647 "parent basic block!", PN);
649 // Get and sort all incoming values in the PHI node...
651 Values.reserve(PN->getNumIncomingValues());
652 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
653 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
654 PN->getIncomingValue(i)));
655 std::sort(Values.begin(), Values.end());
657 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
658 // Check to make sure that if there is more than one entry for a
659 // particular basic block in this PHI node, that the incoming values are
662 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
663 Values[i].second == Values[i-1].second,
664 "PHI node has multiple entries for the same basic block with "
665 "different incoming values!", PN, Values[i].first,
666 Values[i].second, Values[i-1].second);
668 // Check to make sure that the predecessors and PHI node entries are
670 Assert3(Values[i].first == Preds[i],
671 "PHI node entries do not match predecessors!", PN,
672 Values[i].first, Preds[i]);
678 void Verifier::visitTerminatorInst(TerminatorInst &I) {
679 // Ensure that terminators only exist at the end of the basic block.
680 Assert1(&I == I.getParent()->getTerminator(),
681 "Terminator found in the middle of a basic block!", I.getParent());
685 void Verifier::visitReturnInst(ReturnInst &RI) {
686 Function *F = RI.getParent()->getParent();
687 unsigned N = RI.getNumOperands();
688 if (F->getReturnType() == Type::VoidTy)
690 "Found return instr that returns non-void in Function of void "
691 "return type!", &RI, F->getReturnType());
692 else if (N == 1 && F->getReturnType() == RI.getOperand(0)->getType()) {
693 // Exactly one return value and it matches the return type. Good.
694 } else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
695 // The return type is a struct; check for multiple return values.
696 Assert2(STy->getNumElements() == N,
697 "Incorrect number of return values in ret instruction!",
698 &RI, F->getReturnType());
699 for (unsigned i = 0; i != N; ++i)
700 Assert2(STy->getElementType(i) == RI.getOperand(i)->getType(),
701 "Function return type does not match operand "
702 "type of return inst!", &RI, F->getReturnType());
703 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(F->getReturnType())) {
704 // The return type is an array; check for multiple return values.
705 Assert2(ATy->getNumElements() == N,
706 "Incorrect number of return values in ret instruction!",
707 &RI, F->getReturnType());
708 for (unsigned i = 0; i != N; ++i)
709 Assert2(ATy->getElementType() == RI.getOperand(i)->getType(),
710 "Function return type does not match operand "
711 "type of return inst!", &RI, F->getReturnType());
713 CheckFailed("Function return type does not match operand "
714 "type of return inst!", &RI, F->getReturnType());
717 // Check to make sure that the return value has necessary properties for
719 visitTerminatorInst(RI);
722 void Verifier::visitSwitchInst(SwitchInst &SI) {
723 // Check to make sure that all of the constants in the switch instruction
724 // have the same type as the switched-on value.
725 const Type *SwitchTy = SI.getCondition()->getType();
726 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
727 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
728 "Switch constants must all be same type as switch value!", &SI);
730 visitTerminatorInst(SI);
733 void Verifier::visitSelectInst(SelectInst &SI) {
734 Assert1(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
736 "Invalid operands for select instruction!", &SI);
738 Assert1(SI.getTrueValue()->getType() == SI.getType(),
739 "Select values must have same type as select instruction!", &SI);
740 visitInstruction(SI);
744 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
745 /// a pass, if any exist, it's an error.
747 void Verifier::visitUserOp1(Instruction &I) {
748 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
751 void Verifier::visitTruncInst(TruncInst &I) {
752 // Get the source and destination types
753 const Type *SrcTy = I.getOperand(0)->getType();
754 const Type *DestTy = I.getType();
756 // Get the size of the types in bits, we'll need this later
757 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
758 unsigned DestBitSize = DestTy->getScalarSizeInBits();
760 Assert1(SrcTy->isIntOrIntVector(), "Trunc only operates on integer", &I);
761 Assert1(DestTy->isIntOrIntVector(), "Trunc only produces integer", &I);
762 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
763 "trunc source and destination must both be a vector or neither", &I);
764 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
769 void Verifier::visitZExtInst(ZExtInst &I) {
770 // Get the source and destination types
771 const Type *SrcTy = I.getOperand(0)->getType();
772 const Type *DestTy = I.getType();
774 // Get the size of the types in bits, we'll need this later
775 Assert1(SrcTy->isIntOrIntVector(), "ZExt only operates on integer", &I);
776 Assert1(DestTy->isIntOrIntVector(), "ZExt only produces an integer", &I);
777 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
778 "zext source and destination must both be a vector or neither", &I);
779 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
780 unsigned DestBitSize = DestTy->getScalarSizeInBits();
782 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
787 void Verifier::visitSExtInst(SExtInst &I) {
788 // Get the source and destination types
789 const Type *SrcTy = I.getOperand(0)->getType();
790 const Type *DestTy = I.getType();
792 // Get the size of the types in bits, we'll need this later
793 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
794 unsigned DestBitSize = DestTy->getScalarSizeInBits();
796 Assert1(SrcTy->isIntOrIntVector(), "SExt only operates on integer", &I);
797 Assert1(DestTy->isIntOrIntVector(), "SExt only produces an integer", &I);
798 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
799 "sext source and destination must both be a vector or neither", &I);
800 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
805 void Verifier::visitFPTruncInst(FPTruncInst &I) {
806 // Get the source and destination types
807 const Type *SrcTy = I.getOperand(0)->getType();
808 const Type *DestTy = I.getType();
809 // Get the size of the types in bits, we'll need this later
810 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
811 unsigned DestBitSize = DestTy->getScalarSizeInBits();
813 Assert1(SrcTy->isFPOrFPVector(),"FPTrunc only operates on FP", &I);
814 Assert1(DestTy->isFPOrFPVector(),"FPTrunc only produces an FP", &I);
815 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
816 "fptrunc source and destination must both be a vector or neither",&I);
817 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
822 void Verifier::visitFPExtInst(FPExtInst &I) {
823 // Get the source and destination types
824 const Type *SrcTy = I.getOperand(0)->getType();
825 const Type *DestTy = I.getType();
827 // Get the size of the types in bits, we'll need this later
828 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
829 unsigned DestBitSize = DestTy->getScalarSizeInBits();
831 Assert1(SrcTy->isFPOrFPVector(),"FPExt only operates on FP", &I);
832 Assert1(DestTy->isFPOrFPVector(),"FPExt only produces an FP", &I);
833 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
834 "fpext source and destination must both be a vector or neither", &I);
835 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
840 void Verifier::visitUIToFPInst(UIToFPInst &I) {
841 // Get the source and destination types
842 const Type *SrcTy = I.getOperand(0)->getType();
843 const Type *DestTy = I.getType();
845 bool SrcVec = isa<VectorType>(SrcTy);
846 bool DstVec = isa<VectorType>(DestTy);
848 Assert1(SrcVec == DstVec,
849 "UIToFP source and dest must both be vector or scalar", &I);
850 Assert1(SrcTy->isIntOrIntVector(),
851 "UIToFP source must be integer or integer vector", &I);
852 Assert1(DestTy->isFPOrFPVector(),
853 "UIToFP result must be FP or FP vector", &I);
855 if (SrcVec && DstVec)
856 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
857 cast<VectorType>(DestTy)->getNumElements(),
858 "UIToFP source and dest vector length mismatch", &I);
863 void Verifier::visitSIToFPInst(SIToFPInst &I) {
864 // Get the source and destination types
865 const Type *SrcTy = I.getOperand(0)->getType();
866 const Type *DestTy = I.getType();
868 bool SrcVec = SrcTy->getTypeID() == Type::VectorTyID;
869 bool DstVec = DestTy->getTypeID() == Type::VectorTyID;
871 Assert1(SrcVec == DstVec,
872 "SIToFP source and dest must both be vector or scalar", &I);
873 Assert1(SrcTy->isIntOrIntVector(),
874 "SIToFP source must be integer or integer vector", &I);
875 Assert1(DestTy->isFPOrFPVector(),
876 "SIToFP result must be FP or FP vector", &I);
878 if (SrcVec && DstVec)
879 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
880 cast<VectorType>(DestTy)->getNumElements(),
881 "SIToFP source and dest vector length mismatch", &I);
886 void Verifier::visitFPToUIInst(FPToUIInst &I) {
887 // Get the source and destination types
888 const Type *SrcTy = I.getOperand(0)->getType();
889 const Type *DestTy = I.getType();
891 bool SrcVec = isa<VectorType>(SrcTy);
892 bool DstVec = isa<VectorType>(DestTy);
894 Assert1(SrcVec == DstVec,
895 "FPToUI source and dest must both be vector or scalar", &I);
896 Assert1(SrcTy->isFPOrFPVector(), "FPToUI source must be FP or FP vector", &I);
897 Assert1(DestTy->isIntOrIntVector(),
898 "FPToUI result must be integer or integer vector", &I);
900 if (SrcVec && DstVec)
901 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
902 cast<VectorType>(DestTy)->getNumElements(),
903 "FPToUI source and dest vector length mismatch", &I);
908 void Verifier::visitFPToSIInst(FPToSIInst &I) {
909 // Get the source and destination types
910 const Type *SrcTy = I.getOperand(0)->getType();
911 const Type *DestTy = I.getType();
913 bool SrcVec = isa<VectorType>(SrcTy);
914 bool DstVec = isa<VectorType>(DestTy);
916 Assert1(SrcVec == DstVec,
917 "FPToSI source and dest must both be vector or scalar", &I);
918 Assert1(SrcTy->isFPOrFPVector(),
919 "FPToSI source must be FP or FP vector", &I);
920 Assert1(DestTy->isIntOrIntVector(),
921 "FPToSI result must be integer or integer vector", &I);
923 if (SrcVec && DstVec)
924 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
925 cast<VectorType>(DestTy)->getNumElements(),
926 "FPToSI source and dest vector length mismatch", &I);
931 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
932 // Get the source and destination types
933 const Type *SrcTy = I.getOperand(0)->getType();
934 const Type *DestTy = I.getType();
936 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
937 Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
942 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
943 // Get the source and destination types
944 const Type *SrcTy = I.getOperand(0)->getType();
945 const Type *DestTy = I.getType();
947 Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
948 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
953 void Verifier::visitBitCastInst(BitCastInst &I) {
954 // Get the source and destination types
955 const Type *SrcTy = I.getOperand(0)->getType();
956 const Type *DestTy = I.getType();
958 // Get the size of the types in bits, we'll need this later
959 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
960 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
962 // BitCast implies a no-op cast of type only. No bits change.
963 // However, you can't cast pointers to anything but pointers.
964 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
965 "Bitcast requires both operands to be pointer or neither", &I);
966 Assert1(SrcBitSize == DestBitSize, "Bitcast requires types of same width",&I);
968 // Disallow aggregates.
969 Assert1(!SrcTy->isAggregateType(),
970 "Bitcast operand must not be aggregate", &I);
971 Assert1(!DestTy->isAggregateType(),
972 "Bitcast type must not be aggregate", &I);
977 /// visitPHINode - Ensure that a PHI node is well formed.
979 void Verifier::visitPHINode(PHINode &PN) {
980 // Ensure that the PHI nodes are all grouped together at the top of the block.
981 // This can be tested by checking whether the instruction before this is
982 // either nonexistent (because this is begin()) or is a PHI node. If not,
983 // then there is some other instruction before a PHI.
984 Assert2(&PN == &PN.getParent()->front() ||
985 isa<PHINode>(--BasicBlock::iterator(&PN)),
986 "PHI nodes not grouped at top of basic block!",
987 &PN, PN.getParent());
989 // Check that all of the operands of the PHI node have the same type as the
991 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
992 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
993 "PHI node operands are not the same type as the result!", &PN);
995 // All other PHI node constraints are checked in the visitBasicBlock method.
997 visitInstruction(PN);
1000 void Verifier::VerifyCallSite(CallSite CS) {
1001 Instruction *I = CS.getInstruction();
1003 Assert1(isa<PointerType>(CS.getCalledValue()->getType()),
1004 "Called function must be a pointer!", I);
1005 const PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
1006 Assert1(isa<FunctionType>(FPTy->getElementType()),
1007 "Called function is not pointer to function type!", I);
1009 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1011 // Verify that the correct number of arguments are being passed
1012 if (FTy->isVarArg())
1013 Assert1(CS.arg_size() >= FTy->getNumParams(),
1014 "Called function requires more parameters than were provided!",I);
1016 Assert1(CS.arg_size() == FTy->getNumParams(),
1017 "Incorrect number of arguments passed to called function!", I);
1019 // Verify that all arguments to the call match the function type...
1020 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1021 Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
1022 "Call parameter type does not match function signature!",
1023 CS.getArgument(i), FTy->getParamType(i), I);
1025 const AttrListPtr &Attrs = CS.getAttributes();
1027 Assert1(VerifyAttributeCount(Attrs, CS.arg_size()),
1028 "Attributes after last parameter!", I);
1030 // Verify call attributes.
1031 VerifyFunctionAttrs(FTy, Attrs, I);
1033 if (FTy->isVarArg())
1034 // Check attributes on the varargs part.
1035 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
1036 Attributes Attr = Attrs.getParamAttributes(Idx);
1038 VerifyParameterAttrs(Attr, CS.getArgument(Idx-1)->getType(), false, I);
1040 Attributes VArgI = Attr & Attribute::VarArgsIncompatible;
1041 Assert1(!VArgI, "Attribute " + Attribute::getAsString(VArgI) +
1042 " cannot be used for vararg call arguments!", I);
1045 // Verify that there's no metadata unless it's a direct call to an intrinsic.
1046 if (!CS.getCalledFunction() || CS.getCalledFunction()->getName().size() < 5 ||
1047 CS.getCalledFunction()->getName().substr(0, 5) != "llvm.") {
1048 Assert1(FTy->getReturnType() != Type::MetadataTy,
1049 "Only intrinsics may return metadata", I);
1050 for (FunctionType::param_iterator PI = FTy->param_begin(),
1051 PE = FTy->param_end(); PI != PE; ++PI)
1052 Assert1(PI->get() != Type::MetadataTy, "Function has metadata parameter "
1053 "but isn't an intrinsic", I);
1056 visitInstruction(*I);
1059 void Verifier::visitCallInst(CallInst &CI) {
1060 VerifyCallSite(&CI);
1062 if (Function *F = CI.getCalledFunction())
1063 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
1064 visitIntrinsicFunctionCall(ID, CI);
1067 void Verifier::visitInvokeInst(InvokeInst &II) {
1068 VerifyCallSite(&II);
1071 /// visitBinaryOperator - Check that both arguments to the binary operator are
1072 /// of the same type!
1074 void Verifier::visitBinaryOperator(BinaryOperator &B) {
1075 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
1076 "Both operands to a binary operator are not of the same type!", &B);
1078 switch (B.getOpcode()) {
1079 // Check that integer arithmetic operators are only used with
1080 // integral operands.
1081 case Instruction::Add:
1082 case Instruction::Sub:
1083 case Instruction::Mul:
1084 case Instruction::SDiv:
1085 case Instruction::UDiv:
1086 case Instruction::SRem:
1087 case Instruction::URem:
1088 Assert1(B.getType()->isIntOrIntVector(),
1089 "Integer arithmetic operators only work with integral types!", &B);
1090 Assert1(B.getType() == B.getOperand(0)->getType(),
1091 "Integer arithmetic operators must have same type "
1092 "for operands and result!", &B);
1094 // Check that floating-point arithmetic operators are only used with
1095 // floating-point operands.
1096 case Instruction::FAdd:
1097 case Instruction::FSub:
1098 case Instruction::FMul:
1099 case Instruction::FDiv:
1100 case Instruction::FRem:
1101 Assert1(B.getType()->isFPOrFPVector(),
1102 "Floating-point arithmetic operators only work with "
1103 "floating-point types!", &B);
1104 Assert1(B.getType() == B.getOperand(0)->getType(),
1105 "Floating-point arithmetic operators must have same type "
1106 "for operands and result!", &B);
1108 // Check that logical operators are only used with integral operands.
1109 case Instruction::And:
1110 case Instruction::Or:
1111 case Instruction::Xor:
1112 Assert1(B.getType()->isIntOrIntVector(),
1113 "Logical operators only work with integral types!", &B);
1114 Assert1(B.getType() == B.getOperand(0)->getType(),
1115 "Logical operators must have same type for operands and result!",
1118 case Instruction::Shl:
1119 case Instruction::LShr:
1120 case Instruction::AShr:
1121 Assert1(B.getType()->isIntOrIntVector(),
1122 "Shifts only work with integral types!", &B);
1123 Assert1(B.getType() == B.getOperand(0)->getType(),
1124 "Shift return type must be same as operands!", &B);
1127 llvm_unreachable("Unknown BinaryOperator opcode!");
1130 visitInstruction(B);
1133 void Verifier::visitICmpInst(ICmpInst& IC) {
1134 // Check that the operands are the same type
1135 const Type* Op0Ty = IC.getOperand(0)->getType();
1136 const Type* Op1Ty = IC.getOperand(1)->getType();
1137 Assert1(Op0Ty == Op1Ty,
1138 "Both operands to ICmp instruction are not of the same type!", &IC);
1139 // Check that the operands are the right type
1140 Assert1(Op0Ty->isIntOrIntVector() || isa<PointerType>(Op0Ty),
1141 "Invalid operand types for ICmp instruction", &IC);
1143 visitInstruction(IC);
1146 void Verifier::visitFCmpInst(FCmpInst& FC) {
1147 // Check that the operands are the same type
1148 const Type* Op0Ty = FC.getOperand(0)->getType();
1149 const Type* Op1Ty = FC.getOperand(1)->getType();
1150 Assert1(Op0Ty == Op1Ty,
1151 "Both operands to FCmp instruction are not of the same type!", &FC);
1152 // Check that the operands are the right type
1153 Assert1(Op0Ty->isFPOrFPVector(),
1154 "Invalid operand types for FCmp instruction", &FC);
1155 visitInstruction(FC);
1158 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
1159 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
1161 "Invalid extractelement operands!", &EI);
1162 visitInstruction(EI);
1165 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
1166 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
1169 "Invalid insertelement operands!", &IE);
1170 visitInstruction(IE);
1173 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
1174 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
1176 "Invalid shufflevector operands!", &SV);
1178 const VectorType *VTy = dyn_cast<VectorType>(SV.getOperand(0)->getType());
1179 Assert1(VTy, "Operands are not a vector type", &SV);
1181 // Check to see if Mask is valid.
1182 if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
1183 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
1184 if (ConstantInt* CI = dyn_cast<ConstantInt>(MV->getOperand(i))) {
1185 Assert1(!CI->uge(VTy->getNumElements()*2),
1186 "Invalid shufflevector shuffle mask!", &SV);
1188 Assert1(isa<UndefValue>(MV->getOperand(i)),
1189 "Invalid shufflevector shuffle mask!", &SV);
1193 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
1194 isa<ConstantAggregateZero>(SV.getOperand(2)),
1195 "Invalid shufflevector shuffle mask!", &SV);
1198 visitInstruction(SV);
1201 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1202 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
1204 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
1205 Idxs.begin(), Idxs.end());
1206 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
1207 Assert2(isa<PointerType>(GEP.getType()) &&
1208 cast<PointerType>(GEP.getType())->getElementType() == ElTy,
1209 "GEP is not of right type for indices!", &GEP, ElTy);
1210 visitInstruction(GEP);
1213 void Verifier::visitLoadInst(LoadInst &LI) {
1215 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
1216 Assert2(ElTy == LI.getType(),
1217 "Load result type does not match pointer operand type!", &LI, ElTy);
1218 Assert1(ElTy != Type::MetadataTy, "Can't load metadata!", &LI);
1219 visitInstruction(LI);
1222 void Verifier::visitStoreInst(StoreInst &SI) {
1224 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
1225 Assert2(ElTy == SI.getOperand(0)->getType(),
1226 "Stored value type does not match pointer operand type!", &SI, ElTy);
1227 Assert1(ElTy != Type::MetadataTy, "Can't store metadata!", &SI);
1228 visitInstruction(SI);
1231 void Verifier::visitAllocationInst(AllocationInst &AI) {
1232 const PointerType *PTy = AI.getType();
1233 Assert1(PTy->getAddressSpace() == 0,
1234 "Allocation instruction pointer not in the generic address space!",
1236 Assert1(PTy->getElementType()->isSized(), "Cannot allocate unsized type",
1238 visitInstruction(AI);
1241 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
1242 Assert1(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
1243 EVI.idx_begin(), EVI.idx_end()) ==
1245 "Invalid ExtractValueInst operands!", &EVI);
1247 visitInstruction(EVI);
1250 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
1251 Assert1(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
1252 IVI.idx_begin(), IVI.idx_end()) ==
1253 IVI.getOperand(1)->getType(),
1254 "Invalid InsertValueInst operands!", &IVI);
1256 visitInstruction(IVI);
1259 /// verifyInstruction - Verify that an instruction is well formed.
1261 void Verifier::visitInstruction(Instruction &I) {
1262 BasicBlock *BB = I.getParent();
1263 Assert1(BB, "Instruction not embedded in basic block!", &I);
1265 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
1266 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
1268 Assert1(*UI != (User*)&I || !DT->isReachableFromEntry(BB),
1269 "Only PHI nodes may reference their own value!", &I);
1272 // Verify that if this is a terminator that it is at the end of the block.
1273 if (isa<TerminatorInst>(I))
1274 Assert1(BB->getTerminator() == &I, "Terminator not at end of block!", &I);
1277 // Check that void typed values don't have names
1278 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
1279 "Instruction has a name, but provides a void value!", &I);
1281 // Check that the return value of the instruction is either void or a legal
1283 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType()
1284 || ((isa<CallInst>(I) || isa<InvokeInst>(I))
1285 && isa<StructType>(I.getType())),
1286 "Instruction returns a non-scalar type!", &I);
1288 // Check that the instruction doesn't produce metadata or metadata*. Calls
1289 // all already checked against the callee type.
1290 Assert1(I.getType() != Type::MetadataTy ||
1291 isa<CallInst>(I) || isa<InvokeInst>(I),
1292 "Invalid use of metadata!", &I);
1294 if (const PointerType *PTy = dyn_cast<PointerType>(I.getType()))
1295 Assert1(PTy->getElementType() != Type::MetadataTy,
1296 "Instructions may not produce pointer to metadata.", &I);
1299 // Check that all uses of the instruction, if they are instructions
1300 // themselves, actually have parent basic blocks. If the use is not an
1301 // instruction, it is an error!
1302 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
1304 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
1306 Instruction *Used = cast<Instruction>(*UI);
1307 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
1308 " embedded in a basic block!", &I, Used);
1311 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1312 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
1314 // Check to make sure that only first-class-values are operands to
1316 if (!I.getOperand(i)->getType()->isFirstClassType()) {
1317 Assert1(0, "Instruction operands must be first-class values!", &I);
1320 if (const PointerType *PTy =
1321 dyn_cast<PointerType>(I.getOperand(i)->getType()))
1322 Assert1(PTy->getElementType() != Type::MetadataTy,
1323 "Invalid use of metadata pointer.", &I);
1325 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
1326 // Check to make sure that the "address of" an intrinsic function is never
1328 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
1329 "Cannot take the address of an intrinsic!", &I);
1330 Assert1(F->getParent() == Mod, "Referencing function in another module!",
1332 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
1333 Assert1(OpBB->getParent() == BB->getParent(),
1334 "Referring to a basic block in another function!", &I);
1335 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
1336 Assert1(OpArg->getParent() == BB->getParent(),
1337 "Referring to an argument in another function!", &I);
1338 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
1339 Assert1(GV->getParent() == Mod, "Referencing global in another module!",
1341 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
1342 BasicBlock *OpBlock = Op->getParent();
1344 // Check that a definition dominates all of its uses.
1345 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1346 // Invoke results are only usable in the normal destination, not in the
1347 // exceptional destination.
1348 BasicBlock *NormalDest = II->getNormalDest();
1350 Assert2(NormalDest != II->getUnwindDest(),
1351 "No uses of invoke possible due to dominance structure!",
1354 // PHI nodes differ from other nodes because they actually "use" the
1355 // value in the predecessor basic blocks they correspond to.
1356 BasicBlock *UseBlock = BB;
1357 if (isa<PHINode>(I))
1358 UseBlock = cast<BasicBlock>(I.getOperand(i+1));
1360 if (isa<PHINode>(I) && UseBlock == OpBlock) {
1361 // Special case of a phi node in the normal destination or the unwind
1363 Assert2(BB == NormalDest || !DT->isReachableFromEntry(UseBlock),
1364 "Invoke result not available in the unwind destination!",
1367 Assert2(DT->dominates(NormalDest, UseBlock) ||
1368 !DT->isReachableFromEntry(UseBlock),
1369 "Invoke result does not dominate all uses!", Op, &I);
1371 // If the normal successor of an invoke instruction has multiple
1372 // predecessors, then the normal edge from the invoke is critical,
1373 // so the invoke value can only be live if the destination block
1374 // dominates all of it's predecessors (other than the invoke).
1375 if (!NormalDest->getSinglePredecessor() &&
1376 DT->isReachableFromEntry(UseBlock))
1377 // If it is used by something non-phi, then the other case is that
1378 // 'NormalDest' dominates all of its predecessors other than the
1379 // invoke. In this case, the invoke value can still be used.
1380 for (pred_iterator PI = pred_begin(NormalDest),
1381 E = pred_end(NormalDest); PI != E; ++PI)
1382 if (*PI != II->getParent() && !DT->dominates(NormalDest, *PI) &&
1383 DT->isReachableFromEntry(*PI)) {
1384 CheckFailed("Invoke result does not dominate all uses!", Op,&I);
1388 } else if (isa<PHINode>(I)) {
1389 // PHI nodes are more difficult than other nodes because they actually
1390 // "use" the value in the predecessor basic blocks they correspond to.
1391 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
1392 Assert2(DT->dominates(OpBlock, PredBB) ||
1393 !DT->isReachableFromEntry(PredBB),
1394 "Instruction does not dominate all uses!", Op, &I);
1396 if (OpBlock == BB) {
1397 // If they are in the same basic block, make sure that the definition
1398 // comes before the use.
1399 Assert2(InstsInThisBlock.count(Op) || !DT->isReachableFromEntry(BB),
1400 "Instruction does not dominate all uses!", Op, &I);
1403 // Definition must dominate use unless use is unreachable!
1404 Assert2(InstsInThisBlock.count(Op) || DT->dominates(Op, &I) ||
1405 !DT->isReachableFromEntry(BB),
1406 "Instruction does not dominate all uses!", Op, &I);
1408 } else if (isa<InlineAsm>(I.getOperand(i))) {
1409 Assert1(i == 0 && (isa<CallInst>(I) || isa<InvokeInst>(I)),
1410 "Cannot take the address of an inline asm!", &I);
1413 InstsInThisBlock.insert(&I);
1416 // Flags used by TableGen to mark intrinsic parameters with the
1417 // LLVMExtendedElementVectorType and LLVMTruncatedElementVectorType classes.
1418 static const unsigned ExtendedElementVectorType = 0x40000000;
1419 static const unsigned TruncatedElementVectorType = 0x20000000;
1421 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1423 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1424 Function *IF = CI.getCalledFunction();
1425 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1428 #define GET_INTRINSIC_VERIFIER
1429 #include "llvm/Intrinsics.gen"
1430 #undef GET_INTRINSIC_VERIFIER
1435 case Intrinsic::dbg_declare: // llvm.dbg.declare
1436 if (Constant *C = dyn_cast<Constant>(CI.getOperand(1)))
1437 Assert1(C && !isa<ConstantPointerNull>(C),
1438 "invalid llvm.dbg.declare intrinsic call", &CI);
1440 case Intrinsic::memcpy:
1441 case Intrinsic::memmove:
1442 case Intrinsic::memset:
1443 Assert1(isa<ConstantInt>(CI.getOperand(4)),
1444 "alignment argument of memory intrinsics must be a constant int",
1447 case Intrinsic::gcroot:
1448 case Intrinsic::gcwrite:
1449 case Intrinsic::gcread:
1450 if (ID == Intrinsic::gcroot) {
1452 dyn_cast<AllocaInst>(CI.getOperand(1)->stripPointerCasts());
1453 Assert1(AI && isa<PointerType>(AI->getType()->getElementType()),
1454 "llvm.gcroot parameter #1 must be a pointer alloca.", &CI);
1455 Assert1(isa<Constant>(CI.getOperand(2)),
1456 "llvm.gcroot parameter #2 must be a constant.", &CI);
1459 Assert1(CI.getParent()->getParent()->hasGC(),
1460 "Enclosing function does not use GC.", &CI);
1462 case Intrinsic::init_trampoline:
1463 Assert1(isa<Function>(CI.getOperand(2)->stripPointerCasts()),
1464 "llvm.init_trampoline parameter #2 must resolve to a function.",
1467 case Intrinsic::prefetch:
1468 Assert1(isa<ConstantInt>(CI.getOperand(2)) &&
1469 isa<ConstantInt>(CI.getOperand(3)) &&
1470 cast<ConstantInt>(CI.getOperand(2))->getZExtValue() < 2 &&
1471 cast<ConstantInt>(CI.getOperand(3))->getZExtValue() < 4,
1472 "invalid arguments to llvm.prefetch",
1475 case Intrinsic::stackprotector:
1476 Assert1(isa<AllocaInst>(CI.getOperand(2)->stripPointerCasts()),
1477 "llvm.stackprotector parameter #2 must resolve to an alloca.",
1483 /// Produce a string to identify an intrinsic parameter or return value.
1484 /// The ArgNo value numbers the return values from 0 to NumRets-1 and the
1485 /// parameters beginning with NumRets.
1487 static std::string IntrinsicParam(unsigned ArgNo, unsigned NumRets) {
1488 if (ArgNo < NumRets) {
1490 return "Intrinsic result type";
1492 return "Intrinsic result type #" + utostr(ArgNo);
1494 return "Intrinsic parameter #" + utostr(ArgNo - NumRets);
1497 bool Verifier::PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
1498 int VT, unsigned ArgNo, std::string &Suffix) {
1499 const FunctionType *FTy = F->getFunctionType();
1501 unsigned NumElts = 0;
1502 const Type *EltTy = Ty;
1503 const VectorType *VTy = dyn_cast<VectorType>(Ty);
1505 EltTy = VTy->getElementType();
1506 NumElts = VTy->getNumElements();
1509 const Type *RetTy = FTy->getReturnType();
1510 const StructType *ST = dyn_cast<StructType>(RetTy);
1511 unsigned NumRets = 1;
1513 NumRets = ST->getNumElements();
1518 // Check flags that indicate a type that is an integral vector type with
1519 // elements that are larger or smaller than the elements of the matched
1521 if ((Match & (ExtendedElementVectorType |
1522 TruncatedElementVectorType)) != 0) {
1523 const IntegerType *IEltTy = dyn_cast<IntegerType>(EltTy);
1524 if (!VTy || !IEltTy) {
1525 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1526 "an integral vector type.", F);
1529 // Adjust the current Ty (in the opposite direction) rather than
1530 // the type being matched against.
1531 if ((Match & ExtendedElementVectorType) != 0) {
1532 if ((IEltTy->getBitWidth() & 1) != 0) {
1533 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " vector "
1534 "element bit-width is odd.", F);
1537 Ty = VectorType::getTruncatedElementVectorType(VTy);
1539 Ty = VectorType::getExtendedElementVectorType(VTy);
1540 Match &= ~(ExtendedElementVectorType | TruncatedElementVectorType);
1543 if (Match <= static_cast<int>(NumRets - 1)) {
1545 RetTy = ST->getElementType(Match);
1548 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1549 "match return type.", F);
1553 if (Ty != FTy->getParamType(Match - NumRets)) {
1554 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1555 "match parameter %" + utostr(Match - NumRets) + ".", F);
1559 } else if (VT == MVT::iAny) {
1560 if (!EltTy->isInteger()) {
1561 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1562 "an integer type.", F);
1566 unsigned GotBits = cast<IntegerType>(EltTy)->getBitWidth();
1570 Suffix += "v" + utostr(NumElts);
1572 Suffix += "i" + utostr(GotBits);
1574 // Check some constraints on various intrinsics.
1576 default: break; // Not everything needs to be checked.
1577 case Intrinsic::bswap:
1578 if (GotBits < 16 || GotBits % 16 != 0) {
1579 CheckFailed("Intrinsic requires even byte width argument", F);
1584 } else if (VT == MVT::fAny) {
1585 if (!EltTy->isFloatingPoint()) {
1586 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1587 "a floating-point type.", F);
1594 Suffix += "v" + utostr(NumElts);
1596 Suffix += MVT::getMVT(EltTy).getMVTString();
1597 } else if (VT == MVT::iPTR) {
1598 if (!isa<PointerType>(Ty)) {
1599 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1600 "pointer and a pointer is required.", F);
1603 } else if (VT == MVT::iPTRAny) {
1604 // Outside of TableGen, we don't distinguish iPTRAny (to any address space)
1605 // and iPTR. In the verifier, we can not distinguish which case we have so
1606 // allow either case to be legal.
1607 if (const PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
1608 Suffix += ".p" + utostr(PTyp->getAddressSpace()) +
1609 MVT::getMVT(PTyp->getElementType()).getMVTString();
1611 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1612 "pointer and a pointer is required.", F);
1615 } else if (MVT((MVT::SimpleValueType)VT).isVector()) {
1616 MVT VVT = MVT((MVT::SimpleValueType)VT);
1618 // If this is a vector argument, verify the number and type of elements.
1619 if (VVT.getVectorElementType() != MVT::getMVT(EltTy)) {
1620 CheckFailed("Intrinsic prototype has incorrect vector element type!", F);
1624 if (VVT.getVectorNumElements() != NumElts) {
1625 CheckFailed("Intrinsic prototype has incorrect number of "
1626 "vector elements!", F);
1629 } else if (MVT((MVT::SimpleValueType)VT).getTypeForMVT() != EltTy) {
1630 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is wrong!", F);
1632 } else if (EltTy != Ty) {
1633 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is a vector "
1634 "and a scalar is required.", F);
1641 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1642 /// Intrinsics.gen. This implements a little state machine that verifies the
1643 /// prototype of intrinsics.
1644 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
1646 unsigned ParamNum, ...) {
1648 va_start(VA, ParamNum);
1649 const FunctionType *FTy = F->getFunctionType();
1651 // For overloaded intrinsics, the Suffix of the function name must match the
1652 // types of the arguments. This variable keeps track of the expected
1653 // suffix, to be checked at the end.
1656 if (FTy->getNumParams() + FTy->isVarArg() != ParamNum) {
1657 CheckFailed("Intrinsic prototype has incorrect number of arguments!", F);
1661 const Type *Ty = FTy->getReturnType();
1662 const StructType *ST = dyn_cast<StructType>(Ty);
1664 // Verify the return types.
1665 if (ST && ST->getNumElements() != RetNum) {
1666 CheckFailed("Intrinsic prototype has incorrect number of return types!", F);
1670 for (unsigned ArgNo = 0; ArgNo < RetNum; ++ArgNo) {
1671 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1673 if (ST) Ty = ST->getElementType(ArgNo);
1675 if (!PerformTypeCheck(ID, F, Ty, VT, ArgNo, Suffix))
1679 // Verify the parameter types.
1680 for (unsigned ArgNo = 0; ArgNo < ParamNum; ++ArgNo) {
1681 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1683 if (VT == MVT::isVoid && ArgNo > 0) {
1684 if (!FTy->isVarArg())
1685 CheckFailed("Intrinsic prototype has no '...'!", F);
1689 if (!PerformTypeCheck(ID, F, FTy->getParamType(ArgNo), VT, ArgNo + RetNum,
1696 // For intrinsics without pointer arguments, if we computed a Suffix then the
1697 // intrinsic is overloaded and we need to make sure that the name of the
1698 // function is correct. We add the suffix to the name of the intrinsic and
1699 // compare against the given function name. If they are not the same, the
1700 // function name is invalid. This ensures that overloading of intrinsics
1701 // uses a sane and consistent naming convention. Note that intrinsics with
1702 // pointer argument may or may not be overloaded so we will check assuming it
1703 // has a suffix and not.
1704 if (!Suffix.empty()) {
1705 std::string Name(Intrinsic::getName(ID));
1706 if (Name + Suffix != F->getName()) {
1707 CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1708 F->getName().substr(Name.length()) + "'. It should be '" +
1713 // Check parameter attributes.
1714 Assert1(F->getAttributes() == Intrinsic::getAttributes(ID),
1715 "Intrinsic has wrong parameter attributes!", F);
1719 //===----------------------------------------------------------------------===//
1720 // Implement the public interfaces to this file...
1721 //===----------------------------------------------------------------------===//
1723 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1724 return new Verifier(action);
1728 // verifyFunction - Create
1729 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1730 Function &F = const_cast<Function&>(f);
1731 assert(!F.isDeclaration() && "Cannot verify external functions");
1733 ExistingModuleProvider MP(F.getParent());
1734 FunctionPassManager FPM(&MP);
1735 Verifier *V = new Verifier(action);
1742 /// verifyModule - Check a module for errors, printing messages on stderr.
1743 /// Return true if the module is corrupt.
1745 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1746 std::string *ErrorInfo) {
1748 Verifier *V = new Verifier(action);
1750 PM.run(const_cast<Module&>(M));
1752 if (ErrorInfo && V->Broken)
1753 *ErrorInfo = V->msgs.str();