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 VerifyParameterAttrs(Attributes Attrs, const Type *Ty,
280 bool isReturnValue, const Value *V);
281 void VerifyFunctionAttrs(const FunctionType *FT, const AttrListPtr &Attrs,
284 void WriteValue(const Value *V) {
286 if (isa<Instruction>(V)) {
289 WriteAsOperand(msgs, V, true, Mod);
294 void WriteType(const Type *T) {
296 raw_os_ostream RO(msgs);
298 WriteTypeSymbolic(RO, T, Mod);
302 // CheckFailed - A check failed, so print out the condition and the message
303 // that failed. This provides a nice place to put a breakpoint if you want
304 // to see why something is not correct.
305 void CheckFailed(const std::string &Message,
306 const Value *V1 = 0, const Value *V2 = 0,
307 const Value *V3 = 0, const Value *V4 = 0) {
308 msgs << Message << "\n";
316 void CheckFailed( const std::string& Message, const Value* V1,
317 const Type* T2, const Value* V3 = 0 ) {
318 msgs << Message << "\n";
325 } // End anonymous namespace
327 char Verifier::ID = 0;
328 static RegisterPass<Verifier> X("verify", "Module Verifier");
330 // Assert - We know that cond should be true, if not print an error message.
331 #define Assert(C, M) \
332 do { if (!(C)) { CheckFailed(M); return; } } while (0)
333 #define Assert1(C, M, V1) \
334 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
335 #define Assert2(C, M, V1, V2) \
336 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
337 #define Assert3(C, M, V1, V2, V3) \
338 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
339 #define Assert4(C, M, V1, V2, V3, V4) \
340 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
342 void Verifier::visit(Instruction &I) {
343 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
344 Assert1(I.getOperand(i) != 0, "Operand is null", &I);
345 InstVisitor<Verifier>::visit(I);
349 void Verifier::visitGlobalValue(GlobalValue &GV) {
350 Assert1(!GV.isDeclaration() ||
351 GV.hasExternalLinkage() ||
352 GV.hasDLLImportLinkage() ||
353 GV.hasExternalWeakLinkage() ||
354 GV.hasGhostLinkage() ||
355 (isa<GlobalAlias>(GV) &&
356 (GV.hasLocalLinkage() || GV.hasWeakLinkage())),
357 "Global is external, but doesn't have external or dllimport or weak linkage!",
360 Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
361 "Global is marked as dllimport, but not external", &GV);
363 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
364 "Only global variables can have appending linkage!", &GV);
366 if (GV.hasAppendingLinkage()) {
367 GlobalVariable &GVar = cast<GlobalVariable>(GV);
368 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
369 "Only global arrays can have appending linkage!", &GV);
373 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
374 if (GV.hasInitializer()) {
375 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
376 "Global variable initializer type does not match global "
377 "variable type!", &GV);
379 // Verify that any metadata used in a global initializer points only to
381 if (MDNode *FirstNode = dyn_cast<MDNode>(GV.getInitializer())) {
382 SmallVector<const MDNode *, 4> NodesToAnalyze;
383 NodesToAnalyze.push_back(FirstNode);
384 while (!NodesToAnalyze.empty()) {
385 const MDNode *N = NodesToAnalyze.back();
386 NodesToAnalyze.pop_back();
388 for (MDNode::const_elem_iterator I = N->elem_begin(),
389 E = N->elem_end(); I != E; ++I)
390 if (const Value *V = *I) {
391 if (const MDNode *Next = dyn_cast<MDNode>(V))
392 NodesToAnalyze.push_back(Next);
394 Assert3(isa<Constant>(V),
395 "reference to instruction from global metadata node",
401 Assert1(GV.hasExternalLinkage() || GV.hasDLLImportLinkage() ||
402 GV.hasExternalWeakLinkage(),
403 "invalid linkage type for global declaration", &GV);
406 visitGlobalValue(GV);
409 void Verifier::visitGlobalAlias(GlobalAlias &GA) {
410 Assert1(!GA.getName().empty(),
411 "Alias name cannot be empty!", &GA);
412 Assert1(GA.hasExternalLinkage() || GA.hasLocalLinkage() ||
414 "Alias should have external or external weak linkage!", &GA);
415 Assert1(GA.getAliasee(),
416 "Aliasee cannot be NULL!", &GA);
417 Assert1(GA.getType() == GA.getAliasee()->getType(),
418 "Alias and aliasee types should match!", &GA);
420 if (!isa<GlobalValue>(GA.getAliasee())) {
421 const ConstantExpr *CE = dyn_cast<ConstantExpr>(GA.getAliasee());
423 (CE->getOpcode() == Instruction::BitCast ||
424 CE->getOpcode() == Instruction::GetElementPtr) &&
425 isa<GlobalValue>(CE->getOperand(0)),
426 "Aliasee should be either GlobalValue or bitcast of GlobalValue",
430 const GlobalValue* Aliasee = GA.resolveAliasedGlobal(/*stopOnWeak*/ false);
432 "Aliasing chain should end with function or global variable", &GA);
434 visitGlobalValue(GA);
437 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
440 // VerifyParameterAttrs - Check the given attributes for an argument or return
441 // value of the specified type. The value V is printed in error messages.
442 void Verifier::VerifyParameterAttrs(Attributes Attrs, const Type *Ty,
443 bool isReturnValue, const Value *V) {
444 if (Attrs == Attribute::None)
447 Attributes FnCheckAttr = Attrs & Attribute::FunctionOnly;
448 Assert1(!FnCheckAttr, "Attribute " + Attribute::getAsString(FnCheckAttr) +
449 " only applies to the function!", V);
452 Attributes RetI = Attrs & Attribute::ParameterOnly;
453 Assert1(!RetI, "Attribute " + Attribute::getAsString(RetI) +
454 " does not apply to return values!", V);
458 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
459 Attributes MutI = Attrs & Attribute::MutuallyIncompatible[i];
460 Assert1(!(MutI & (MutI - 1)), "Attributes " +
461 Attribute::getAsString(MutI) + " are incompatible!", V);
464 Attributes TypeI = Attrs & Attribute::typeIncompatible(Ty);
465 Assert1(!TypeI, "Wrong type for attribute " +
466 Attribute::getAsString(TypeI), V);
468 Attributes ByValI = Attrs & Attribute::ByVal;
469 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
470 Assert1(!ByValI || PTy->getElementType()->isSized(),
471 "Attribute " + Attribute::getAsString(ByValI) +
472 " does not support unsized types!", V);
475 "Attribute " + Attribute::getAsString(ByValI) +
476 " only applies to parameters with pointer type!", V);
480 // VerifyFunctionAttrs - Check parameter attributes against a function type.
481 // The value V is printed in error messages.
482 void Verifier::VerifyFunctionAttrs(const FunctionType *FT,
483 const AttrListPtr &Attrs,
488 bool SawNest = false;
490 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
491 const AttributeWithIndex &Attr = Attrs.getSlot(i);
495 Ty = FT->getReturnType();
496 else if (Attr.Index-1 < FT->getNumParams())
497 Ty = FT->getParamType(Attr.Index-1);
499 break; // VarArgs attributes, verified elsewhere.
501 VerifyParameterAttrs(Attr.Attrs, Ty, Attr.Index == 0, V);
503 if (Attr.Attrs & Attribute::Nest) {
504 Assert1(!SawNest, "More than one parameter has attribute nest!", V);
508 if (Attr.Attrs & Attribute::StructRet)
509 Assert1(Attr.Index == 1, "Attribute sret not on first parameter!", V);
512 Attributes FAttrs = Attrs.getFnAttributes();
513 Attributes NotFn = FAttrs & (~Attribute::FunctionOnly);
514 Assert1(!NotFn, "Attribute " + Attribute::getAsString(NotFn) +
515 " does not apply to the function!", V);
518 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
519 Attributes MutI = FAttrs & Attribute::MutuallyIncompatible[i];
520 Assert1(!(MutI & (MutI - 1)), "Attributes " +
521 Attribute::getAsString(MutI) + " are incompatible!", V);
525 static bool VerifyAttributeCount(const AttrListPtr &Attrs, unsigned Params) {
529 unsigned LastSlot = Attrs.getNumSlots() - 1;
530 unsigned LastIndex = Attrs.getSlot(LastSlot).Index;
531 if (LastIndex <= Params
532 || (LastIndex == (unsigned)~0
533 && (LastSlot == 0 || Attrs.getSlot(LastSlot - 1).Index <= Params)))
538 // visitFunction - Verify that a function is ok.
540 void Verifier::visitFunction(Function &F) {
541 // Check function arguments.
542 const FunctionType *FT = F.getFunctionType();
543 unsigned NumArgs = F.arg_size();
545 Assert2(FT->getNumParams() == NumArgs,
546 "# formal arguments must match # of arguments for function type!",
548 Assert1(F.getReturnType()->isFirstClassType() ||
549 F.getReturnType() == Type::VoidTy ||
550 isa<StructType>(F.getReturnType()),
551 "Functions cannot return aggregate values!", &F);
553 Assert1(!F.hasStructRetAttr() || F.getReturnType() == Type::VoidTy,
554 "Invalid struct return type!", &F);
556 const AttrListPtr &Attrs = F.getAttributes();
558 Assert1(VerifyAttributeCount(Attrs, FT->getNumParams()),
559 "Attributes after last parameter!", &F);
561 // Check function attributes.
562 VerifyFunctionAttrs(FT, Attrs, &F);
564 // Check that this function meets the restrictions on this calling convention.
565 switch (F.getCallingConv()) {
570 case CallingConv::Fast:
571 case CallingConv::Cold:
572 case CallingConv::X86_FastCall:
573 Assert1(!F.isVarArg(),
574 "Varargs functions must have C calling conventions!", &F);
578 bool isLLVMdotName = F.getName().size() >= 5 &&
579 F.getName().substr(0, 5) == "llvm.";
581 Assert1(F.getReturnType() != Type::MetadataTy,
582 "Function may not return metadata unless it's an intrinsic", &F);
584 // Check that the argument values match the function type for this function...
586 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
588 Assert2(I->getType() == FT->getParamType(i),
589 "Argument value does not match function argument type!",
590 I, FT->getParamType(i));
591 Assert1(I->getType()->isFirstClassType(),
592 "Function arguments must have first-class types!", I);
594 Assert2(I->getType() != Type::MetadataTy,
595 "Function takes metadata but isn't an intrinsic", I, &F);
598 if (F.isDeclaration()) {
599 Assert1(F.hasExternalLinkage() || F.hasDLLImportLinkage() ||
600 F.hasExternalWeakLinkage() || F.hasGhostLinkage(),
601 "invalid linkage type for function declaration", &F);
603 // Verify that this function (which has a body) is not named "llvm.*". It
604 // is not legal to define intrinsics.
605 Assert1(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
607 // Check the entry node
608 BasicBlock *Entry = &F.getEntryBlock();
609 Assert1(pred_begin(Entry) == pred_end(Entry),
610 "Entry block to function must not have predecessors!", Entry);
615 // verifyBasicBlock - Verify that a basic block is well formed...
617 void Verifier::visitBasicBlock(BasicBlock &BB) {
618 InstsInThisBlock.clear();
620 // Ensure that basic blocks have terminators!
621 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
623 // Check constraints that this basic block imposes on all of the PHI nodes in
625 if (isa<PHINode>(BB.front())) {
626 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
627 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
628 std::sort(Preds.begin(), Preds.end());
630 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
632 // Ensure that PHI nodes have at least one entry!
633 Assert1(PN->getNumIncomingValues() != 0,
634 "PHI nodes must have at least one entry. If the block is dead, "
635 "the PHI should be removed!", PN);
636 Assert1(PN->getNumIncomingValues() == Preds.size(),
637 "PHINode should have one entry for each predecessor of its "
638 "parent basic block!", PN);
640 // Get and sort all incoming values in the PHI node...
642 Values.reserve(PN->getNumIncomingValues());
643 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
644 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
645 PN->getIncomingValue(i)));
646 std::sort(Values.begin(), Values.end());
648 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
649 // Check to make sure that if there is more than one entry for a
650 // particular basic block in this PHI node, that the incoming values are
653 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
654 Values[i].second == Values[i-1].second,
655 "PHI node has multiple entries for the same basic block with "
656 "different incoming values!", PN, Values[i].first,
657 Values[i].second, Values[i-1].second);
659 // Check to make sure that the predecessors and PHI node entries are
661 Assert3(Values[i].first == Preds[i],
662 "PHI node entries do not match predecessors!", PN,
663 Values[i].first, Preds[i]);
669 void Verifier::visitTerminatorInst(TerminatorInst &I) {
670 // Ensure that terminators only exist at the end of the basic block.
671 Assert1(&I == I.getParent()->getTerminator(),
672 "Terminator found in the middle of a basic block!", I.getParent());
676 void Verifier::visitReturnInst(ReturnInst &RI) {
677 Function *F = RI.getParent()->getParent();
678 unsigned N = RI.getNumOperands();
679 if (F->getReturnType() == Type::VoidTy)
681 "Found return instr that returns non-void in Function of void "
682 "return type!", &RI, F->getReturnType());
683 else if (N == 1 && F->getReturnType() == RI.getOperand(0)->getType()) {
684 // Exactly one return value and it matches the return type. Good.
685 } else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
686 // The return type is a struct; check for multiple return values.
687 Assert2(STy->getNumElements() == N,
688 "Incorrect number of return values in ret instruction!",
689 &RI, F->getReturnType());
690 for (unsigned i = 0; i != N; ++i)
691 Assert2(STy->getElementType(i) == RI.getOperand(i)->getType(),
692 "Function return type does not match operand "
693 "type of return inst!", &RI, F->getReturnType());
694 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(F->getReturnType())) {
695 // The return type is an array; check for multiple return values.
696 Assert2(ATy->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(ATy->getElementType() == RI.getOperand(i)->getType(),
701 "Function return type does not match operand "
702 "type of return inst!", &RI, F->getReturnType());
704 CheckFailed("Function return type does not match operand "
705 "type of return inst!", &RI, F->getReturnType());
708 // Check to make sure that the return value has necessary properties for
710 visitTerminatorInst(RI);
713 void Verifier::visitSwitchInst(SwitchInst &SI) {
714 // Check to make sure that all of the constants in the switch instruction
715 // have the same type as the switched-on value.
716 const Type *SwitchTy = SI.getCondition()->getType();
717 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
718 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
719 "Switch constants must all be same type as switch value!", &SI);
721 visitTerminatorInst(SI);
724 void Verifier::visitSelectInst(SelectInst &SI) {
725 Assert1(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
727 "Invalid operands for select instruction!", &SI);
729 Assert1(SI.getTrueValue()->getType() == SI.getType(),
730 "Select values must have same type as select instruction!", &SI);
731 visitInstruction(SI);
735 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
736 /// a pass, if any exist, it's an error.
738 void Verifier::visitUserOp1(Instruction &I) {
739 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
742 void Verifier::visitTruncInst(TruncInst &I) {
743 // Get the source and destination types
744 const Type *SrcTy = I.getOperand(0)->getType();
745 const Type *DestTy = I.getType();
747 // Get the size of the types in bits, we'll need this later
748 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
749 unsigned DestBitSize = DestTy->getScalarSizeInBits();
751 Assert1(SrcTy->isIntOrIntVector(), "Trunc only operates on integer", &I);
752 Assert1(DestTy->isIntOrIntVector(), "Trunc only produces integer", &I);
753 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
754 "trunc source and destination must both be a vector or neither", &I);
755 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
760 void Verifier::visitZExtInst(ZExtInst &I) {
761 // Get the source and destination types
762 const Type *SrcTy = I.getOperand(0)->getType();
763 const Type *DestTy = I.getType();
765 // Get the size of the types in bits, we'll need this later
766 Assert1(SrcTy->isIntOrIntVector(), "ZExt only operates on integer", &I);
767 Assert1(DestTy->isIntOrIntVector(), "ZExt only produces an integer", &I);
768 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
769 "zext source and destination must both be a vector or neither", &I);
770 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
771 unsigned DestBitSize = DestTy->getScalarSizeInBits();
773 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
778 void Verifier::visitSExtInst(SExtInst &I) {
779 // Get the source and destination types
780 const Type *SrcTy = I.getOperand(0)->getType();
781 const Type *DestTy = I.getType();
783 // Get the size of the types in bits, we'll need this later
784 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
785 unsigned DestBitSize = DestTy->getScalarSizeInBits();
787 Assert1(SrcTy->isIntOrIntVector(), "SExt only operates on integer", &I);
788 Assert1(DestTy->isIntOrIntVector(), "SExt only produces an integer", &I);
789 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
790 "sext source and destination must both be a vector or neither", &I);
791 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
796 void Verifier::visitFPTruncInst(FPTruncInst &I) {
797 // Get the source and destination types
798 const Type *SrcTy = I.getOperand(0)->getType();
799 const Type *DestTy = I.getType();
800 // Get the size of the types in bits, we'll need this later
801 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
802 unsigned DestBitSize = DestTy->getScalarSizeInBits();
804 Assert1(SrcTy->isFPOrFPVector(),"FPTrunc only operates on FP", &I);
805 Assert1(DestTy->isFPOrFPVector(),"FPTrunc only produces an FP", &I);
806 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
807 "fptrunc source and destination must both be a vector or neither",&I);
808 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
813 void Verifier::visitFPExtInst(FPExtInst &I) {
814 // Get the source and destination types
815 const Type *SrcTy = I.getOperand(0)->getType();
816 const Type *DestTy = I.getType();
818 // Get the size of the types in bits, we'll need this later
819 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
820 unsigned DestBitSize = DestTy->getScalarSizeInBits();
822 Assert1(SrcTy->isFPOrFPVector(),"FPExt only operates on FP", &I);
823 Assert1(DestTy->isFPOrFPVector(),"FPExt only produces an FP", &I);
824 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
825 "fpext source and destination must both be a vector or neither", &I);
826 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
831 void Verifier::visitUIToFPInst(UIToFPInst &I) {
832 // Get the source and destination types
833 const Type *SrcTy = I.getOperand(0)->getType();
834 const Type *DestTy = I.getType();
836 bool SrcVec = isa<VectorType>(SrcTy);
837 bool DstVec = isa<VectorType>(DestTy);
839 Assert1(SrcVec == DstVec,
840 "UIToFP source and dest must both be vector or scalar", &I);
841 Assert1(SrcTy->isIntOrIntVector(),
842 "UIToFP source must be integer or integer vector", &I);
843 Assert1(DestTy->isFPOrFPVector(),
844 "UIToFP result must be FP or FP vector", &I);
846 if (SrcVec && DstVec)
847 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
848 cast<VectorType>(DestTy)->getNumElements(),
849 "UIToFP source and dest vector length mismatch", &I);
854 void Verifier::visitSIToFPInst(SIToFPInst &I) {
855 // Get the source and destination types
856 const Type *SrcTy = I.getOperand(0)->getType();
857 const Type *DestTy = I.getType();
859 bool SrcVec = SrcTy->getTypeID() == Type::VectorTyID;
860 bool DstVec = DestTy->getTypeID() == Type::VectorTyID;
862 Assert1(SrcVec == DstVec,
863 "SIToFP source and dest must both be vector or scalar", &I);
864 Assert1(SrcTy->isIntOrIntVector(),
865 "SIToFP source must be integer or integer vector", &I);
866 Assert1(DestTy->isFPOrFPVector(),
867 "SIToFP result must be FP or FP vector", &I);
869 if (SrcVec && DstVec)
870 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
871 cast<VectorType>(DestTy)->getNumElements(),
872 "SIToFP source and dest vector length mismatch", &I);
877 void Verifier::visitFPToUIInst(FPToUIInst &I) {
878 // Get the source and destination types
879 const Type *SrcTy = I.getOperand(0)->getType();
880 const Type *DestTy = I.getType();
882 bool SrcVec = isa<VectorType>(SrcTy);
883 bool DstVec = isa<VectorType>(DestTy);
885 Assert1(SrcVec == DstVec,
886 "FPToUI source and dest must both be vector or scalar", &I);
887 Assert1(SrcTy->isFPOrFPVector(), "FPToUI source must be FP or FP vector", &I);
888 Assert1(DestTy->isIntOrIntVector(),
889 "FPToUI result must be integer or integer vector", &I);
891 if (SrcVec && DstVec)
892 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
893 cast<VectorType>(DestTy)->getNumElements(),
894 "FPToUI source and dest vector length mismatch", &I);
899 void Verifier::visitFPToSIInst(FPToSIInst &I) {
900 // Get the source and destination types
901 const Type *SrcTy = I.getOperand(0)->getType();
902 const Type *DestTy = I.getType();
904 bool SrcVec = isa<VectorType>(SrcTy);
905 bool DstVec = isa<VectorType>(DestTy);
907 Assert1(SrcVec == DstVec,
908 "FPToSI source and dest must both be vector or scalar", &I);
909 Assert1(SrcTy->isFPOrFPVector(),
910 "FPToSI source must be FP or FP vector", &I);
911 Assert1(DestTy->isIntOrIntVector(),
912 "FPToSI result must be integer or integer vector", &I);
914 if (SrcVec && DstVec)
915 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
916 cast<VectorType>(DestTy)->getNumElements(),
917 "FPToSI source and dest vector length mismatch", &I);
922 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
923 // Get the source and destination types
924 const Type *SrcTy = I.getOperand(0)->getType();
925 const Type *DestTy = I.getType();
927 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
928 Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
933 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
934 // Get the source and destination types
935 const Type *SrcTy = I.getOperand(0)->getType();
936 const Type *DestTy = I.getType();
938 Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
939 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
944 void Verifier::visitBitCastInst(BitCastInst &I) {
945 // Get the source and destination types
946 const Type *SrcTy = I.getOperand(0)->getType();
947 const Type *DestTy = I.getType();
949 // Get the size of the types in bits, we'll need this later
950 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
951 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
953 // BitCast implies a no-op cast of type only. No bits change.
954 // However, you can't cast pointers to anything but pointers.
955 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
956 "Bitcast requires both operands to be pointer or neither", &I);
957 Assert1(SrcBitSize == DestBitSize, "Bitcast requies types of same width", &I);
959 // Disallow aggregates.
960 Assert1(!SrcTy->isAggregateType(),
961 "Bitcast operand must not be aggregate", &I);
962 Assert1(!DestTy->isAggregateType(),
963 "Bitcast type must not be aggregate", &I);
968 /// visitPHINode - Ensure that a PHI node is well formed.
970 void Verifier::visitPHINode(PHINode &PN) {
971 // Ensure that the PHI nodes are all grouped together at the top of the block.
972 // This can be tested by checking whether the instruction before this is
973 // either nonexistent (because this is begin()) or is a PHI node. If not,
974 // then there is some other instruction before a PHI.
975 Assert2(&PN == &PN.getParent()->front() ||
976 isa<PHINode>(--BasicBlock::iterator(&PN)),
977 "PHI nodes not grouped at top of basic block!",
978 &PN, PN.getParent());
980 // Check that all of the operands of the PHI node have the same type as the
982 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
983 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
984 "PHI node operands are not the same type as the result!", &PN);
986 // All other PHI node constraints are checked in the visitBasicBlock method.
988 visitInstruction(PN);
991 void Verifier::VerifyCallSite(CallSite CS) {
992 Instruction *I = CS.getInstruction();
994 Assert1(isa<PointerType>(CS.getCalledValue()->getType()),
995 "Called function must be a pointer!", I);
996 const PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
997 Assert1(isa<FunctionType>(FPTy->getElementType()),
998 "Called function is not pointer to function type!", I);
1000 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1002 // Verify that the correct number of arguments are being passed
1003 if (FTy->isVarArg())
1004 Assert1(CS.arg_size() >= FTy->getNumParams(),
1005 "Called function requires more parameters than were provided!",I);
1007 Assert1(CS.arg_size() == FTy->getNumParams(),
1008 "Incorrect number of arguments passed to called function!", I);
1010 // Verify that all arguments to the call match the function type...
1011 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1012 Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
1013 "Call parameter type does not match function signature!",
1014 CS.getArgument(i), FTy->getParamType(i), I);
1016 const AttrListPtr &Attrs = CS.getAttributes();
1018 Assert1(VerifyAttributeCount(Attrs, CS.arg_size()),
1019 "Attributes after last parameter!", I);
1021 // Verify call attributes.
1022 VerifyFunctionAttrs(FTy, Attrs, I);
1024 if (FTy->isVarArg())
1025 // Check attributes on the varargs part.
1026 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
1027 Attributes Attr = Attrs.getParamAttributes(Idx);
1029 VerifyParameterAttrs(Attr, CS.getArgument(Idx-1)->getType(), false, I);
1031 Attributes VArgI = Attr & Attribute::VarArgsIncompatible;
1032 Assert1(!VArgI, "Attribute " + Attribute::getAsString(VArgI) +
1033 " cannot be used for vararg call arguments!", I);
1036 // Verify that there's no metadata unless it's a direct call to an intrinsic.
1037 if (!CS.getCalledFunction() || CS.getCalledFunction()->getName().size() < 5 ||
1038 CS.getCalledFunction()->getName().substr(0, 5) != "llvm.") {
1039 Assert1(FTy->getReturnType() != Type::MetadataTy,
1040 "Only intrinsics may return metadata", I);
1041 for (FunctionType::param_iterator PI = FTy->param_begin(),
1042 PE = FTy->param_end(); PI != PE; ++PI)
1043 Assert1(PI->get() != Type::MetadataTy, "Function has metadata parameter "
1044 "but isn't an intrinsic", I);
1047 visitInstruction(*I);
1050 void Verifier::visitCallInst(CallInst &CI) {
1051 VerifyCallSite(&CI);
1053 if (Function *F = CI.getCalledFunction())
1054 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
1055 visitIntrinsicFunctionCall(ID, CI);
1058 void Verifier::visitInvokeInst(InvokeInst &II) {
1059 VerifyCallSite(&II);
1062 /// visitBinaryOperator - Check that both arguments to the binary operator are
1063 /// of the same type!
1065 void Verifier::visitBinaryOperator(BinaryOperator &B) {
1066 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
1067 "Both operands to a binary operator are not of the same type!", &B);
1069 switch (B.getOpcode()) {
1070 // Check that integer arithmetic operators are only used with
1071 // integral operands.
1072 case Instruction::Add:
1073 case Instruction::Sub:
1074 case Instruction::Mul:
1075 case Instruction::SDiv:
1076 case Instruction::UDiv:
1077 case Instruction::SRem:
1078 case Instruction::URem:
1079 Assert1(B.getType()->isIntOrIntVector(),
1080 "Integer arithmetic operators only work with integral types!", &B);
1081 Assert1(B.getType() == B.getOperand(0)->getType(),
1082 "Integer arithmetic operators must have same type "
1083 "for operands and result!", &B);
1085 // Check that floating-point arithmetic operators are only used with
1086 // floating-point operands.
1087 case Instruction::FAdd:
1088 case Instruction::FSub:
1089 case Instruction::FMul:
1090 case Instruction::FDiv:
1091 case Instruction::FRem:
1092 Assert1(B.getType()->isFPOrFPVector(),
1093 "Floating-point arithmetic operators only work with "
1094 "floating-point types!", &B);
1095 Assert1(B.getType() == B.getOperand(0)->getType(),
1096 "Floating-point arithmetic operators must have same type "
1097 "for operands and result!", &B);
1099 // Check that logical operators are only used with integral operands.
1100 case Instruction::And:
1101 case Instruction::Or:
1102 case Instruction::Xor:
1103 Assert1(B.getType()->isIntOrIntVector(),
1104 "Logical operators only work with integral types!", &B);
1105 Assert1(B.getType() == B.getOperand(0)->getType(),
1106 "Logical operators must have same type for operands and result!",
1109 case Instruction::Shl:
1110 case Instruction::LShr:
1111 case Instruction::AShr:
1112 Assert1(B.getType()->isIntOrIntVector(),
1113 "Shifts only work with integral types!", &B);
1114 Assert1(B.getType() == B.getOperand(0)->getType(),
1115 "Shift return type must be same as operands!", &B);
1118 assert(0 && "Unknown BinaryOperator opcode!");
1121 visitInstruction(B);
1124 void Verifier::visitICmpInst(ICmpInst& IC) {
1125 // Check that the operands are the same type
1126 const Type* Op0Ty = IC.getOperand(0)->getType();
1127 const Type* Op1Ty = IC.getOperand(1)->getType();
1128 Assert1(Op0Ty == Op1Ty,
1129 "Both operands to ICmp instruction are not of the same type!", &IC);
1130 // Check that the operands are the right type
1131 Assert1(Op0Ty->isIntOrIntVector() || isa<PointerType>(Op0Ty),
1132 "Invalid operand types for ICmp instruction", &IC);
1134 visitInstruction(IC);
1137 void Verifier::visitFCmpInst(FCmpInst& FC) {
1138 // Check that the operands are the same type
1139 const Type* Op0Ty = FC.getOperand(0)->getType();
1140 const Type* Op1Ty = FC.getOperand(1)->getType();
1141 Assert1(Op0Ty == Op1Ty,
1142 "Both operands to FCmp instruction are not of the same type!", &FC);
1143 // Check that the operands are the right type
1144 Assert1(Op0Ty->isFPOrFPVector(),
1145 "Invalid operand types for FCmp instruction", &FC);
1146 visitInstruction(FC);
1149 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
1150 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
1152 "Invalid extractelement operands!", &EI);
1153 visitInstruction(EI);
1156 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
1157 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
1160 "Invalid insertelement operands!", &IE);
1161 visitInstruction(IE);
1164 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
1165 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
1167 "Invalid shufflevector operands!", &SV);
1169 const VectorType *VTy = dyn_cast<VectorType>(SV.getOperand(0)->getType());
1170 Assert1(VTy, "Operands are not a vector type", &SV);
1172 // Check to see if Mask is valid.
1173 if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
1174 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
1175 if (ConstantInt* CI = dyn_cast<ConstantInt>(MV->getOperand(i))) {
1176 Assert1(!CI->uge(VTy->getNumElements()*2),
1177 "Invalid shufflevector shuffle mask!", &SV);
1179 Assert1(isa<UndefValue>(MV->getOperand(i)),
1180 "Invalid shufflevector shuffle mask!", &SV);
1184 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
1185 isa<ConstantAggregateZero>(SV.getOperand(2)),
1186 "Invalid shufflevector shuffle mask!", &SV);
1189 visitInstruction(SV);
1192 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1193 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
1195 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
1196 Idxs.begin(), Idxs.end());
1197 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
1198 Assert2(isa<PointerType>(GEP.getType()) &&
1199 cast<PointerType>(GEP.getType())->getElementType() == ElTy,
1200 "GEP is not of right type for indices!", &GEP, ElTy);
1201 visitInstruction(GEP);
1204 void Verifier::visitLoadInst(LoadInst &LI) {
1206 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
1207 Assert2(ElTy == LI.getType(),
1208 "Load result type does not match pointer operand type!", &LI, ElTy);
1209 Assert1(ElTy != Type::MetadataTy, "Can't load metadata!", &LI);
1210 visitInstruction(LI);
1213 void Verifier::visitStoreInst(StoreInst &SI) {
1215 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
1216 Assert2(ElTy == SI.getOperand(0)->getType(),
1217 "Stored value type does not match pointer operand type!", &SI, ElTy);
1218 Assert1(ElTy != Type::MetadataTy, "Can't store metadata!", &SI);
1219 visitInstruction(SI);
1222 void Verifier::visitAllocationInst(AllocationInst &AI) {
1223 const PointerType *PTy = AI.getType();
1224 Assert1(PTy->getAddressSpace() == 0,
1225 "Allocation instruction pointer not in the generic address space!",
1227 Assert1(PTy->getElementType()->isSized(), "Cannot allocate unsized type",
1229 visitInstruction(AI);
1232 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
1233 Assert1(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
1234 EVI.idx_begin(), EVI.idx_end()) ==
1236 "Invalid ExtractValueInst operands!", &EVI);
1238 visitInstruction(EVI);
1241 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
1242 Assert1(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
1243 IVI.idx_begin(), IVI.idx_end()) ==
1244 IVI.getOperand(1)->getType(),
1245 "Invalid InsertValueInst operands!", &IVI);
1247 visitInstruction(IVI);
1250 /// verifyInstruction - Verify that an instruction is well formed.
1252 void Verifier::visitInstruction(Instruction &I) {
1253 BasicBlock *BB = I.getParent();
1254 Assert1(BB, "Instruction not embedded in basic block!", &I);
1256 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
1257 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
1259 Assert1(*UI != (User*)&I || !DT->isReachableFromEntry(BB),
1260 "Only PHI nodes may reference their own value!", &I);
1263 // Verify that if this is a terminator that it is at the end of the block.
1264 if (isa<TerminatorInst>(I))
1265 Assert1(BB->getTerminator() == &I, "Terminator not at end of block!", &I);
1268 // Check that void typed values don't have names
1269 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
1270 "Instruction has a name, but provides a void value!", &I);
1272 // Check that the return value of the instruction is either void or a legal
1274 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType()
1275 || ((isa<CallInst>(I) || isa<InvokeInst>(I))
1276 && isa<StructType>(I.getType())),
1277 "Instruction returns a non-scalar type!", &I);
1279 // Check that the instruction doesn't produce metadata or metadata*. Calls
1280 // all already checked against the callee type.
1281 Assert1(I.getType() != Type::MetadataTy ||
1282 isa<CallInst>(I) || isa<InvokeInst>(I),
1283 "Invalid use of metadata!", &I);
1285 if (const PointerType *PTy = dyn_cast<PointerType>(I.getType()))
1286 Assert1(PTy->getElementType() != Type::MetadataTy,
1287 "Instructions may not produce pointer to metadata.", &I);
1290 // Check that all uses of the instruction, if they are instructions
1291 // themselves, actually have parent basic blocks. If the use is not an
1292 // instruction, it is an error!
1293 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
1295 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
1297 Instruction *Used = cast<Instruction>(*UI);
1298 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
1299 " embedded in a basic block!", &I, Used);
1302 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1303 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
1305 // Check to make sure that only first-class-values are operands to
1307 if (!I.getOperand(i)->getType()->isFirstClassType()) {
1308 Assert1(0, "Instruction operands must be first-class values!", &I);
1311 if (const PointerType *PTy =
1312 dyn_cast<PointerType>(I.getOperand(i)->getType()))
1313 Assert1(PTy->getElementType() != Type::MetadataTy,
1314 "Invalid use of metadata pointer.", &I);
1316 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
1317 // Check to make sure that the "address of" an intrinsic function is never
1319 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
1320 "Cannot take the address of an intrinsic!", &I);
1321 Assert1(F->getParent() == Mod, "Referencing function in another module!",
1323 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
1324 Assert1(OpBB->getParent() == BB->getParent(),
1325 "Referring to a basic block in another function!", &I);
1326 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
1327 Assert1(OpArg->getParent() == BB->getParent(),
1328 "Referring to an argument in another function!", &I);
1329 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
1330 Assert1(GV->getParent() == Mod, "Referencing global in another module!",
1332 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
1333 BasicBlock *OpBlock = Op->getParent();
1335 // Check that a definition dominates all of its uses.
1336 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1337 // Invoke results are only usable in the normal destination, not in the
1338 // exceptional destination.
1339 BasicBlock *NormalDest = II->getNormalDest();
1341 Assert2(NormalDest != II->getUnwindDest(),
1342 "No uses of invoke possible due to dominance structure!",
1345 // PHI nodes differ from other nodes because they actually "use" the
1346 // value in the predecessor basic blocks they correspond to.
1347 BasicBlock *UseBlock = BB;
1348 if (isa<PHINode>(I))
1349 UseBlock = cast<BasicBlock>(I.getOperand(i+1));
1351 if (isa<PHINode>(I) && UseBlock == OpBlock) {
1352 // Special case of a phi node in the normal destination or the unwind
1354 Assert2(BB == NormalDest || !DT->isReachableFromEntry(UseBlock),
1355 "Invoke result not available in the unwind destination!",
1358 Assert2(DT->dominates(NormalDest, UseBlock) ||
1359 !DT->isReachableFromEntry(UseBlock),
1360 "Invoke result does not dominate all uses!", Op, &I);
1362 // If the normal successor of an invoke instruction has multiple
1363 // predecessors, then the normal edge from the invoke is critical,
1364 // so the invoke value can only be live if the destination block
1365 // dominates all of it's predecessors (other than the invoke).
1366 if (!NormalDest->getSinglePredecessor() &&
1367 DT->isReachableFromEntry(UseBlock))
1368 // If it is used by something non-phi, then the other case is that
1369 // 'NormalDest' dominates all of its predecessors other than the
1370 // invoke. In this case, the invoke value can still be used.
1371 for (pred_iterator PI = pred_begin(NormalDest),
1372 E = pred_end(NormalDest); PI != E; ++PI)
1373 if (*PI != II->getParent() && !DT->dominates(NormalDest, *PI) &&
1374 DT->isReachableFromEntry(*PI)) {
1375 CheckFailed("Invoke result does not dominate all uses!", Op,&I);
1379 } else if (isa<PHINode>(I)) {
1380 // PHI nodes are more difficult than other nodes because they actually
1381 // "use" the value in the predecessor basic blocks they correspond to.
1382 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
1383 Assert2(DT->dominates(OpBlock, PredBB) ||
1384 !DT->isReachableFromEntry(PredBB),
1385 "Instruction does not dominate all uses!", Op, &I);
1387 if (OpBlock == BB) {
1388 // If they are in the same basic block, make sure that the definition
1389 // comes before the use.
1390 Assert2(InstsInThisBlock.count(Op) || !DT->isReachableFromEntry(BB),
1391 "Instruction does not dominate all uses!", Op, &I);
1394 // Definition must dominate use unless use is unreachable!
1395 Assert2(InstsInThisBlock.count(Op) || DT->dominates(Op, &I) ||
1396 !DT->isReachableFromEntry(BB),
1397 "Instruction does not dominate all uses!", Op, &I);
1399 } else if (isa<InlineAsm>(I.getOperand(i))) {
1400 Assert1(i == 0 && (isa<CallInst>(I) || isa<InvokeInst>(I)),
1401 "Cannot take the address of an inline asm!", &I);
1404 InstsInThisBlock.insert(&I);
1407 // Flags used by TableGen to mark intrinsic parameters with the
1408 // LLVMExtendedElementVectorType and LLVMTruncatedElementVectorType classes.
1409 static const unsigned ExtendedElementVectorType = 0x40000000;
1410 static const unsigned TruncatedElementVectorType = 0x20000000;
1412 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1414 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1415 Function *IF = CI.getCalledFunction();
1416 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1419 #define GET_INTRINSIC_VERIFIER
1420 #include "llvm/Intrinsics.gen"
1421 #undef GET_INTRINSIC_VERIFIER
1426 case Intrinsic::dbg_declare: // llvm.dbg.declare
1427 if (Constant *C = dyn_cast<Constant>(CI.getOperand(1)))
1428 Assert1(C && !isa<ConstantPointerNull>(C),
1429 "invalid llvm.dbg.declare intrinsic call", &CI);
1431 case Intrinsic::memcpy:
1432 case Intrinsic::memmove:
1433 case Intrinsic::memset:
1434 Assert1(isa<ConstantInt>(CI.getOperand(4)),
1435 "alignment argument of memory intrinsics must be a constant int",
1438 case Intrinsic::gcroot:
1439 case Intrinsic::gcwrite:
1440 case Intrinsic::gcread:
1441 if (ID == Intrinsic::gcroot) {
1443 dyn_cast<AllocaInst>(CI.getOperand(1)->stripPointerCasts());
1444 Assert1(AI && isa<PointerType>(AI->getType()->getElementType()),
1445 "llvm.gcroot parameter #1 must be a pointer alloca.", &CI);
1446 Assert1(isa<Constant>(CI.getOperand(2)),
1447 "llvm.gcroot parameter #2 must be a constant.", &CI);
1450 Assert1(CI.getParent()->getParent()->hasGC(),
1451 "Enclosing function does not use GC.", &CI);
1453 case Intrinsic::init_trampoline:
1454 Assert1(isa<Function>(CI.getOperand(2)->stripPointerCasts()),
1455 "llvm.init_trampoline parameter #2 must resolve to a function.",
1458 case Intrinsic::prefetch:
1459 Assert1(isa<ConstantInt>(CI.getOperand(2)) &&
1460 isa<ConstantInt>(CI.getOperand(3)) &&
1461 cast<ConstantInt>(CI.getOperand(2))->getZExtValue() < 2 &&
1462 cast<ConstantInt>(CI.getOperand(3))->getZExtValue() < 4,
1463 "invalid arguments to llvm.prefetch",
1466 case Intrinsic::stackprotector:
1467 Assert1(isa<AllocaInst>(CI.getOperand(2)->stripPointerCasts()),
1468 "llvm.stackprotector parameter #2 must resolve to an alloca.",
1474 /// Produce a string to identify an intrinsic parameter or return value.
1475 /// The ArgNo value numbers the return values from 0 to NumRets-1 and the
1476 /// parameters beginning with NumRets.
1478 static std::string IntrinsicParam(unsigned ArgNo, unsigned NumRets) {
1479 if (ArgNo < NumRets) {
1481 return "Intrinsic result type";
1483 return "Intrinsic result type #" + utostr(ArgNo);
1485 return "Intrinsic parameter #" + utostr(ArgNo - NumRets);
1488 bool Verifier::PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
1489 int VT, unsigned ArgNo, std::string &Suffix) {
1490 const FunctionType *FTy = F->getFunctionType();
1492 unsigned NumElts = 0;
1493 const Type *EltTy = Ty;
1494 const VectorType *VTy = dyn_cast<VectorType>(Ty);
1496 EltTy = VTy->getElementType();
1497 NumElts = VTy->getNumElements();
1500 const Type *RetTy = FTy->getReturnType();
1501 const StructType *ST = dyn_cast<StructType>(RetTy);
1502 unsigned NumRets = 1;
1504 NumRets = ST->getNumElements();
1509 // Check flags that indicate a type that is an integral vector type with
1510 // elements that are larger or smaller than the elements of the matched
1512 if ((Match & (ExtendedElementVectorType |
1513 TruncatedElementVectorType)) != 0) {
1514 const IntegerType *IEltTy = dyn_cast<IntegerType>(EltTy);
1515 if (!VTy || !IEltTy) {
1516 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1517 "an integral vector type.", F);
1520 // Adjust the current Ty (in the opposite direction) rather than
1521 // the type being matched against.
1522 if ((Match & ExtendedElementVectorType) != 0) {
1523 if ((IEltTy->getBitWidth() & 1) != 0) {
1524 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " vector "
1525 "element bit-width is odd.", F);
1528 Ty = VectorType::getTruncatedElementVectorType(VTy);
1530 Ty = VectorType::getExtendedElementVectorType(VTy);
1531 Match &= ~(ExtendedElementVectorType | TruncatedElementVectorType);
1534 if (Match <= static_cast<int>(NumRets - 1)) {
1536 RetTy = ST->getElementType(Match);
1539 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1540 "match return type.", F);
1544 if (Ty != FTy->getParamType(Match - 1)) {
1545 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1546 "match parameter %" + utostr(Match - 1) + ".", F);
1550 } else if (VT == MVT::iAny) {
1551 if (!EltTy->isInteger()) {
1552 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1553 "an integer type.", F);
1557 unsigned GotBits = cast<IntegerType>(EltTy)->getBitWidth();
1561 Suffix += "v" + utostr(NumElts);
1563 Suffix += "i" + utostr(GotBits);
1565 // Check some constraints on various intrinsics.
1567 default: break; // Not everything needs to be checked.
1568 case Intrinsic::bswap:
1569 if (GotBits < 16 || GotBits % 16 != 0) {
1570 CheckFailed("Intrinsic requires even byte width argument", F);
1575 } else if (VT == MVT::fAny) {
1576 if (!EltTy->isFloatingPoint()) {
1577 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1578 "a floating-point type.", F);
1585 Suffix += "v" + utostr(NumElts);
1587 Suffix += MVT::getMVT(EltTy).getMVTString();
1588 } else if (VT == MVT::iPTR) {
1589 if (!isa<PointerType>(Ty)) {
1590 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1591 "pointer and a pointer is required.", F);
1594 } else if (VT == MVT::iPTRAny) {
1595 // Outside of TableGen, we don't distinguish iPTRAny (to any address space)
1596 // and iPTR. In the verifier, we can not distinguish which case we have so
1597 // allow either case to be legal.
1598 if (const PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
1599 Suffix += ".p" + utostr(PTyp->getAddressSpace()) +
1600 MVT::getMVT(PTyp->getElementType()).getMVTString();
1602 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1603 "pointer and a pointer is required.", F);
1606 } else if (MVT((MVT::SimpleValueType)VT).isVector()) {
1607 MVT VVT = MVT((MVT::SimpleValueType)VT);
1609 // If this is a vector argument, verify the number and type of elements.
1610 if (VVT.getVectorElementType() != MVT::getMVT(EltTy)) {
1611 CheckFailed("Intrinsic prototype has incorrect vector element type!", F);
1615 if (VVT.getVectorNumElements() != NumElts) {
1616 CheckFailed("Intrinsic prototype has incorrect number of "
1617 "vector elements!", F);
1620 } else if (MVT((MVT::SimpleValueType)VT).getTypeForMVT() != EltTy) {
1621 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is wrong!", F);
1623 } else if (EltTy != Ty) {
1624 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is a vector "
1625 "and a scalar is required.", F);
1632 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1633 /// Intrinsics.gen. This implements a little state machine that verifies the
1634 /// prototype of intrinsics.
1635 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
1637 unsigned ParamNum, ...) {
1639 va_start(VA, ParamNum);
1640 const FunctionType *FTy = F->getFunctionType();
1642 // For overloaded intrinsics, the Suffix of the function name must match the
1643 // types of the arguments. This variable keeps track of the expected
1644 // suffix, to be checked at the end.
1647 if (FTy->getNumParams() + FTy->isVarArg() != ParamNum) {
1648 CheckFailed("Intrinsic prototype has incorrect number of arguments!", F);
1652 const Type *Ty = FTy->getReturnType();
1653 const StructType *ST = dyn_cast<StructType>(Ty);
1655 // Verify the return types.
1656 if (ST && ST->getNumElements() != RetNum) {
1657 CheckFailed("Intrinsic prototype has incorrect number of return types!", F);
1661 for (unsigned ArgNo = 0; ArgNo < RetNum; ++ArgNo) {
1662 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1664 if (ST) Ty = ST->getElementType(ArgNo);
1666 if (!PerformTypeCheck(ID, F, Ty, VT, ArgNo, Suffix))
1670 // Verify the parameter types.
1671 for (unsigned ArgNo = 0; ArgNo < ParamNum; ++ArgNo) {
1672 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1674 if (VT == MVT::isVoid && ArgNo > 0) {
1675 if (!FTy->isVarArg())
1676 CheckFailed("Intrinsic prototype has no '...'!", F);
1680 if (!PerformTypeCheck(ID, F, FTy->getParamType(ArgNo), VT, ArgNo + RetNum,
1687 // For intrinsics without pointer arguments, if we computed a Suffix then the
1688 // intrinsic is overloaded and we need to make sure that the name of the
1689 // function is correct. We add the suffix to the name of the intrinsic and
1690 // compare against the given function name. If they are not the same, the
1691 // function name is invalid. This ensures that overloading of intrinsics
1692 // uses a sane and consistent naming convention. Note that intrinsics with
1693 // pointer argument may or may not be overloaded so we will check assuming it
1694 // has a suffix and not.
1695 if (!Suffix.empty()) {
1696 std::string Name(Intrinsic::getName(ID));
1697 if (Name + Suffix != F->getName()) {
1698 CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1699 F->getName().substr(Name.length()) + "'. It should be '" +
1704 // Check parameter attributes.
1705 Assert1(F->getAttributes() == Intrinsic::getAttributes(ID),
1706 "Intrinsic has wrong parameter attributes!", F);
1710 //===----------------------------------------------------------------------===//
1711 // Implement the public interfaces to this file...
1712 //===----------------------------------------------------------------------===//
1714 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1715 return new Verifier(action);
1719 // verifyFunction - Create
1720 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1721 Function &F = const_cast<Function&>(f);
1722 assert(!F.isDeclaration() && "Cannot verify external functions");
1724 ExistingModuleProvider MP(F.getParent());
1725 FunctionPassManager FPM(&MP);
1726 Verifier *V = new Verifier(action);
1733 /// verifyModule - Check a module for errors, printing messages on stderr.
1734 /// Return true if the module is corrupt.
1736 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1737 std::string *ErrorInfo) {
1739 Verifier *V = new Verifier(action);
1741 PM.run(const_cast<Module&>(M));
1743 if (ErrorInfo && V->Broken)
1744 *ErrorInfo = V->msgs.str();