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/TypeSymbolTable.h"
54 #include "llvm/Analysis/Dominators.h"
55 #include "llvm/Assembly/Writer.h"
56 #include "llvm/CodeGen/ValueTypes.h"
57 #include "llvm/Support/CallSite.h"
58 #include "llvm/Support/CFG.h"
59 #include "llvm/Support/InstVisitor.h"
60 #include "llvm/ADT/SetVector.h"
61 #include "llvm/ADT/SmallPtrSet.h"
62 #include "llvm/ADT/SmallVector.h"
63 #include "llvm/ADT/StringExtras.h"
64 #include "llvm/ADT/STLExtras.h"
65 #include "llvm/Support/ErrorHandling.h"
66 #include "llvm/Support/raw_ostream.h"
71 namespace { // Anonymous namespace for class
72 struct 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 errs() << "Basic Block does not have terminator!\n";
89 WriteAsOperand(errs(), I, true);
96 llvm_report_error("Broken module, no Basic Block terminator!");
103 char PreVerifier::ID = 0;
104 static RegisterPass<PreVerifier>
105 PreVer("preverify", "Preliminary module verification");
106 static const PassInfo *const PreVerifyID = &PreVer;
109 class TypeSet : public AbstractTypeUser {
113 /// Insert a type into the set of types.
114 bool insert(const Type *Ty) {
115 if (!Types.insert(Ty))
117 if (Ty->isAbstract())
118 Ty->addAbstractTypeUser(this);
122 // Remove ourselves as abstract type listeners for any types that remain
123 // abstract when the TypeSet is destroyed.
125 for (SmallSetVector<const Type *, 16>::iterator I = Types.begin(),
126 E = Types.end(); I != E; ++I) {
128 if (Ty->isAbstract())
129 Ty->removeAbstractTypeUser(this);
133 // Abstract type user interface.
135 /// Remove types from the set when refined. Do not insert the type it was
136 /// refined to because that type hasn't been verified yet.
137 void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
139 OldTy->removeAbstractTypeUser(this);
142 /// Stop listening for changes to a type which is no longer abstract.
143 void typeBecameConcrete(const DerivedType *AbsTy) {
144 AbsTy->removeAbstractTypeUser(this);
150 SmallSetVector<const Type *, 16> Types;
153 TypeSet(const TypeSet &);
154 TypeSet &operator=(const TypeSet &);
157 struct Verifier : public FunctionPass, public InstVisitor<Verifier> {
158 static char ID; // Pass ID, replacement for typeid
159 bool Broken; // Is this module found to be broken?
160 bool RealPass; // Are we not being run by a PassManager?
161 VerifierFailureAction action;
162 // What to do if verification fails.
163 Module *Mod; // Module we are verifying right now
164 DominatorTree *DT; // Dominator Tree, caution can be null!
166 std::string Messages;
167 raw_string_ostream MessagesStr;
169 /// InstInThisBlock - when verifying a basic block, keep track of all of the
170 /// instructions we have seen so far. This allows us to do efficient
171 /// dominance checks for the case when an instruction has an operand that is
172 /// an instruction in the same block.
173 SmallPtrSet<Instruction*, 16> InstsInThisBlock;
175 /// Types - keep track of the types that have been checked already.
180 Broken(false), RealPass(true), action(AbortProcessAction),
181 DT(0), MessagesStr(Messages) {}
182 explicit Verifier(VerifierFailureAction ctn)
184 Broken(false), RealPass(true), action(ctn), DT(0),
185 MessagesStr(Messages) {}
186 explicit Verifier(bool AB)
188 Broken(false), RealPass(true),
189 action( AB ? AbortProcessAction : PrintMessageAction), DT(0),
190 MessagesStr(Messages) {}
191 explicit Verifier(DominatorTree &dt)
193 Broken(false), RealPass(false), action(PrintMessageAction),
194 DT(&dt), MessagesStr(Messages) {}
197 bool doInitialization(Module &M) {
199 verifyTypeSymbolTable(M.getTypeSymbolTable());
201 // If this is a real pass, in a pass manager, we must abort before
202 // returning back to the pass manager, or else the pass manager may try to
203 // run other passes on the broken module.
205 return abortIfBroken();
209 bool runOnFunction(Function &F) {
210 // Get dominator information if we are being run by PassManager
211 if (RealPass) DT = &getAnalysis<DominatorTree>();
216 InstsInThisBlock.clear();
218 // If this is a real pass, in a pass manager, we must abort before
219 // returning back to the pass manager, or else the pass manager may try to
220 // run other passes on the broken module.
222 return abortIfBroken();
227 bool doFinalization(Module &M) {
228 // Scan through, checking all of the external function's linkage now...
229 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
230 visitGlobalValue(*I);
232 // Check to make sure function prototypes are okay.
233 if (I->isDeclaration()) visitFunction(*I);
236 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
238 visitGlobalVariable(*I);
240 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
242 visitGlobalAlias(*I);
244 // If the module is broken, abort at this time.
245 return abortIfBroken();
248 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
249 AU.setPreservesAll();
250 AU.addRequiredID(PreVerifyID);
252 AU.addRequired<DominatorTree>();
255 /// abortIfBroken - If the module is broken and we are supposed to abort on
256 /// this condition, do so.
258 bool abortIfBroken() {
259 if (!Broken) return false;
260 MessagesStr << "Broken module found, ";
262 default: llvm_unreachable("Unknown action");
263 case AbortProcessAction:
264 MessagesStr << "compilation aborted!\n";
265 errs() << MessagesStr.str();
266 // Client should choose different reaction if abort is not desired
268 case PrintMessageAction:
269 MessagesStr << "verification continues.\n";
270 errs() << MessagesStr.str();
272 case ReturnStatusAction:
273 MessagesStr << "compilation terminated.\n";
279 // Verification methods...
280 void verifyTypeSymbolTable(TypeSymbolTable &ST);
281 void visitGlobalValue(GlobalValue &GV);
282 void visitGlobalVariable(GlobalVariable &GV);
283 void visitGlobalAlias(GlobalAlias &GA);
284 void visitFunction(Function &F);
285 void visitBasicBlock(BasicBlock &BB);
286 using InstVisitor<Verifier>::visit;
288 void visit(Instruction &I);
290 void visitTruncInst(TruncInst &I);
291 void visitZExtInst(ZExtInst &I);
292 void visitSExtInst(SExtInst &I);
293 void visitFPTruncInst(FPTruncInst &I);
294 void visitFPExtInst(FPExtInst &I);
295 void visitFPToUIInst(FPToUIInst &I);
296 void visitFPToSIInst(FPToSIInst &I);
297 void visitUIToFPInst(UIToFPInst &I);
298 void visitSIToFPInst(SIToFPInst &I);
299 void visitIntToPtrInst(IntToPtrInst &I);
300 void visitPtrToIntInst(PtrToIntInst &I);
301 void visitBitCastInst(BitCastInst &I);
302 void visitPHINode(PHINode &PN);
303 void visitBinaryOperator(BinaryOperator &B);
304 void visitICmpInst(ICmpInst &IC);
305 void visitFCmpInst(FCmpInst &FC);
306 void visitExtractElementInst(ExtractElementInst &EI);
307 void visitInsertElementInst(InsertElementInst &EI);
308 void visitShuffleVectorInst(ShuffleVectorInst &EI);
309 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
310 void visitCallInst(CallInst &CI);
311 void visitInvokeInst(InvokeInst &II);
312 void visitGetElementPtrInst(GetElementPtrInst &GEP);
313 void visitLoadInst(LoadInst &LI);
314 void visitStoreInst(StoreInst &SI);
315 void visitInstruction(Instruction &I);
316 void visitTerminatorInst(TerminatorInst &I);
317 void visitReturnInst(ReturnInst &RI);
318 void visitSwitchInst(SwitchInst &SI);
319 void visitSelectInst(SelectInst &SI);
320 void visitUserOp1(Instruction &I);
321 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
322 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
323 void visitAllocaInst(AllocaInst &AI);
324 void visitExtractValueInst(ExtractValueInst &EVI);
325 void visitInsertValueInst(InsertValueInst &IVI);
327 void VerifyCallSite(CallSite CS);
328 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
329 int VT, unsigned ArgNo, std::string &Suffix);
330 void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
331 unsigned RetNum, unsigned ParamNum, ...);
332 void VerifyParameterAttrs(Attributes Attrs, const Type *Ty,
333 bool isReturnValue, const Value *V);
334 void VerifyFunctionAttrs(const FunctionType *FT, const AttrListPtr &Attrs,
336 void VerifyType(const Type *Ty);
338 void WriteValue(const Value *V) {
340 if (isa<Instruction>(V)) {
341 MessagesStr << *V << '\n';
343 WriteAsOperand(MessagesStr, V, true, Mod);
348 void WriteType(const Type *T) {
351 WriteTypeSymbolic(MessagesStr, T, Mod);
355 // CheckFailed - A check failed, so print out the condition and the message
356 // that failed. This provides a nice place to put a breakpoint if you want
357 // to see why something is not correct.
358 void CheckFailed(const Twine &Message,
359 const Value *V1 = 0, const Value *V2 = 0,
360 const Value *V3 = 0, const Value *V4 = 0) {
361 MessagesStr << Message.str() << "\n";
369 void CheckFailed(const Twine &Message, const Value *V1,
370 const Type *T2, const Value *V3 = 0) {
371 MessagesStr << Message.str() << "\n";
378 void CheckFailed(const Twine &Message, const Type *T1,
379 const Type *T2 = 0, const Type *T3 = 0) {
380 MessagesStr << Message.str() << "\n";
387 } // End anonymous namespace
389 char Verifier::ID = 0;
390 static RegisterPass<Verifier> X("verify", "Module Verifier");
392 // Assert - We know that cond should be true, if not print an error message.
393 #define Assert(C, M) \
394 do { if (!(C)) { CheckFailed(M); return; } } while (0)
395 #define Assert1(C, M, V1) \
396 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
397 #define Assert2(C, M, V1, V2) \
398 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
399 #define Assert3(C, M, V1, V2, V3) \
400 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
401 #define Assert4(C, M, V1, V2, V3, V4) \
402 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
404 void Verifier::visit(Instruction &I) {
405 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
406 Assert1(I.getOperand(i) != 0, "Operand is null", &I);
407 InstVisitor<Verifier>::visit(I);
411 void Verifier::visitGlobalValue(GlobalValue &GV) {
412 Assert1(!GV.isDeclaration() ||
413 GV.hasExternalLinkage() ||
414 GV.hasDLLImportLinkage() ||
415 GV.hasExternalWeakLinkage() ||
416 GV.hasGhostLinkage() ||
417 (isa<GlobalAlias>(GV) &&
418 (GV.hasLocalLinkage() || GV.hasWeakLinkage())),
419 "Global is external, but doesn't have external or dllimport or weak linkage!",
422 Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
423 "Global is marked as dllimport, but not external", &GV);
425 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
426 "Only global variables can have appending linkage!", &GV);
428 if (GV.hasAppendingLinkage()) {
429 GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
430 Assert1(GVar && isa<ArrayType>(GVar->getType()->getElementType()),
431 "Only global arrays can have appending linkage!", GVar);
435 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
436 if (GV.hasInitializer()) {
437 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
438 "Global variable initializer type does not match global "
439 "variable type!", &GV);
441 // If the global has common linkage, it must have a zero initializer and
442 // cannot be constant.
443 if (GV.hasCommonLinkage()) {
444 Assert1(GV.getInitializer()->isNullValue(),
445 "'common' global must have a zero initializer!", &GV);
446 Assert1(!GV.isConstant(), "'common' global may not be marked constant!",
450 Assert1(GV.hasExternalLinkage() || GV.hasDLLImportLinkage() ||
451 GV.hasExternalWeakLinkage(),
452 "invalid linkage type for global declaration", &GV);
455 visitGlobalValue(GV);
458 void Verifier::visitGlobalAlias(GlobalAlias &GA) {
459 Assert1(!GA.getName().empty(),
460 "Alias name cannot be empty!", &GA);
461 Assert1(GA.hasExternalLinkage() || GA.hasLocalLinkage() ||
463 "Alias should have external or external weak linkage!", &GA);
464 Assert1(GA.getAliasee(),
465 "Aliasee cannot be NULL!", &GA);
466 Assert1(GA.getType() == GA.getAliasee()->getType(),
467 "Alias and aliasee types should match!", &GA);
469 if (!isa<GlobalValue>(GA.getAliasee())) {
470 const ConstantExpr *CE = dyn_cast<ConstantExpr>(GA.getAliasee());
472 (CE->getOpcode() == Instruction::BitCast ||
473 CE->getOpcode() == Instruction::GetElementPtr) &&
474 isa<GlobalValue>(CE->getOperand(0)),
475 "Aliasee should be either GlobalValue or bitcast of GlobalValue",
479 const GlobalValue* Aliasee = GA.resolveAliasedGlobal(/*stopOnWeak*/ false);
481 "Aliasing chain should end with function or global variable", &GA);
483 visitGlobalValue(GA);
486 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
487 for (TypeSymbolTable::iterator I = ST.begin(), E = ST.end(); I != E; ++I)
488 VerifyType(I->second);
491 // VerifyParameterAttrs - Check the given attributes for an argument or return
492 // value of the specified type. The value V is printed in error messages.
493 void Verifier::VerifyParameterAttrs(Attributes Attrs, const Type *Ty,
494 bool isReturnValue, const Value *V) {
495 if (Attrs == Attribute::None)
498 Attributes FnCheckAttr = Attrs & Attribute::FunctionOnly;
499 Assert1(!FnCheckAttr, "Attribute " + Attribute::getAsString(FnCheckAttr) +
500 " only applies to the function!", V);
503 Attributes RetI = Attrs & Attribute::ParameterOnly;
504 Assert1(!RetI, "Attribute " + Attribute::getAsString(RetI) +
505 " does not apply to return values!", V);
509 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
510 Attributes MutI = Attrs & Attribute::MutuallyIncompatible[i];
511 Assert1(!(MutI & (MutI - 1)), "Attributes " +
512 Attribute::getAsString(MutI) + " are incompatible!", V);
515 Attributes TypeI = Attrs & Attribute::typeIncompatible(Ty);
516 Assert1(!TypeI, "Wrong type for attribute " +
517 Attribute::getAsString(TypeI), V);
519 Attributes ByValI = Attrs & Attribute::ByVal;
520 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
521 Assert1(!ByValI || PTy->getElementType()->isSized(),
522 "Attribute " + Attribute::getAsString(ByValI) +
523 " does not support unsized types!", V);
526 "Attribute " + Attribute::getAsString(ByValI) +
527 " only applies to parameters with pointer type!", V);
531 // VerifyFunctionAttrs - Check parameter attributes against a function type.
532 // The value V is printed in error messages.
533 void Verifier::VerifyFunctionAttrs(const FunctionType *FT,
534 const AttrListPtr &Attrs,
539 bool SawNest = false;
541 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
542 const AttributeWithIndex &Attr = Attrs.getSlot(i);
546 Ty = FT->getReturnType();
547 else if (Attr.Index-1 < FT->getNumParams())
548 Ty = FT->getParamType(Attr.Index-1);
550 break; // VarArgs attributes, verified elsewhere.
552 VerifyParameterAttrs(Attr.Attrs, Ty, Attr.Index == 0, V);
554 if (Attr.Attrs & Attribute::Nest) {
555 Assert1(!SawNest, "More than one parameter has attribute nest!", V);
559 if (Attr.Attrs & Attribute::StructRet)
560 Assert1(Attr.Index == 1, "Attribute sret not on first parameter!", V);
563 Attributes FAttrs = Attrs.getFnAttributes();
564 Attributes NotFn = FAttrs & (~Attribute::FunctionOnly);
565 Assert1(!NotFn, "Attribute " + Attribute::getAsString(NotFn) +
566 " does not apply to the function!", V);
569 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
570 Attributes MutI = FAttrs & Attribute::MutuallyIncompatible[i];
571 Assert1(!(MutI & (MutI - 1)), "Attributes " +
572 Attribute::getAsString(MutI) + " are incompatible!", V);
576 static bool VerifyAttributeCount(const AttrListPtr &Attrs, unsigned Params) {
580 unsigned LastSlot = Attrs.getNumSlots() - 1;
581 unsigned LastIndex = Attrs.getSlot(LastSlot).Index;
582 if (LastIndex <= Params
583 || (LastIndex == (unsigned)~0
584 && (LastSlot == 0 || Attrs.getSlot(LastSlot - 1).Index <= Params)))
590 // visitFunction - Verify that a function is ok.
592 void Verifier::visitFunction(Function &F) {
593 // Check function arguments.
594 const FunctionType *FT = F.getFunctionType();
595 unsigned NumArgs = F.arg_size();
597 Assert1(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
598 Assert2(FT->getNumParams() == NumArgs,
599 "# formal arguments must match # of arguments for function type!",
601 Assert1(F.getReturnType()->isFirstClassType() ||
602 F.getReturnType()->isVoidTy() ||
603 isa<StructType>(F.getReturnType()),
604 "Functions cannot return aggregate values!", &F);
606 Assert1(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
607 "Invalid struct return type!", &F);
609 const AttrListPtr &Attrs = F.getAttributes();
611 Assert1(VerifyAttributeCount(Attrs, FT->getNumParams()),
612 "Attributes after last parameter!", &F);
614 // Check function attributes.
615 VerifyFunctionAttrs(FT, Attrs, &F);
617 // Check that this function meets the restrictions on this calling convention.
618 switch (F.getCallingConv()) {
623 case CallingConv::Fast:
624 case CallingConv::Cold:
625 case CallingConv::X86_FastCall:
626 Assert1(!F.isVarArg(),
627 "Varargs functions must have C calling conventions!", &F);
631 bool isLLVMdotName = F.getName().size() >= 5 &&
632 F.getName().substr(0, 5) == "llvm.";
634 // Check that the argument values match the function type for this function...
636 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
638 Assert2(I->getType() == FT->getParamType(i),
639 "Argument value does not match function argument type!",
640 I, FT->getParamType(i));
641 Assert1(I->getType()->isFirstClassType(),
642 "Function arguments must have first-class types!", I);
644 Assert2(!I->getType()->isMetadataTy(),
645 "Function takes metadata but isn't an intrinsic", I, &F);
648 if (F.isDeclaration()) {
649 Assert1(F.hasExternalLinkage() || F.hasDLLImportLinkage() ||
650 F.hasExternalWeakLinkage() || F.hasGhostLinkage(),
651 "invalid linkage type for function declaration", &F);
653 // Verify that this function (which has a body) is not named "llvm.*". It
654 // is not legal to define intrinsics.
655 Assert1(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
657 // Check the entry node
658 BasicBlock *Entry = &F.getEntryBlock();
659 Assert1(pred_begin(Entry) == pred_end(Entry),
660 "Entry block to function must not have predecessors!", Entry);
662 // The address of the entry block cannot be taken, unless it is dead.
663 if (Entry->hasAddressTaken()) {
664 Entry->removeDeadBlockAddress();
665 Assert1(!Entry->hasAddressTaken(),
666 "blockaddress may not be used with the entry block!", Entry);
670 // If this function is actually an intrinsic, verify that it is only used in
671 // direct call/invokes, never having its "address taken".
672 if (F.getIntrinsicID()) {
673 for (Value::use_iterator UI = F.use_begin(), E = F.use_end(); UI != E;++UI){
674 User *U = cast<User>(UI);
675 if ((isa<CallInst>(U) || isa<InvokeInst>(U)) && UI.getOperandNo() == 0)
676 continue; // Direct calls/invokes are ok.
678 Assert1(0, "Invalid user of intrinsic instruction!", U);
683 // verifyBasicBlock - Verify that a basic block is well formed...
685 void Verifier::visitBasicBlock(BasicBlock &BB) {
686 InstsInThisBlock.clear();
688 // Ensure that basic blocks have terminators!
689 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
691 // Check constraints that this basic block imposes on all of the PHI nodes in
693 if (isa<PHINode>(BB.front())) {
694 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
695 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
696 std::sort(Preds.begin(), Preds.end());
698 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
699 // Ensure that PHI nodes have at least one entry!
700 Assert1(PN->getNumIncomingValues() != 0,
701 "PHI nodes must have at least one entry. If the block is dead, "
702 "the PHI should be removed!", PN);
703 Assert1(PN->getNumIncomingValues() == Preds.size(),
704 "PHINode should have one entry for each predecessor of its "
705 "parent basic block!", PN);
707 // Get and sort all incoming values in the PHI node...
709 Values.reserve(PN->getNumIncomingValues());
710 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
711 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
712 PN->getIncomingValue(i)));
713 std::sort(Values.begin(), Values.end());
715 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
716 // Check to make sure that if there is more than one entry for a
717 // particular basic block in this PHI node, that the incoming values are
720 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
721 Values[i].second == Values[i-1].second,
722 "PHI node has multiple entries for the same basic block with "
723 "different incoming values!", PN, Values[i].first,
724 Values[i].second, Values[i-1].second);
726 // Check to make sure that the predecessors and PHI node entries are
728 Assert3(Values[i].first == Preds[i],
729 "PHI node entries do not match predecessors!", PN,
730 Values[i].first, Preds[i]);
736 void Verifier::visitTerminatorInst(TerminatorInst &I) {
737 // Ensure that terminators only exist at the end of the basic block.
738 Assert1(&I == I.getParent()->getTerminator(),
739 "Terminator found in the middle of a basic block!", I.getParent());
743 void Verifier::visitReturnInst(ReturnInst &RI) {
744 Function *F = RI.getParent()->getParent();
745 unsigned N = RI.getNumOperands();
746 if (F->getReturnType()->isVoidTy())
748 "Found return instr that returns non-void in Function of void "
749 "return type!", &RI, F->getReturnType());
750 else if (N == 1 && F->getReturnType() == RI.getOperand(0)->getType()) {
751 // Exactly one return value and it matches the return type. Good.
752 } else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
753 // The return type is a struct; check for multiple return values.
754 Assert2(STy->getNumElements() == N,
755 "Incorrect number of return values in ret instruction!",
756 &RI, F->getReturnType());
757 for (unsigned i = 0; i != N; ++i)
758 Assert2(STy->getElementType(i) == RI.getOperand(i)->getType(),
759 "Function return type does not match operand "
760 "type of return inst!", &RI, F->getReturnType());
761 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(F->getReturnType())) {
762 // The return type is an array; check for multiple return values.
763 Assert2(ATy->getNumElements() == N,
764 "Incorrect number of return values in ret instruction!",
765 &RI, F->getReturnType());
766 for (unsigned i = 0; i != N; ++i)
767 Assert2(ATy->getElementType() == RI.getOperand(i)->getType(),
768 "Function return type does not match operand "
769 "type of return inst!", &RI, F->getReturnType());
771 CheckFailed("Function return type does not match operand "
772 "type of return inst!", &RI, F->getReturnType());
775 // Check to make sure that the return value has necessary properties for
777 visitTerminatorInst(RI);
780 void Verifier::visitSwitchInst(SwitchInst &SI) {
781 // Check to make sure that all of the constants in the switch instruction
782 // have the same type as the switched-on value.
783 const Type *SwitchTy = SI.getCondition()->getType();
784 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
785 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
786 "Switch constants must all be same type as switch value!", &SI);
788 visitTerminatorInst(SI);
791 void Verifier::visitSelectInst(SelectInst &SI) {
792 Assert1(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
794 "Invalid operands for select instruction!", &SI);
796 Assert1(SI.getTrueValue()->getType() == SI.getType(),
797 "Select values must have same type as select instruction!", &SI);
798 visitInstruction(SI);
801 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
802 /// a pass, if any exist, it's an error.
804 void Verifier::visitUserOp1(Instruction &I) {
805 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
808 void Verifier::visitTruncInst(TruncInst &I) {
809 // Get the source and destination types
810 const Type *SrcTy = I.getOperand(0)->getType();
811 const Type *DestTy = I.getType();
813 // Get the size of the types in bits, we'll need this later
814 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
815 unsigned DestBitSize = DestTy->getScalarSizeInBits();
817 Assert1(SrcTy->isIntOrIntVector(), "Trunc only operates on integer", &I);
818 Assert1(DestTy->isIntOrIntVector(), "Trunc only produces integer", &I);
819 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
820 "trunc source and destination must both be a vector or neither", &I);
821 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
826 void Verifier::visitZExtInst(ZExtInst &I) {
827 // Get the source and destination types
828 const Type *SrcTy = I.getOperand(0)->getType();
829 const Type *DestTy = I.getType();
831 // Get the size of the types in bits, we'll need this later
832 Assert1(SrcTy->isIntOrIntVector(), "ZExt only operates on integer", &I);
833 Assert1(DestTy->isIntOrIntVector(), "ZExt only produces an integer", &I);
834 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
835 "zext source and destination must both be a vector or neither", &I);
836 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
837 unsigned DestBitSize = DestTy->getScalarSizeInBits();
839 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
844 void Verifier::visitSExtInst(SExtInst &I) {
845 // Get the source and destination types
846 const Type *SrcTy = I.getOperand(0)->getType();
847 const Type *DestTy = I.getType();
849 // Get the size of the types in bits, we'll need this later
850 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
851 unsigned DestBitSize = DestTy->getScalarSizeInBits();
853 Assert1(SrcTy->isIntOrIntVector(), "SExt only operates on integer", &I);
854 Assert1(DestTy->isIntOrIntVector(), "SExt only produces an integer", &I);
855 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
856 "sext source and destination must both be a vector or neither", &I);
857 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
862 void Verifier::visitFPTruncInst(FPTruncInst &I) {
863 // Get the source and destination types
864 const Type *SrcTy = I.getOperand(0)->getType();
865 const Type *DestTy = I.getType();
866 // Get the size of the types in bits, we'll need this later
867 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
868 unsigned DestBitSize = DestTy->getScalarSizeInBits();
870 Assert1(SrcTy->isFPOrFPVector(),"FPTrunc only operates on FP", &I);
871 Assert1(DestTy->isFPOrFPVector(),"FPTrunc only produces an FP", &I);
872 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
873 "fptrunc source and destination must both be a vector or neither",&I);
874 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
879 void Verifier::visitFPExtInst(FPExtInst &I) {
880 // Get the source and destination types
881 const Type *SrcTy = I.getOperand(0)->getType();
882 const Type *DestTy = I.getType();
884 // Get the size of the types in bits, we'll need this later
885 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
886 unsigned DestBitSize = DestTy->getScalarSizeInBits();
888 Assert1(SrcTy->isFPOrFPVector(),"FPExt only operates on FP", &I);
889 Assert1(DestTy->isFPOrFPVector(),"FPExt only produces an FP", &I);
890 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
891 "fpext source and destination must both be a vector or neither", &I);
892 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
897 void Verifier::visitUIToFPInst(UIToFPInst &I) {
898 // Get the source and destination types
899 const Type *SrcTy = I.getOperand(0)->getType();
900 const Type *DestTy = I.getType();
902 bool SrcVec = isa<VectorType>(SrcTy);
903 bool DstVec = isa<VectorType>(DestTy);
905 Assert1(SrcVec == DstVec,
906 "UIToFP source and dest must both be vector or scalar", &I);
907 Assert1(SrcTy->isIntOrIntVector(),
908 "UIToFP source must be integer or integer vector", &I);
909 Assert1(DestTy->isFPOrFPVector(),
910 "UIToFP result must be FP or FP vector", &I);
912 if (SrcVec && DstVec)
913 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
914 cast<VectorType>(DestTy)->getNumElements(),
915 "UIToFP source and dest vector length mismatch", &I);
920 void Verifier::visitSIToFPInst(SIToFPInst &I) {
921 // Get the source and destination types
922 const Type *SrcTy = I.getOperand(0)->getType();
923 const Type *DestTy = I.getType();
925 bool SrcVec = isa<VectorType>(SrcTy);
926 bool DstVec = isa<VectorType>(DestTy);
928 Assert1(SrcVec == DstVec,
929 "SIToFP source and dest must both be vector or scalar", &I);
930 Assert1(SrcTy->isIntOrIntVector(),
931 "SIToFP source must be integer or integer vector", &I);
932 Assert1(DestTy->isFPOrFPVector(),
933 "SIToFP result must be FP or FP vector", &I);
935 if (SrcVec && DstVec)
936 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
937 cast<VectorType>(DestTy)->getNumElements(),
938 "SIToFP source and dest vector length mismatch", &I);
943 void Verifier::visitFPToUIInst(FPToUIInst &I) {
944 // Get the source and destination types
945 const Type *SrcTy = I.getOperand(0)->getType();
946 const Type *DestTy = I.getType();
948 bool SrcVec = isa<VectorType>(SrcTy);
949 bool DstVec = isa<VectorType>(DestTy);
951 Assert1(SrcVec == DstVec,
952 "FPToUI source and dest must both be vector or scalar", &I);
953 Assert1(SrcTy->isFPOrFPVector(), "FPToUI source must be FP or FP vector", &I);
954 Assert1(DestTy->isIntOrIntVector(),
955 "FPToUI result must be integer or integer vector", &I);
957 if (SrcVec && DstVec)
958 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
959 cast<VectorType>(DestTy)->getNumElements(),
960 "FPToUI source and dest vector length mismatch", &I);
965 void Verifier::visitFPToSIInst(FPToSIInst &I) {
966 // Get the source and destination types
967 const Type *SrcTy = I.getOperand(0)->getType();
968 const Type *DestTy = I.getType();
970 bool SrcVec = isa<VectorType>(SrcTy);
971 bool DstVec = isa<VectorType>(DestTy);
973 Assert1(SrcVec == DstVec,
974 "FPToSI source and dest must both be vector or scalar", &I);
975 Assert1(SrcTy->isFPOrFPVector(),
976 "FPToSI source must be FP or FP vector", &I);
977 Assert1(DestTy->isIntOrIntVector(),
978 "FPToSI result must be integer or integer vector", &I);
980 if (SrcVec && DstVec)
981 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
982 cast<VectorType>(DestTy)->getNumElements(),
983 "FPToSI source and dest vector length mismatch", &I);
988 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
989 // Get the source and destination types
990 const Type *SrcTy = I.getOperand(0)->getType();
991 const Type *DestTy = I.getType();
993 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
994 Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
999 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
1000 // Get the source and destination types
1001 const Type *SrcTy = I.getOperand(0)->getType();
1002 const Type *DestTy = I.getType();
1004 Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
1005 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
1007 visitInstruction(I);
1010 void Verifier::visitBitCastInst(BitCastInst &I) {
1011 // Get the source and destination types
1012 const Type *SrcTy = I.getOperand(0)->getType();
1013 const Type *DestTy = I.getType();
1015 // Get the size of the types in bits, we'll need this later
1016 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
1017 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
1019 // BitCast implies a no-op cast of type only. No bits change.
1020 // However, you can't cast pointers to anything but pointers.
1021 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
1022 "Bitcast requires both operands to be pointer or neither", &I);
1023 Assert1(SrcBitSize == DestBitSize, "Bitcast requires types of same width",&I);
1025 // Disallow aggregates.
1026 Assert1(!SrcTy->isAggregateType(),
1027 "Bitcast operand must not be aggregate", &I);
1028 Assert1(!DestTy->isAggregateType(),
1029 "Bitcast type must not be aggregate", &I);
1031 visitInstruction(I);
1034 /// visitPHINode - Ensure that a PHI node is well formed.
1036 void Verifier::visitPHINode(PHINode &PN) {
1037 // Ensure that the PHI nodes are all grouped together at the top of the block.
1038 // This can be tested by checking whether the instruction before this is
1039 // either nonexistent (because this is begin()) or is a PHI node. If not,
1040 // then there is some other instruction before a PHI.
1041 Assert2(&PN == &PN.getParent()->front() ||
1042 isa<PHINode>(--BasicBlock::iterator(&PN)),
1043 "PHI nodes not grouped at top of basic block!",
1044 &PN, PN.getParent());
1046 // Check that all of the values of the PHI node have the same type as the
1047 // result, and that the incoming blocks are really basic blocks.
1048 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1049 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
1050 "PHI node operands are not the same type as the result!", &PN);
1051 Assert1(isa<BasicBlock>(PN.getOperand(
1052 PHINode::getOperandNumForIncomingBlock(i))),
1053 "PHI node incoming block is not a BasicBlock!", &PN);
1056 // All other PHI node constraints are checked in the visitBasicBlock method.
1058 visitInstruction(PN);
1061 void Verifier::VerifyCallSite(CallSite CS) {
1062 Instruction *I = CS.getInstruction();
1064 Assert1(isa<PointerType>(CS.getCalledValue()->getType()),
1065 "Called function must be a pointer!", I);
1066 const PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
1068 Assert1(isa<FunctionType>(FPTy->getElementType()),
1069 "Called function is not pointer to function type!", I);
1070 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1072 // Verify that the correct number of arguments are being passed
1073 if (FTy->isVarArg())
1074 Assert1(CS.arg_size() >= FTy->getNumParams(),
1075 "Called function requires more parameters than were provided!",I);
1077 Assert1(CS.arg_size() == FTy->getNumParams(),
1078 "Incorrect number of arguments passed to called function!", I);
1080 // Verify that all arguments to the call match the function type...
1081 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1082 Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
1083 "Call parameter type does not match function signature!",
1084 CS.getArgument(i), FTy->getParamType(i), I);
1086 const AttrListPtr &Attrs = CS.getAttributes();
1088 Assert1(VerifyAttributeCount(Attrs, CS.arg_size()),
1089 "Attributes after last parameter!", I);
1091 // Verify call attributes.
1092 VerifyFunctionAttrs(FTy, Attrs, I);
1094 if (FTy->isVarArg())
1095 // Check attributes on the varargs part.
1096 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
1097 Attributes Attr = Attrs.getParamAttributes(Idx);
1099 VerifyParameterAttrs(Attr, CS.getArgument(Idx-1)->getType(), false, I);
1101 Attributes VArgI = Attr & Attribute::VarArgsIncompatible;
1102 Assert1(!VArgI, "Attribute " + Attribute::getAsString(VArgI) +
1103 " cannot be used for vararg call arguments!", I);
1106 // Verify that there's no metadata unless it's a direct call to an intrinsic.
1107 if (!CS.getCalledFunction() || CS.getCalledFunction()->getName().size() < 5 ||
1108 CS.getCalledFunction()->getName().substr(0, 5) != "llvm.") {
1109 for (FunctionType::param_iterator PI = FTy->param_begin(),
1110 PE = FTy->param_end(); PI != PE; ++PI)
1111 Assert1(!PI->get()->isMetadataTy(),
1112 "Function has metadata parameter but isn't an intrinsic", I);
1115 visitInstruction(*I);
1118 void Verifier::visitCallInst(CallInst &CI) {
1119 VerifyCallSite(&CI);
1121 if (Function *F = CI.getCalledFunction())
1122 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
1123 visitIntrinsicFunctionCall(ID, CI);
1126 void Verifier::visitInvokeInst(InvokeInst &II) {
1127 VerifyCallSite(&II);
1130 /// visitBinaryOperator - Check that both arguments to the binary operator are
1131 /// of the same type!
1133 void Verifier::visitBinaryOperator(BinaryOperator &B) {
1134 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
1135 "Both operands to a binary operator are not of the same type!", &B);
1137 switch (B.getOpcode()) {
1138 // Check that integer arithmetic operators are only used with
1139 // integral operands.
1140 case Instruction::Add:
1141 case Instruction::Sub:
1142 case Instruction::Mul:
1143 case Instruction::SDiv:
1144 case Instruction::UDiv:
1145 case Instruction::SRem:
1146 case Instruction::URem:
1147 Assert1(B.getType()->isIntOrIntVector(),
1148 "Integer arithmetic operators only work with integral types!", &B);
1149 Assert1(B.getType() == B.getOperand(0)->getType(),
1150 "Integer arithmetic operators must have same type "
1151 "for operands and result!", &B);
1153 // Check that floating-point arithmetic operators are only used with
1154 // floating-point operands.
1155 case Instruction::FAdd:
1156 case Instruction::FSub:
1157 case Instruction::FMul:
1158 case Instruction::FDiv:
1159 case Instruction::FRem:
1160 Assert1(B.getType()->isFPOrFPVector(),
1161 "Floating-point arithmetic operators only work with "
1162 "floating-point types!", &B);
1163 Assert1(B.getType() == B.getOperand(0)->getType(),
1164 "Floating-point arithmetic operators must have same type "
1165 "for operands and result!", &B);
1167 // Check that logical operators are only used with integral operands.
1168 case Instruction::And:
1169 case Instruction::Or:
1170 case Instruction::Xor:
1171 Assert1(B.getType()->isIntOrIntVector(),
1172 "Logical operators only work with integral types!", &B);
1173 Assert1(B.getType() == B.getOperand(0)->getType(),
1174 "Logical operators must have same type for operands and result!",
1177 case Instruction::Shl:
1178 case Instruction::LShr:
1179 case Instruction::AShr:
1180 Assert1(B.getType()->isIntOrIntVector(),
1181 "Shifts only work with integral types!", &B);
1182 Assert1(B.getType() == B.getOperand(0)->getType(),
1183 "Shift return type must be same as operands!", &B);
1186 llvm_unreachable("Unknown BinaryOperator opcode!");
1189 visitInstruction(B);
1192 void Verifier::visitICmpInst(ICmpInst& IC) {
1193 // Check that the operands are the same type
1194 const Type* Op0Ty = IC.getOperand(0)->getType();
1195 const Type* Op1Ty = IC.getOperand(1)->getType();
1196 Assert1(Op0Ty == Op1Ty,
1197 "Both operands to ICmp instruction are not of the same type!", &IC);
1198 // Check that the operands are the right type
1199 Assert1(Op0Ty->isIntOrIntVector() || isa<PointerType>(Op0Ty),
1200 "Invalid operand types for ICmp instruction", &IC);
1202 visitInstruction(IC);
1205 void Verifier::visitFCmpInst(FCmpInst& FC) {
1206 // Check that the operands are the same type
1207 const Type* Op0Ty = FC.getOperand(0)->getType();
1208 const Type* Op1Ty = FC.getOperand(1)->getType();
1209 Assert1(Op0Ty == Op1Ty,
1210 "Both operands to FCmp instruction are not of the same type!", &FC);
1211 // Check that the operands are the right type
1212 Assert1(Op0Ty->isFPOrFPVector(),
1213 "Invalid operand types for FCmp instruction", &FC);
1214 visitInstruction(FC);
1217 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
1218 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
1220 "Invalid extractelement operands!", &EI);
1221 visitInstruction(EI);
1224 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
1225 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
1228 "Invalid insertelement operands!", &IE);
1229 visitInstruction(IE);
1232 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
1233 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
1235 "Invalid shufflevector operands!", &SV);
1237 const VectorType *VTy = dyn_cast<VectorType>(SV.getOperand(0)->getType());
1238 Assert1(VTy, "Operands are not a vector type", &SV);
1240 // Check to see if Mask is valid.
1241 if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
1242 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
1243 if (ConstantInt* CI = dyn_cast<ConstantInt>(MV->getOperand(i))) {
1244 Assert1(!CI->uge(VTy->getNumElements()*2),
1245 "Invalid shufflevector shuffle mask!", &SV);
1247 Assert1(isa<UndefValue>(MV->getOperand(i)),
1248 "Invalid shufflevector shuffle mask!", &SV);
1252 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
1253 isa<ConstantAggregateZero>(SV.getOperand(2)),
1254 "Invalid shufflevector shuffle mask!", &SV);
1257 visitInstruction(SV);
1260 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1261 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
1263 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
1264 Idxs.begin(), Idxs.end());
1265 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
1266 Assert2(isa<PointerType>(GEP.getType()) &&
1267 cast<PointerType>(GEP.getType())->getElementType() == ElTy,
1268 "GEP is not of right type for indices!", &GEP, ElTy);
1269 visitInstruction(GEP);
1272 void Verifier::visitLoadInst(LoadInst &LI) {
1273 const PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
1274 Assert1(PTy, "Load operand must be a pointer.", &LI);
1275 const Type *ElTy = PTy->getElementType();
1276 Assert2(ElTy == LI.getType(),
1277 "Load result type does not match pointer operand type!", &LI, ElTy);
1278 visitInstruction(LI);
1281 void Verifier::visitStoreInst(StoreInst &SI) {
1282 const PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
1283 Assert1(PTy, "Load operand must be a pointer.", &SI);
1284 const Type *ElTy = PTy->getElementType();
1285 Assert2(ElTy == SI.getOperand(0)->getType(),
1286 "Stored value type does not match pointer operand type!",
1288 visitInstruction(SI);
1291 void Verifier::visitAllocaInst(AllocaInst &AI) {
1292 const PointerType *PTy = AI.getType();
1293 Assert1(PTy->getAddressSpace() == 0,
1294 "Allocation instruction pointer not in the generic address space!",
1296 Assert1(PTy->getElementType()->isSized(), "Cannot allocate unsized type",
1298 visitInstruction(AI);
1301 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
1302 Assert1(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
1303 EVI.idx_begin(), EVI.idx_end()) ==
1305 "Invalid ExtractValueInst operands!", &EVI);
1307 visitInstruction(EVI);
1310 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
1311 Assert1(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
1312 IVI.idx_begin(), IVI.idx_end()) ==
1313 IVI.getOperand(1)->getType(),
1314 "Invalid InsertValueInst operands!", &IVI);
1316 visitInstruction(IVI);
1319 /// verifyInstruction - Verify that an instruction is well formed.
1321 void Verifier::visitInstruction(Instruction &I) {
1322 BasicBlock *BB = I.getParent();
1323 Assert1(BB, "Instruction not embedded in basic block!", &I);
1325 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
1326 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
1328 Assert1(*UI != (User*)&I || !DT->isReachableFromEntry(BB),
1329 "Only PHI nodes may reference their own value!", &I);
1332 // Verify that if this is a terminator that it is at the end of the block.
1333 if (isa<TerminatorInst>(I))
1334 Assert1(BB->getTerminator() == &I, "Terminator not at end of block!", &I);
1336 // Check that void typed values don't have names
1337 Assert1(!I.getType()->isVoidTy() || !I.hasName(),
1338 "Instruction has a name, but provides a void value!", &I);
1340 // Check that the return value of the instruction is either void or a legal
1342 Assert1(I.getType()->isVoidTy() ||
1343 I.getType()->isFirstClassType(),
1344 "Instruction returns a non-scalar type!", &I);
1346 // Check that the instruction doesn't produce metadata. Calls are already
1347 // checked against the callee type.
1348 Assert1(!I.getType()->isMetadataTy() ||
1349 isa<CallInst>(I) || isa<InvokeInst>(I),
1350 "Invalid use of metadata!", &I);
1352 // Check that all uses of the instruction, if they are instructions
1353 // themselves, actually have parent basic blocks. If the use is not an
1354 // instruction, it is an error!
1355 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
1357 if (Instruction *Used = dyn_cast<Instruction>(*UI))
1358 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
1359 " embedded in a basic block!", &I, Used);
1361 CheckFailed("Use of instruction is not an instruction!", *UI);
1366 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1367 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
1369 // Check to make sure that only first-class-values are operands to
1371 if (!I.getOperand(i)->getType()->isFirstClassType()) {
1372 Assert1(0, "Instruction operands must be first-class values!", &I);
1375 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
1376 // Check to make sure that the "address of" an intrinsic function is never
1378 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
1379 "Cannot take the address of an intrinsic!", &I);
1380 Assert1(F->getParent() == Mod, "Referencing function in another module!",
1382 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
1383 Assert1(OpBB->getParent() == BB->getParent(),
1384 "Referring to a basic block in another function!", &I);
1385 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
1386 Assert1(OpArg->getParent() == BB->getParent(),
1387 "Referring to an argument in another function!", &I);
1388 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
1389 Assert1(GV->getParent() == Mod, "Referencing global in another module!",
1391 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
1392 BasicBlock *OpBlock = Op->getParent();
1394 // Check that a definition dominates all of its uses.
1395 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1396 // Invoke results are only usable in the normal destination, not in the
1397 // exceptional destination.
1398 BasicBlock *NormalDest = II->getNormalDest();
1400 Assert2(NormalDest != II->getUnwindDest(),
1401 "No uses of invoke possible due to dominance structure!",
1404 // PHI nodes differ from other nodes because they actually "use" the
1405 // value in the predecessor basic blocks they correspond to.
1406 BasicBlock *UseBlock = BB;
1407 if (isa<PHINode>(I))
1408 UseBlock = dyn_cast<BasicBlock>(I.getOperand(i+1));
1409 Assert2(UseBlock, "Invoke operand is PHI node with bad incoming-BB",
1412 if (isa<PHINode>(I) && UseBlock == OpBlock) {
1413 // Special case of a phi node in the normal destination or the unwind
1415 Assert2(BB == NormalDest || !DT->isReachableFromEntry(UseBlock),
1416 "Invoke result not available in the unwind destination!",
1419 Assert2(DT->dominates(NormalDest, UseBlock) ||
1420 !DT->isReachableFromEntry(UseBlock),
1421 "Invoke result does not dominate all uses!", Op, &I);
1423 // If the normal successor of an invoke instruction has multiple
1424 // predecessors, then the normal edge from the invoke is critical,
1425 // so the invoke value can only be live if the destination block
1426 // dominates all of it's predecessors (other than the invoke).
1427 if (!NormalDest->getSinglePredecessor() &&
1428 DT->isReachableFromEntry(UseBlock))
1429 // If it is used by something non-phi, then the other case is that
1430 // 'NormalDest' dominates all of its predecessors other than the
1431 // invoke. In this case, the invoke value can still be used.
1432 for (pred_iterator PI = pred_begin(NormalDest),
1433 E = pred_end(NormalDest); PI != E; ++PI)
1434 if (*PI != II->getParent() && !DT->dominates(NormalDest, *PI) &&
1435 DT->isReachableFromEntry(*PI)) {
1436 CheckFailed("Invoke result does not dominate all uses!", Op,&I);
1440 } else if (isa<PHINode>(I)) {
1441 // PHI nodes are more difficult than other nodes because they actually
1442 // "use" the value in the predecessor basic blocks they correspond to.
1443 BasicBlock *PredBB = dyn_cast<BasicBlock>(I.getOperand(i+1));
1444 Assert2(PredBB && (DT->dominates(OpBlock, PredBB) ||
1445 !DT->isReachableFromEntry(PredBB)),
1446 "Instruction does not dominate all uses!", Op, &I);
1448 if (OpBlock == BB) {
1449 // If they are in the same basic block, make sure that the definition
1450 // comes before the use.
1451 Assert2(InstsInThisBlock.count(Op) || !DT->isReachableFromEntry(BB),
1452 "Instruction does not dominate all uses!", Op, &I);
1455 // Definition must dominate use unless use is unreachable!
1456 Assert2(InstsInThisBlock.count(Op) || DT->dominates(Op, &I) ||
1457 !DT->isReachableFromEntry(BB),
1458 "Instruction does not dominate all uses!", Op, &I);
1460 } else if (isa<InlineAsm>(I.getOperand(i))) {
1461 Assert1(i == 0 && (isa<CallInst>(I) || isa<InvokeInst>(I)),
1462 "Cannot take the address of an inline asm!", &I);
1465 InstsInThisBlock.insert(&I);
1467 VerifyType(I.getType());
1470 /// VerifyType - Verify that a type is well formed.
1472 void Verifier::VerifyType(const Type *Ty) {
1473 if (!Types.insert(Ty)) return;
1475 switch (Ty->getTypeID()) {
1476 case Type::FunctionTyID: {
1477 const FunctionType *FTy = cast<FunctionType>(Ty);
1479 const Type *RetTy = FTy->getReturnType();
1480 Assert2(FunctionType::isValidReturnType(RetTy),
1481 "Function type with invalid return type", RetTy, FTy);
1484 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
1485 const Type *ElTy = FTy->getParamType(i);
1486 Assert2(FunctionType::isValidArgumentType(ElTy),
1487 "Function type with invalid parameter type", ElTy, FTy);
1491 case Type::StructTyID: {
1492 const StructType *STy = cast<StructType>(Ty);
1493 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1494 const Type *ElTy = STy->getElementType(i);
1495 Assert2(StructType::isValidElementType(ElTy),
1496 "Structure type with invalid element type", ElTy, STy);
1500 case Type::ArrayTyID: {
1501 const ArrayType *ATy = cast<ArrayType>(Ty);
1502 Assert1(ArrayType::isValidElementType(ATy->getElementType()),
1503 "Array type with invalid element type", ATy);
1504 VerifyType(ATy->getElementType());
1506 case Type::PointerTyID: {
1507 const PointerType *PTy = cast<PointerType>(Ty);
1508 Assert1(PointerType::isValidElementType(PTy->getElementType()),
1509 "Pointer type with invalid element type", PTy);
1510 VerifyType(PTy->getElementType());
1512 case Type::VectorTyID: {
1513 const VectorType *VTy = cast<VectorType>(Ty);
1514 Assert1(VectorType::isValidElementType(VTy->getElementType()),
1515 "Vector type with invalid element type", VTy);
1516 VerifyType(VTy->getElementType());
1523 // Flags used by TableGen to mark intrinsic parameters with the
1524 // LLVMExtendedElementVectorType and LLVMTruncatedElementVectorType classes.
1525 static const unsigned ExtendedElementVectorType = 0x40000000;
1526 static const unsigned TruncatedElementVectorType = 0x20000000;
1528 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1530 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1531 Function *IF = CI.getCalledFunction();
1532 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1535 #define GET_INTRINSIC_VERIFIER
1536 #include "llvm/Intrinsics.gen"
1537 #undef GET_INTRINSIC_VERIFIER
1542 case Intrinsic::dbg_declare: // llvm.dbg.declare
1543 if (Constant *C = dyn_cast<Constant>(CI.getOperand(1)))
1544 Assert1(C && !isa<ConstantPointerNull>(C),
1545 "invalid llvm.dbg.declare intrinsic call", &CI);
1547 case Intrinsic::memcpy:
1548 case Intrinsic::memmove:
1549 case Intrinsic::memset:
1550 Assert1(isa<ConstantInt>(CI.getOperand(4)),
1551 "alignment argument of memory intrinsics must be a constant int",
1554 case Intrinsic::gcroot:
1555 case Intrinsic::gcwrite:
1556 case Intrinsic::gcread:
1557 if (ID == Intrinsic::gcroot) {
1559 dyn_cast<AllocaInst>(CI.getOperand(1)->stripPointerCasts());
1560 Assert1(AI && isa<PointerType>(AI->getType()->getElementType()),
1561 "llvm.gcroot parameter #1 must be a pointer alloca.", &CI);
1562 Assert1(isa<Constant>(CI.getOperand(2)),
1563 "llvm.gcroot parameter #2 must be a constant.", &CI);
1566 Assert1(CI.getParent()->getParent()->hasGC(),
1567 "Enclosing function does not use GC.", &CI);
1569 case Intrinsic::init_trampoline:
1570 Assert1(isa<Function>(CI.getOperand(2)->stripPointerCasts()),
1571 "llvm.init_trampoline parameter #2 must resolve to a function.",
1574 case Intrinsic::prefetch:
1575 Assert1(isa<ConstantInt>(CI.getOperand(2)) &&
1576 isa<ConstantInt>(CI.getOperand(3)) &&
1577 cast<ConstantInt>(CI.getOperand(2))->getZExtValue() < 2 &&
1578 cast<ConstantInt>(CI.getOperand(3))->getZExtValue() < 4,
1579 "invalid arguments to llvm.prefetch",
1582 case Intrinsic::stackprotector:
1583 Assert1(isa<AllocaInst>(CI.getOperand(2)->stripPointerCasts()),
1584 "llvm.stackprotector parameter #2 must resolve to an alloca.",
1587 case Intrinsic::lifetime_start:
1588 case Intrinsic::lifetime_end:
1589 case Intrinsic::invariant_start:
1590 Assert1(isa<ConstantInt>(CI.getOperand(1)),
1591 "size argument of memory use markers must be a constant integer",
1594 case Intrinsic::invariant_end:
1595 Assert1(isa<ConstantInt>(CI.getOperand(2)),
1596 "llvm.invariant.end parameter #2 must be a constant integer", &CI);
1601 /// Produce a string to identify an intrinsic parameter or return value.
1602 /// The ArgNo value numbers the return values from 0 to NumRets-1 and the
1603 /// parameters beginning with NumRets.
1605 static std::string IntrinsicParam(unsigned ArgNo, unsigned NumRets) {
1606 if (ArgNo < NumRets) {
1608 return "Intrinsic result type";
1610 return "Intrinsic result type #" + utostr(ArgNo);
1612 return "Intrinsic parameter #" + utostr(ArgNo - NumRets);
1615 bool Verifier::PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
1616 int VT, unsigned ArgNo, std::string &Suffix) {
1617 const FunctionType *FTy = F->getFunctionType();
1619 unsigned NumElts = 0;
1620 const Type *EltTy = Ty;
1621 const VectorType *VTy = dyn_cast<VectorType>(Ty);
1623 EltTy = VTy->getElementType();
1624 NumElts = VTy->getNumElements();
1627 const Type *RetTy = FTy->getReturnType();
1628 const StructType *ST = dyn_cast<StructType>(RetTy);
1629 unsigned NumRets = 1;
1631 NumRets = ST->getNumElements();
1636 // Check flags that indicate a type that is an integral vector type with
1637 // elements that are larger or smaller than the elements of the matched
1639 if ((Match & (ExtendedElementVectorType |
1640 TruncatedElementVectorType)) != 0) {
1641 const IntegerType *IEltTy = dyn_cast<IntegerType>(EltTy);
1642 if (!VTy || !IEltTy) {
1643 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1644 "an integral vector type.", F);
1647 // Adjust the current Ty (in the opposite direction) rather than
1648 // the type being matched against.
1649 if ((Match & ExtendedElementVectorType) != 0) {
1650 if ((IEltTy->getBitWidth() & 1) != 0) {
1651 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " vector "
1652 "element bit-width is odd.", F);
1655 Ty = VectorType::getTruncatedElementVectorType(VTy);
1657 Ty = VectorType::getExtendedElementVectorType(VTy);
1658 Match &= ~(ExtendedElementVectorType | TruncatedElementVectorType);
1661 if (Match <= static_cast<int>(NumRets - 1)) {
1663 RetTy = ST->getElementType(Match);
1666 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1667 "match return type.", F);
1671 if (Ty != FTy->getParamType(Match - NumRets)) {
1672 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1673 "match parameter %" + utostr(Match - NumRets) + ".", F);
1677 } else if (VT == MVT::iAny) {
1678 if (!EltTy->isInteger()) {
1679 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1680 "an integer type.", F);
1684 unsigned GotBits = cast<IntegerType>(EltTy)->getBitWidth();
1688 Suffix += "v" + utostr(NumElts);
1690 Suffix += "i" + utostr(GotBits);
1692 // Check some constraints on various intrinsics.
1694 default: break; // Not everything needs to be checked.
1695 case Intrinsic::bswap:
1696 if (GotBits < 16 || GotBits % 16 != 0) {
1697 CheckFailed("Intrinsic requires even byte width argument", F);
1702 } else if (VT == MVT::fAny) {
1703 if (!EltTy->isFloatingPoint()) {
1704 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1705 "a floating-point type.", F);
1712 Suffix += "v" + utostr(NumElts);
1714 Suffix += EVT::getEVT(EltTy).getEVTString();
1715 } else if (VT == MVT::vAny) {
1717 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a vector type.", F);
1720 Suffix += ".v" + utostr(NumElts) + EVT::getEVT(EltTy).getEVTString();
1721 } else if (VT == MVT::iPTR) {
1722 if (!isa<PointerType>(Ty)) {
1723 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1724 "pointer and a pointer is required.", F);
1727 } else if (VT == MVT::iPTRAny) {
1728 // Outside of TableGen, we don't distinguish iPTRAny (to any address space)
1729 // and iPTR. In the verifier, we can not distinguish which case we have so
1730 // allow either case to be legal.
1731 if (const PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
1732 Suffix += ".p" + utostr(PTyp->getAddressSpace()) +
1733 EVT::getEVT(PTyp->getElementType()).getEVTString();
1735 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1736 "pointer and a pointer is required.", F);
1739 } else if (EVT((MVT::SimpleValueType)VT).isVector()) {
1740 EVT VVT = EVT((MVT::SimpleValueType)VT);
1742 // If this is a vector argument, verify the number and type of elements.
1743 if (VVT.getVectorElementType() != EVT::getEVT(EltTy)) {
1744 CheckFailed("Intrinsic prototype has incorrect vector element type!", F);
1748 if (VVT.getVectorNumElements() != NumElts) {
1749 CheckFailed("Intrinsic prototype has incorrect number of "
1750 "vector elements!", F);
1753 } else if (EVT((MVT::SimpleValueType)VT).getTypeForEVT(Ty->getContext()) !=
1755 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is wrong!", F);
1757 } else if (EltTy != Ty) {
1758 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is a vector "
1759 "and a scalar is required.", F);
1766 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1767 /// Intrinsics.gen. This implements a little state machine that verifies the
1768 /// prototype of intrinsics.
1769 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
1771 unsigned ParamNum, ...) {
1773 va_start(VA, ParamNum);
1774 const FunctionType *FTy = F->getFunctionType();
1776 // For overloaded intrinsics, the Suffix of the function name must match the
1777 // types of the arguments. This variable keeps track of the expected
1778 // suffix, to be checked at the end.
1781 if (FTy->getNumParams() + FTy->isVarArg() != ParamNum) {
1782 CheckFailed("Intrinsic prototype has incorrect number of arguments!", F);
1786 const Type *Ty = FTy->getReturnType();
1787 const StructType *ST = dyn_cast<StructType>(Ty);
1789 // Verify the return types.
1790 if (ST && ST->getNumElements() != RetNum) {
1791 CheckFailed("Intrinsic prototype has incorrect number of return types!", F);
1795 for (unsigned ArgNo = 0; ArgNo < RetNum; ++ArgNo) {
1796 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1798 if (ST) Ty = ST->getElementType(ArgNo);
1800 if (!PerformTypeCheck(ID, F, Ty, VT, ArgNo, Suffix))
1804 // Verify the parameter types.
1805 for (unsigned ArgNo = 0; ArgNo < ParamNum; ++ArgNo) {
1806 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1808 if (VT == MVT::isVoid && ArgNo > 0) {
1809 if (!FTy->isVarArg())
1810 CheckFailed("Intrinsic prototype has no '...'!", F);
1814 if (!PerformTypeCheck(ID, F, FTy->getParamType(ArgNo), VT, ArgNo + RetNum,
1821 // For intrinsics without pointer arguments, if we computed a Suffix then the
1822 // intrinsic is overloaded and we need to make sure that the name of the
1823 // function is correct. We add the suffix to the name of the intrinsic and
1824 // compare against the given function name. If they are not the same, the
1825 // function name is invalid. This ensures that overloading of intrinsics
1826 // uses a sane and consistent naming convention. Note that intrinsics with
1827 // pointer argument may or may not be overloaded so we will check assuming it
1828 // has a suffix and not.
1829 if (!Suffix.empty()) {
1830 std::string Name(Intrinsic::getName(ID));
1831 if (Name + Suffix != F->getName()) {
1832 CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1833 F->getName().substr(Name.length()) + "'. It should be '" +
1838 // Check parameter attributes.
1839 Assert1(F->getAttributes() == Intrinsic::getAttributes(ID),
1840 "Intrinsic has wrong parameter attributes!", F);
1844 //===----------------------------------------------------------------------===//
1845 // Implement the public interfaces to this file...
1846 //===----------------------------------------------------------------------===//
1848 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1849 return new Verifier(action);
1853 // verifyFunction - Create
1854 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1855 Function &F = const_cast<Function&>(f);
1856 assert(!F.isDeclaration() && "Cannot verify external functions");
1858 ExistingModuleProvider MP(F.getParent());
1859 FunctionPassManager FPM(&MP);
1860 Verifier *V = new Verifier(action);
1867 /// verifyModule - Check a module for errors, printing messages on stderr.
1868 /// Return true if the module is corrupt.
1870 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1871 std::string *ErrorInfo) {
1873 Verifier *V = new Verifier(action);
1875 PM.run(const_cast<Module&>(M));
1877 if (ErrorInfo && V->Broken)
1878 *ErrorInfo = V->MessagesStr.str();